chore(ci): test against multiple platforms

Author: cxw620

.github/workflows/ci.yml

@@ -1,38 +1,99 @@
-name: CI Test
+name: CI
 
 on:
   push:
-    paths: [ "src/**", "Cargo.toml"]
-  workflow_dispatch: {}
+    branches: ["main"]
+    paths:
+      - "src/**"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".github/workflows/ci.yml"
+  pull_request:
+    paths:
+      - "src/**"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".github/workflows/ci.yml"
+  merge_group:
+    paths:
+      - "src/**"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".github/workflows/ci.yml"
+  workflow_dispatch:
+
+permissions:
+  contents: read
 
 env:
+  RUSTFLAGS: -Dwarnings
+  RUST_BACKTRACE: full
   CARGO_TERM_COLOR: always
 
 jobs:
   test:
-    name: Build & Test
+    name: Test (Rust ${{matrix.toolchain}}, ${{matrix.os}}, target ${{matrix.target}})
+    runs-on: ${{matrix.os}}
+    strategy:
+      fail-fast: false
+      matrix:
+        toolchain: ["nightly", "beta", "stable", "1.83.0"]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        include:
+          - os: ubuntu-latest
+            target: x86_64-unknown-linux-gnu
+          - os: windows-latest
+            target: x86_64-pc-windows-msvc
+          - os: macos-latest
+            target: aarch64-apple-darwin
+    timeout-minutes: 45
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{matrix.toolchain}}
+          components: llvm-tools, clippy, rust-src
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: just,cargo-llvm-cov,cargo-nextest
+      - name: Enable type layout randomization
+        if: matrix.toolchain == 'nightly'
+        run: echo RUSTFLAGS=${RUSTFLAGS}\ -Zrandomize-layout >> $GITHUB_ENV
+      - run: sudo apt-get update && sudo apt-get install -y musl-tools
+        if: endsWith(matrix.target, 'musl')
+      - run: rustup target add ${{matrix.target}}
+      - run: just ci-test --target ${{matrix.target}}
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    env:
+      RUSTDOCFLAGS: -Dwarnings
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: dtolnay/install@cargo-docs-rs
+      - run: cargo docs-rs
+
+  clippy:
+    name: Clippy
     runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    timeout-minutes: 45
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - name: Read MSRV from Cargo.toml
-        id: msrv
-        run: |
-          echo "MSRV=$(grep '^rust-version = ' Cargo.toml | cut -d'"' -f2)" >> $GITHUB_ENV
-      - name: Setup Rust toolchain to MSRV
-        uses: actions-rust-lang/setup-rust-toolchain@v1
+      - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: ${{ env.MSRV }}
-      - name: Build
-        run: cargo build --verbose
-      # criterion breaks MSRV
-      - name: Setup Rust toolchain to latest stable
-        uses: actions-rust-lang/setup-rust-toolchain@v1
+          toolchain: 1.83.0
+          components: clippy
+      - uses: taiki-e/install-action@v2
         with:
-          toolchain: stable
-      - name: Test
-        run: cargo test --verbose
-        env:
-          RUST_BACKTRACE: 1
+          tool: just
+      - run: just clippy --all

Cargo.toml

@@ -17,7 +17,7 @@ repository = "https://github.com/hanyu-dev/proxy-protocol-codec"
 crc32c = { version = "0.6.8", default-features = false, optional = true }
 slicur = { version = "0.3.0", optional = true }
 thiserror = { version = "2.0", optional = true }
-uni-addr = { version = "0.3.1", default-features = false, optional = true }
+uni-addr = { version = "0.3.4", default-features = false, optional = true }
 wrapper-lite = { version = "0.3.2", default-features = false }
 
 [dev-dependencies]
@@ -65,9 +65,6 @@ feat-codec-v2-crc32c = ["feat-std", "dep:crc32c"]
 # Enable uni-addr support.
 feat-uni-addr = ["feat-std", "dep:uni-addr"]
 
-# Deprecated features.
-feat-codec-v2-uni-addr = ["feat-uni-addr", "feat-std"]
-
 [lints]
 clippy.allow_attributes_without_reason = "warn"
 clippy.assertions_on_result_states = "warn"

Justfile

@@ -0,0 +1,48 @@
+# just manual: https://github.com/casey/just#readme
+
+_default:
+	just --list
+
+# Run all tests with nextest and cargo-llvm-cov
+ci-test *args:
+	#!/bin/bash -eux
+	cargo llvm-cov nextest {{args}} --locked --lcov --output-path coverage.lcov
+
+# =========== LOCAL COMMANDS ===========
+
+build *args:
+	cargo build {{args}} --locked
+
+b *args:
+	just build {{args}}
+
+# Show coverage locally
+cov *args:
+	#!/bin/bash -eux
+	cargo llvm-cov nextest {{args}} --locked --hide-instantiations --html --output-dir coverage
+
+check *args:
+    cargo check {{args}} --locked --all-features
+
+c *args:
+	just check {{args}}
+
+clippy *args:
+	cargo clippy {{args}} --locked --all-features -- -Dclippy::all -Dclippy::pedantic
+
+example *args:
+	cargo run --example {{args}}
+
+e *args:
+	just example {{args}}
+
+msrv *args:
+	cargo +1.83.0 clippy {{args}} --locked --all-features -- -Dclippy::all -Dclippy::pedantic
+
+t *args:
+	just test {{args}}
+
+test *args:
+	#!/bin/bash -eux
+	export RUST_BACKTRACE=1
+	cargo nextest run {{args}} --locked --all-features

src/lib.rs

