v0.10.0 (#48)

Draft pull request for release v0.10.0 to receive status and coverage
information through GH Actions. Closes #44 and #45

# Release v0.10

The tenth release of the polyproto crate is the biggest one yet. It
touches almost all areas of the source code and brings numerous
improvements, bug fixes and additions.

Most notably, v0.10 has been updated to be almost fully compliant with
Beta 1 of the polyproto specification! All the API routes, types and the
most important behaviors are there and available for you to tinker and
prototype with!

Some more advanced features are missing, though. Notably, v0.10 lacks
`zstd` WebSocket compression support and advanced migrations features,
such as performing and verifying migrations out of the box. Developers
and tinkerers can add this functionality themselves, as all the needed
"parts" for it exist (API routes, verification behaviors, etc.)—there
just isn't one, simple function you can call yet.

Things like these are planned for the v0.11 and v0.12 releases.

## Gateway

This version ships polyproto WebSocket gateway client functionality,
gated behind the `gateway` crate feature. The implementation of this
feature is super backend-agnostic—though, for now, we have sealed the
needed traits, and are only shipping a `tokio-tungstenite` backend for
testing.

The gateway handles establishing a connection to the server, sending
regular heartbeats at the specified interval and responding to Opcode
11—the manual heartbeat request.

Apart from the `Hello` payload, library consumers can easily get access
to all messages received from the gateway by calling `subscribe()` on
the internal `tokio::sync::watch::Sender<GatewayMessage>`. This means
that this crate handles only the bare necessities of connecting to the
gateway, and that you are free to handle incoming messages however you
would like to. Our `GatewayMessage` type is `.into()` and
`From::<>`-compatible with `tokio_tungstenite::tungstenite::Message`, so
that you are not locked into using our types, should you not want that.

Author: bitfl0wer

.github/license-check/config.json

@@ -0,0 +1,10 @@
+[
+	{
+		"include": ["**/*.rs"],
+		"license": "./.github/license-check/header-mpl-2.0.txt",
+		"exclude": ["target/**", "**/"]
+	},
+	{
+		"include": ["target/**", "**/**"]
+	}
+]

.github/license-check/header-mpl-2.0.txt

@@ -0,0 +1,3 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.

.github/workflows/build_and_test.yml

@@ -15,32 +15,13 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+      - name: Install rust toolchain 1.85.1
+        uses: dtolnay/rust-toolchain@1.85.1
       - uses: Swatinem/rust-cache@v2
         with:
           cache-all-crates: "true"
           prefix-key: "linux"
       - uses: taiki-e/install-action@nextest
       - name: nextest run
         run: |
-          cargo nextest run --verbose --all-features --tests --examples
-
-  # wasm:
-  #   runs-on: ubuntu-latest
-  #   steps:
-  #     - uses: actions/checkout@v4
-  #     - 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
-  #         cargo binstall --no-confirm wasm-pack --force
-  #         wasm-pack test --node -- --features wasm --examples
-  #         wasm-pack test --firefox -- --features wasm --examples
-  #         wasm-pack test --chrome -- --features wasm --examples
-  #         wasm-pack test --node -- --features wasm
-  #         wasm-pack test --firefox -- --features wasm
-  #         wasm-pack test --chrome -- --features wasm
+          cargo nextest run --features="types,reqwest,gateway" --failure-output final --no-fail-fast

.github/workflows/coverage.yml

@@ -23,7 +23,7 @@ jobs:
           if [ -n "${{ secrets.COVERALLS_REPO_TOKEN }}" ]; then
               curl -L --proto '=https' --tlsv1.3 -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 --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120
+              cargo tarpaulin --features="gateway, reqwest, serde, types" --tests --verbose --skip-clean --coveralls ${{ secrets.COVERALLS_REPO_TOKEN }} --timeout 120 --fail-immediately
           else
               echo "Code Coverage step is skipped on PRs from forks."
           fi

.github/workflows/license-header.yml

@@ -0,0 +1,17 @@
+name: License Header Check
+
+on: [push, pull_request]
+
+jobs:
+  check-license-headers:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Check license headers
+        uses: viperproject/check-license-header@v2
+        with:
+          path: .
+          config: ./.github/license-check/config.json
+          strict: true

.github/workflows/wasm.yml

@@ -0,0 +1,35 @@
+name: Build and Test (wasm32)
+
+on:
+  push:
+    branches: ["main"]
+  pull_request:
+    branches: ["*"]
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  wasm:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install rust toolchain 1.85.1
+        uses: dtolnay/rust-toolchain@1.85.1
+      - uses: Swatinem/rust-cache@v2
+        with:
+          cache-all-crates: "true"
+          prefix-key: "wasm"
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "lts/*"
+          check-latest: true
+      - name: Compile wasm
+        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-pack --force
+          wasm-pack build --features=wasm,serde,types --no-default-features
+          wasm-pack build --features=wasm,types --no-default-features
+          wasm-pack build --features=wasm --no-default-features

.gitignore

@@ -7,4 +7,6 @@
 cert.csr
 cert.der
 /firedbg
-.vscode/ltex.*
+.vscode/ltex.*
+pkg/
+wasm-pack.log

.vscode/settings.json

@@ -1,4 +1,16 @@
 {
 	"markiscodecoverage.searchCriteria": ".coverage/lcov*.info",
+	// --- Toggle the below setting using line comments to enable/disable working with wasm platforms ---
 	"rust-analyzer.cargo.features": ["types", "reqwest", "gateway", "serde"]
+	// --- Toggle the below settings using line comments to enable/disable working with wasm platforms ---
+	// "rust-analyzer.cargo.features": [
+	// 	"_wasm_bindgen",
+	// 	"wasm",
+	// 	"types",
+	// 	"reqwest",
+	// 	"gateway",
+	// 	"serde"
+	// ],
+	// "rust-analyzer.cargo.noDefaultFeatures": true,
+	// "rust-analyzer.cargo.target": "wasm32-unknown-unknown"
 }

Cargo.toml

@@ -1,59 +1,97 @@
 [package]
 name = "polyproto"
-version = "0.9.0"
-edition = "2021"
+version = "0.10.0"
+edition = "2024"
 license = "MPL-2.0"
 description = "(Generic) Rust types and traits to quickly get a polyproto implementation up and running"
 repository = "https://github.com/polyphony-chat/polyproto"
-rust-version = "1.71.1"
+rust-version = "1.85.0"
 
 [lib]
-crate-type = ["rlib", "cdylib", "staticlib"]
+crate-type = ["cdylib", "rlib"]
 
 [features]
-default = ["types"]
-wasm = ["getrandom", "getrandom/js"]
+default = ["types", "serde", "gateway", "tokio/net"]
+wasm = ["getrandom", "getrandom/js", "dep:ws_stream_wasm"]
 getrandom = ["dep:getrandom"]
 types = ["dep:http"]
-reqwest = ["dep:reqwest", "types", "serde", "dep:url"]
-serde = [
-    "dep:serde",
-    "dep:serde_json",
-    "dep:url",
-    "url/serde",
-    "dep:serde_with",
-]
+reqwest = ["dep:reqwest", "types", "serde"]
+serde = ["dep:serde", "serde_json", "serde_with", "url/serde"]
+serde_with = ["dep:serde_with"]
+serde_json = ["dep:serde_json"]
 gateway = ["serde", "types"]
+_wasm_bindgen = ["wasm", "dep:wasm-bindgen", "dep:js-sys", "dep:wee_alloc"]
+__no_wee_alloc = []
 
 [dependencies]
 der = { version = "0.7.9", features = ["pem"] }
 getrandom = { version = "0.2.15", optional = true }
 regex = "1.11.1"
-reqwest = { version = "0.12.12", features = ["json", "zstd"], optional = true }
-serde = { version = "1.0.217", optional = true, features = ["derive"] }
-serde_json = { version = "1.0.137", optional = true }
+reqwest = { version = "0.12.15", features = [
+    "json",
+    "zstd",
+    "rustls-tls-webpki-roots",
+    "charset",
+    "http2",
+    "macos-system-configuration",
+    "multipart",
+], optional = true, default-features = false }
+serde = { version = "1.0.219", optional = true, features = ["derive"] }
+serde_json = { version = "1.0.140", optional = true }
 spki = { version = "0.7.3", features = ["pem"] }
-thiserror = "2.0.11"
+thiserror = "2.0.12"
 x509-cert = "0.2.5"
-log = "0.4.25"
-url = { version = "2.5.4", optional = true }
-http = { version = "1.2.0", optional = true }
+log = "0.4.27"
+url = { version = "2.5.4" }
+http = { version = "1.3.1", optional = true }
 serde_with = { version = "3.12.0", optional = true }
+hex = "0.4.3"
+tokio = { version = "1.44.1", features = ["macros", "sync", "time", "rt"] }
+webpki-roots = "0.26.8"
+futures-util = "0.3.31"
+urlencoding = "2.1.3"
+ws_stream_wasm = { version = "*", optional = true }
+
+[target.'cfg(target_arch = "wasm32")'.dependencies]
+wasm-bindgen = { version = "0.2.100", optional = true }
+js-sys = { version = "0.3.77", optional = true }
+wee_alloc = { version = "0.4.5", optional = true }
+
+[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
+rustls = "0.23.25"
+tokio-tungstenite = { version = "0.26.2", features = [
+    "rustls-tls-webpki-roots",
+    "url",
+] }
 
 [dev-dependencies]
 ed25519-dalek = { version = "2.1.1", features = ["rand_core", "signature"] }
-env_logger = "0.11.6"
-httptest = "0.16.1"
 rand = "0.8.5"
-tokio = { version = "1.43.0", features = ["full"] }
-serde = { version = "1.0.217", features = ["derive"] }
-serde_json = { version = "1.0.137" }
+serde = { version = "1.0.219", features = ["derive"] }
+serde_json = { version = "1.0.140" }
 serde_test = "1.0.177"
 polyproto = { path = "./", features = ["types", "reqwest", "serde"] }
+env_logger = "0.11.7"
+
+[target.'cfg(not(target_arch = "wasm32"))'.dev-dependencies]
+ws-mock = "0.3.0"
+httptest = "0.16.3"
+
 
 [target.'cfg(target_arch = "wasm32")'.dev-dependencies]
 wasm-bindgen-test = "0.3.50"
-wasm-bindgen = "0.2.100"
+# The `console_error_panic_hook` crate provides better debugging of panics by
+# logging them with `console.error`. This is great for development, but requires
+# all the `std::fmt` and `std::panicking` infrastructure, so isn't great for
+# code size when deploying.
+console_error_panic_hook = { version = "0.1.7" }
+
+[target.'cfg(target_arch = "wasm32")'.release]
+# Tell `rustc` to optimize for small code size.
+opt-level = "s"
+lto = true
+codegen-units = 1
+panic = "abort"
 
 [lints.rust]
 unexpected_cfgs = { level = "warn", check-cfg = ['cfg(tarpaulin_include)'] }

README.md

@@ -26,12 +26,12 @@ crate.
 
 ## Implementing polyproto
 
-Start by implementing the trait [crate::signature::Signature] for a signature algorithm of your
+Start by implementing the trait `[crate::signature::Signature]` for a signature algorithm of your
 choice. Popular crates for cryptography and signature algorithms supply their own `PublicKey` and
 `PrivateKey` types. You should extend upon these types with your own structs and implement the
-[crate::key] traits for these new structs.
+`[crate::key]` traits for these new structs.
 
-You can then use the [crate::certs] types to build certificates using your implementations of the
+You can then use the `[crate::certs]` types to build certificates using your implementations of the
 aforementioned traits.
 
 **View the [examples](./examples/)** directory for a simple example on how to implement and use this
@@ -63,6 +63,10 @@ will have to use the `wasm` feature:
 polyproto = { version = "0", features = ["wasm"] }
 ```
 
+Additionally, you will have to compile the project using the `--no-default-features` flag, to ensure
+that `tokio/net` is not pulled in as a feature dependency. The `types`, `serde`, `reqwest` and `gateway`
+features all work with WASM.
+
 ## HTTP API client through `reqwest`
 
 If the `reqwest` feature is activated, this crate offers a polyproto HTTP API client, using the
@@ -75,6 +79,28 @@ the `types` and `serde` features. Using these features, you can implement your o
 the polyproto crate acting as a single source of truth for request and response types, as well as
 request routes and methods through the exported `static` `Route`s.
 
+## WebSocket Gateway client
+
+Since `v0.10`, this crate ships polyproto WebSocket Gateway client functionality, gated behind the `gateway` feature.
+The implementation of this feature is super backend-agnostic—though, for now, we have sealed the needed traits, and are only shipping a `tokio-tungstenite` backend for testing.
+
+The gateway handles establishing a connection to the server, sending regular heartbeats at the specified interval and responding to Opcode 11—the manual heartbeat request.
+
+Apart from the Hello payload, library consumers can easily get access to all messages received from the gateway by calling `subscribe()` on the internal `tokio::sync::watch::Sender<GatewayMessage>`. This means that this crate handles only the bare necessities of connecting to the gateway, and that you are free to handle incoming messages however you would like to. Our `GatewayMessage` type is `.into()` and `From::<>`-compatible with `tokio_tungstenite::tungstenite::Message`, so that you are not locked into using our message types, should you not want that.
+
+## Versioning and MSRV
+
+Semver v2.0 is used for the versioning scheme for this crate.
+
+The default feature set of this crate is used to determine, verify and update the MSRV and semver version
+of this crate.
+
+## Logo
+
+The polyproto logo was designed by the wonderful [antidoxi](https://antidoxi.carrd.co/).
+The polyproto logos provided in this document are not covered by the MPL-2.0 license covering the rest
+of this project.
+
 [dev-status]: https://img.shields.io/static/v1?label=Status&message=Alpha&color=blue
 [build-shield]: https://img.shields.io/github/actions/workflow/status/polyphony-chat/polyproto-rs/build_and_test.yml?style=flat
 [build-url]: https://github.com/polyphony-chat/polyproto-rs/blob/main/.github/workflows/build_and_test.yml
@@ -85,7 +111,3 @@ request routes and methods through the exported `static` `Route`s.
 [crates-link]: https://crates.io/crates/polyproto
 [docs]: https://docs.polyphony.chat/Protocol%20Specifications/core/
 [overview]: https://docs.polyphony.chat/Overviews/core/
-
-## Logo
-
-The polyproto logo was designed by the wonderful [antidoxi](https://antidoxi.carrd.co/).