reports.yml

name: Generate Reports and Deploy to GitHub Pages

on:
    workflow_call:
        inputs:
            cleanup-previews:
                description: Remove stale pull request previews without publishing production reports.
                required: false
                type: boolean
                default: false
    workflow_dispatch:
        inputs:
            cleanup-previews:
                description: Remove stale pull request previews without publishing production reports.
                required: false
                type: boolean
                default: false
    schedule:
        - cron: '41 3 * * *'
    pull_request:
        types: [ "opened", "synchronize", "reopened", "closed" ]
    push:
        branches: [ "main" ]

permissions:
    contents: read

concurrency:
    group: ${{ github.event_name == 'pull_request' && format('reports-preview-pr-{0}', github.event.pull_request.number) || 'reports-pages' }}
    cancel-in-progress: ${{ github.event_name == 'pull_request' && github.event.action != 'closed' }}

jobs:
    resolve_php:
        name: Resolve PHP Version
        runs-on: ubuntu-latest
        outputs:
            php-version: ${{ steps.resolve.outputs.php-version }}
            php-version-source: ${{ steps.resolve.outputs.php-version-source }}

        steps:
            - uses: actions/checkout@v6

            - name: Resolve workflow PHP version
              id: resolve
              uses: php-fast-forward/dev-tools/resources/resolve-php-version@main

    reports:
        needs: resolve_php
        if: github.event_name != 'schedule' && !(github.event_name == 'workflow_dispatch' && inputs.cleanup-previews) && (github.event_name != 'pull_request' || github.event.action != 'closed')
        name: Generate Reports
        runs-on: ubuntu-latest
        permissions:
            contents: write

        env:
            PAGES_ARTIFACT_NAME: ${{ github.event_name == 'pull_request' && format('github-pages-pr-{0}', github.event.pull_request.number) || 'github-pages' }}
            REPORTS_ROOT_VERSION: ${{ github.event_name == 'pull_request' && format('dev-{0}', github.event.pull_request.head.ref) || 'dev-main' }}
            FORCE_COLOR: '1'

        steps:
            - uses: actions/checkout@v6
              with:
                fetch-depth: 0

            - name: Setup PHP
              uses: shivammathur/setup-php@v2
              with:
                php-version: ${{ needs.resolve_php.outputs.php-version }}
                extensions: pcov, pcntl
                coverage: pcov

            - name: Cache Composer dependencies
              uses: actions/cache@v5
              with:
                path: /tmp/composer-cache
                key: ${{ runner.os }}-composer-${{ needs.resolve_php.outputs.php-version }}-${{ hashFiles('**/composer.lock') }}
                restore-keys: |
                  ${{ runner.os }}-composer-${{ needs.resolve_php.outputs.php-version }}-
                  ${{ runner.os }}-composer-

            - name: Install dependencies
              env:
                COMPOSER_AUTH: '{"github-oauth": {"github.com": "${{ github.token }}"} }'
                COMPOSER_CACHE_DIR: /tmp/composer-cache
                COMPOSER_ROOT_VERSION: ${{ env.REPORTS_ROOT_VERSION }}
              run: composer install --prefer-dist --no-progress --no-interaction --no-scripts

            - name: Mark workspace as safe for git
              run: git config --global --add safe.directory "$GITHUB_WORKSPACE"

            - name: Generate reports
              env:
                COMPOSER_ROOT_VERSION: ${{ env.REPORTS_ROOT_VERSION }}
              run: composer dev-tools reports -- --target=tmp/reports --coverage=tmp/reports/coverage --metrics=tmp/reports/metrics

            - name: Fix permissions
              run: |
                chmod -c -R +rX "tmp/reports/" | while read line; do
                    echo "::warning title=Invalid file permissions automatically fixed::$line"
                done

            - name: Add .nojekyll
              run: touch tmp/reports/.nojekyll

            - name: Restore previews from gh-pages
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              uses: actions/checkout@v6
              continue-on-error: true
              with:
                ref: gh-pages
                path: gh-pages-current

            - name: Copy existing previews into publish directory
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              run: |
                if [ -d "gh-pages-current/previews" ]; then
                    mkdir -p tmp/reports/previews
                    cp -R gh-pages-current/previews/. tmp/reports/previews/
                fi

            - name: Deploy main reports
              if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
              uses: peaceiris/actions-gh-pages@v4
              with:
                github_token: ${{ secrets.GITHUB_TOKEN }}
                publish_branch: gh-pages
                publish_dir: ./tmp/reports/
                destination_dir: .
                keep_files: false
                force_orphan: false

            - name: Deploy PR preview
              if: github.event_name == 'pull_request'
              uses: peaceiris/actions-gh-pages@v4
              with:
                github_token: ${{ secrets.GITHUB_TOKEN }}
                publish_branch: gh-pages
                publish_dir: ./tmp/reports/
                destination_dir: previews/pr-${{ github.event.pull_request.number }}
                keep_files: false
                force_orphan: false

    verify_main_reports:
        if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && !(github.event_name == 'workflow_dispatch' && inputs.cleanup-previews)
        name: Verify Main Reports Deployment
        needs: reports
        runs-on: ubuntu-latest

        steps:
            - name: Health check deployed reports
              env:
                BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}
              run: |
                check_url() {
                    url="$1"
                    label="$2"
                    attempts=6
                    delay=5

                    for attempt in $(seq 1 "${attempts}"); do
                        echo "Checking ${label}: ${url} (attempt ${attempt}/${attempts})"

                        http_status="$(curl --silent --show-error --output /dev/null --location --write-out '%{http_code}' "${url}" 2>/tmp/curl-error.log || true)"

                        if [ "${http_status}" -ge 200 ] && [ "${http_status}" -lt 400 ]; then
                            echo "${label} is reachable (${http_status})."
                            return 0
                        fi

                        curl_error="$(cat /tmp/curl-error.log)"

                        if [ -n "${curl_error}" ]; then
                            echo "Attempt ${attempt} failed for ${label}: ${url} (curl error: ${curl_error})"
                        else
                            echo "Attempt ${attempt} failed for ${label}: ${url} (HTTP ${http_status})"
                        fi

                        if [ "${attempt}" -lt "${attempts}" ]; then
                            sleep "${delay}"
                        fi
                    done

                    echo "::error title=Reports health check failed::${label} is not reachable at ${url}. Last HTTP status: ${http_status}${curl_error:+; curl error: ${curl_error}}"
                    return 1
                }

                check_url "${BASE_URL}/" "Reports index"
                check_url "${BASE_URL}/coverage/" "Coverage report"

    verify_preview_reports:
        if: github.event_name == 'pull_request' && github.event.action != 'closed'
        name: Verify Pull Request Reports Preview
        needs: reports
        runs-on: ubuntu-latest

        steps:
            - name: Health check deployed preview
              env:
                BASE_URL: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}
              run: |
                check_url() {
                    url="$1"
                    label="$2"
                    attempts=6
                    delay=5

                    for attempt in $(seq 1 "${attempts}"); do
                        echo "Checking ${label}: ${url} (attempt ${attempt}/${attempts})"

                        http_status="$(curl --silent --show-error --output /dev/null --location --write-out '%{http_code}' "${url}" 2>/tmp/curl-error.log || true)"

                        if [ "${http_status}" -ge 200 ] && [ "${http_status}" -lt 400 ]; then
                            echo "${label} is reachable (${http_status})."
                            return 0
                        fi

                        curl_error="$(cat /tmp/curl-error.log)"

                        if [ -n "${curl_error}" ]; then
                            echo "Attempt ${attempt} failed for ${label}: ${url} (curl error: ${curl_error})"
                        else
                            echo "Attempt ${attempt} failed for ${label}: ${url} (HTTP ${http_status})"
                        fi

                        if [ "${attempt}" -lt "${attempts}" ]; then
                            sleep "${delay}"
                        fi
                    done

                    echo "::error title=Preview health check failed::${label} is not reachable at ${url}. Last HTTP status: ${http_status}${curl_error:+; curl error: ${curl_error}}"
                    return 1
                }

                check_url "${BASE_URL}/" "Preview reports index"
                check_url "${BASE_URL}/coverage/" "Preview coverage report"

    comment_preview:
        if: github.event_name == 'pull_request' && github.event.action != 'closed'
        name: Comment Pull Request Preview URLs
        needs:
            - reports
            - verify_preview_reports
        runs-on: ubuntu-latest
        permissions:
            pull-requests: write

        steps:
            - name: Comment preview URLs on pull request
              uses: marocchino/sticky-pull-request-comment@v2
              with:
                header: pr-preview
                message: |
                  🚀 Preview is available for this pull request.

                  - Docs: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/
                  - Coverage: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/coverage/
                  - Metrics: https://${{ github.repository_owner }}.github.io/${{ github.event.repository.name }}/previews/pr-${{ github.event.pull_request.number }}/metrics/

    cleanup_preview:
        if: github.event_name == 'pull_request' && github.event.action == 'closed'
        name: Cleanup Pull Request Preview
        runs-on: ubuntu-latest
        permissions:
            contents: write

        steps:
            - name: Checkout gh-pages
              uses: actions/checkout@v6
              with:
                ref: gh-pages
                path: gh-pages

            - name: Remove preview directory
              run: |
                rm -rf "gh-pages/previews/pr-${{ github.event.pull_request.number }}"
                cd gh-pages
                touch .nojekyll
                git config user.name "github-actions[bot]"
                git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
                git add -A
                git diff --cached --quiet || git commit -m "chore: remove preview for PR #${{ github.event.pull_request.number }}"

            - name: Push changes
              run: |
                cd gh-pages
                git push

    cleanup_orphaned_previews:
        if: github.event_name == 'schedule' || (github.event_name == 'workflow_dispatch' && inputs.cleanup-previews)
        name: Cleanup Orphaned Pull Request Previews
        runs-on: ubuntu-latest
        permissions:
            contents: write
            pull-requests: read

        steps:
            - name: Checkout gh-pages
              uses: actions/checkout@v6
              with:
                ref: gh-pages
                path: gh-pages

            - name: Remove previews for closed pull requests
              env:
                GH_TOKEN: ${{ github.token }}
              run: |
                cd gh-pages

                deleted=0
                skipped=0
                unresolved=0

                if [ ! -d previews ]; then
                    echo "No previews directory exists. Nothing to clean."
                    exit 0
                fi

                while read -r preview_dir; do
                    branch="${preview_dir#previews/}"
                    pull_request_number="${branch#pr-}"

                    if ! [[ "${pull_request_number}" =~ ^[0-9]+$ ]]; then
                        echo "Skipping preview directory ${preview_dir}: name does not match pr-<number>."
                        skipped=$((skipped + 1))
                        continue
                    fi

                    state="$(gh pr view "${pull_request_number}" --repo "${GITHUB_REPOSITORY}" --json state --jq '.state' 2>/dev/null || echo UNKNOWN)"

                    case "${state}" in
                        CLOSED|MERGED)
                            echo "Deleting preview directory ${preview_dir} for ${state} pull request #${pull_request_number}."
                            rm -rf "${preview_dir}"
                            deleted=$((deleted + 1))
                            ;;
                        OPEN)
                            echo "Keeping preview directory ${preview_dir} for open pull request #${pull_request_number}."
                            skipped=$((skipped + 1))
                            ;;
                        *)
                            echo "Could not resolve pull request #${pull_request_number} for preview directory ${preview_dir}. Keeping it."
                            unresolved=$((unresolved + 1))
                            ;;
                    esac
                done < <(find previews -mindepth 1 -maxdepth 1 -type d -name 'pr-*' | sort)

                echo "Preview cleanup summary: deleted=${deleted}, skipped=${skipped}, unresolved=${unresolved}."

                touch .nojekyll
                git config user.name "github-actions[bot]"
                git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
                git add -A
                git diff --cached --quiet || git commit -m "chore: remove orphaned pull request previews"

            - name: Push changes
              run: |
                cd gh-pages
                git push