@@ -3,10 +3,8 @@
 //! See [HAProxy](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) for the protocol specification.
 
 #![no_std]
-#![cfg_attr(feature = "feat-nightly", feature(cold_path))]
-
-#[cfg(feature = "feat-codec-v2-uni-addr")]
-compile_error!("The `feat-codec-v2-uni-addr` feature is deprecated. Please use the `feat-uni-addr` feature instead.");
+#![allow(clippy::must_use_candidate, reason = "XXX")]
+#![allow(clippy::return_self_not_must_use, reason = "XXX")]
 
 #[cfg(feature = "feat-codec-v1")]
 pub mod v1;
@@ -35,7 +33,8 @@ impl Version {
     /// The magic bytes that indicate a PROXY Protocol v2 header.
     pub const MAGIC_V2: &'static [u8; 12] = b"\r\n\r\n\x00\r\nQUIT\n";
 
-    #[allow(clippy::result_unit_err)]
+    #[allow(clippy::result_unit_err, reason = "XXX")]
+    #[allow(clippy::missing_errors_doc, reason = "XXX")]
     #[inline]
     /// Peeks into the given buffer to determine if it contains a valid PROXY
     /// Protocol version magic.
@@ -45,18 +44,27 @@ impl Version {
     /// If the buffer is too short to determine the version, `Ok(None)` is
     /// returned. If the buffer contains a valid version magic,
     /// `Ok(Some(Version))` is returned. Otherwise, `Err(())` is returned.
+    ///
+    /// ```
+    /// # use proxy_protocol_codec::Version;
+    /// let v1_magic = Version::MAGIC_V1.as_bytes();
+    /// let v2_magic = Version::MAGIC_V2;
+    /// assert_eq!(Version::peek(v1_magic), Ok(Some(Version::V1)));
+    /// assert_eq!(Version::peek(&v1_magic[..3]), Ok(None));
+    /// assert_eq!(Version::peek(v2_magic), Ok(Some(Version::V2)));
+    /// assert_eq!(Version::peek(&v2_magic[..6]), Ok(None));
+    /// # assert_eq!(Version::peek(&[0]), Err(()));
+    /// ```
     pub fn peek(buf: &[u8]) -> Result<Option<Self>, ()> {
         const V1_MAGIC_LEN: usize = Version::MAGIC_V1.len();
         const V2_MAGIC_LEN: usize = Version::MAGIC_V2.len();
 
-        #[allow(overlapping_range_endpoints)]
-        // Rust 1.77 doesn't support exclusive range endpoints in pattern matching.
         match buf.len() {
             0 => Ok(None),
             V2_MAGIC_LEN.. if buf.starts_with(Self::MAGIC_V2) => Ok(Some(Self::V2)),
+            1..V2_MAGIC_LEN if Self::MAGIC_V2.starts_with(buf) => Ok(None),
             V1_MAGIC_LEN.. if buf.starts_with(Self::MAGIC_V1.as_bytes()) => Ok(Some(Self::V1)),
-            1..=V2_MAGIC_LEN if Self::MAGIC_V2.starts_with(buf) => Ok(None),
-            1..=V1_MAGIC_LEN if Self::MAGIC_V1.as_bytes().starts_with(buf) => Ok(None),
+            1..V1_MAGIC_LEN if Self::MAGIC_V1.as_bytes().starts_with(buf) => Ok(None),
             _ => Err(()),
         }
     }

src/v1.rs

@@ -105,6 +105,10 @@ impl Header {
     /// exceed the [`MAXIMUM_LENGTH`].
     ///
     /// When any error is returned, the caller SHOULD reject the connection.
+    ///
+    /// # Errors
+    ///
+    /// See [`DecodeError`].
     pub fn decode(header_bytes: &[u8]) -> Result<Decoded, DecodeError> {
         // 1. Magic bytes flight check
         {

src/v1/model.rs

@@ -73,6 +73,10 @@ impl AddressPair {
     #[cfg(feature = "feat-codec-v2")]
     #[inline]
     /// Converts a [`v2::AddressPair`] to an [`AddressPair`].
+    ///
+    /// # Errors
+    ///
+    /// See [`Unsupported`].
     pub const fn try_from_v2(value: v2::AddressPair) -> Result<Self, Unsupported> {
         match value {
             v2::AddressPair::Unspecified => Ok(Self::Unspecified),
@@ -104,6 +108,10 @@ impl AddressPair {
 
     #[cfg(feature = "feat-uni-addr")]
     /// Returns the source address.
+    ///
+    /// # Errors
+    ///
+    /// This is infallible, but kept for API consistency.
     pub fn src_uni_addr(&self) -> io::Result<Option<uni_addr::UniAddr>> {
         use core::net::{SocketAddr, SocketAddrV4, SocketAddrV6};
 
@@ -120,6 +128,10 @@ impl AddressPair {
 
     #[cfg(feature = "feat-uni-addr")]
     /// Returns the destination address.
+    ///
+    /// # Errors
+    ///
+    /// This is infallible, but kept for API consistency.
     pub fn dst_uni_addr(&self) -> io::Result<Option<uni_addr::UniAddr>> {
         use core::net::{SocketAddr, SocketAddrV4, SocketAddrV6};
 

src/v2.rs

@@ -76,6 +76,10 @@ impl Header {
     #[cfg(feature = "feat-codec-decode")]
     #[inline]
     /// See [`HeaderDecoder::decode`].
+    ///
+    /// # Errors
+    ///
+    /// See [`DecodeError`].
     pub fn decode(encoded: &[u8]) -> Result<Decoded<'_>, DecodeError> {
         HeaderDecoder::decode(encoded)
     }