oxc-project__oxc/.github/workflows/benchmark.yml

# Benchmarks are sharded.
#
# Each benchmark (parser, transformer, etc) runs in parallel in a separate job.
#
# See https://docs.codspeed.io/features/sharded-benchmarks

name: Benchmark

permissions: {}

on:
  workflow_dispatch:
  pull_request:
    types: [opened, synchronize]
    paths: &paths
      - "crates/**/*.rs"
      - "tasks/benchmark/**/*.rs"
      - "tasks/common/**/*.rs"
      - "Cargo.lock"
      - "rust-toolchain.toml"
      - ".github/workflows/benchmark.yml"
  push:
    branches:
      - main
    paths: *paths

concurrency:
  group: ${{ github.workflow }}-${{ github.ref_name }}-${{ github.event.pull_request.number || github.sha }}
  cancel-in-progress: true

jobs:
  determine-matrix:
    name: Determine Benchmark
    runs-on: ubuntu-latest
    if: ${{ github.event_name != 'pull_request' || !contains(github.event.pull_request.labels.*.name, '0-merge') }}
    outputs:
      matrix: ${{ steps.set-matrix.outputs.matrix }}
    steps:
      - uses: taiki-e/checkout-action@7d1e50e93dc4fb3bba58f85018fadf77898aee8b # v1.4.2

      - name: Determine affected components
        id: set-matrix
        env:
          GITHUB_EVENT_NAME: ${{ github.event_name }}
          GITHUB_BASE_REF: ${{ github.base_ref }}
          GITHUB_REPOSITORY: ${{ github.repository }}
          GITHUB_SHA: ${{ github.sha }}
          GITHUB_REF: ${{ github.ref }}
          GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          MATRIX=$(node .github/scripts/generate-benchmark-matrix.js)
          echo "Matrix: $MATRIX"
          echo "matrix=$MATRIX" >> $GITHUB_OUTPUT

  benchmark:
    needs: determine-matrix
    if: needs.determine-matrix.outputs.matrix != '[]'
    runs-on: ubuntu-latest
    permissions:
      id-token: write # required for OIDC authentication with CodSpeed
    strategy:
      fail-fast: false
      matrix:
        include: ${{ fromJSON(needs.determine-matrix.outputs.matrix) }}
    name: Bench ${{ matrix.component }}
    steps:
      - uses: taiki-e/checkout-action@7d1e50e93dc4fb3bba58f85018fadf77898aee8b # v1.4.2

      - uses: oxc-project/setup-rust@3d6fb132fbe7cdcb66bf8ec193911c2945369d12 # v1.0.17
        with:
          cache-key: benchmark-${{ matrix.feature }}
          save-cache: ${{ github.ref_name == 'main' }}
          tools: cargo-codspeed

      # Memory mode reuses these binaries: cargo-codspeed maps both simulation and
      # memory modes to the same `analysis` build (`--cfg codspeed`) and directory.
      - name: Build benchmark
        env:
          RUSTFLAGS: "-C debuginfo=1 -C strip=none -g --cfg codspeed"
        run: |
          if [ "${{ matrix.component }}" = "linter" ]; then
            cargo build --release -p oxc_benchmark --bench linter \
              --no-default-features --features ${{ matrix.feature }} --features codspeed
          else
            cargo build --release -p oxc_benchmark \
              --bench ${{ matrix.component }} \
              --no-default-features --features ${{ matrix.feature }} --features codspeed
          fi
          mkdir -p target/codspeed/analysis/oxc_benchmark
          mv target/release/deps/${{ matrix.component }}-* target/codspeed/analysis/oxc_benchmark
          rm target/codspeed/analysis/oxc_benchmark/*.d

      - name: Run benchmark
        uses: CodSpeedHQ/action@0ca9cbbf4623b599a6c3ed4fc8a922942705d9f1 # v5.0.2
        timeout-minutes: 30
        with:
          mode: ${{ matrix.mode }}
          run: cargo codspeed run ${{ matrix.component }}