contrib_checks.yml

name: "Checks: Lints, Tests, Docs"

on:
  workflow_call:
    inputs:
      CONCURRENCY:
        required: true
        type: string
      PR_NUMBER:
        required: false
        type: string
        default: ""

concurrency:
  group: ${{ inputs.CONCURRENCY }}-checks
  cancel-in-progress: true

env:
  PYTHON_VERSION: "3.8"
  # web_sys_unstable_apis is required to enable the web_sys clipboard API which egui_web uses
  # https://rustwasm.github.io/wasm-bindgen/api/web_sys/struct.Clipboard.html
  # https://rustwasm.github.io/docs/wasm-bindgen/web-sys/unstable-apis.html
  RUSTFLAGS: --cfg=web_sys_unstable_apis --deny warnings

  RUSTDOCFLAGS: --deny warnings

  # Do *not* use sscache since on contributor ci we don't have access to the gcloud stored cache.
  #RUSTC_WRAPPER: "sccache"

  # Not only `sccache` cannot cache incremental builds, it's counter-productive to generate all
  # these incremental artifacts when running on CI.
  CARGO_INCREMENTAL: "0"

defaults:
  run:
    shell: bash

permissions:
  contents: "read"

jobs:
  py-lints:
    name: Python lints (ruff, mypy, …)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: prefix-dev/setup-pixi@v0.8.1
        with:
          pixi-version: v0.25.0

      - name: Python format check
        run: pixi run py-fmt-check

      - name: Lint Python
        run: pixi run py-lint

  py-test-docs:
    name: Test Python Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v4
        with:
          python-version: "3.8"

      - name: Install Python dependencies
        shell: bash
        run: |
          pip install --upgrade pip
          pip install -r rerun_py/requirements-doc.txt

      - name: Build via mkdocs
        shell: bash
        run: |
          mkdocs build --strict -f rerun_py/mkdocs.yml

  no-codegen-changes:
    name: Check if running codegen would produce any changes
    runs-on: ubuntu-latest-16-cores
    steps:
      # Note: We explicitly don't override `ref` here. We need to see if changes would be made
      # in a context where we have merged with main. Otherwise we might miss changes such as one
      # PR introduces a new type and another PR changes the codegen.
      - uses: actions/checkout@v4

      - uses: prefix-dev/setup-pixi@v0.8.1
        with:
          pixi-version: v0.25.0

      - name: Codegen check
        run: pixi run codegen --force --check

  rs-lints:
    name: Rust lints (fmt, check, clippy, tests, doc)
    runs-on: ubuntu-latest-16-cores
    steps:
      - uses: actions/checkout@v4

      - uses: prefix-dev/setup-pixi@v0.8.1
        with:
          pixi-version: v0.25.0

      - name: Rust checks & tests
        run: pixi run rs-check --skip individual_crates docs_slow

  misc-rerun-lints:
    name: Rerun lints
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: prefix-dev/setup-pixi@v0.8.1
        with:
          pixi-version: v0.25.0

      - name: Rerun lints
        run: pixi run lint-rerun

      - name: Toml format check
        run: pixi run toml-fmt-check

      - name: Check for too large files
        run: pixi run check-large-files

      - name: Check Python example thumbnails
        run: pixi run ./scripts/ci/thumbnails.py check

  spell-check:
    name: Spell Check
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Actions Repository
        uses: actions/checkout@v4

      - name: Check spelling of entire workspace
        uses: crate-ci/typos@v1.18.0

  cpp-formatting:
    name: C++ formatting check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Run clang format on all relevant files
        uses: jidicula/clang-format-action@v4.11.0
        with:
          clang-format-version: "16"
          # Only check c/cpp/h/hpp (default checks also .proto and others)
          include-regex: ^.*\.(c|cpp|h|hpp)$

  cpp-tests:
    name: C++ tests
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: prefix-dev/setup-pixi@v0.8.1
        with:
          pixi-version: v0.25.0
          environments: cpp

      # TODO(emilk): make this work somehow. Right now this just results in
      # > Compiler: GNU 12.3.0 (/__w/rerun/rerun/.pixi/env/bin/x86_64-conda-linux-gnu-c++)
      # 😭
      # - name: Build and run C++ tests with clang++
      #   run: |
      #     pixi run -e cpp cpp-clean
      #     RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-build-all
      #     RERUN_WERROR=ON RERUN_USE_ASAN=ON CXX=clang++ pixi run -e cpp cpp-test

      - name: Build and run C++ tests with g++
        run: |
          pixi run -e cpp cpp-clean
          RERUN_WERROR=ON RERUN_USE_ASAN=ON LSAN_OPTIONS=suppressions=.github/workflows/lsan_suppressions.supp CXX=g++ pixi run -e cpp cpp-build-all
          RERUN_WERROR=ON RERUN_USE_ASAN=ON LSAN_OPTIONS=suppressions=.github/workflows/lsan_suppressions.supp CXX=g++ pixi run -e cpp cpp-test