name: Blocks Playwright Tests

on:
    pull_request:
        paths:
            - '.github/workflows/blocks-playwright.yml' # This file
            - 'plugins/woocommerce-blocks/**'
            - 'plugins/woocommerce/src/Blocks/**'
            - 'plugins/woocommerce/templates/**'
            - 'plugins/woocommerce/patterns/**'
    # Allow manually triggering the workflow.
    workflow_dispatch:
    # Run workflow when a PR is merged to trunk branch
    # to create github issues for flaky tests.
    push:
        branches:
            - trunk
        paths:
            - '.github/workflows/blocks-playwright.yml' # This file
            - 'plugins/woocommerce-blocks/**'
            - 'plugins/woocommerce/src/Blocks/**'
            - 'plugins/woocommerce/templates/**'
            - 'plugins/woocommerce/patterns/**'

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

env:
    FORCE_COLOR: 1

jobs:
    blocks-playwright-tests:
        name: Shard ${{ matrix.shardIndex }} of ${{ matrix.shardTotal }}
        timeout-minutes: 60
        runs-on: ubuntu-latest
        defaults:
            run:
                working-directory: plugins/woocommerce-blocks
        strategy:
            fail-fast: false
            matrix:
                shardIndex: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
                shardTotal: [10]

        steps:
            - uses: actions/checkout@v4

            - name: Setup WooCommerce Monorepo
              uses: ./.github/actions/setup-woocommerce-monorepo
              with:
                  install: '@woocommerce/plugin-woocommerce...'
                  build: '@woocommerce/plugin-woocommerce'
                  pull-playwright-cache: true

            - name: Install Playwright dependencies
              run: pnpm exec playwright install chromium --with-deps

            - name: Setup testing environment and start the server
              run: pnpm env:start

            - name: Run Playwright tests
              run: pnpm test:e2e --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }}

            - name: Archive debug artifacts (screenshots, traces)
              uses: actions/upload-artifact@v4
              if: ${{ !cancelled() }}
              with:
                  name: failures-artifacts-shard-${{ matrix.shardIndex }}
                  path: plugins/woocommerce-blocks/tests/e2e/artifacts/test-results
                  if-no-files-found: ignore

            - name: Archive flaky test reports
              uses: actions/upload-artifact@v4
              if: ${{ !cancelled() }}
              with:
                  name: flaky-tests-report-shard-${{ matrix.shardIndex }}
                  path: plugins/woocommerce-blocks/flaky-tests
                  if-no-files-found: ignore

    merge-artifacts:
        # Merges all artifacts from all shards into a single zip and
        # deletes the parts. In case of a rerun, artifacts from the
        # previous run will be retained by merging them with the new ones.
        name: Merge Artifacts
        if: ${{ !cancelled() }}
        needs: [blocks-playwright-tests]
        runs-on: ubuntu-latest
        outputs:
            has-flaky-test-report: ${{ !!steps.merge-flaky-tests-reports.outputs.artifact-id }}
        steps:
            - name: Merge failures artifacts
              uses: actions/upload-artifact/merge@v4
              # Don't fail the job if there aren't any artifacts to merge.
              continue-on-error: true
              with:
                  name: failures-artifacts
                  pattern: failures-artifacts*
                  delete-merged: true

            - name: Merge flaky tests reports
              id: merge-flaky-tests-reports
              uses: actions/upload-artifact/merge@v4
              continue-on-error: true
              with:
                  name: flaky-tests-report
                  pattern: flaky-tests-report*
                  delete-merged: true

    create-github-issues-for-flaky-tests:
        name: Create GitHub issues for flaky tests
        needs: [merge-artifacts]
        if: ${{ !cancelled() && needs.merge-artifacts.outputs.has-flaky-test-report == 'true' }}
        runs-on: ubuntu-latest
        permissions:
            contents: read
            issues: write
        steps:
            # We are using @wordpress/report-flaky-tests package from Gutenberg repo
            # to create GitHub issues for flaky tests.
            - uses: actions/checkout@v4
              with:
                  repository: WordPress/gutenberg
                  # We are using commit hash to checkout the exact version of the script.
                  # This is to avoid any breaking changes.
                  ref: dbf201449e9736f672b61e422787d47659db327a

            - uses: actions/download-artifact@v4
              with:
                  name: flaky-tests-report
                  path: flaky-tests

            - name: Setup Node.js and install dependencies
              uses: ./.github/setup-node

            - name: Npm build
              # TODO: We don't have to build the entire project, just the action itself.
              run: npm run build:packages

            - name: Report flaky tests
              uses: ./packages/report-flaky-tests
              with:
                  repo-token: '${{ secrets.GITHUB_TOKEN }}'
                  label: 'metric: flaky e2e test'
                  artifact-path: flaky-tests