mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-04-20 06:20:11 +00:00
## Summary Fixes three critical issues with the CI performance reporting pipeline that made perf reports useless on PRs (demonstrated by PR #9248 — deep watcher removal merged without useful perf signal). ## Changes ### 1. Fix z-score baseline variance collection (`0/5 runs`) **Root cause:** PR #9305 added z-score statistical analysis code to `perf-report.ts`, but the historical data download step was placed in the wrong workflow file. The report is generated in `pr-perf-report.yaml` (a `workflow_run`-triggered job), but the historical download was in `ci-perf-report.yaml` (the test runner) — different runners, different filesystems. **Fix:** Implement `perf-data` orphan branch storage: - On push to main: save `perf-metrics.json` to `perf-data` branch with timestamped filename - On PR report: fetch last 5 baselines from `perf-data` branch into `temp/perf-history/` - Rolling window of 20 baselines, oldest pruned automatically - Same pattern used by `github-action-benchmark` (33.7k repos) ### 2. Fix force-push comment staleness **Root cause:** `cancel-in-progress: true` kills the perf test run before it uploads artifacts. The downstream report workflow only triggers on `conclusion == 'success'` — cancelled runs are ignored, so the comment from the first successful run goes stale. **Fix:** - Change `cancel-in-progress: false` — with GitHub's queue depth of 1, rapid pushes (A,B,C,D) run A and D, skipping B and C - Add SHA validation in `pr-perf-report.yaml` — before posting, check if the workflow_run's head SHA still matches the PR's current head. Skip posting stale results. ### 3. Add permissions for baseline operations - `contents: write` on CI job (needed for pushing to perf-data branch) - `actions: read` on both workflows (needed for artifact/baseline access) ## One-time setup required After merging, create the `perf-data` orphan branch: ```bash git checkout --orphan perf-data git rm -rf . echo '# Performance Baselines' > README.md mkdir -p baselines git add README.md baselines git commit -m 'Initialize perf-data branch' git push origin perf-data ``` The first 2 pushes to main after setup will build up variance data, and z-scores will start appearing in PR reports (threshold is `historical.length >= 2`). ## Testing - YAML validated with `yaml.safe_load()` - `perf-report.ts` `loadHistoricalReports()` already reads from `temp/perf-history/<index>/perf-metrics.json` — no code changes needed - All new steps use `continue-on-error: true` for graceful degradation ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-9886-fix-fix-perf-CI-pipeline-z-score-baselines-force-push-staleness-baseline-storage-3226d73d365081538424c7945e71f308) by [Unito](https://www.unito.io)
115 lines
3.6 KiB
YAML
115 lines
3.6 KiB
YAML
name: 'CI: Performance Report'
|
|
|
|
on:
|
|
push:
|
|
branches: [main, core/*]
|
|
paths-ignore: ['**/*.md']
|
|
pull_request:
|
|
branches-ignore: [wip/*, draft/*, temp/*]
|
|
paths-ignore: ['**/*.md']
|
|
|
|
concurrency:
|
|
group: perf-${{ github.ref }}
|
|
cancel-in-progress: false
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
jobs:
|
|
perf-tests:
|
|
if: github.repository == 'Comfy-Org/ComfyUI_frontend'
|
|
runs-on: ubuntu-latest
|
|
timeout-minutes: 30
|
|
container:
|
|
image: ghcr.io/comfy-org/comfyui-ci-container:0.0.12
|
|
credentials:
|
|
username: ${{ github.actor }}
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
permissions:
|
|
contents: write
|
|
packages: read
|
|
actions: read
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v6
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Setup frontend
|
|
uses: ./.github/actions/setup-frontend
|
|
with:
|
|
include_build_step: true
|
|
|
|
- name: Start ComfyUI server
|
|
uses: ./.github/actions/start-comfyui-server
|
|
|
|
- name: Run performance tests
|
|
id: perf
|
|
continue-on-error: true
|
|
run: pnpm exec playwright test --project=performance --workers=1 --repeat-each=3
|
|
|
|
- name: Upload perf metrics
|
|
if: always()
|
|
uses: actions/upload-artifact@v6
|
|
with:
|
|
name: perf-metrics
|
|
path: test-results/perf-metrics.json
|
|
retention-days: 30
|
|
if-no-files-found: warn
|
|
|
|
- name: Save PR metadata
|
|
if: github.event_name == 'pull_request'
|
|
run: |
|
|
mkdir -p temp/perf-meta
|
|
echo "${{ github.event.number }}" > temp/perf-meta/number.txt
|
|
echo "${{ github.event.pull_request.base.ref }}" > temp/perf-meta/base.txt
|
|
|
|
- name: Upload PR metadata
|
|
if: github.event_name == 'pull_request'
|
|
uses: actions/upload-artifact@v6
|
|
with:
|
|
name: perf-meta
|
|
path: temp/perf-meta/
|
|
|
|
- name: Save perf baseline to perf-data branch
|
|
if: github.event_name == 'push' && github.ref == 'refs/heads/main' && steps.perf.outcome == 'success'
|
|
continue-on-error: true
|
|
run: |
|
|
git config user.name "github-actions[bot]"
|
|
git config user.email "github-actions[bot]@users.noreply.github.com"
|
|
git config url."https://x-access-token:${GH_TOKEN}@github.com/".insteadOf "https://github.com/"
|
|
|
|
cp test-results/perf-metrics.json /tmp/perf-metrics.json
|
|
|
|
git fetch origin perf-data || {
|
|
echo "Creating perf-data branch"
|
|
git checkout --orphan perf-data
|
|
git rm -rf . 2>/dev/null || true
|
|
echo "# Performance Baselines" > README.md
|
|
mkdir -p baselines
|
|
git add README.md baselines
|
|
git commit -m "Initialize perf-data branch"
|
|
git push origin perf-data
|
|
git fetch origin perf-data
|
|
}
|
|
|
|
git worktree add /tmp/perf-data origin/perf-data
|
|
|
|
TIMESTAMP=$(date -u +%Y%m%dT%H%M%SZ)
|
|
SHA=$(echo "${{ github.sha }}" | cut -c1-8)
|
|
mkdir -p /tmp/perf-data/baselines
|
|
cp /tmp/perf-metrics.json "/tmp/perf-data/baselines/perf-${TIMESTAMP}-${SHA}.json"
|
|
|
|
# Keep only last 20 baselines
|
|
cd /tmp/perf-data
|
|
ls -t baselines/perf-*.json 2>/dev/null | tail -n +21 | xargs -r rm
|
|
|
|
git -C /tmp/perf-data add baselines/
|
|
git -C /tmp/perf-data commit -m "perf: add baseline for ${SHA}" || echo "No changes to commit"
|
|
git -C /tmp/perf-data push origin HEAD:perf-data
|
|
|
|
git worktree remove /tmp/perf-data --force 2>/dev/null || true
|
|
env:
|
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|