chore(ci): switch lighthouse to unlighthouse (#2338)

Co-authored-by: Jordan Arldt <jordan.arldt@bigcommerce.com>

Author: chanceaclark

.github/workflows/.lighthouserc-desktop.json

@@ -5,100 +5,40 @@ on:
     states: ['success']
 
 env:
-  PLAYWRIGHT_TEST_BASE_URL: ${{ github.event.deployment_status.target_url }}
   VERCEL_PROTECTION_BYPASS: ${{ secrets.VERCEL_AUTOMATION_BYPASS_SECRET }}
-  BIGCOMMERCE_ACCESS_TOKEN: ${{ secrets.BIGCOMMERCE_ACCESS_TOKEN }}
-  BIGCOMMERCE_STORE_HASH: ${{ secrets.BIGCOMMERCE_STORE_HASH }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event.deployment_status.target_url }}
+  cancel-in-progress: true
 
 jobs:
-  generate-lighthouse-audit:
-    name: Lighthouse Audit
-    timeout-minutes: 30
-    runs-on: ubuntu-latest
+  unlighthouse-audit:
     if: ${{ contains(fromJson('["Production – catalyst-canary", "Preview – catalyst-canary"]'), github.event.deployment_status.environment) }}
+    name: Unlighthouse Audit - ${{ matrix.device }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        device: [desktop, mobile]
+    concurrency: 
+      group: ${{ github.workflow }}-${{ github.ref }}-${{ github.event.deployment_status.target_url }}-${{ matrix.device }}
+      cancel-in-progress: true
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-
-      - name: Pull Request Details
-        id: pr_details
-        uses: actions/github-script@v7
         with:
-          script: |
-            const prData = require('./.github/workflows/pull-request-data.js');
-            await prData({ github, context, core });
+          fetch-depth: 0
 
-      - name: Lighthouse house audit on desktop
-        id: lighthouse_audit_desktop
-        uses: treosh/lighthouse-ci-action@v11
-        with:
-          urls: |
-            ${{ github.event.deployment_status.target_url }}
-          configPath: '.github/workflows/.lighthouserc-desktop.json'
-          temporaryPublicStorage: true
-          runs: 3
-
-      - name: Lighthouse audit on mobile
-        id: lighthouse_audit_mobile
-        uses: treosh/lighthouse-ci-action@v11
-        with:
-          urls: |
-            ${{ github.event.deployment_status.target_url }}
-          temporaryPublicStorage: true
-          runs: 3
-
-      - uses: pnpm/action-setup@v3
-      - name: Format lighthouse score on desktop
-        id: format_lighthouse_score_desktop
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const lighthouseCommentMaker = require('./.github/workflows/lighthouseCommentMaker.js');
-
-            const lighthouseOutputs = {
-              manifest: ${{ steps.lighthouse_audit_desktop.outputs.manifest }},
-              links: ${{ steps.lighthouse_audit_desktop.outputs.links }},
-              preset: "desktop"
-            };
-
-            const comment = lighthouseCommentMaker({ lighthouseOutputs });
-            core.setOutput("comment", comment);
-
-      - name: Format lighthouse score on mobile
-        id: format_lighthouse_score_mobile
-        uses: actions/github-script@v7
-        with:
-          script: |
-            const lighthouseCommentMaker = require('./.github/workflows/lighthouseCommentMaker.js');
-            
-            const lighthouseOutputs = {
-              manifest: ${{ steps.lighthouse_audit_mobile.outputs.manifest }},
-              links: ${{ steps.lighthouse_audit_mobile.outputs.links }},
-              preset: "mobile"
-            };
+      - name: Install Dependencies
+        run: npm install @unlighthouse/cli puppeteer -g
 
-            const comment = lighthouseCommentMaker({ lighthouseOutputs });
-            core.setOutput("comment", comment);
+      - name: Unlighthouse audit on ${{ matrix.device }}
+        run: unlighthouse-ci --site ${{ github.event.deployment_status.target_url }} --${{ matrix.device }} --disable-robots-txt --extra-headers x-vercel-protection-bypass=$VERCEL_PROTECTION_BYPASS,x-vercel-set-bypass-cookie=true
 
-      - name: Add comment to PR
-        id: comment_to_pr
-        uses: marocchino/sticky-pull-request-comment@v2.9.0
-        if: ${{ steps.pr_details.outputs.pr }}
+      - name: Upload ${{ matrix.device }} audit
+        if: failure() || success()
+        uses: actions/upload-artifact@v4
         with:
-          recreate: true
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          number: ${{ steps.pr_details.outputs.pr }}
-          header: lighthouse
-          message: |
-            # ⚡️🏠 Lighthouse report
-            
-            *Lighthouse ran against ${{ github.event.deployment_status.target_url }}* 
-            
-            ## 🖥️ Desktop
-            
-            ${{ steps.format_lighthouse_score_desktop.outputs.comment }}
-            
-            ## 📱 Mobile
-            
-            ${{ steps.format_lighthouse_score_mobile.outputs.comment }}
+          name: unlighthouse-${{ matrix.device }}-report
+          path: './.unlighthouse/'
+          include-hidden-files: 'true'

.github/workflows/lighthouseCommentMaker.js

@@ -18,3 +18,4 @@ bigcommerce-graphql.d.ts
 .DS_Store
 coverage/
 .history
+.unlighthouse

.github/workflows/pull-request-data.js

@@ -24,6 +24,7 @@
     "@changesets/cli": "^2.29.0",
     "dotenv-cli": "^8.0.0",
     "turbo": "^2.5.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "unlighthouse": "^0.16.3"
   }
 }