@jsenv/lighthouse-impact 1.1.1 → 2.1.0

package/README.md

@@ -1,18 +1,10 @@
-# Lighthouse impact
-
-Report pull request impacts on lighthouse score.
-
-[![npm package](https://img.shields.io/npm/v/@jsenv/lighthouse-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/lighthouse-impact)
-[![github main](https://github.com/jsenv/lighthouse-impact/workflows/main/badge.svg)](https://github.com/jsenv/lighthouse-impact/actions?workflow=main)
-[![codecov coverage](https://codecov.io/gh/jsenv/lighthouse-impact/branch/main/graph/badge.svg)](https://codecov.io/gh/jsenv/lighthouse-impact)
-
-# Presentation
+# Lighthouse impact [![npm package](https://img.shields.io/npm/v/@jsenv/lighthouse-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/lighthouse-impact) [![github main](https://github.com/jsenv/lighthouse-impact/workflows/main/badge.svg)](https://github.com/jsenv/lighthouse-impact/actions?workflow=main) [![codecov coverage](https://codecov.io/gh/jsenv/lighthouse-impact/branch/main/graph/badge.svg)](https://codecov.io/gh/jsenv/lighthouse-impact)
 
 `@jsenv/lighthouse-impact` analyses a pull request impact on lighthouse score. This analysis is posted in a comment of the pull request on GitHub.
 
 - Helps you to catch lighthouse score impacts before merging a pull request
-- Can be added to any workflow like a GitHub workflow
 - Gives you the ability to get lighthouse report on your machine during dev
+- Can be added to any automated process (GitHub workflow, Jenkins, ...)
 
 # Pull request comment
 
@@ -42,24 +34,23 @@ _generate_lighthouse_report.mjs_
  */
 import { createServer } from "node:http"
 import { readFileSync } from "node:fs"
-import { getLighthouseReportUsingHeadlessChrome } from "@jsenv/lighthouse-impact"
+import { generateLighthouseReport } from "@jsenv/lighthouse-impact"
 
 const htmlFileUrl = new URL("./index.html", import.meta.url)
 const html = String(readFileSync(htmlFileUrl))
 
-export const generateLighthouseReport = async () => {
-  const server = createServer((request, response) => {
-    response.writeHead(200, {
-      "content-type": "text/html",
-    })
-    response.end(html)
+const server = createServer((request, response) => {
+  response.writeHead(200, {
+    "content-type": "text/html",
   })
-  server.listen(8080)
-  server.unref()
+  response.end(html)
+})
+server.listen(8080)
+server.unref()
 
-  const lighthouseReport = await getLighthouseReportUsingHeadlessChrome("http://127.0.0.1:8080")
-  return lighthouseReport
-}
+export const lighthouseReport = await generateLighthouseReport(
+  "http://127.0.0.1:8080",
+)
 ```
 
 _index.html_
@@ -78,9 +69,9 @@ _index.html_
 </html>
 ```
 
-At this stage, you could generate a lighthouse report on your machine. For an example, see `"generate-lighthouse-report"` in [package.json#L42](./package.json#L42) and [script/lighthouse/generate_lighthouse_report.mjs#L32](./script/lighthouse/generate_lighthouse_report.mjs#L32).
+At this stage, you could generate a lighthouse report on your machine. For an example, see [package.json#L36](./package.json#L36) and [script/lighthouse/generate_lighthouse_report.mjs#L37](./script/lighthouse/generate_lighthouse_report.mjs#L37).
 
-All that's left is to configure a workflow to compare lighthouse reports before and after merging a pull request.
+Now it's time to configure a workflow to compare lighthouse reports before and after merging a pull request.
 
 ## GitHub workflow
 
@@ -127,25 +118,28 @@ _report_lighthouse_impact.mjs_
  * See https://github.com/jsenv/lighthouse-impact#how-it-works
  */
 
-import { reportLighthouseImpact, readGitHubWorkflowEnv } from "@jsenv/lighthouse-impact"
+import {
+  reportLighthouseImpact,
+  readGitHubWorkflowEnv,
+} from "@jsenv/lighthouse-impact"
 
 reportLighthouseImpact({
   ...readGitHubWorkflowEnv(),
-  generateLighthouseReportFileRelativeUrl: "./generate_lighthouse_report.mjs",
+  lighthouseReportPath: "./generate_lighthouse_report.mjs#lighthouseReport",
 })
 ```
 
-## Other worklow
+## Other tools
 
-For a workflow different from GitHub workflow, there is a few things to do:
+If you want to use an other tool than GitHub worflow to run the pull request comparison, like Jenkins, there is a few things to do:
 
 1. Replicate _lighthouse_impact.yml_
 2. Adjust _report_lighthouse_impact.mjs_
-3. Create a GitHub token
+3. Create a GitHub token (required to post comment on GitHub)
 
 ### 1. Replicate _lighthouse_impact.yml_
 
-Your workflow must reproduce the state where your git repository has been cloned and you are currently on the pull request branch. The corresponding commands looks as below:
+Your script must reproduce the state where your git repository has been cloned and you are currently on the pull request branch. Something like the commands below.
 
 ```console
 git init
@@ -158,7 +152,9 @@ node ./report_lighthouse_impact.mjs
 
 ### 2. Adjust _report_lighthouse_impact.mjs_
 
-When outside a GitHub workflow, you cannot use _readGitHubWorkflowEnv()_. It means you must pass several parameters to _reportLighthouseImpact_. The example below assume code is executed by Travis.
+When outside a GitHub workflow, you cannot use _readGitHubWorkflowEnv()_.
+It means you must pass several parameters to _reportLighthouseImpact_.
+The example below assume code is executed by Travis.
 
 ```diff
 - import { reportLighthouseImpact, readGitHubWorkflowEnv } from "@jsenv/lighthouse-impact"
@@ -171,14 +167,15 @@ reportLighthouseImpact({
 +  repositoryName: process.env.TRAVIS_REPO_SLUG.split("/")[1],
 +  pullRequestNumber: process.env.TRAVIS_PULL_REQUEST,
 +  githubToken: process.env.GITHUB_TOKEN, // see next step
-
-  generateLighthouseReportFileRelativeUrl: "./generate_lighthouse_report.mjs",
+   lighthouseReportPath: "./generate_lighthouse_report.mjs#lighthouseReport",
 })
 ```
 
 ### 3. Create a GitHub token
 
-The GitHub token is required to be able to post a commment in the pull request. You need to create a GitHub token with `repo` scope at https://github.com/settings/tokens/new. Finally you need to setup this environment variable. The exact way to do this is specific to the tools your are using.
+The GitHub token is required to be able to post a commment in the pull request.
+You need to create a GitHub token with `repo` scope at https://github.com/settings/tokens/new.
+Finally you need to setup this environment variable. The exact way to do this is specific to the tools your are using.
 
 # Lighthouse report viewer
 
@@ -186,7 +183,10 @@ The pull request comment can contain links to see lighthouse reports in [Lightho
 
 ![screenshot of pull request comment with links highlighted](./docs/comment-links-highlighted.png)
 
-To unlock this you need a GitHub token with the right to create gists. Every github workflow has access to a magic token `secrets.GITHUB_TOKEN`. But this token is not allowed to create gists. We need to update the worflow file like [lighthouse-score-impact.yml#L21](./.github/workflows/lighthouse_impact.yml#L21) to use an other token that will have the rights to create gists.
+To unlock this you need a GitHub token with the right to create gists.
+Every github workflow has access to a magic token `secrets.GITHUB_TOKEN`.
+But this token is not allowed to create gists.
+We need to update the worflow file like [lighthouse-score-impact.yml#L21](./.github/workflows/lighthouse_impact.yml#L21) to use an other token that will have the rights to create gists.
 
 ```diff
 - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/main.js

@@ -1,4 +1,4 @@
-export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
+export { generateLighthouseReport } from "./src/generateLighthouseReport.js"
 
-export { getLighthouseReportUsingHeadlessChrome } from "./src/getLighthouseReportUsingHeadlessChrome.js"
+export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
 export { reportLighthouseImpact } from "./src/reportLighthouseImpact.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/lighthouse-impact",
-  "version": "1.1.1",
+  "version": "2.1.0",
   "description": "Package description",
   "license": "MIT",
   "author": {
@@ -16,8 +16,7 @@
     "node": ">=14.17.0"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "type": "module",
   "exports": {
@@ -31,43 +30,45 @@
     "/main.js"
   ],
   "scripts": {
-    "eslint-check": "node ./node_modules/eslint/bin/eslint.js .",
-    "test": "node ./script/test/test.js",
-    "generate-importmap": "node ./script/generate-importmap/generate-importmap.js",
-    "generate-comment-snapshot-file": "node --experimental-top-level-await ./test/comment/generate_comment_snapshot_file.js",
+    "eslint-check": "node ./node_modules/eslint/bin/eslint.js . --ext=.js,.mjs",
+    "generate-importmap": "node ./script/importmap/generate_importmap.mjs",
+    "measure-performances": "node --expose-gc ./script/performance/generate_performance_report.mjs --log",
+    "generate-lighthouse-report": "node ./script/lighthouse/generate_lighthouse_report.mjs --local",
+    "generate-comment-snapshot-file": "node ./test/comment/generate_comment_snapshot_file.mjs",
+    "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
-    "prettier-format": "node ./script/prettier/prettier_format.js",
+    "prettier-format": "node ./script/prettier/prettier_format.mjs",
     "prettier-format-stage": "npm run prettier-format -- --staged",
     "prettier-check": "npm run prettier-format -- --dry-run",
-    "log-performance-report": "node .github/workflows/performance_impact/generate_performance_report.js --log",
-    "n": "node ./script/lighthouse/generate_lighthouse_report.mjs --local",
-    "upload-coverage": "node ./script/upload-coverage/upload-coverage.js",
-    "prepublishOnly": "node ./script/transform-package/remove-postinstall.js",
-    "postpublish": "node ./script/transform-package/restore-postinstall.js"
+    "prepublishOnly": "node ./script/publish/remove_postinstall.mjs",
+    "postpublish": "node ./script/publish/restore_postinstall.mjs"
   },
   "dependencies": {
     "@jsenv/cancellation": "3.0.0",
+    "@jsenv/dynamic-import-worker": "1.0.0",
+    "@jsenv/filesystem": "2.3.1",
     "@jsenv/github-pull-request-impact": "1.6.4",
     "@jsenv/logger": "4.0.1",
-    "@jsenv/util": "4.1.1",
     "chrome-launcher": "0.14.0",
     "lighthouse": "8.2.0"
   },
   "devDependencies": {
-    "@jsenv/assert": "2.2.6",
+    "@babel/core": "7.15.8",
+    "@babel/eslint-parser": "7.15.8",
+    "@jsenv/assert": "2.3.2",
     "@jsenv/codecov-upload": "3.5.0",
-    "@jsenv/core": "19.6.2",
-    "@jsenv/eslint-config": "15.0.2",
+    "@jsenv/core": "23.0.5",
+    "@jsenv/eslint-config": "16.0.8",
     "@jsenv/github-release-package": "1.2.3",
-    "@jsenv/importmap-eslint-resolver": "5.1.0",
-    "@jsenv/importmap-node-module": "1.0.1",
+    "@jsenv/importmap-eslint-resolver": "5.1.2",
+    "@jsenv/importmap-node-module": "2.4.1",
     "@jsenv/package-publish": "1.6.2",
-    "@jsenv/performance-impact": "1.6.2",
+    "@jsenv/performance-impact": "2.0.2",
     "@jsenv/prettier-check-project": "5.6.1",
-    "@jsenv/server": "6.1.1",
+    "@jsenv/server": "7.2.0",
     "eslint": "7.32.0",
-    "eslint-plugin-html": "6.1.2",
-    "eslint-plugin-import": "2.24.0",
-    "prettier": "2.3.2"
+    "eslint-plugin-html": "6.2.0",
+    "eslint-plugin-import": "2.25.2",
+    "prettier": "2.4.1"
   }
 }

package/src/{getLighthouseReportUsingHeadlessChrome.js → generateLighthouseReport.js}

@@ -10,23 +10,22 @@ import {
   createOperation,
   executeAsyncFunction,
 } from "@jsenv/cancellation"
-import { writeFile, resolveUrl } from "@jsenv/util"
+import {
+  writeFile,
+  resolveUrl,
+  assertAndNormalizeDirectoryUrl,
+} from "@jsenv/filesystem"
 
-const require = createRequire(import.meta.url)
+import { formatLighthouseReportForLog } from "./internal/formatLighthouseReportForLog.js"
 
-const lighthouse = require("lighthouse")
-// eslint-disable-next-line import/no-unresolved
-const ReportGenerator = require("lighthouse/report/report-generator")
-const { computeMedianRun } = require("lighthouse/lighthouse-core/lib/median-run.js")
-const chromeLauncher = require("chrome-launcher")
+const require = createRequire(import.meta.url)
 
-export const getLighthouseReportUsingHeadlessChrome = async (
+export const generateLighthouseReport = async (
   url,
   {
     cancellationToken = createCancellationToken(),
     cancelOnSIGINT = true,
     logLevel,
-    projectDirectoryUrl,
 
     headless = true,
     gpu = false,
@@ -38,20 +37,32 @@ export const getLighthouseReportUsingHeadlessChrome = async (
     runCount = 1,
     delayBetweenEachRunInSeconds = 1,
 
-    jsonFile = Boolean(projectDirectoryUrl),
+    projectDirectoryUrl, // required only when jsonFile or htmlFile is passed
+    log = false,
+    jsonFile = false,
     jsonFileRelativeUrl = "./lighthouse/lighthouse_report.json",
     jsonFileLog = true,
-    htmlFile = Boolean(projectDirectoryUrl),
+    htmlFile = false,
     htmlFileRelativeUrl = "./lighthouse/lighthouse_report.html",
     htmlFileLog = true,
   } = {},
 ) => {
+  // eslint-disable-next-line import/no-unresolved
+  const ReportGenerator = require("lighthouse/report/report-generator")
+  const {
+    computeMedianRun,
+  } = require("lighthouse/lighthouse-core/lib/median-run.js")
+  const chromeLauncher = require("chrome-launcher")
+
   let cleanup = () => {}
 
   if (cancelOnSIGINT) {
     const processCancellationSource = createCancellationSource()
     const processCancellationToken = processCancellationSource.token
-    cancellationToken = composeCancellationToken(cancellationToken, processCancellationToken)
+    cancellationToken = composeCancellationToken(
+      cancellationToken,
+      processCancellationToken,
+    )
     const SIGINTCallback = () => {
       processCancellationSource.cancel("process SIGINT")
     }
@@ -90,7 +101,9 @@ export const getLighthouseReportUsingHeadlessChrome = async (
       .reduce(async (previous, _, index) => {
         await previous
         if (index > 0 && delayBetweenEachRunInSeconds) {
-          await new Promise((resolve) => setTimeout(resolve, delayBetweenEachRunInSeconds * 1000))
+          await new Promise((resolve) =>
+            setTimeout(resolve, delayBetweenEachRunInSeconds * 1000),
+          )
         }
         const report = await generateOneLighthouseReport(url, {
           cancellationToken,
@@ -101,13 +114,25 @@ export const getLighthouseReportUsingHeadlessChrome = async (
       }, Promise.resolve())
 
     const lighthouseReport = computeMedianRun(reports)
+
+    if (log) {
+      logger.info(formatLighthouseReportForLog(lighthouseReport))
+    }
+
     await chrome.kill()
 
+    if (jsonFile || htmlFile) {
+      projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+    }
+
     const promises = []
     if (jsonFile) {
       promises.push(
         (async () => {
-          const jsonFileUrl = resolveUrl(jsonFileRelativeUrl, projectDirectoryUrl)
+          const jsonFileUrl = resolveUrl(
+            jsonFileRelativeUrl,
+            projectDirectoryUrl,
+          )
           const json = JSON.stringify(lighthouseReport, null, "  ")
           await writeFile(jsonFileUrl, json)
           if (jsonFileLog) {
@@ -119,7 +144,10 @@ export const getLighthouseReportUsingHeadlessChrome = async (
     if (htmlFile) {
       promises.push(
         (async () => {
-          const htmlFileUrl = resolveUrl(htmlFileRelativeUrl, projectDirectoryUrl)
+          const htmlFileUrl = resolveUrl(
+            htmlFileRelativeUrl,
+            projectDirectoryUrl,
+          )
           const html = ReportGenerator.generateReportHtml(lighthouseReport)
           await writeFile(htmlFileUrl, html)
           if (htmlFileLog) {
@@ -152,6 +180,7 @@ const generateOneLighthouseReport = async (
   url,
   { cancellationToken, lighthouseOptions, config },
 ) => {
+  const lighthouse = require("lighthouse")
   const results = await createOperation({
     cancellationToken,
     start: () => lighthouse(url, lighthouseOptions, config),

package/src/internal/createLighthouseImpactComment.js

@@ -38,8 +38,12 @@ export const createLighthouseImpactComment = ({
   }
 
   const bodyLines = [
-    ...(beforeMergeGist ? [`<!-- before_merge_gist_id=${beforeMergeGist.id} -->`] : []),
-    ...(afterMergeGist ? [`<!-- after_merge_gist_id=${afterMergeGist.id} -->`] : []),
+    ...(beforeMergeGist
+      ? [`<!-- before_merge_gist_id=${beforeMergeGist.id} -->`]
+      : []),
+    ...(afterMergeGist
+      ? [`<!-- after_merge_gist_id=${afterMergeGist.id} -->`]
+      : []),
     `<h4>Lighthouse impact</h4>`,
     ...(impactAnalysisEnabled
       ? [
@@ -76,19 +80,24 @@ const renderBody = ({
   pullRequestBase,
   pullRequestHead,
 }) => {
-  return Object.keys(afterMergeLighthouseReport.categories).map((categoryName) => {
-    return renderCategory(categoryName, {
-      beforeMergeLighthouseReport,
-      afterMergeLighthouseReport,
-      pullRequestBase,
-      pullRequestHead,
-    })
-  }).join(`
+  return Object.keys(afterMergeLighthouseReport.categories).map(
+    (categoryName) => {
+      return renderCategory(categoryName, {
+        beforeMergeLighthouseReport,
+        afterMergeLighthouseReport,
+        pullRequestBase,
+        pullRequestHead,
+      })
+    },
+  ).join(`
 
 `)
 }
 
-const renderCategory = (category, { beforeMergeLighthouseReport, afterMergeLighthouseReport }) => {
+const renderCategory = (
+  category,
+  { beforeMergeLighthouseReport, afterMergeLighthouseReport },
+) => {
   const beforeMergeDisplayedScore = scoreToDisplayedScore(
     beforeMergeLighthouseReport.categories[category].score,
   )
@@ -114,7 +123,8 @@ const renderCategory = (category, { beforeMergeLighthouseReport, afterMergeLight
 </details>`
 }
 
-const scoreToDisplayedScore = (floatingNumber) => Math.round(floatingNumber * 100)
+const scoreToDisplayedScore = (floatingNumber) =>
+  Math.round(floatingNumber * 100)
 
 const renderCategoryAudits = (
   category,
@@ -156,7 +166,10 @@ const renderCategoryAudits = (
       return
     }
 
-    if (typeof beforeMergeAuditOutput === "number" && typeof afterMergeAuditOutput === "number") {
+    if (
+      typeof beforeMergeAuditOutput === "number" &&
+      typeof afterMergeAuditOutput === "number"
+    ) {
       const diff = afterMergeAuditOutput - beforeMergeAuditOutput
 
       audits.push([
@@ -170,7 +183,9 @@ const renderCategoryAudits = (
 
     audits.push([
       `<td nowrap>${auditId}</td>`,
-      `<td nowrap>${beforeMergeAuditOutput === afterMergeAuditOutput ? "none" : "---"}</td>`,
+      `<td nowrap>${
+        beforeMergeAuditOutput === afterMergeAuditOutput ? "none" : "---"
+      }</td>`,
       `<td nowrap>${beforeMergeAuditOutput}</td>`,
       `<td nowrap>${afterMergeAuditOutput}</td>`,
     ])
@@ -237,7 +252,11 @@ const renderAudit = (audit) => {
   return null
 }
 
-const renderGistLinks = ({ beforeMergeGist, afterMergeGist, pullRequestBase }) => {
+const renderGistLinks = ({
+  beforeMergeGist,
+  afterMergeGist,
+  pullRequestBase,
+}) => {
   return `<sub>
   Impact analyzed comparing <a href="${gistIdToReportUrl(
     beforeMergeGist.id,

package/src/internal/formatLighthouseReportForLog.js

@@ -0,0 +1,7 @@
+export const formatLighthouseReportForLog = (lighthouseReport) => {
+  const scores = {}
+  Object.keys(lighthouseReport.categories).forEach((name) => {
+    scores[name] = lighthouseReport.categories[name].score
+  })
+  return JSON.stringify(scores, null, "  ")
+}

package/src/internal/patchOrPostGists.js

@@ -1,6 +1,10 @@
 /* eslint-disable new-cap */
 import { createDetailedMessage } from "@jsenv/logger"
-import { GET, POST, PATCH } from "@jsenv/github-pull-request-impact/src/internal/git_hub_api.js"
+import {
+  GET,
+  POST,
+  PATCH,
+} from "@jsenv/github-pull-request-impact/src/internal/git_hub_api.js"
 
 // https://developer.github.com/v3/gists/#create-a-gist
 
@@ -27,8 +31,10 @@ export const patchOrPostGists = async ({
       afterMergeGistId = gistIds.afterMergeGistId
       logger.debug(
         createDetailedMessage(`gists found in comment body`, {
-          "before merging gist with lighthouse report": gistIdToUrl(beforeMergeGistId),
-          "after merging gist with lighthouse report": gistIdToUrl(afterMergeGistId),
+          "before merging gist with lighthouse report":
+            gistIdToUrl(beforeMergeGistId),
+          "after merging gist with lighthouse report":
+            gistIdToUrl(afterMergeGistId),
         }),
       )
     } else {
@@ -39,10 +45,16 @@ export const patchOrPostGists = async ({
   logger.debug(`update or create both gists.`)
   let [beforeMergeGist, afterMergeGist] = await Promise.all([
     beforeMergeGistId
-      ? GET(`https://api.github.com/gists/${beforeMergeGistId}`, { cancellationToken, githubToken })
+      ? GET(`https://api.github.com/gists/${beforeMergeGistId}`, {
+          cancellationToken,
+          githubToken,
+        })
       : null,
     afterMergeGistId
-      ? GET(`https://api.github.com/gists/${afterMergeGistId}`, { cancellationToken, githubToken })
+      ? GET(`https://api.github.com/gists/${afterMergeGistId}`, {
+          cancellationToken,
+          githubToken,
+        })
       : null,
   ])
 
@@ -65,10 +77,14 @@ export const patchOrPostGists = async ({
     logger.info(`base gist updated`)
   } else {
     logger.info(`creating base gist`)
-    beforeMergeGist = await POST(`https://api.github.com/gists`, beforeMergeGistBody, {
-      cancellationToken,
-      githubToken,
-    })
+    beforeMergeGist = await POST(
+      `https://api.github.com/gists`,
+      beforeMergeGistBody,
+      {
+        cancellationToken,
+        githubToken,
+      },
+    )
     logger.info(`base gist created at ${gistIdToUrl(beforeMergeGist.id)}`)
   }
 
@@ -79,7 +95,9 @@ export const patchOrPostGists = async ({
     beforeMerge: false,
   })
   if (afterMergeGist) {
-    logger.info(`updating after merge gist at ${gistIdToUrl(afterMergeGist.id)}`)
+    logger.info(
+      `updating after merge gist at ${gistIdToUrl(afterMergeGist.id)}`,
+    )
     afterMergeGist = await PATCH(
       `https://api.github.com/gists/${afterMergeGist.id}`,
       afterMergeGistBody,
@@ -91,10 +109,14 @@ export const patchOrPostGists = async ({
     logger.info(`after merge gist updated`)
   } else {
     logger.info(`creating after merge gist`)
-    afterMergeGist = await POST(`https://api.github.com/gists`, afterMergeGistBody, {
-      cancellationToken,
-      githubToken,
-    })
+    afterMergeGist = await POST(
+      `https://api.github.com/gists`,
+      afterMergeGistBody,
+      {
+        cancellationToken,
+        githubToken,
+      },
+    )
     logger.info(`after merge gist created at ${gistIdToUrl(afterMergeGist.id)}`)
   }
 
@@ -120,8 +142,12 @@ const createGistBody = (
   }
 }
 
-const beforeMergeGistIdRegex = new RegExp("<!-- before_merge_gist_id=([a-zA-Z0-9_]+) -->")
-const afterMergeGistIdRegex = new RegExp("<!-- after_merge_gist_id=([a-zA-Z0-9_]+) -->")
+const beforeMergeGistIdRegex = new RegExp(
+  "<!-- before_merge_gist_id=([a-zA-Z0-9_]+) -->",
+)
+const afterMergeGistIdRegex = new RegExp(
+  "<!-- after_merge_gist_id=([a-zA-Z0-9_]+) -->",
+)
 
 const gistIdsFromComment = (comment) => {
   const beforeMergeGistIdMatch = comment.body.match(beforeMergeGistIdRegex)

package/src/reportLighthouseImpact.js

@@ -1,5 +1,6 @@
 import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
-import { assertAndNormalizeDirectoryUrl, resolveUrl, readFileSystemNodeStat } from "@jsenv/util"
+import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
+import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
 import { patchOrPostGists } from "./internal/patchOrPostGists.js"
 import { createLighthouseImpactComment } from "./internal/createLighthouseImpactComment.js"
@@ -16,7 +17,7 @@ export const reportLighthouseImpact = async ({
   repositoryName,
   pullRequestNumber,
   installCommand = "npm install",
-  moduleGeneratinLighthouseReportRelativeUrl, // rename this
+  lighthouseReportPath,
 
   runLink,
   commitInGeneratedByInfo,
@@ -24,14 +25,14 @@ export const reportLighthouseImpact = async ({
   skipGistWarning = false,
 }) => {
   projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-  if (typeof moduleGeneratinLighthouseReportRelativeUrl !== "string") {
+  if (typeof lighthouseReportPath !== "string") {
     throw new TypeError(
-      `moduleGeneratinLighthouseReportRelativeUrl must be a string but received ${moduleGeneratinLighthouseReportRelativeUrl}`,
+      `lighthouseReportPath must be a string but received ${lighthouseReportPath}`,
     )
   }
   projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-  const moduleGeneratingLighthouseReportUrl = resolveUrl(
-    moduleGeneratinLighthouseReportRelativeUrl,
+  const lighthouseReportUrl = resolveUrl(
+    lighthouseReportPath,
     projectDirectoryUrl,
   )
 
@@ -51,19 +52,9 @@ export const reportLighthouseImpact = async ({
 
     collectInfo: async ({ execCommandInProjectDirectory }) => {
       await execCommandInProjectDirectory(installCommand)
-      await assertGenerateLighthouseReportFileExists(moduleGeneratingLighthouseReportUrl)
-
-      const { generateLighthouseReport } = await import(
-        `${moduleGeneratingLighthouseReportUrl}?cache_busting=${Date.now()}`
+      const lighthouseReport = await importOneExportFromFile(
+        lighthouseReportUrl,
       )
-      if (typeof generateLighthouseReport !== "function") {
-        throw new TypeError(
-          `generateLighthouseReport export must be a function, got ${generateLighthouseReport}`,
-        )
-      }
-
-      const lighthouseReport = await generateLighthouseReport()
-
       return { version: 1, data: lighthouseReport }
     },
     commentIdentifier: `<!-- Generated by @jsenv/lighthouse-impact -->`,
@@ -132,15 +123,3 @@ export const reportLighthouseImpact = async ({
     catchError,
   })
 }
-
-const assertGenerateLighthouseReportFileExists = async (fileUrl) => {
-  const fileStat = await readFileSystemNodeStat(fileUrl, {
-    nullIfNotFound: true,
-  })
-
-  if (!fileStat) {
-    throw new Error(
-      `Cannot find the file responsible to export generateLighthouseReport at ${fileUrl}`,
-    )
-  }
-}