cachekit-core 0.7.3

name: CI

on:
  pull_request:
    branches: [main]

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  test:
    name: ${{ matrix.label || matrix.rust }} / ${{ matrix.os }}
    runs-on: ${{ matrix.os }}
    # Fail fast instead of hanging ~10min to GitHub's heartbeat if a runner wedges.
    timeout-minutes: 20
    continue-on-error: ${{ matrix.rust == 'beta' }}
    strategy:
      fail-fast: false
      matrix:
        # Full OS matrix for stable only; MSRV and beta on Linux only.
        include:
          # rust-version floor from Cargo.toml. New releases support stable
          # Rust: when a dependency needs a newer toolchain, raise
          # rust-version and this row together instead of holding it back.
          # The label keeps the job name ("msrv / ubuntu-latest", a required
          # check) free of the version, so a raise changes no branch rule.
          - rust: "1.91"
            label: msrv
            os: ubuntu-latest
          # Stable - primary target, all platforms
          - rust: stable
            os: ubuntu-latest
          - rust: stable
            os: macos-latest
          - rust: stable
            os: windows-latest
          # Beta - early warning (allowed to fail)
          - rust: beta
            os: ubuntu-latest
    steps:
      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@3c5f7ea28cd621ae0bf5283f0e981fb97b8a7af9 # master
        with:
          toolchain: ${{ matrix.rust }}
          components: ${{ matrix.label != 'msrv' && 'rustfmt, clippy' || '' }}

      - name: Cache cargo registry
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
        with:
          cache-all-crates: true

      # Formatting and clippy only on stable (lints evolve between versions)
      - name: Check formatting
        if: matrix.rust == 'stable'
        run: cargo fmt --check

      - name: Run clippy
        if: matrix.label != 'msrv'
        run: cargo clippy --all-features -- -D warnings

      - name: Run tests (all features)
        run: cargo test --all-features

      - name: Run FFI tests
        if: matrix.rust == 'stable'
        run: cargo test --features ffi

      # The config the SDKs ship: encryption on, ffi off. --all-features also
      # turns ffi on, so it never builds exactly what the SDKs compile.
      - name: Run clippy (encryption, SDK config)
        if: matrix.rust == 'stable'
        run: cargo clippy --features encryption --all-targets -- -D warnings

      - name: Run tests (encryption, SDK config)
        if: matrix.rust == 'stable'
        run: cargo test --features encryption

  # The 32-bit ratio-product vector must pass on each 32-bit target the crate
  # supports (spec/wire-format.md, Decompression Bomb Detection). A 64-bit
  # host computes a pointer-width product exactly, so only a 32-bit run shows
  # the bound holds there. wasm32 is the 32-bit target this crate supports.
  wasm32:
    name: wasm32 / ratio-product vector
    runs-on: ubuntu-latest
    timeout-minutes: 20
    env:
      # Must equal the wasm-bindgen version in Cargo.lock: the test runner and
      # the crate share a private ABI, and a mismatch refuses to run. Bump this,
      # the sha256 below and the wasm-bindgen-test pin in Cargo.toml together.
      WASM_BINDGEN_VERSION: "0.2.121"
      # Public release-tarball checksum, not a credential.
      WASM_BINDGEN_SHA256: "3039f38f65fe237b640cf06a140c919ca8d717ec5012146d145d3f27bb4d6b28" # pragma: allowlist secret
    steps:
      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
        with:
          persist-credentials: false

      - name: Install Rust toolchain
        uses: dtolnay/rust-toolchain@29eef336d9b2848a0b548edc03f92a220660cdb8 # stable
        with:
          targets: wasm32-unknown-unknown

      - name: Cache cargo registry
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
        with:
          cache-all-crates: true

      - name: Guard wasm-bindgen lockfile drift
        run: |
          locked=$(cargo pkgid wasm-bindgen | sed 's/.*[@#]//')
          if [ "$locked" != "$WASM_BINDGEN_VERSION" ]; then
            echo "::error::Cargo.lock has wasm-bindgen $locked but this job pins the $WASM_BINDGEN_VERSION test runner. Update WASM_BINDGEN_VERSION, WASM_BINDGEN_SHA256 and the wasm-bindgen-test pin in Cargo.toml together."
            exit 1
          fi

      - name: Install Node (wasm-bindgen-test-runner host)
        uses: actions/setup-node@249970729cb0ef3589644e2896645e5dc5ba9c38 # v6.5.0
        with:
          node-version: "22"

      - name: Install wasm-bindgen-test-runner
        run: |
          curl -sSfL --retry 3 -o /tmp/wbg.tar.gz \
            "https://github.com/wasm-bindgen/wasm-bindgen/releases/download/${WASM_BINDGEN_VERSION}/wasm-bindgen-${WASM_BINDGEN_VERSION}-x86_64-unknown-linux-musl.tar.gz"
          echo "${WASM_BINDGEN_SHA256}  /tmp/wbg.tar.gz" | sha256sum -c -
          tar -xzf /tmp/wbg.tar.gz -C /tmp
          mkdir -p "$HOME/.wbg-bin"
          install -m 0755 "/tmp/wasm-bindgen-${WASM_BINDGEN_VERSION}-x86_64-unknown-linux-musl/wasm-bindgen-test-runner" "$HOME/.wbg-bin/"
          echo "$HOME/.wbg-bin" >> "$GITHUB_PATH"

      # The runner prints "no tests to run!" and exits 0 when it finds no
      # wasm_bindgen_test, so the step also requires the named pass in the log.
      - name: Run the ratio-product vector on wasm32
        shell: bash
        env:
          CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER: wasm-bindgen-test-runner
        run: |
          cargo test --target wasm32-unknown-unknown --features wasm \
            --test wire_format_constructed 2>&1 | tee wasm32-test.log
          grep -qxF 'test envelope_ratio_product_wraps_32_bits ... ok' wasm32-test.log
          grep -qE '^test result: ok\. 1 passed; 0 failed' wasm32-test.log

      # lz4_flex's output bound (16 + 4 + len * 110 / 100) must not overflow a
      # 32-bit usize below the 512 MiB input cap. Same "no tests to run!" guard.
      - name: Run the LZ4 compress-bound round trip on wasm32
        shell: bash
        env:
          CARGO_TARGET_WASM32_UNKNOWN_UNKNOWN_RUNNER: wasm-bindgen-test-runner
        run: |
          cargo test --target wasm32-unknown-unknown --features wasm \
            --test compress_bound_32_bits 2>&1 | tee wasm32-compress-bound.log
          grep -qxF 'test store_retrieve_past_32_bit_compress_bound ... ok' wasm32-compress-bound.log
          grep -qE '^test result: ok\. 1 passed; 0 failed' wasm32-compress-bound.log

  # Instruction-count gate (README, "Instruction counts"). The committed
  # budgets only hold on the machine they were recorded on, so this job
  # measures the PR's merge-base and the PR on the same runner and fails at
  # +1% Ir/op on any case.
  perf-ir:
    name: perf-ir / instruction counts vs base
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
        with:
          persist-credentials: false
          # The script measures the merge-base, so it needs the base history.
          fetch-depth: 0

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

      - name: Cache cargo registry
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
        with:
          cache-all-crates: true

      - name: Install valgrind
        run: |
          sudo apt-get update -q
          sudo apt-get install -y -q --no-install-recommends valgrind

      - name: Gate Ir/op against the merge-base
        env:
          BASE_REF: origin/${{ github.base_ref }}
        run: scripts/perf-ir-vs-base.sh "$BASE_REF"

  security:
    runs-on: ubuntu-latest
    timeout-minutes: 20
    steps:
      - uses: actions/checkout@d23441a48e516b6c34aea4fa41551a30e30af803 # v6
        with:
          persist-credentials: false

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

      - name: Cache cargo registry
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2
        with:
          cache-all-crates: true

      - name: Install security tools
        run: cargo install cargo-deny cargo-audit

      - name: Check dependencies (licenses & security advisories)
        run: cargo deny check

      - name: Run cargo audit
        run: cargo audit