ci.yml

name: CI

# Pull requests are validated here. Releases are validated locally, so branch
# and tag pushes must not start hosted CI.
on:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

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

env:
  CARGO_TERM_COLOR: always
  RUST_BACKTRACE: 1
  RUST_VERSION: "1.97.0"

jobs:
  fmt:
    name: Rustfmt
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}
          components: rustfmt

      - name: Check repository release invariants
        shell: bash
        run: |
          while read -r action; do
            [[ "$action" == ./* ]] && continue
            revision="${action##*@}"
            if [[ ! "$revision" =~ ^[0-9a-f]{40}$ ]]; then
              echo "GitHub Action is not pinned to a full commit SHA: $action" >&2
              exit 1
            fi
          done < <(awk '/^[[:space:]]*uses:/ { print $2 }' .github/workflows/ci.yml)
          if git check-ignore --quiet --no-index crates/example/src/debug/mod.rs; then
            echo "Nested source directory named debug must not be ignored" >&2
            exit 1
          fi
          git check-ignore --quiet --no-index .claude/worktrees/example
          if grep --quiet '^serde-wasm-bindgen[[:space:]]*=' crates/lsp/Cargo.toml; then
            echo "solcore-lsp must not expose its removed dead dependency" >&2
            exit 1
          fi

      - name: Check formatting
        run: cargo fmt --all -- --check

  check:
    name: Check (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    timeout-minutes: 20
    strategy:
      fail-fast: false
      matrix:
        os:
          - ubuntu-latest
          - macos-latest
          - windows-latest

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Check workspace
        run: cargo check --workspace --all-targets --all-features --locked

  clippy:
    name: Clippy
    runs-on: ubuntu-latest
    timeout-minutes: 20

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}
          components: clippy

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Lint workspace
        run: cargo clippy --workspace --all-targets --all-features --locked -- -D warnings

  wasm-build:
    name: Wasm build
    runs-on: ubuntu-latest
    timeout-minutes: 45

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}
          targets: wasm32-unknown-unknown

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Install Node
        uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: "22"
          cache: npm
          cache-dependency-path: |
            playground/package-lock.json
            editors/vscode-solcore/package-lock.json

      - name: Install wasm-pack
        run: cargo install wasm-pack --version 0.15.0 --locked

      - name: Install tutorial builder
        run: cargo install mdbook --version 0.4.52 --locked

      - name: Install playground dependencies
        working-directory: playground
        run: npm ci

      - name: Test playground JavaScript
        working-directory: playground
        run: npm run test:unit

      - name: Build release playground
        working-directory: playground
        run: npm run build

      - name: Test and build standalone tutorial
        working-directory: solcore-tutorial
        run: |
          npm test
          npm run build:book
          npm run test:bundle
          npm run test:wasm

      - name: Test playground WASM execution
        working-directory: playground
        run: npm run test:wasm

      - name: Validate VS Code extension package
        working-directory: editors/vscode-solcore
        run: |
          npm ci
          npm run test:unit
          node --check extension.js
          npm pack --dry-run

  test:
    name: Test
    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Run tests
        run: cargo test --workspace --all-features --locked

  platform-test:
    name: Platform tests (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    timeout-minutes: 30
    strategy:
      fail-fast: false
      matrix:
        os:
          - macos-latest
          - windows-latest

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Run path and editor integration tests
        run: >-
          cargo test --all-features --locked
          -p solcore-parser
          -p solcore-nameres
          -p solcore-vfs
          -p solcore-lsp
          -p solcore-driver

  performance:
    name: Performance pathology guard
    runs-on: ubuntu-latest
    timeout-minutes: 30

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Run scaling workloads with generous ceilings
        run: scripts/check-compile-performance.sh

  e2e:
    name: E2E
    runs-on: ubuntu-latest
    timeout-minutes: 45

    env:
      E2E: "1"
      E2E_REQUIRED: "1"
      ANVIL_HARDFORK: "osaka"
      # Published in https://binaries.soliditylang.org/linux-amd64/list.json.
      SOLC_SHA256: fa8ac9a32d301ad023a36ee5a29f8e291fe3200c60244e43c142539e82a617f4

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Install Foundry
        uses: foundry-rs/foundry-toolchain@b00af27efadbc7b4ca8b82abbd903b17cc874d2a # v1.9.0
        with:
          version: v1.7.1

      - name: Configure solc path
        run: echo "SOLC=$RUNNER_TEMP/solc" >> "$GITHUB_ENV"

      - name: Install solc
        run: |
          curl --fail --location --retry 3 \
            --output "$SOLC" \
            https://github.com/ethereum/solidity/releases/download/v0.8.35/solc-static-linux
          echo "$SOLC_SHA256  $SOLC" | sha256sum --check --strict
          chmod +x "$SOLC"

      - name: Show tool versions
        run: |
          "$SOLC" --version
          anvil --version
          cast --version

      - name: Compile Yul regression corpus with solc
        run: >-
          cargo test --profile e2e -p solcore-yul --test snapshots --locked
          solc_strict_assembly_compiles_snapshots_and_repros_when_present --
          --nocapture

      - name: Run E2E tests
        run: >-
          cargo test --profile e2e -p solcore-yul -p solcore-sonatina
          --test e2e --locked -- --nocapture --test-threads=1

      - name: Test playground execution through solc
        env:
          SOLCORE_WASM_TEST_BACKEND: solc
        run: cargo test --profile e2e -p solcore-wasm --locked

  docs:
    name: Docs
    runs-on: ubuntu-latest
    timeout-minutes: 20

    env:
      RUSTDOCFLAGS: -D warnings

    steps:
      - name: Checkout
        uses: actions/checkout@df4cb1c069e1874edd31b4311f1884172cec0e10 # v6.0.3

      - name: Install Rust
        uses: dtolnay/rust-toolchain@4be7066ada62dd38de10e7b70166bc74ed198c30
        with:
          toolchain: ${{ env.RUST_VERSION }}

      - name: Rust cache
        uses: Swatinem/rust-cache@e18b497796c12c097a38f9edb9d0641fb99eee32 # v2

      - name: Build documentation
        run: cargo doc --workspace --all-features --no-deps --locked