data-refresh.yaml

name: Weekly Data Refresh

on:
  schedule:
    # Run at 02:00 UTC every Sunday
    - cron: "0 2 * * Sun"
  # Allow manual triggering
  workflow_dispatch:

permissions:
  contents: write
  pull-requests: write
  issues: write

jobs:
  test-data:
    runs-on: ubuntu-latest
    outputs:
      tests-passed: ${{ (steps.test.outcome == 'success' && 'true') || 'false' }}
      branch-name: ${{ steps.branch.outputs.name }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "22"
          cache: "npm"

      - name: Create or reset branch
        id: branch
        run: |
          BRANCH_NAME="data-refresh"
          git checkout -b $BRANCH_NAME
          echo "name=$BRANCH_NAME" >> $GITHUB_OUTPUT

      - name: Install dependencies
        run: npm ci

      - name: Redownload mock data
        run: npm run redownload

      - name: Run tests
        id: test
        continue-on-error: true
        run: npm run test

      - name: Upload mock data
        if: steps.test.outcome == 'failure'
        uses: actions/upload-artifact@v4
        with:
          name: mock-data
          path: tests/mocks/data/
          retention-days: 1
          if-no-files-found: error

  update-snapshots:
    runs-on: ubuntu-latest
    needs: test-data
    # TODO: this is a workaround to allow the job to continue even if the tests fail so
    # we can post the outcome of the job in case of failure but it will show the job as successful
    # even if the tests fail. We should figure out how to do this without continuing on error.
    continue-on-error: true
    if: ${{ needs.test-data.outputs.tests-passed == 'false' }}
    outputs:
      tests-passed: ${{ (steps.retest.outcome == 'success' && 'true') || 'false' }}

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "22"
          cache: "npm"

      - name: Checkout branch
        run: git checkout -b ${{ needs.test-data.outputs.branch-name }}

      # Each job runs on a new machine, so we need to reinstall dependencies
      # even though we're on the same branch
      - name: Install dependencies
        run: npm ci

      # Download the mock data from the previous job to ensure we're using
      # the same data that caused the test failure
      - name: Download mock data
        uses: actions/download-artifact@v4
        with:
          name: mock-data
          path: tests/mocks/data/

      - name: Update snapshots
        # TODO: check if we need the next step or we can just run this one instead
        continue-on-error: true
        run: npm run test:update

      - name: Run tests again
        id: retest
        continue-on-error: true
        run: npm run test

      - name: Commit changes
        run: |
          git config user.name "github-actions[bot]"
          git config user.email "github-actions[bot]@users.noreply.github.com"
          git add .
          git commit -m "🤖💖 — Update snapshots after data refresh" || echo "No changes to commit"

      - name: Push branch
        run: git push --force -u origin ${{ needs.test-data.outputs.branch-name }}

  create-success-pr:
    runs-on: ubuntu-latest
    needs: [test-data, update-snapshots]
    if: ${{ needs.update-snapshots.outputs.tests-passed == 'true' }}

    steps:
      - name: Create or update Pull Request
        uses: actions/github-script@v7
        with:
          script: |
            const head = '${{ needs.test-data.outputs.branch-name }}';
            const today = new Date().toISOString().split('T')[0];
            const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;

            const [{ data: existingIssues }, { data: existingPRs }] = await Promise.all([
              github.rest.issues.listForRepo({
                owner: context.repo.owner,
                repo: context.repo.repo,
                labels: 'data-refresh',
                state: 'open',
                per_page: 100,
              }),
              github.rest.pulls.list({
                owner: context.repo.owner,
                repo: context.repo.repo,
                head: `${context.repo.owner}:${head}`,
                base: 'main',
                state: 'open',
              }),
            ]);
            const openIssues = existingIssues.filter(i => !i.pull_request);
            const fixesLine = openIssues.length > 0
              ? `\n\nFixes ${openIssues.map(i => `#${i.number}`).join(', ')}`
              : '';

            const body = `The Automatic data refresh on ${today} detected changes in AO3 responses.

            Snapshots have been updated to reflect current status. All tests are now passing! 🎉🎊🌟

            Changes look good? ➡️ Merge this PR to update the snapshots and tests.
            Changes look _yikes_? ❌ Check out this PR and go get 'em! 💪🔥${fixesLine}`;

            if (existingPRs.length > 0) {
              const prNumber = existingPRs[0].number;
              await github.rest.pulls.update({
                owner: context.repo.owner,
                repo: context.repo.repo,
                pull_number: prNumber,
                title: '🔄✅ Data Refresh: Snapshot Update Complete!',
                body,
              });
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: prNumber,
                body: `🔄✨ Fresh data just dropped (${today})! Tests are passing and this PR is ready for another look~ [Workflow run](${runUrl}) 👀`,
              });
              core.info(`Updated existing PR #${prNumber}`);
            } else {
              const pr = await github.rest.pulls.create({
                owner: context.repo.owner,
                repo: context.repo.repo,
                title: '🔄✅ Data Refresh: Snapshot Update Complete!',
                head,
                base: 'main',
                body,
              });
              await github.rest.issues.addLabels({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: pr.data.number,
                labels: ['data-refresh'],
              });
              core.info(`Created new PR #${pr.data.number}`);
            }

  create-failure-pr-and-issue:
    runs-on: ubuntu-latest
    needs: [test-data, update-snapshots]
    if: ${{ needs.update-snapshots.outputs.tests-passed == 'false' }}

    steps:
      - name: Create or update issue and PR for failed tests
        uses: actions/github-script@v7
        with:
          script: |
            const head = '${{ needs.test-data.outputs.branch-name }}';
            const today = new Date().toISOString().split('T')[0];
            const runUrl = `${context.serverUrl}/${context.repo.owner}/${context.repo.repo}/actions/runs/${context.runId}`;

            const [{ data: existingIssues }, { data: existingPRs }] = await Promise.all([
              github.rest.issues.listForRepo({
                owner: context.repo.owner,
                repo: context.repo.repo,
                labels: 'data-refresh',
                state: 'open',
                per_page: 100,
              }),
              github.rest.pulls.list({
                owner: context.repo.owner,
                repo: context.repo.repo,
                head: `${context.repo.owner}:${head}`,
                base: 'main',
                state: 'open',
              }),
            ]);
            const openIssues = existingIssues.filter(i => !i.pull_request);

            let issueNumber;
            const issueBody = `The daily data refresh tests failed on ${today}. Yes, even with the snapshot updates!

            Please check the [workflow run](${runUrl}) for details.

            ---

            Want to learn more about this issue and help us fix it? Check out the [README](https://github.com/FujoWebDev/AO3.js/blob/main/README.md#about--data-refresh-tests-failed-issues) for more information!`;

            if (openIssues.length > 0) {
              issueNumber = openIssues[0].number;
              await github.rest.issues.update({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: issueNumber,
                body: issueBody,
              });
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: issueNumber,
                body: `🚨 Oop, tests are STILL failing as of ${today}. The bugs persist! 🐛💪 [Workflow run](${runUrl})`,
              });
              core.info(`Updated existing issue #${issueNumber}`);
            } else {
              const issue = await github.rest.issues.create({
                owner: context.repo.owner,
                repo: context.repo.repo,
                title: '🚨 Data Refresh Tests Failed After Snapshot Update',
                body: issueBody,
                labels: ['data-refresh'],
              });
              issueNumber = issue.data.number;
              core.info(`Created new issue #${issueNumber}`);
            }

            const prBody = `Automatic data refresh on ${today} detected changes in AO3 responses.

            Despite our best efforts (in the form of a snapshot update), tests are still failing.

            Manual investigation is required 🔍🕵️ To help you get started, we've created this PR with the already-updated data. May the bugs be ever in your favor! 🍀

            Check the [workflow run](${runUrl}) for details.

            Closes #${issueNumber}...eventually 🤞

            ---

            Want to learn more about this issue and help us fix it? Check out the [README](https://github.com/FujoWebDev/AO3.js/blob/main/README.md#about--data-refresh-tests-failed-issues) for more information!`;

            if (existingPRs.length > 0) {
              const prNumber = existingPRs[0].number;
              await github.rest.pulls.update({
                owner: context.repo.owner,
                repo: context.repo.repo,
                pull_number: prNumber,
                title: '🚨 HALP! Tests are failing after data refresh!',
                body: prBody,
              });
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: prNumber,
                body: `🚨 Another week, another data refresh (${today}), and the tests are still throwing a tantrum 😤 [Workflow run](${runUrl}). Someone come get their bugs! 🍀`,
              });
              core.info(`Updated existing PR #${prNumber}`);
            } else {
              const pr = await github.rest.pulls.create({
                owner: context.repo.owner,
                repo: context.repo.repo,
                title: '🚨 HALP! Tests are failing after data refresh!',
                head,
                base: 'main',
                body: prBody,
              });
              await github.rest.issues.addLabels({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: pr.data.number,
                labels: ['data-refresh'],
              });
              core.info(`Created new PR #${pr.data.number}`);
            }