@jsenv/lighthouse-impact 2.0.0 → 2.1.3

package/README.md

@@ -1,12 +1,4 @@
-# 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)
 
 `@jsenv/lighthouse-impact` analyses a pull request impact on lighthouse score. This analysis is posted in a comment of the pull request on GitHub.
 
@@ -32,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
 /*
@@ -77,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.
 
@@ -107,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
@@ -131,9 +123,9 @@ import {
   readGitHubWorkflowEnv,
 } from "@jsenv/lighthouse-impact"
 
-reportLighthouseImpact({
+await reportLighthouseImpact({
   ...readGitHubWorkflowEnv(),
-  lighthouseReportPath: "./generate_lighthouse_report.mjs#lighthouseReport",
+  lighthouseReportPath: "./lighthouse.mjs#lighthouseReport",
 })
 ```
 
@@ -175,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/main.js

@@ -1,5 +1,4 @@
 export { generateLighthouseReport } from "./src/generateLighthouseReport.js"
-export { logLighthouseReport } from "./src/logLighthouseReport.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": "2.0.0",
+  "version": "2.1.3",
   "description": "Package description",
   "license": "MIT",
   "author": {
@@ -10,10 +10,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/jsenv/lighthouse-impact"
+    "url": "https://github.com/jsenv/workflow",
+    "directory": "packages/jsenv-lighthouse-impact"
   },
   "engines": {
-    "node": ">=14.17.0"
+    "node": ">=16.13.0"
   },
   "publishConfig": {
     "access": "public",
@@ -26,50 +27,36 @@
     },
     "./*": "./*"
   },
+  "main": "./main.js",
   "files": [
     "/src/",
     "/main.js"
   ],
   "scripts": {
-    "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",
+    "eslint": "npx eslint . --ext=.js,.mjs",
+    "importmap": "node ./script/importmap/importmap.mjs",
+    "snapshot": "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.mjs",
-    "prettier-format-stage": "npm run prettier-format -- --staged",
-    "prettier-check": "npm run prettier-format -- --dry-run",
-    "prepublishOnly": "node ./script/publish/remove_postinstall.mjs",
-    "postpublish": "node ./script/publish/restore_postinstall.mjs"
+    "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/github-pull-request-impact": "1.6.4",
+    "@jsenv/filesystem": "2.7.1",
+    "@jsenv/github-pull-request-impact": "1.6.6",
     "@jsenv/logger": "4.0.1",
-    "chrome-launcher": "0.14.0",
-    "lighthouse": "8.2.0"
+    "chrome-launcher": "0.15.0",
+    "lighthouse": "9.2.0"
   },
   "devDependencies": {
-    "@babel/core": "7.15.8",
-    "@babel/eslint-parser": "7.15.8",
-    "@jsenv/assert": "2.3.2",
-    "@jsenv/codecov-upload": "3.5.0",
-    "@jsenv/core": "23.0.5",
-    "@jsenv/eslint-config": "16.0.8",
-    "@jsenv/github-release-package": "1.2.3",
-    "@jsenv/importmap-eslint-resolver": "5.1.2",
-    "@jsenv/importmap-node-module": "2.4.1",
-    "@jsenv/package-publish": "1.6.2",
-    "@jsenv/performance-impact": "2.0.2",
-    "@jsenv/prettier-check-project": "5.6.1",
-    "@jsenv/server": "7.2.0",
-    "eslint": "7.32.0",
-    "eslint-plugin-html": "6.2.0",
-    "eslint-plugin-import": "2.25.2",
-    "prettier": "2.4.1"
+    "@jsenv/assert": "2.4.1",
+    "@jsenv/core": "25.3.0",
+    "@jsenv/eslint-config": "16.0.9",
+    "@jsenv/importmap-eslint-resolver": "5.2.5",
+    "@jsenv/importmap-node-module": "5.1.3",
+    "eslint": "8.7.0",
+    "eslint-plugin-import": "2.25.4",
+    "prettier": "2.5.1"
   }
 }

package/src/generateLighthouseReport.js

@@ -2,27 +2,23 @@
 
 import { createRequire } from "node:module"
 
-import { createLogger } from "@jsenv/logger"
-import {
-  createCancellationToken,
-  createCancellationSource,
-  composeCancellationToken,
-  createOperation,
-  executeAsyncFunction,
-} from "@jsenv/cancellation"
 import {
   writeFile,
   resolveUrl,
   assertAndNormalizeDirectoryUrl,
 } from "@jsenv/filesystem"
+import { createLogger } from "@jsenv/logger"
+import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
+
+import { formatLighthouseReportForLog } from "./internal/formatLighthouseReportForLog.js"
 
 const require = createRequire(import.meta.url)
 
 export const generateLighthouseReport = async (
   url,
   {
-    cancellationToken = createCancellationToken(),
-    cancelOnSIGINT = true,
+    signal = new AbortController().signal,
+    handleSIGINT = true,
     logLevel,
 
     headless = true,
@@ -36,6 +32,7 @@ export const generateLighthouseReport = async (
     delayBetweenEachRunInSeconds = 1,
 
     projectDirectoryUrl, // required only when jsonFile or htmlFile is passed
+    log = false,
     jsonFile = false,
     jsonFileRelativeUrl = "./lighthouse/lighthouse_report.json",
     jsonFileLog = true,
@@ -44,31 +41,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 () => {
@@ -83,34 +72,49 @@ 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)
+
+    if (log) {
+      logger.info(formatLighthouseReportForLog(lighthouseReport))
+    }
+
     await chrome.kill()
 
     if (jsonFile || htmlFile) {
@@ -153,30 +157,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/{logLighthouseReport.js → internal/formatLighthouseReportForLog.js}

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

package/src/internal/patchOrPostGists.js

@@ -1,15 +1,9 @@
-/* eslint-disable new-cap */
+import * as githubRESTAPI from "@jsenv/github-pull-request-impact/src/internal/github_rest_api.js"
 import { createDetailedMessage } from "@jsenv/logger"
