ComfyUI_frontend/.github/workflows/pr-update-playwright-expectations.yaml

# Setting test expectation screenshots for Playwright
name: "PR: Update Playwright Expectations"

on:
  pull_request:
    types: [labeled]
  issue_comment:
    types: [created]

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

jobs:
  setup:
    runs-on: ubuntu-latest
    if: >
      ( github.event_name == 'pull_request' && github.event.label.name == 'New Browser Test Expectations' ) ||
      ( github.event.issue.pull_request &&
        github.event_name == 'issue_comment' &&
        (
          github.event.comment.author_association == 'OWNER' ||
          github.event.comment.author_association == 'MEMBER' ||
          github.event.comment.author_association == 'COLLABORATOR'
        ) &&
        startsWith(github.event.comment.body, '/update-playwright') )
    outputs:
      cache-key: ${{ steps.cache-key.outputs.key }}
      pr-number: ${{ steps.pr-info.outputs.pr-number }}
      branch: ${{ steps.pr-info.outputs.branch }}
      comment-id: ${{ steps.find-update-comment.outputs.comment-id }}
    steps:
      - name: Get PR info
        id: pr-info
        run: |
          echo "pr-number=${{ github.event.number || github.event.issue.number }}" >> $GITHUB_OUTPUT
          echo "branch=$(gh pr view ${{ github.event.number || github.event.issue.number }} --repo ${{ github.repository }} --json headRefName --jq '.headRefName')" >> $GITHUB_OUTPUT
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

      - name: Find Update Comment
        uses: peter-evans/find-comment@b30e6a3c0ed37e7c023ccd3f1db5c6c0b0c23aad
        id: "find-update-comment"
        with:
          issue-number: ${{ steps.pr-info.outputs.pr-number }}
          comment-author: "github-actions[bot]"
          body-includes: "Updating Playwright Expectations"

      - name: Add Starting Reaction
        uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9
        with:
          comment-id: ${{ steps.find-update-comment.outputs.comment-id }}
          issue-number: ${{ steps.pr-info.outputs.pr-number }}
          body: |
            Updating Playwright Expectations
          edit-mode: replace
          reactions: eyes

      - name: Checkout repository
        uses: actions/checkout@v5
        with:
          ref: ${{ steps.pr-info.outputs.branch }}
      - name: Setup frontend
        uses: ./.github/actions/setup-frontend
        with:
          include_build_step: true
      # Save expensive build artifacts (Python env, built frontend, node_modules)
      # Source code will be checked out fresh in sharded jobs
      - name: Generate cache key
        id: cache-key
        run: echo "key=$(date +%s)" >> $GITHUB_OUTPUT
      - name: Save cache
        uses: actions/cache/save@5a3ec84eff668545956fd18022155c47e93e2684
        with:
          path: |
            ComfyUI
            dist
          key: comfyui-setup-${{ steps.cache-key.outputs.key }}

  # Sharded snapshot updates
  update-snapshots-sharded:
    needs: setup
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        shardIndex: [1, 2, 3, 4]
        shardTotal: [4]
    steps:
      # Checkout source code fresh (not cached)
      - name: Checkout repository
        uses: actions/checkout@v5
        with:
          ref: ${{ needs.setup.outputs.branch }}

      # Restore expensive build artifacts from setup job
      - name: Restore cached artifacts
        uses: actions/cache/restore@5a3ec84eff668545956fd18022155c47e93e2684
        with:
          fail-on-cache-miss: true
          path: |
            ComfyUI
            dist
          key: comfyui-setup-${{ needs.setup.outputs.cache-key }}

      - name: Setup ComfyUI server (from cache)
        uses: ./.github/actions/setup-comfyui-server
        with:
          launch_server: true

      - name: Setup nodejs, pnpm, reuse built frontend
        uses: ./.github/actions/setup-frontend

      - name: Setup Playwright
        uses: ./.github/actions/setup-playwright

      # Run sharded tests with snapshot updates
      - name: Update snapshots (Shard ${{ matrix.shardIndex }}/${{ matrix.shardTotal }})
        id: playwright-tests
        run: pnpm exec playwright test --update-snapshots --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}
        continue-on-error: true

      # Upload updated snapshots from this shard
      - name: Upload updated snapshots
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: snapshots-shard-${{ matrix.shardIndex }}
          path: browser_tests/**/*-snapshots/
          retention-days: 1

      - name: Upload test report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: playwright-report-shard-${{ matrix.shardIndex }}
          path: ./playwright-report/
          retention-days: 30

  # Merge snapshots and commit
  merge-and-commit:
    needs: [setup, update-snapshots-sharded]
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v5
        with:
          ref: ${{ needs.setup.outputs.branch }}

      # Download all snapshot artifacts from shards
      - name: Download all snapshots
        uses: actions/download-artifact@v4
        with:
          pattern: snapshots-shard-*
          path: ./downloaded-snapshots
          merge-multiple: false

      # Merge snapshots from all shards into browser_tests directory
      - name: Merge snapshots
        run: |
          set -euo pipefail

          echo "Merging snapshots from all shards..."

          # Verify target directory exists
          if [ ! -d "browser_tests" ]; then
            echo "::error::Target directory 'browser_tests' does not exist"
            exit 1
          fi

          # List all downloaded artifacts for debugging
          echo "Available shard artifacts:"
          ls -la ./downloaded-snapshots/ || echo "No downloaded-snapshots directory found"

          merged_count=0
          skipped_count=0

          for shard_dir in ./downloaded-snapshots/snapshots-shard-*; do
            echo "Processing: $shard_dir"

            # Check if glob matched any directories
            if [ ! -e "$shard_dir" ]; then
              echo "::warning::No shard directories found matching pattern"
              break
            fi

            if [ ! -d "$shard_dir" ]; then
              echo "::warning::Expected directory but found file: $shard_dir"
              skipped_count=$((skipped_count + 1))
              continue
            fi

            # Check if directory has content (empty is OK - shard might have no changes)
            if [ -z "$(ls -A "$shard_dir" 2>/dev/null)" ]; then
              echo "Shard directory $shard_dir is empty (no snapshots updated in this shard)"
              skipped_count=$((skipped_count + 1))
              continue
            fi

            echo "Merging snapshots from $shard_dir..."

            # The artifact path 'browser_tests/**/*-snapshots/' uploads relative to browser_tests/
            # So downloaded artifacts contain 'tests/' directly, not 'browser_tests/tests/'
            # We need to merge the artifact contents into browser_tests/
            if ! rsync -a "$shard_dir/" browser_tests/; then
              echo "::error::Failed to merge snapshots from $shard_dir/ to browser_tests/"
              echo "Contents of $shard_dir:"
              find "$shard_dir" -type f | head -20
              exit 1
            fi
            merged_count=$((merged_count + 1))
            echo "Successfully merged shard $merged_count"
          done

          echo "Snapshot merge complete. Merged: $merged_count shard(s), Skipped: $skipped_count shard(s)"

      - name: Debugging info
        run: |
          echo "PR: ${{ needs.setup.outputs.pr-number }}"
          echo "Branch: ${{ needs.setup.outputs.branch }}"
          git status

      - name: Commit updated expectations
        run: |
          git config --global user.name 'github-actions'
          git config --global user.email 'github-actions@github.com'
          git add browser_tests
          if git diff --cached --quiet; then
            echo "No changes to commit"
          else
            git commit -m "[automated] Update test expectations"
            git push origin ${{ needs.setup.outputs.branch }}
          fi

      - name: Add Done Reaction
        uses: peter-evans/create-or-update-comment@e8674b075228eee787fea43ef493e45ece1004c9
        if: github.event_name == 'issue_comment'
        with:
          comment-id: ${{ needs.setup.outputs.comment-id }}
          issue-number: ${{ needs.setup.outputs.pr-number }}
          reactions: +1
          reactions-edit-mode: replace

      - name: Remove New Browser Test Expectations label
        if: always() && github.event_name == 'pull_request'
        run: gh pr edit ${{ needs.setup.outputs.pr-number }} --remove-label "New Browser Test Expectations"
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}