ci: optimize page load benchmarks (#37210)

## **Description**

- Reduces by 2 the number of reusable workflows called by workflow
`main` ([there's a limit of
20](https://docs.github.com/en/actions/reference/workflows-and-actions/reusing-workflow-configurations#limitations-of-reusable-workflows))
- This also has the effect of making everything run faster, due to fewer
jobs and fewer `action-checkout-and-setup` steps
- Folds the `Page Load Benchmark Results` PR comment into the other
metamaskbot comment for less disruption

## **Changelog**

CHANGELOG entry: null

<!--## **Related issues**
## **Manual testing steps**
## **Screenshots/Recordings**
## **Pre-merge author checklist**
## **Pre-merge reviewer checklist**-->

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Consolidates page-load benchmark into a single workflow with new
artifact/filename, uploads historical data on main, and folds PR comment
generation into the build announce with historical comparisons.
> 
> - **CI/Workflows**:
> - Replace `page-load-benchmark-pr` and remove
`page-load-benchmark-upload`; use unified `page-load-benchmark` workflow
with numeric inputs and required secret.
> - Run benchmarks on PRs and main; upload artifact
`page-load-benchmark-results` and, on `main`, commit stats to
`extension_benchmark_stats`.
> - Update `main.yml` to call
`./.github/workflows/page-load-benchmark.yml` and gate publish on
`page-load-benchmark`.
> - In `publish-prerelease.yml`, download `page-load-benchmark-results`
directly instead of using the deleted action.
> - **Scripts**:
> - Update `.github/scripts/benchmark-stats-commit.sh` to use
`HEAD_COMMIT_HASH`, `OWNER`, and new results path
`test-artifacts/benchmarks/page-load-benchmark-results.json`.
> - **Bot Comment Integration**:
> - Refactor `development/page-load-benchmark-pr-comment.ts` to export
`getPageLoadBenchmarkComment` (no direct posting), wrap output in a
collapsible section, and compare against recent `main` data with
regression warnings.
> - Integrate page-load benchmark comment into
`development/metamaskbot-build-announce.ts` so a single MetaMask bot
comment includes builds, benchmarks, and size diffs.
> - **Artifacts/Paths**:
> - Rename benchmark output file and artifact from
`benchmark-results.json` → `page-load-benchmark-results.json` and update
all references.
> - **Tests/Docs**:
>   - Update Playwright spec and README to use the new results filename.
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
424ed39. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

---------

Co-authored-by: Norbert Elter <[email protected]>

Author: HowardBraham

.github/actions/page-load-benchmark-comment/action.yml

@@ -9,13 +9,13 @@ if [[ -z "${EXTENSION_BENCHMARK_STATS_TOKEN:-}" ]]; then
     exit 1
 fi
 
-if [[ -z "${GITHUB_SHA:-}" ]]; then
-    printf '%s\n' 'GITHUB_SHA environment variable must be set'
+if [[ -z "${HEAD_COMMIT_HASH:-}" ]]; then
+    printf '%s\n' 'HEAD_COMMIT_HASH environment variable must be set'
     exit 1
 fi
 
-if [[ -z "${GITHUB_REPOSITORY_OWNER:-}" ]]; then
-    printf '%s\n' 'GITHUB_REPOSITORY_OWNER environment variable must be set'
+if [[ -z "${OWNER:-}" ]]; then
+    printf '%s\n' 'OWNER environment variable must be set'
     exit 1
 fi
 
@@ -33,7 +33,7 @@ git fetch origin main:main
 
 git checkout main
 
-BENCHMARK_FILE="../test-artifacts/benchmarks/benchmark-results.json"
+BENCHMARK_FILE="../test-artifacts/benchmarks/page-load-benchmark-results.json"
 STATS_FILE="stats/page_load_data.json"
 TEMP_FILE="stats/page_load_data.temp.json"
 
@@ -53,13 +53,13 @@ jq . "${BENCHMARK_FILE}" > /dev/null || {
 }
 
 # Check if the SHA already exists in the stats file
-if jq -e "has(\"${GITHUB_SHA}\")" "${STATS_FILE}" > /dev/null; then
-    echo "SHA ${GITHUB_SHA} already exists in stats file. No new commit needed."
+if jq -e "has(\"${HEAD_COMMIT_HASH}\")" "${STATS_FILE}" > /dev/null; then
+    echo "SHA ${HEAD_COMMIT_HASH} already exists in stats file. No new commit needed."
     exit 0
 fi
 
 # Append new benchmark data correctly using jq
-jq --arg sha "${GITHUB_SHA}" --argjson data "$(cat "${BENCHMARK_FILE}")" \
+jq --arg sha "${HEAD_COMMIT_HASH}" --argjson data "$(cat "${BENCHMARK_FILE}")" \
     '. + {($sha): $data}' "${STATS_FILE}" > "${TEMP_FILE}"
 
 # Overwrite the original JSON file with the corrected version
@@ -68,9 +68,9 @@ mv "${TEMP_FILE}" "${STATS_FILE}"
 # Only add the JSON file
 git add stats/page_load_data.json
 
-git commit --message "Adding page load benchmark data at commit: ${GITHUB_SHA}"
+git commit --message "Adding page load benchmark data at commit: ${HEAD_COMMIT_HASH}"
 
-repo_slug="${GITHUB_REPOSITORY_OWNER}/extension_benchmark_stats"
+repo_slug="${OWNER}/extension_benchmark_stats"
 
 git push "https://metamaskbot:${EXTENSION_BENCHMARK_STATS_TOKEN}@github.com/${repo_slug}" main
 

.github/scripts/benchmark-stats-commit.sh

@@ -241,22 +241,15 @@ jobs:
           s3-bucket: ${{ vars.AWS_S3_BUCKET }}/${{ github.event.repository.name }}/${{ github.run_id }}/bundle-size
           path: test-artifacts/chrome
 
-  page-load-benchmark-pr:
+  page-load-benchmark:
     needs:
       - build-test-browserify
-    if: ${{ github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref_name == 'main') }}
-    uses: ./.github/workflows/page-load-benchmark-pr.yml
-    with:
-      browser-loads: '10'
-      page-loads: '10'
-
-  page-load-benchmark-upload:
-    needs:
-      - page-load-benchmark-pr
-    if: github.ref == 'refs/heads/main'
-    uses: ./.github/workflows/page-load-benchmark-upload.yml
+    uses: ./.github/workflows/page-load-benchmark.yml
     secrets:
       EXTENSION_BENCHMARK_STATS_TOKEN: ${{ secrets.EXTENSION_BENCHMARK_STATS_TOKEN }}
+    with:
+      browser-loads: 10
+      page-loads: 10
 
   needs-e2e:
     needs:
@@ -419,6 +412,7 @@ jobs:
       - build-test-flask-browserify
       - build-test-flask-mv2-browserify
       - run-benchmarks
+      - page-load-benchmark
       - bundle-size
       - build-storybook
       - build-ts-migration-dashboard

.github/workflows/main.yml

@@ -6,13 +6,16 @@ on:
       browser-loads:
         description: 'Number of browser loads to perform'
         required: false
-        type: string
-        default: '10'
+        type: number
+        default: 10
       page-loads:
         description: 'Number of page loads per browser'
         required: false
-        type: string
-        default: '10'
+        type: number
+        default: 10
+    secrets:
+      EXTENSION_BENCHMARK_STATS_TOKEN:
+        required: true
 
 jobs:
   page-load-benchmark-pr:
@@ -23,28 +26,42 @@ jobs:
       OWNER: ${{ github.repository_owner }}
       REPOSITORY: ${{ github.event.repository.name }}
       PR_NUMBER: ${{ github.event.pull_request.number }}
-      GITHUB_SHA: ${{ github.event.pull_request.head.sha }}
+      HEAD_COMMIT_HASH: ${{ github.event.pull_request.head.sha || github.sha }}
+      BENCHMARK_BROWSER_LOADS: ${{ inputs.browser-loads }}
+      BENCHMARK_PAGE_LOADS: ${{ inputs.page-loads }}
+      IS_PR_OR_MAIN: ${{ github.event_name == 'pull_request' || (github.event_name == 'push' && github.ref_name == 'main') }}
     steps:
       - name: Checkout and setup environment
+        if: ${{ env.IS_PR_OR_MAIN }}
         uses: MetaMask/action-checkout-and-setup@v1
         with:
           is-high-risk-environment: false
           skip-allow-scripts: true
           use-yarn-hydrate: true
 
       - name: Download artifact 'build-test-browserify'
+        if: ${{ env.IS_PR_OR_MAIN }}
         uses: actions/download-artifact@v4
         with:
           name: build-test-browserify
 
       - name: Install Playwright browsers
+        if: ${{ env.IS_PR_OR_MAIN }}
         run: yarn playwright install chromium
 
       - name: Run page load benchmarks
+        if: ${{ env.IS_PR_OR_MAIN }}
         run: yarn test:e2e:benchmark
 
       - name: Upload benchmark results (github artifacts)
+        if: ${{ env.IS_PR_OR_MAIN }}
         uses: actions/upload-artifact@v4
         with:
-          name: benchmark-results
-          path: test-artifacts/benchmarks/benchmark-results.json
+          name: page-load-benchmark-results
+          path: test-artifacts/benchmarks/page-load-benchmark-results.json
+
+      - name: Upload benchmark results (historical data)
+        if: ${{ github.event_name == 'push' && github.ref_name == 'main' }}
+        run: .github/scripts/benchmark-stats-commit.sh
+        env:
+          EXTENSION_BENCHMARK_STATS_TOKEN: ${{ secrets.EXTENSION_BENCHMARK_STATS_TOKEN }}

.github/workflows/page-load-benchmark-upload.yml

@@ -67,12 +67,12 @@ jobs:
           echo "MERGE_BASE_COMMIT_HASH=${merge_base_commit_hash}" >> "${GITHUB_ENV}"
           echo "The merge base commit hash is '${merge_base_commit_hash}'"
 
-      - name: Page load benchmark comment
+      - name: Download page load benchmark results
         if: ${{ github.event_name == 'pull_request' }}
-        uses: ./.github/actions/page-load-benchmark-comment
+        uses: actions/download-artifact@v4
         with:
-          head-commit-hash: ${{ env.HEAD_COMMIT_HASH }}
-          pr-comment-token: ${{ secrets.PR_COMMENT_TOKEN }}
+          name: page-load-benchmark-results
+          path: test-artifacts/benchmarks
 
       - name: Publish prerelease
         if: ${{ env.MERGE_BASE_COMMIT_HASH && env.PR_NUMBER && env.PR_COMMENT_TOKEN && vars.AWS_CLOUDFRONT_URL }}

.github/workflows/page-load-benchmark-pr.yml renamed to .github/workflows/page-load-benchmark.yml

@@ -1,5 +1,6 @@
 import startCase from 'lodash/startCase';
 import { version as VERSION } from '../package.json';
+import { getPageLoadBenchmarkComment } from './page-load-benchmark-pr-comment';
 import { postCommentWithMetamaskBot } from './utils/benchmark-utils';
 
 const benchmarkPlatforms = ['chrome', 'firefox'];
@@ -330,6 +331,12 @@ async function start(): Promise<void> {
     console.log(`No results for ${summaryPlatform} found; skipping benchmark`);
   }
 
+  // Add the page load benchmark results
+  const pageLoadBenchmarkComment = await getPageLoadBenchmarkComment();
+  if (pageLoadBenchmarkComment) {
+    commentBody += pageLoadBenchmarkComment;
+  }
+
   try {
     const prBundleSizeStatsResponse = await fetch(bundleSizeStatsUrl);
     if (!prBundleSizeStatsResponse.ok) {