-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
 
 export const patchOrPostGists = async ({
-  cancellationToken,
   logger,
 
   githubToken,
@@ -45,14 +39,14 @@ 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,
+      ? githubRESTAPI.GET({
+          url: `https://api.github.com/gists/${beforeMergeGistId}`,
           githubToken,
         })
       : null,
     afterMergeGistId
-      ? GET(`https://api.github.com/gists/${afterMergeGistId}`, {
-          cancellationToken,
+      ? githubRESTAPI.GET({
+          url: `https://api.github.com/gists/${afterMergeGistId}`,
           githubToken,
         })
       : null,
@@ -66,25 +60,19 @@ export const patchOrPostGists = async ({
   })
   if (beforeMergeGist) {
     logger.info(`updating base gist at ${gistIdToUrl(beforeMergeGist.id)}`)
-    beforeMergeGist = await PATCH(
-      `https://api.github.com/gists/${beforeMergeGist.id}`,
-      beforeMergeGistBody,
-      {
-        cancellationToken,
-        githubToken,
-      },
-    )
+    beforeMergeGist = await githubRESTAPI.PATCH({
+      url: `https://api.github.com/gists/${beforeMergeGist.id}`,
+      githubToken,
+      body: beforeMergeGistBody,
+    })
     logger.info(`base gist updated`)
   } else {
     logger.info(`creating base gist`)
-    beforeMergeGist = await POST(
-      `https://api.github.com/gists`,
-      beforeMergeGistBody,
-      {
-        cancellationToken,
-        githubToken,
-      },
-    )
+    beforeMergeGist = await githubRESTAPI.POST({
+      url: `https://api.github.com/gists`,
+      githubToken,
+      body: beforeMergeGistBody,
+    })
     logger.info(`base gist created at ${gistIdToUrl(beforeMergeGist.id)}`)
   }
 
@@ -98,25 +86,19 @@ export const patchOrPostGists = async ({
     logger.info(
       `updating after merge gist at ${gistIdToUrl(afterMergeGist.id)}`,
     )
-    afterMergeGist = await PATCH(
-      `https://api.github.com/gists/${afterMergeGist.id}`,
-      afterMergeGistBody,
-      {
-        cancellationToken,
-        githubToken,
-      },
-    )
+    afterMergeGist = await githubRESTAPI.PATCH({
+      url: `https://api.github.com/gists/${afterMergeGist.id}`,
+      githubToken,
+      body: afterMergeGistBody,
+    })
     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 githubRESTAPI.POST({
+      url: `https://api.github.com/gists`,
+      githubToken,
+      body: afterMergeGistBody,
+    })
     logger.info(`after merge gist created at ${gistIdToUrl(afterMergeGist.id)}`)
   }
 

package/src/reportLighthouseImpact.js

@@ -1,5 +1,5 @@
-import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
+import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
 import { patchOrPostGists } from "./internal/patchOrPostGists.js"
@@ -8,7 +8,6 @@ import { createLighthouseImpactComment } from "./internal/createLighthouseImpact
 export const reportLighthouseImpact = async ({
   logLevel,
   commandLogs = false,
-  cancellationToken,
   cancelOnSIGINT,
   projectDirectoryUrl,
 
@@ -41,7 +40,6 @@ export const reportLighthouseImpact = async ({
     commandLogs,
     // lighthouse report are super verbose, do not log them
     infoLogs: false,
-    cancellationToken,
     cancelOnSIGINT,
     projectDirectoryUrl,
 
@@ -59,7 +57,6 @@ export const reportLighthouseImpact = async ({
     },
     commentIdentifier: `<!-- Generated by @jsenv/lighthouse-impact -->`,
     createCommentForComparison: async ({
-      cancellationToken,
       logger,
 
       pullRequestBase,
@@ -74,7 +71,6 @@ export const reportLighthouseImpact = async ({
       let afterMergeGist
       try {
         const gistResult = await patchOrPostGists({
-          cancellationToken,
           logger,
 
           githubToken,