ci.yml

name: "CI"

on:
  push:
    branches:
      - "main"
      - "forks/*"
      - release-*.*
  pull_request:
    branches:
      - "main"
      - "v*.*.*-rc"
      - release-*.*

concurrency:
    group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event_name }}
    cancel-in-progress: ${{ github.event_name == 'pull_request' }}

env:
  CARGO_TERM_COLOR: always
  CACHE_KEY_SUFFIX: 20260112
  CARGO_UDEPS_KEY_SUFFIX: 20260112

jobs:
  misc-check:
    name: misc check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: stable
      - name: Run typos check
        uses: crate-ci/typos@master
      - name: Check if Grafana dashboards are minimized
        run: |
          cargo x json --check
      - name: Run ShellCheck
        uses: ludeeus/action-shellcheck@master
  cargo-manifest-check:
    name: cargo manifest check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-cargo-manifest-check
      - name: Install tools
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          cargo install taplo-cli --locked
      - name: Run taplo fmt check
        run: |
          taplo fmt --check
  rust-machete:
    name: rust machete check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: stable
      - name: Run cargo machete
        uses: bnjbvr/cargo-machete@main
  rust-udeps:
    name: rust udeps test
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ env.CARGO_UDEPS_KEY_SUFFIX }}-rust-udeps
      - name: Install NASM for aws-lc-rs on Windows
        if: runner.os == 'Windows'
        uses: ilammy/setup-nasm@v1
      - name: Install ninja-build tool for aws-lc-fips-sys on Windows
        if: runner.os == 'Windows'
        uses: seanmiddleditch/gha-setup-ninja@v5
      - name: Install cargo-udeps
        if: steps.cache.outputs.cache-hit != 'true'
        run: |
          cargo install cargo-udeps --locked
      - name: Unused Dependencies Check
        env:
          RUSTFLAGS: "--cfg tokio_unstable -Awarnings"
        run: |
          cargo udeps --all-targets
  rust-ffmt-check:
    name: rust ffmt check
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
          components: rustfmt
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-rust-ffmt-check
      - name: Fastidious Format Check
        run: |
          cargo fmt --all --check -- --config-path rustfmt.nightly.toml
      - name: Hint
        if: ${{ failure() }}
        run: |-
          echo "The ffmt (Fastidious Format Check) test is not a necessary."
          echo "It uses unstable features to achieve a better format."
          echo "If you want to pass the test, please install the nightly toolchain with \`rustup install nightly\`."
          echo "Then run \`make ffmt\`."
  rust-test:
    name: rust test with codecov
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm]
        rust_toolchain: [stable, 1.86.0]
        serde: ["", "--features serde"]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust_toolchain }}
          components: rustfmt, clippy, llvm-tools-preview
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-rust-test
      - name: Install NASM for aws-lc-rs on Windows
        if: runner.os == 'Windows'
        uses: ilammy/setup-nasm@v1
      - name: Install ninja-build tool for aws-lc-fips-sys on Windows
        if: runner.os == 'Windows'
        uses: seanmiddleditch/gha-setup-ninja@v5
      - name: Run rust format check
        run: |
          cargo fmt --all -- --check
      - name: Run rust clippy check (stable)
        if: matrix.rust_toolchain == 'stable'
        run: |
          cargo clippy -p foyer
          cargo clippy -p foyer --features "tracing"
          cargo clippy --all-targets ${{ matrix.serde }} --features tokio-console -- -D warnings -A "clippy::large_enum_variant"
          cargo clippy --all-targets ${{ matrix.serde }} --features deadlock -- -D warnings
          cargo clippy --all-targets ${{ matrix.serde }} --features tracing -- -D warnings
          cargo clippy --all-targets ${{ matrix.serde }} --features clap -- -D warnings
          cargo clippy --all-targets ${{ matrix.serde }} -- -D warnings
      - if: steps.cache.outputs.cache-hit != 'true'
        uses: taiki-e/install-action@cargo-llvm-cov
      - if: steps.cache.outputs.cache-hit != 'true'
        uses: taiki-e/install-action@nextest
      - name: Run rust test with coverage (igored tests)
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          cargo llvm-cov --no-report nextest --run-ignored only --no-capture --workspace ${{ matrix.serde }} --features "strict_assertions"
      - name: Run rust test with coverage
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          cargo llvm-cov --no-report nextest --features "strict_assertions"
      - name: Run examples with coverage
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example memory
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example hybrid
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example hybrid_full
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example event_listener
          cargo llvm-cov --no-report run ${{ matrix.serde }} --features "tracing,jaeger" --example tail_based_tracing
          cargo llvm-cov --no-report run ${{ matrix.serde }} --features "tracing,ot" --example tail_based_tracing
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example equivalent
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example export_metrics_prometheus_hyper
          cargo llvm-cov --no-report run ${{ matrix.serde }} --example serde
      - name: Generate codecov report
        run: |
          cargo llvm-cov report --lcov --output-path lcov.info
      - uses: codecov/codecov-action@v4
        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.rust_toolchain == 'stable'
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          verbose: true
  foyer-bench-fuzzy-test:
    name: foyer bench fuzzy test with codecov
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest]
        rust_toolchain: [stable, 1.86.0]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust_toolchain }}
          components: rustfmt, clippy, llvm-tools-preview
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-foyer-bench-fuzzy-test
      - if: steps.cache.outputs.cache-hit != 'true'
        uses: taiki-e/install-action@cargo-llvm-cov
      - if: steps.cache.outputs.cache-hit != 'true'
        uses: taiki-e/install-action@nextest
      - name: Build foyer-bench
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- -h
      - name: Run foyer-bench with coverage (eviction, psync)
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy eviction --io-engine psync
      - name: Run foyer-bench with coverage (insertion, psync)
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy insertion --io-engine psync
      - name: Run foyer-bench with coverage (eviction, io_uring)
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy eviction --io-engine io_uring
      - name: Run foyer-bench with coverage (insertion, io_uring)
        env:
          RUST_BACKTRACE: 1
          CI: true
        run: |
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
          cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy insertion --io-engine io_uring
      
      # - name: Run foyer-bench with coverage (large, eviction)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine large --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy eviction
      # - name: Run foyer-bench with coverage (large, insertion)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine large --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy insertion
      # - name: Run foyer-bench with coverage (small, eviction)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine small --mem 4MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 1MiB --entry-size-min 1KiB --entry-size-max 24KiB --time 60 --policy eviction
      # - name: Run foyer-bench with coverage (small, insertion)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine small --mem 4MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 1MiB --entry-size-min 1KiB --entry-size-max 24KiB --time 60 --policy insertion
      # - name: Run foyer-bench with coverage (mixed, eviction)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine mixed=0.1 --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 1KiB --entry-size-max 128KiB --time 60 --policy eviction
      # - name: Run foyer-bench with coverage (mixed, insertion)
      #   env:
      #     RUST_BACKTRACE: 1
      #     CI: true
      #   run: |
      #     rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov
      #     cargo llvm-cov --no-report run --package foyer-bench --bin foyer-bench --features "strict_assertions" -- --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/codecov --engine mixed=0.1 --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 1KiB --entry-size-max 128KiB --time 60 --policy insertion
      - name: Generate codecov report
        run: |
          cargo llvm-cov report --lcov --output-path lcov.info
      - uses: codecov/codecov-action@v4
        if: runner.os == 'Linux' && runner.arch == 'X64' && matrix.rust_toolchain == 'stable'
        env:
          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
        with:
          verbose: true
  rustdoc-test:
    name: rust doc test
    strategy:
      fail-fast: false
      matrix:
        os: [ubuntu-latest, macos-latest, windows-latest, ubuntu-24.04-arm]
    runs-on: ${{ matrix.os }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-rustdoc-test
      - name: Install NASM for aws-lc-rs on Windows
        if: runner.os == 'Windows'
        uses: ilammy/setup-nasm@v1
      - name: Install ninja-build tool for aws-lc-fips-sys on Windows
        if: runner.os == 'Windows'
        uses: seanmiddleditch/gha-setup-ninja@v5
      - name: Run rustdoc test
        run: |
          cargo test --features "nightly" --doc
      - name: Test docs build with docs.rs
        env:
          RUSTDOCFLAGS: --cfg docsrs -D warnings
        run: |
          cargo doc --features "nightly" --no-deps
      - name: Upload docs.rs docs as artifacts
        uses: actions/upload-artifact@v4
        with:
          name: foyer-docs-${{ github.sha }}-${{ runner.os }}-${{ runner.arch }}
          path: target/doc
          if-no-files-found: error
          retention-days: 7
        
  deadlock:
    name: run with single worker thread and deadlock detection
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: stable
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-deadlock
      - name: Run tests with single worker thread and deadlock detection
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          cargo test --all --features deadlock -- --nocapture
      - name: Build foyer-bench with single worker thread and deadlock detection
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          cargo build --all --features deadlock
      - name: Run foyer-bench with single worker thread and deadlock detection (eviction, psync)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          timeout 2m ./target/debug/foyer-bench --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/deadlock --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy eviction --io-engine psync
      - name: Run foyer-bench with single worker thread and deadlock detection (insertion, psync)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          timeout 2m ./target/debug/foyer-bench --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/deadlock --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy insertion --io-engine psync
      - name: Run foyer-bench with single worker thread and deadlock detection (eviction, io_uring)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          timeout 2m ./target/debug/foyer-bench --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/deadlock --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy eviction --io-engine io_uring
      - name: Run foyer-bench with single worker thread and deadlock detection (insertion, io_uring)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          rm -rf $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-storage/deadlock
          timeout 2m ./target/debug/foyer-bench --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/deadlock --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60 --policy insertion --io-engine io_uring
  asan:
    name: run with address saniziter
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-asan
      - name: Run Unit Tests With Address Sanitizer
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "-Zsanitizer=address --cfg tokio_unstable"
          RUST_LOG: info
          CI: true
        run: |-
          cargo test --lib --bins --tests --target x86_64-unknown-linux-gnu -- --nocapture
      - name: Run foyer-bench With Address Sanitizer
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "-Zsanitizer=address --cfg tokio_unstable"
          RUST_LOG: info
          CI: true
        run: |-
          cargo build --all --target x86_64-unknown-linux-gnu
          mkdir -p $GITHUB_WORKSPACE/foyer-data/foyer-bench/asan
          timeout 2m ./target/x86_64-unknown-linux-gnu/debug/foyer-bench --dir $GITHUB_WORKSPACE/foyer-data/foyer-bench/asan --mem 16MiB --disk 256MiB --block-size 16MiB --get-range 1000 --w-rate 1MiB --r-rate 1MiB --disk-write-throughput 10MiB --entry-size-min 2KiB --entry-size-max 128KiB --time 60
      - name: Prepare Artifacts on Failure
        if: ${{ failure() }}
        run: |-
          find ./target/x86_64-unknown-linux-gnu/debug/ -type f -executable -name 'foyer*' -print0 | xargs -0 tar czvf artifacts.asan.tgz --transform 's#.*/##'
      - name: Upload Artifacts on Failure
        uses: actions/upload-artifact@v4
        if: ${{ failure() }}
        with:
          name: artifacts.asan.tgz
          path: artifacts.asan.tgz
  madsim:
    name: check build with madsim
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          persist-credentials: false
      - name: Install rust toolchain
        uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
          components: rustfmt, clippy
      - name: Cache Cargo home
        uses: actions/cache@v4
        id: cache
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
          key: ${{ runner.os }}-${{ runner.arch }}-cargo-${{ hashFiles('**/Cargo.toml') }}-${{ env.CACHE_KEY_SUFFIX }}-madsim
      - if: steps.cache.outputs.cache-hit != 'true'
        uses: taiki-e/install-action@nextest
      - name: Run rust check (madsim)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable --cfg madsim"
          RUST_LOG: info
          TOKIO_WORKER_THREADS: 1
          CI: true
        run: |-
          cargo check -p foyer --no-default-features --features "runtime-madsim-tokio"
      - name: Run nextest (madsim)
        env:
          RUST_BACKTRACE: 1
          RUSTFLAGS: "--cfg tokio_unstable --cfg madsim"
          RUST_LOG: info
        run: |-
          cargo nextest run --workspace --exclude foyer-bench --exclude examples --no-default-features --features "runtime-madsim-tokio"