@jsenv/lighthouse-impact 2.1.1 → 2.1.2

package/README.md

@@ -24,7 +24,7 @@ The first thing you need is a script capable to generate a lighthouse report.
 npm install --save-dev @jsenv/lighthouse-impact
 ```
 
-_generate_lighthouse_report.mjs_
+_lighthouse.mjs_
 
 ```js
 /*
@@ -69,7 +69,7 @@ _index.html_
 </html>
 ```
 
-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).
+At this stage, you could generate a lighthouse report on your machine. For an example, see [package.json#L37](./package.json#L37) and [script/lighthouse/lighthouse.mjs#L19](./script/lighthouse/lighthouse.mjs#L19).
 
 Now it's time to configure a workflow to compare lighthouse reports before and after merging a pull request.
 
@@ -99,10 +99,10 @@ jobs:
       - name: Setup git
         uses: actions/checkout@v2
       - name: Setup node
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
-          node-version: "16.x"
-      - name: Setup npm
+          node-version: "16.13.0"
+      - name: Install node modules
         run: npm install
       - name: Report lighthouse impact
         run: node ./report_lighthouse_impact.mjs
@@ -123,9 +123,9 @@ import {
   readGitHubWorkflowEnv,
 } from "@jsenv/lighthouse-impact"
 
-reportLighthouseImpact({
+await reportLighthouseImpact({
   ...readGitHubWorkflowEnv(),
-  lighthouseReportPath: "./generate_lighthouse_report.mjs#lighthouseReport",
+  lighthouseReportPath: "./lighthouse.mjs#lighthouseReport",
 })
 ```
 
@@ -167,7 +167,7 @@ reportLighthouseImpact({
 +  repositoryName: process.env.TRAVIS_REPO_SLUG.split("/")[1],
 +  pullRequestNumber: process.env.TRAVIS_PULL_REQUEST,
 +  githubToken: process.env.GITHUB_TOKEN, // see next step
-   lighthouseReportPath: "./generate_lighthouse_report.mjs#lighthouseReport",
+   lighthouseReportPath: "./lighthouse.mjs#lighthouseReport",
 })
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/lighthouse-impact",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Package description",
   "license": "MIT",
   "author": {
@@ -42,13 +42,13 @@
     "prettier": "prettier --write ."
   },
   "dependencies": {
-    "@jsenv/cancellation": "3.0.0",
+    "@jsenv/abort": "4.1.2",
     "@jsenv/dynamic-import-worker": "1.0.0",
-    "@jsenv/filesystem": "2.3.1",
+    "@jsenv/filesystem": "2.5.1",
     "@jsenv/github-pull-request-impact": "1.6.4",
     "@jsenv/logger": "4.0.1",
-    "chrome-launcher": "0.14.0",
-    "lighthouse": "8.2.0"
+    "chrome-launcher": "0.15.0",
+    "lighthouse": "9.1.0"
   },
   "devDependencies": {
     "@jsenv/assert": "2.4.0",
@@ -61,8 +61,8 @@
     "@jsenv/performance-impact": "2.2.1",
     "@jsenv/server": "12.2.0",
     "eslint": "8.4.1",
-    "eslint-plugin-import": "2.25.3",
     "eslint-plugin-html": "6.2.0",
+    "eslint-plugin-import": "2.25.3",
     "prettier": "2.5.1"
   }
 }

package/src/generateLighthouseReport.js

@@ -3,13 +3,8 @@
 import { createRequire } from "node:module"
 
 import { createLogger } from "@jsenv/logger"
-import {
-  createCancellationToken,
-  createCancellationSource,
-  composeCancellationToken,
-  createOperation,
-  executeAsyncFunction,
-} from "@jsenv/cancellation"
+import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
+
 import {
   writeFile,
   resolveUrl,
@@ -23,8 +18,8 @@ const require = createRequire(import.meta.url)
 export const generateLighthouseReport = async (
   url,
   {
-    cancellationToken = createCancellationToken(),
-    cancelOnSIGINT = true,
+    signal = new AbortController().signal,
+    handleSIGINT = true,
     logLevel,
 
     headless = true,
@@ -47,31 +42,23 @@ export const generateLighthouseReport = async (
     htmlFileLog = true,
   } = {},
 ) => {
-  // eslint-disable-next-line import/no-unresolved
-  const ReportGenerator = require("lighthouse/report/report-generator")
+  const ReportGenerator = require("lighthouse/report/generator/report-generator.js")
   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,
-    )
-    const SIGINTCallback = () => {
-      processCancellationSource.cancel("process SIGINT")
-    }
-    process.once("SIGINT", SIGINTCallback)
-    // beware if someday something do things on cleanup
-    // to call the old cleanup function
-    cleanup = () => {
-      process.removeListener("SIGINT", SIGINTCallback)
-    }
+  const generateReportOperation = Abort.startOperation()
+  generateReportOperation.addAbortSignal(signal)
+  if (handleSIGINT) {
+    generateReportOperation.addAbortSource((abort) => {
+      return raceProcessTeardownEvents(
+        {
+          SIGINT: true,
+        },
+        abort,
+      )
+    })
   }
 
   const jsenvGenerateLighthouseReport = async () => {
@@ -86,32 +73,42 @@ export const generateLighthouseReport = async (
       "--disk-cache-size=1",
       // "--disk-cache-dir=/dev/null",
     ]
-    const chrome = await createOperation({
-      cancellationToken,
-      start: () => chromeLauncher.launch({ chromeFlags }),
-    })
+    const chrome = await chromeLauncher.launch({ chromeFlags })
+    if (generateReportOperation.signal.aborted) {
+      return { aborted: true }
+    }
+
     const lighthouseOptions = {
       chromeFlags,
       port: chrome.port,
     }
 
     const reports = []
-    await Array(runCount)
-      .fill()
-      .reduce(async (previous, _, index) => {
-        await previous
-        if (index > 0 && delayBetweenEachRunInSeconds) {
-          await new Promise((resolve) =>
-            setTimeout(resolve, delayBetweenEachRunInSeconds * 1000),
-          )
-        }
-        const report = await generateOneLighthouseReport(url, {
-          cancellationToken,
-          lighthouseOptions,
-          config,
-        })
-        reports.push(report)
-      }, Promise.resolve())
+    try {
+      await Array(runCount)
+        .fill()
+        .reduce(async (previous, _, index) => {
+          generateReportOperation.throwIfAborted()
+          await previous
+
+          if (index > 0 && delayBetweenEachRunInSeconds) {
+            await new Promise((resolve) =>
+              setTimeout(resolve, delayBetweenEachRunInSeconds * 1000),
+            )
+          }
+          generateReportOperation.throwIfAborted()
+          const report = await generateOneLighthouseReport(url, {
+            lighthouseOptions,
+            config,
+          })
+          reports.push(report)
+        }, Promise.resolve())
+    } catch (e) {
+      if (Abort.isAbortError(e)) {
+        return { aborted: true }
+      }
+      throw e
+    }
 
     const lighthouseReport = computeMedianRun(reports)
 
@@ -161,30 +158,19 @@ export const generateLighthouseReport = async (
     return lighthouseReport
   }
 
-  return executeAsyncFunction(
-    async () => {
-      try {
-        return await jsenvGenerateLighthouseReport()
-      } finally {
-        cleanup()
-      }
-    },
-    {
-      catchCancellation: true,
-      considerUnhandledRejectionsAsExceptions: true,
-    },
-  )
+  try {
+    return await jsenvGenerateLighthouseReport()
+  } finally {
+    await generateReportOperation.end()
+  }
 }
 
 const generateOneLighthouseReport = async (
   url,
-  { cancellationToken, lighthouseOptions, config },
+  { lighthouseOptions, config },
 ) => {
   const lighthouse = require("lighthouse")
-  const results = await createOperation({
-    cancellationToken,
-    start: () => lighthouse(url, lighthouseOptions, config),
-  })
+  const results = await lighthouse(url, lighthouseOptions, config)
 
   // use results.lhr for the JS-consumeable output
   // https://github.com/GoogleChrome/lighthouse/blob/master/types/lhr.d.ts

package/src/reportLighthouseImpact.js

@@ -8,6 +8,8 @@ import { createLighthouseImpactComment } from "./internal/createLighthouseImpact
 export const reportLighthouseImpact = async ({
   logLevel,
   commandLogs = false,
+  // TODO: update { cancellationToken, cancelOnSIGINT } in "@jsenv/github-pull-request-impact"
+  // to use { signal, handleSIGINT } instead
   cancellationToken,
   cancelOnSIGINT,
   projectDirectoryUrl,