action.yml

# Shared Flutter toolchain setup for the analyze_and_test jobs. Both jobs pay
# this prefix (checks needs generated code for analyze/tests; integration needs
# it to build the app), so it lives here to keep the two copies from drifting.
#
# Cache notes: keys derive from lockfiles, so they self-invalidate when deps
# change. When both parallel jobs miss the same key (lockfile just changed),
# both build and both try to save — the first save wins, the second logs a
# benign "cache already exists" warning. No restore-keys on the pub cache on
# purpose: it holds the bull_sdk git clone, and a fuzzy fallback can restore a
# checkout from an OLDER lock whose pinned commit differs; pub then resolves
# against that stale clone and `pub get --enforce-lockfile` fails wanting to
# drop deps. The exact key already pins the commit via pubspec.lock.
name: Flutter setup
description: FVM + pub caches, FVM install, deps, build_runner, translations

inputs:
  cargo-cache:
    description: Also restore the Cargo cache (only the integration job compiles the FRB native crates)
    required: false
    default: 'false'

runs:
  using: composite
  steps:
    # runner.arch is in the FVM key because the SDK is native binaries — an
    # x64 SDK restored on an arm64 runner is broken. pub/cargo caches hold
    # sources only (arch-independent), so they keep os-only keys and stay
    # shared across arches.
    - name: Cache Flutter SDK (FVM)
      uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: ~/fvm/versions
        key: fvm-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('.fvmrc') }}

    - name: Cache pub (hosted + git deps)
      uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: ~/.pub-cache
        key: pub-${{ runner.os }}-${{ hashFiles('pubspec.lock') }}

    - name: Cache Cargo (FRB native crates)
      if: ${{ inputs.cargo-cache == 'true' }}
      uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: |
          ~/.cargo/registry
          ~/.cargo/git
        key: cargo-${{ runner.os }}-${{ hashFiles('pubspec.lock') }}
        restore-keys: cargo-${{ runner.os }}-

    - name: Install FVM
      shell: bash
      run: |
        curl -fsSL https://fvm.app/install.sh | bash -s -- 4.1.2
        echo "$HOME/fvm/bin" >> $GITHUB_PATH

    - name: Check Flutter version
      shell: bash
      run: make fvm-check

    - name: Get dependencies
      shell: bash
      run: make deps

    # build_runner's incremental cache — RESTORE ONLY. PR jobs never save (a sha-keyed save per push would blow the 10GB repo cache quota and evict the FVM/pub/cargo caches); only the cache-warmer workflow saves, on develop pushes, so all PRs restore develop's latest warm snapshot.
    # ALL gitignored generated source files are cached alongside .dart_tool/build so the restored state is self-consistent (outputs present + asset graph present); build_runner hashes inputs itself and regenerates what changed.
    # The suffix list MUST cover every gitignored to-source output: build_runner trusts .dart_tool/build and will NOT regenerate an output whose file is missing from disk (it reports "N skipped"), so a suffix left out here is silently absent after restore and breaks the build — that is how the missing assets.gen.dart (flutter_gen, *.gen.dart ≠ *.g.dart) incident happened.
    # *.gr.dart / *.config.dart match nothing today but are pre-listed to mirror the format-filter regex (makefile format-check), so adding auto_route/injectable later cannot reproduce the incident; *.steps.dart is deliberately NOT cached — drift schema snapshots are git-tracked, and restoring a tracked file would overwrite the checkout (same reason main.directories.g.dart is excluded below).
    # Arch is in the key defensively: the build cache holds kernel/asset hashes we don't want shared across arches.
    # The key embeds hashFiles of this action and the warmer workflow, so any edit to either file self-busts the cache instead of restoring a stale pre-edit snapshot — no manual version token to bump (this replaced the short-lived -v2- token).
    # Keep path + key in sync with the save step in cache-warmer.yml.
    - name: Restore build_runner cache
      uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
      with:
        path: |
          .dart_tool/build
          **/*.g.dart
          **/*.freezed.dart
          **/*.mocks.dart
          **/*.gen.dart
          **/*.gr.dart
          **/*.config.dart
          !packages/bull_ui_catalogue/lib/main.directories.g.dart
        key: buildrunner-${{ hashFiles('.github/actions/flutter-setup/action.yml', '.github/workflows/cache-warmer.yml') }}-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('pubspec.lock') }}-${{ github.sha }}
        restore-keys: buildrunner-${{ hashFiles('.github/actions/flutter-setup/action.yml', '.github/workflows/cache-warmer.yml') }}-${{ runner.os }}-${{ runner.arch }}-${{ hashFiles('pubspec.lock') }}-

    - name: Generate code (build_runner)
      shell: bash
      run: make build-runner

    - name: Generate translations
      shell: bash
      run: make translations

    - name: Disk telemetry (for trimming free-disk later)
      shell: bash
      run: df -h /