chore: Make Lighthouse CI run on local build (#9447)

facebook · Oct 25, 2023 · dd03a25 · dd03a25
1 parent c6762a2
commit dd03a25
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 15 deletions.
diff --git a/.github/workflows/lighthouse-report.yml b/.github/workflows/lighthouse-report.yml
@@ -22,29 +22,33 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
-      - name: Wait for the Netlify Preview
-        uses: jakepartusch/wait-for-netlify-action@f1e137043864b9ab9034ae3a5adc1c108e3f1a48 # v1
-        id: netlify
+
+      - name: Use Node.js
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
-          site_name: docusaurus-2
-          max_timeout: 600
+          node-version: 18
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build website fast
+        run: yarn build:website:fast
+
       - name: Audit URLs using Lighthouse
         id: lighthouse_audit
         uses: treosh/lighthouse-ci-action@03becbfc543944dd6e7534f7ff768abb8a296826 # 10.1.0
         with:
           urls: |
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/docs/installation/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/docs/category/getting-started/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/preparing-your-site-for-docusaurus-v3/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/tags/release/
-            https://deploy-preview-$PR_NUMBER--docusaurus-2.netlify.app/blog/tags/
+            http://localhost:3000
+            http://localhost:3000/docs/installation
+            http://localhost:3000/docs/category/getting-started
+            http://localhost:3000/blog
+            http://localhost:3000/blog/preparing-your-site-for-docusaurus-v3
+            http://localhost:3000/blog/tags/release
+            http://localhost:3000/blog/tags
           configPath: ./.github/workflows/lighthouserc.json
           uploadArtifacts: true
           temporaryPublicStorage: true
-        env:
-          PR_NUMBER: ${{ github.event.pull_request.number}}
 
       - name: Format lighthouse score
         id: format_lighthouse_score

diff --git a/.github/workflows/lighthouserc.json b/.github/workflows/lighthouserc.json
@@ -1,6 +1,12 @@
 {
   "ci": {
     "collect": {
+      "startServerCommand": "yarn serve:website",
+      "startServerReadyPattern": "Serving",
+      "startServerReadyTimeout": 10000,
+
+      "numberOfRuns": 5,
+
       "settings": {
         "skipAudits": [
           "robots-txt",

diff --git a/admin/scripts/formatLighthouseReport.js b/admin/scripts/formatLighthouseReport.js
@@ -26,6 +26,18 @@ const scoreEntry = (rawScore) => {
   return `${scoreIcon} ${score}`;
 };
 
+/**
+ * @param {string} url
+ * @returns {module:url.URL}
+ */
+function createURL(url) {
+  try {
+    return new URL(url);
+  } catch (e) {
+    throw new Error(`Can't create URL for string=${url}`, {cause: e});
+  }
+}
+
 /**
  * @param {Object} param0
  * @param {string} param0.url
@@ -34,7 +46,7 @@ const scoreEntry = (rawScore) => {
  */
 const createMarkdownTableRow = ({url, summary, reportUrl}) =>
   [
-    `| [${new URL(url).pathname}](${url})`,
+    `| [${createURL(url).pathname}](${url})`,
     .../** @type {(keyof LighthouseSummary)[]} */ (
       Object.keys(summaryKeys)
     ).map((k) => scoreEntry(summary[k])),