Pre OSS commit

Author: nginx

.github/workflows/lighthouse.yml

@@ -0,0 +1,52 @@
+name: Lighthouse
+on: 
+  workflow_run:
+    workflows: [Build and deploy (docs)]
+    types:
+      - completed
+env:
+  FRONT_DOOR_USERNAME: ${{ secrets.FRONT_DOOR_USERNAME }}
+  FRONT_DOOR_PASSWORD: ${{ secrets.FRONT_DOOR_PASSWORD }}
+  GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }}
+jobs:
+  lighthouseci:
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: Installing packages
+        run: npm install
+      - name: Generating lighthouse reports for PR and main...
+        run: | 
+            node lighthouse-script.js
+      - name: Compare the artifacts for negative differences in performance
+        run: |
+            FIELDS=("performance" "accessibility") 
+            for FIELD in "${FIELDS[@]}"; do
+                PR_VALUE=$(cat lighthouse-reports/pr-report.json | jq -r ".categories.$FIELD.score")
+                MAIN_VALUE=$(cat lighthouse-reports/main-report.json | jq -r ".categories.$FIELD.score")
+                echo "$FIELD: PR - $PR_VALUE | Main - $MAIN_VALUE"
+
+                if [ $FIELD = "performance" ]; then  
+                  LOWER_BOUND=$(echo "$MAIN_VALUE - 0.05" | bc)
+                  UPPER_BOUND=$(echo "$MAIN_VALUE + 0.05" | bc)
+                  if (( $(echo "$PR_VALUE < $LOWER_BOUND" | bc -l) || $(echo "$PR_VALUE > $UPPER_BOUND" | bc -l) )); then
+                      echo "Error: $FIELD score in PR ($PR_VALUE) is less than in MAIN ($MAIN_VALUE)"
+                      exit 1
+                  fi
+                else
+                  if (( $(echo "$PR_VALUE < $MAIN_VALUE" | bc -l) )); then
+                    echo "Error: $FIELD score in PR ($PR_VALUE) is less than in MAIN ($MAIN_VALUE)"
+                    exit 1
+                  fi
+                fi
+            done
+      - uses: actions/upload-artifact@v4
+        if: ${{ !cancelled() }}
+        with:
+            name: lighthouse-reports
+            path: lighthouse-reports/
+            retention-days: 30

.gitignore

@@ -35,6 +35,9 @@ resources/
 .netlify/plugins/*
 .netlify/
 
+# Local Lighthouse artifacts
+lighthouse-reports
+
 *.pyc
 build
 *.swp

lighthouse-script.js

@@ -0,0 +1,53 @@
+const puppeteer = require('puppeteer');
+const fs = require('fs');
+
+const PORT = 8041;
+const PR_NUMBER = process.env.GITHUB_PR_NUMBER;
+const environments = [
+  {
+    title: "pr",
+    url: `https://frontdoor-test-docs.nginx.com/previews/docs/${PR_NUMBER}/`
+  }, 
+  {
+    title: "main",
+    url: "https://docs.nginx.com/"
+  }];
+const OUTPUT_DIR = './lighthouse-reports';
+
+const signIntoFrontDoor = async (browser, env) => {
+  const page = await browser.newPage();
+  await page.authenticate({
+    username: process.env.FRONT_DOOR_USERNAME,
+    password: process.env.FRONT_DOOR_PASSWORD
+  });
+
+  await page.goto(env['url']);
+  await page.waitForSelector('.navbar');
+  console.log("Logged in...");
+  await page.close();
+}
+
+const runLighthouse = async (env) => {
+  const OUTPUT_FILE= `${env['title']}-report.json`;
+
+  const lighthouse = (await import('lighthouse')).default;
+  console.log(`Running Lighthouse for ${env['title']}...`)
+  const result = await lighthouse(env['url'], { port: PORT });
+  fs.writeFileSync(`${OUTPUT_DIR}/${OUTPUT_FILE}`, result.report);
+}
+
+(async () => {
+  const browser = await puppeteer.launch({ args: [`--remote-debugging-port=${PORT}`], headless: true });
+  if (!fs.existsSync(OUTPUT_DIR)){
+    fs.mkdirSync(OUTPUT_DIR);
+  }
+
+  for(const env of environments){
+    if(env['title'] == 'pr') {
+      await signIntoFrontDoor(browser, env);
+    }
+    await runLighthouse(env);
+  }
+
+  await browser.close();
+})();