Skip to content

Commit

Permalink
🎉 Release 0.16.0
Browse files Browse the repository at this point in the history
* add WebSocketEvent macro derive, bump chorus-macros to 0.3.0 (#490)

* feat: add WebSocketEvent derive, bump to 0.2.1

* change license, version of macros

* Use WebSocketEvent derive instead of impl WebSocketEvent for .. (#491)

use derive macro instead of manual impl blocks

* Move Shared<T> to types/mod.rs, bump some dependencies (#492)

* deps: bump rustls to 0.21.11

This is done to fix CVE-2024-32650, which practically shouldn't affect
us but it's still better not to use vulnerable dependencies.

* deps: bump h2 to 0.3.26

This is done to fix another vulnerability, which should also not affect
us (non-critical, in h2 servers)

* fix: move Shared<T> to types/mod.rs

* Reuse gateway backends, don't duplicate them for voice gateway (#493)

* Refactor / fix login and register (#495)

Change login and register to only use one ChorusUser object, change the
api of related methods which were also somewhat ugly

* Add the repository field to Cargo.toml

* Ci improvements (#498)

* bump wasm-bindgen version to 0.2.92

* change wasm-gecko to using ubuntu-latest, since geckodriver is not supported on macos-latest

* check some common non-default feature configurations

* add experimental semver checks

* Update poem dependency

* Convert timestamp fields to DateTime's

* Feature lock different types for UserSettings::status

* Make config register_configuration use Rights bitflag object

* Update tests to use DateTime's for timestamps

* Fix tests

* Allow joined_at to default if field is not in responses.

* Allow last_pin_timestamp to default if field is not in responses.

* Remove serde(with) for message timestamps

* Fix some iso timestamps being strings, not DateTime<Utc> (#499)

* fix: some iso timestamps being strings

* fix: register uses dates, not datetimes

* Add sqlx::FromRow derive to GuildMember

* remove dep: prefix in backend feature list

* Implement sqlx Encode, Decode, Type for Rights bitflag object.

* Use Snowflake in Claims

* Use ChannelType enum on ChannelModifySchema

* Feature lock Shared, so backend feature gets a facade type

* Remove erroneous serde with attributes

* Add From<Vec<GuildFeatures>> impl for GuildFeaturesList

* Add feature sqlx locks for user, roles on GuildMember

* Use distinct type for explicit_content_filter

* Remove unused imports

* Revert c445213

* Remove final usages of erroneous serde impl

* Fix errors in documentation tests

* update dev-dependencies

* actually fix linux tests

* clear warnings

* Update Cargo.lock

* Expand documentation to explain facade type

* Fix oversight for premium_since

* Backend related updates (#501)

(by Quat3rnion)

Some updates relating to usage with Symfonia:
* Using distinct types instead of primitives on some objects
* Add sqlx derives and implementations
* Make a facade type for Shared to be used in non-client contexts

* Distinguish InviteType and InviteTargetType

* Add sqlx Type, Encode, Decode impl for InviteFlags bitflag object.

* Use distinct type `DefaultReaction`

* Update fields for backend/sqlx compatibility.

* Update derive for backend/sqlx compatibility.

* Write custom serialize/deserialize impl's for InviteFlags

* Clear warnings

* Add InviteFlags::VIEWED

* Remove double bound for E

* Use distinct types in `InviteGuild` object.

* Implement `From<Guild> for InviteGuild`

* Add `GetInvitesSchema`

* Add forgotten import and pub use.

* Fix compile error

* Update docs aesthetics

Co-authored-by: kozabrada123 <[email protected]>

* Add type locks

* Fix inverted type wrapping

* Update Cargo.lock

* Add SqlxBitFlags derive macro

* Utilize new macros and use distinct Flag types

* Add distinct MessageType enum

* Fix error in macro

* Make UserFlags deserialize from string

* Add partial emoji and custom reaction types, refine SQLx mapping

* Use chorus_macros from path, since it's there anyway

* Fix test

* Add forgotten feature locks

* Remove unused imports, feature locks in macro

* forgot a file :(

* Feature lock the macro

* Dirty hack

* Fix test

I feel silly.

* Fix compilation for real, no dirty hack

* Maybe fix tests, make UserFlags able to be deserialized from String or u64

* Add new SerdeBitFlags derive macro, to help reduce repetitive code

* u8 -> u64

* Fix deserialization error w/ guild features list

* chorus macros 0.4.0

* always update to latest release of macros

* Update and add some types in support of the backend (#507)

* Implement gateway options, zlib-stream compression (#508)

* feat: add GatewayOptions

* feat: implement zlib-stream compression

This also changes how gateway messages work.
Now each gateway backend converts its message into an
intermediary RawGatewayMessage, from which we inflate
and parse GatewayMessages.

Thanks to ByteAlex and their zlib-stream-rs crate, which
helped me understand how to parse a compressed websocket stream

* Backend/guilds (#509)

* Fix SQL encode/decode for GuildFeatures

* Use distinct PermissionFlags type

* Add Emoji schema types, modify GuildBan with feature lock

* Add Schemas for pruning guild members

* Add schemas for interfacing with stickers backend routes

* Add schemas for interfacing with vanity-url backend routes

* Add schema for interfacing with guilds/id/welcome-screen route

* Make all Option<Vec> types Vec types with #[serde(default)]

* Add various types to support guilds/* api routes

* Add missing enums and structs for searching messages

* Use proper distinct types

* Add EmbedType enum

* Use distinct PermissionFlags type

* Changes supporting backend for VoiceState

* Changes supporting backend for AuditLog's

* Add custom deserializer for PermissionOverwriteType (#512)

* Add custom deserializer for PermissionOverwriteType

* Miscellaneous fixes (#514)

- fix `PATCH /users/@me` - It incorrectly returned a required password error, even if the current password was set
- fix `GET /users/@me/guilds` - It incorrectly sent body parameters instead of query ones
- don't log debug! for every successful ratelimited request - use trace! so it's less spamy
- update the max expected compression ratio (several times) from 20 to 200. let's hope that will be enough
- fix deserialization errors relating to guild folders in user settings
- fix a panic in `SqlxBitFlags` if there are extra flags. It now truncates them
- update `chorus_macros` to 0.4.1 (due to the above fix)
- log (trace!) event data if we fail to parse it or it's unrecognised, for debugging purposes
- fix a deserialization error in the `MessageACK` event
- fix `public_flags` in user objects not being `PublicFlags` bitflags

* No openssl (#522)

* Remove openssl from some packages' deps

* Add shorthand wasm build script

* Eliminate openssl dependency from crate

* Build RootCertStore from webpki roots instead of native roots

* Expand wasm documentation

* Revert reqwest

* Lock reqwest at 0.11.23

* Lock reqwest at 0.11.26, latest possible version

* Add wasm test script

* Replace `Observer` and `GatewayEvent` with `pubserve` crate

* Fix voice, voice_udp features

* Add one BILLION derives

* Provide alternative implementations for PartialEq for some types when sqlx feature is enabled

* Provide alternative implementations for PartialEq for some types when sqlx feature is enabled

* Fix: Wrong function name

* Fix: Turn unconditional import of sqlx::types::Json into conditional one

* Fix: Compile error with no default features

* Update CONTRIBUTING.md

* Use cargo nextest

* Use cargo nextest

* Fix/Correct UnavailableGuild object

* Fix testcase that relied on false behavior implemented by older spacebar servers

* Increase limit integer size to match spacebars' possibilities

* Cargo nextest on wasm, Parallelize "Check common non-default feat. cfg."

* forgor installing nextest

* Revert: nextest on wasm

* Bump browser_version according to https://www.useragents.me/#most-common-desktop-useragents

* Fix voice_simple example

* Update documentation in gateway_observers example

* Readd Observer trait as reexport

* remove cargo lock from example

* Fix #525 (pr #532)

* change theme_colors from Vec<u32> to (u32, u32)

* Custom ThemeColors type with sqlx::Encode and sqlx::Decode impls

* impl sqlx::Type for ThemeColors

* More accurate "GatewayHello::default()"

* Manually implement std::default::Default for GatewayHeartbeat and GatewayHeartbeatAck

* bump versions of packages to latest compatible versions

* Update MSRV (#540)

* Update msrv

* sqlx related improvements (#542)

* Bump sqlx to 0.8.0

* Update sqlx syntax to 0.8.0, change MySql for sqlx:: Any

* Update sqlx syntax to 0.8.0, change MySql for sqlx:: Any

* Modify chorus_macros::SqlxBitflagDerive to use sqlx::Any over sqlx::MySql (broken!)

* Fix: `cannot infer type for type parameter `DB` declared on the trait...`

* Change remaining impls of sqlx traits for MySql to sqlx::Any

* Alter chorus_macros to correctly derive SqlxBitFlag for sqlx::Any

* rustc/clippy>=v1.80.0: Do not warn when encountering cfg(tarpaulin_include)

* Port compare_* methods to sqlx v0.8.0

* CI/CD: add cargo-doc job (#544)

* CI/CD: add cargo-doc job

* fix: make it rustdoc, totally not clippy

* Initial support for PostgreSQL (#548)

* Change sqlx::Any to sqlx::Postgres

* Change sqlx::Any to sqlx::Postgres

* Remove JSONified overrides when sqlx feature is enabled, where it makes sense

* Add num-bigint dep

* Remove generic impl for From<T> for Snowflake
For some reason, this trait bound conflicts with another trait bound from the sqlx-pg-uint crate, even though I personally don't get why.

* Remove num_bigint, adsd sqlx-pg-uint

* swap u64 for PgU64 in some files

* use v0.3.0 of sqlx-pg-uint

* Lots of sqlx-postgres type changes

* Lots of sqlx-postgres type changes

* gwah

* Change repr(i8) to repr(i16) in enums when sqlx feature is enabled, fix sqlx incompatibilities

* impl sqlx::postgres::PgHasArrayType for Snowflake

* Try: derive Type for FriendSourceFlags, GuildFolder

* Try: Derive FromRow, Type for DefaultReaction

* Try: Derive Type for CustomStatus

* Try: Derive Type, FromRow for Tag

* Replace conditional compiling of uNN/PgUNN with conditional compiled type alias

* Fix: Conditional compiling errors and warnings

* Bump: wasm-bindgen* crate versions

* Bump sqlx-pg-uint

* Uncomment and update decode_token()

* Snowflake: PgU64 as base for sqlx (#551)

* Bump sqlx-pg-uint, sqlx

* Use PgU64 as base for implementations of sqlx traits for Snowflake

* sqlx_bitflag_derive: Use PgU64 as translation base (#552)

* sqlx_bitflag_derive: Use PgU64 as translation base

* Bump version of chorus-macros

* Prefer `&str` over `String` when possible (#553)

Prefer &str over String where possible.

* Tungstenite: Match scheme for "ws" or "wss" (#554)

Match scheme for "ws" or "wss" and choose whether to connect with TLS connector for tungstenite

* Add missing `impl From<Snowflake> for u64`, closes `From<Snowflake> for u64` missing #550

* Update README.md

* Bump package versions

* move up sending identify

* Make instance GatewayOptions configurable for library consumers (#555)

* Make instance GatewayOptions configurable for library consumers

* Update example in README

* Revert d846ce9

* 0.16.0: fix lints (#558)

* chore: fix doc lints

* fix: use different chrono function due to deprecation

* chore: format

* Bump version to v0.16.0

---------

Co-authored-by: Gábor Szabó <[email protected]>
Co-authored-by: Flori <[email protected]>
Co-authored-by: Quat3rnion <[email protected]>
Co-authored-by: Quat3rnion <[email protected]>
Co-authored-by: bitfl0wer <[email protected]>
  • Loading branch information
6 people authored Aug 28, 2024
1 parent cb3551d commit 3e22b5c
Show file tree
Hide file tree
Showing 160 changed files with 4,962 additions and 2,393 deletions.
216 changes: 108 additions & 108 deletions .github/workflows/build_and_test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,133 +2,133 @@ name: Build and Test

on:
push:
branches: [ "main" ]
branches: ["main"]
pull_request:
branches: [ "main", "dev" ]
branches: ["main", "dev"]

env:
CARGO_TERM_COLOR: always

jobs:
linux:

runs-on: ubuntu-latest
timeout-minutes: 30

steps:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
node-version: 18
cache: 'npm'
cache: "npm"
cache-dependency-path: server/package-lock.json
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "linux"
- name: Build, Test and Publish Coverage
run: |
if [ -n "${{ secrets.COVERALLS_REPO_TOKEN }}" ]; then
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm cargo-tarpaulin --force
cargo tarpaulin --all-features --avoid-cfg-tarpaulin --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120
else
echo "Code Coverage step is skipped on forks!"
cargo build --verbose --all-features
cargo test --verbose --all-features
fi
# wasm-safari:
# runs-on: macos-latest
# steps:
# - uses: actions/checkout@v4
# - name: Clone spacebar server
# run: |
# git clone https://github.com/bitfl0wer/server.git
# - uses: actions/setup-node@v4
# with:
# node-version: 18
# cache: 'npm'
# cache-dependency-path: server/package-lock.json
# - name: Prepare and start Spacebar server
# run: |
# npm install
# npm run setup
# npm run start &
# working-directory: ./server
# - uses: Swatinem/rust-cache@v2
# with:
# cache-all-crates: "true"
# prefix-key: "macos-safari"
# - name: Run WASM tests with Safari, Firefox, Chrome
# run: |
# rustup target add wasm32-unknown-unknown
# curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
# cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
# SAFARIDRIVER=$(which safaridriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt" --no-fail-fast
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "linux"
- uses: taiki-e/install-action@nextest
- name: Build, Test with nextest, Publish Coverage
run: |
if [ -n "${{ secrets.COVERALLS_REPO_TOKEN }}" ]; then
if [ "${{github.event.pull_request.head.ref}}" = "main" ]; then
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm cargo-tarpaulin --force
cargo tarpaulin --all-features --avoid-cfg-tarpaulin --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120
else
echo "Code Coverage step is skipped on non-main PRs and PRs from forks."
cargo nextest run --verbose --all-features
fi
else
echo "Code Coverage step is skipped on non-main PRs and PRs from forks."
cargo nextest run --verbose --all-features
fi
linux-non-default-features:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- uses: actions/checkout@v4
- name: Check common non-default feature configurations
run: |
echo "No features:"
cargo check --features="" --no-default-features
echo "Only client:"
cargo check --features="client" --no-default-features
echo "Only backend:"
cargo check --features="backend" --no-default-features
echo "Only voice:"
cargo check --features="voice" --no-default-features
echo "Only voice gateway:"
cargo check --features="voice_gateway" --no-default-features
echo "Backend + client:"
cargo check --features="backend, client" --no-default-features
echo "Backend + voice:"
cargo check --features="backend, voice" --no-default-features
echo "Backend + voice gateway:"
cargo check --features="backend, voice_gateway" --no-default-features
echo "Client + voice gateway:"
cargo check --features="client, voice_gateway" --no-default-features
wasm-gecko:
runs-on: macos-latest
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
node-version: 18
cache: 'npm'
cache: "npm"
cache-dependency-path: server/package-lock.json
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "macos"
- name: Run WASM tests with Safari, Firefox, Chrome
run: |
rustup target add wasm32-unknown-unknown
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "macos"
- name: Run WASM tests with Safari, Firefox, Chrome
run: |
rustup target add wasm32-unknown-unknown
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.93" --force
GECKODRIVER=$(which geckodriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
wasm-chrome:
runs-on: macos-latest
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
- uses: actions/checkout@v4
- name: Clone spacebar server
run: |
git clone https://github.com/bitfl0wer/server.git
- uses: actions/setup-node@v4
with:
node-version: 18
cache: 'npm'
cache: "npm"
cache-dependency-path: server/package-lock.json
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "macos"
- name: Run WASM tests with Safari, Firefox, Chrome
run: |
rustup target add wasm32-unknown-unknown
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.88" --force
CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
- name: Prepare and start Spacebar server
run: |
npm install
npm run setup
npm run start &
working-directory: ./server
- uses: Swatinem/rust-cache@v2
with:
cache-all-crates: "true"
prefix-key: "macos"
- name: Run WASM tests with Safari, Firefox, Chrome
run: |
rustup target add wasm32-unknown-unknown
curl -L --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh | bash
cargo binstall --no-confirm wasm-bindgen-cli --version "0.2.93" --force
CHROMEDRIVER=$(which chromedriver) cargo test --target wasm32-unknown-unknown --no-default-features --features="client, rt, voice_gateway"
35 changes: 35 additions & 0 deletions .github/workflows/cargo-doc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: cargo doc lints

on:
push:
branches: [ "main", "preserve/*" ]
pull_request:
branches: [ "main", "dev" ]

jobs:
cargo-doc-lints:
name: Run cargo doc for doc lints
runs-on: ubuntu-latest
permissions:
contents: read
security-events: write
actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Install Rust toolchain
uses: dtolnay/rust-toolchain@stable

- name: Install aditional components for sarif
run: cargo install clippy-sarif sarif-fmt

- name: Run cargo doc
run: cargo doc --no-deps --all-features --locked --message-format=json | clippy-sarif | sed 's/rust-lang.github.io\/rust-clippy/doc.rust-lang.org\/rustdoc\/lints.html/g' | sed 's/clippy/rustdoc/g' | tee cargo-doc-results.sarif | sarif-fmt
continue-on-error: true

- name: Upload analysis results to GitHub
uses: github/codeql-action/upload-sarif@v3
with:
sarif_file: cargo-doc-results.sarif
wait-for-processing: true
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@

**Please refer to the [contribution guidelines](https://github.com/polyphony-chat/.github/blob/main/CONTRIBUTION_GUIDELINES.md) and [our Code of Conduct](https://github.com/polyphony-chat/.github/blob/main/CODE_OF_CONDUCT.md) before making a contribution.**

Contributions should always fork from and merge back into the `dev` branch.

Chorus is currently missing voice support and a lot of API endpoints, many of which should be trivial to implement,
ever since [we streamlined the process of doing so](https://github.com/polyphony-chat/chorus/discussions/401).

If you'd like to contribute new functionality, check out [The 'Meta'-issues.](https://github.com/polyphony-chat/chorus/issues?q=is%3Aissue+label%3A%22Type%3A+Meta%22+) They contain a comprehensive list of all features which are yet missing for full Discord.com compatibility.
Please feel free to open an Issue with the idea you have, or a Pull Request.
Please feel free to open an Issue with the idea you have, or a Pull Request.
Loading

0 comments on commit 3e22b5c

Please sign in to comment.