@jsenv/file-size-impact 11.0.0 → 12.1.0

package/index.js

@@ -1,10 +1,8 @@
-export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
-
 export { jsenvTrackingConfig } from "./src/jsenvTrackingConfig.js"
 export { transform as raw } from "./src/rawTransformation.js"
 export { transform as gzip } from "./src/gzipTransformation.js"
 export { transform as brotli } from "./src/brotliTransformation.js"
+export { generateFileSizeReport } from "./src/generateFileSizeReport.js"
 
-export { getFileSizeReport } from "./src/getFileSizeReport.js"
-export { logFileSizeReport } from "./src/logFileSizeReport.js"
+export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
 export { reportFileSizeImpact } from "./src/reportFileSizeImpact.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "11.0.0",
+  "version": "12.1.0",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -11,8 +11,7 @@
     "node": ">=14.17.0"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "type": "module",
   "exports": {
@@ -28,7 +27,7 @@
   "scripts": {
     "eslint-check": "node ./node_modules/eslint/bin/eslint.js . --ext=.js,.mjs",
     "generate-importmap": "node ./script/importmap/generate_importmap.mjs",
-    "measure-file-sizes": "node ./script/file_size/generate_file_size_report.mjs --local",
+    "measure-file-sizes": "node ./script/file_size/generate_file_size_report.mjs --log",
     "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",
@@ -39,9 +38,10 @@
     "postpublish": "node ./script/publish/restore_postinstall.mjs"
   },
   "dependencies": {
+    "@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/filesystem": "2.2.0",
     "pretty-bytes": "5.6.0"
   },
   "devDependencies": {
@@ -50,7 +50,7 @@
     "@jsenv/assert": "2.3.2",
     "@jsenv/cancellation": "3.0.0",
     "@jsenv/codecov-upload": "3.5.0",
-    "@jsenv/core": "23.0.2",
+    "@jsenv/core": "23.0.5",
     "@jsenv/eslint-config": "16.0.8",
     "@jsenv/filesystem": "2.2.0",
     "@jsenv/github-release-package": "1.2.3",

package/readme.md

@@ -9,17 +9,29 @@
 
 # Pull request comment
 
-This section shows pull request comment and how to read _group summary_ and _size impact_ sections.
+This section shows pull request comment and how to read it.
 
-![legend of pull request comment](./docs/comment-legend.png)
+![legend of pull request comment](./docs/comment_legend.png)
 
-"_critical files (1/2)_" is a group summary, it translates into the following sentence:
+## group summary
 
-> "There is a group of files named **critical files** and pull request impacts **1** out of **2** files in this group."
+"_remaining files (+4.71%)_" is a group summary, it translates into the following sentence:
 
-"_127.83KB (+6.84KB / +5.65%)_" is a size impact, it translates into the following sentence:
+> "There is a group of files named **remaining files** and pull request has an overall impact of +4.71% on these files."
 
-> "The size after merge is **127.83KB** and pull request adds **6.84KB** representing an increase of **5.65%** of the size before merge."
+## size impact
+
+"_21.6 kB (+4.11 kB / +23.55%)_" is a size impact, it translates into the following sentence:
+
+> "The size after merge is **21.6 kB**. Pull request adds **4.11 kB** representing an increase of **23.55%** of the size before merge."
+
+## Unmodified row
+
+Unmodified row is the sum of all files in a group that are not impacted by changes in the pull request.
+
+## Total row
+
+Total row is the sum of all files in a group.
 
 # Installation
 
@@ -32,22 +44,25 @@ npm install --save-dev @jsenv/file-size-impact
 _generate_file_size_report.mjs_
 
 ```js
-import { getFileSizeReport } from "@jsenv/file-size-impact"
-
-export const generateFileSizeReport = async () => {
-  return getFileSizeReport({
-    projectDirectoryUrl: new URL("./", import.meta.url),
-    trackingConfig: {
-      dist: {
-        "./dist/**/*": true,
-        "./dist/**/*.map": false,
-      },
+import { generateFileSizeReport } from "@jsenv/file-size-impact"
+
+export const filesizeReport = await generateFileSizeReport({
+  log: process.argv.includes("--log"),
+  projectDirectoryUrl: new URL("./", import.meta.url),
+  trackingConfig: {
+    dist: {
+      "./dist/**/*": true,
+      "./dist/**/*.map": false,
     },
-  })
-}
+  },
+})
 ```
 
-At this stage, you could generate a file size report on your machine. For an example, see [script/file_size/generate_file_size_report.mjs#L14](./script/file_size/generate_file_size_report.mjs#L14).
+At this stage, you could generate a file size report on your machine with the following command.
+
+```console
+node ./generate_file_size_report.mjs --log
+```
 
 Now it's time to configure a workflow to compare file size reports before and after merging a pull request.
 
@@ -164,14 +179,14 @@ In order to analyse the impact of a pull request on file size the following step
 7. Analyse differences between the two file size reports
 8. Post or update comment in the pull request
 
-# getFileSizeReport
+# generateFileSizeReport
 
-_getFileSizeReport_ is an async function scanning filesystem to compute a list of file sizes and return these infos into an object.
+_generateFileSizeReport_ is an async function scanning filesystem to compute a list of file sizes and return these infos into an object.
 
 ```js
-import { getFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
+import { generateFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
 
-const fileSizeReport = await getFileSizeReport({
+const fileSizeReport = await generateFileSizeReport({
   projectDirectoryUrl: new URL("./", import.meta.url),
   trackingConfig: {
     dist: {
@@ -192,9 +207,9 @@ _trackingConfig_ values are objects associating a pattern to a value. This objec
 For example you can create two groups named _"critical files"_ and _"remaining files"_ like this:
 
 ```js
-import { getFileSizeReport } from "@jsenv/file-size-impact"
+import { generateFileSizeReport } from "@jsenv/file-size-impact"
 
-await getFileSizeReport({
+await generateFileSizeReport({
   trackingConfig: {
     "critical files": {
       "./dist/main.js": true,
@@ -210,7 +225,7 @@ await getFileSizeReport({
 })
 ```
 
-![screenshot of pull request comment where groups are highlighted](./docs/group-highlighted.png)
+![screenshot of pull request comment where groups are highlighted](./docs/comment_group_highlighted.png)
 
 ## transformations
 
@@ -219,23 +234,23 @@ _transformations_ parameter is an object used to transform files content before
 You can use this parameter to track file size after gzip compression.
 
 ```js
-import { getFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
+import { generateFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
 
-await getFileSizeReport({
+await generateFileSizeReport({
   transformations: { raw, gzip, brotli },
 })
 ```
 
-![screenshot of pull request comment with gzip and brotli](./docs/comment-compression.png)
+![screenshot of pull request comment with gzip and brotli](./docs/comment_compression.png)
 
 _raw_, _gzip_ and _brotli_ compression can be enabled this way.
 
 It's also possible to control compression level.
 
 ```js
-import { getFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
+import { generateFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
 
-await getFileSizeReport({
+await generateFileSizeReport({
   transformations: {
     raw,
     gzip7: (buffer) => gzip(buffer, { level: 7 }),
@@ -247,9 +262,9 @@ await getFileSizeReport({
 Finally _transformations_ can be used to add custom _transformations_.
 
 ```js
-import { getFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
+import { generateFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
 
-await getFileSizeReport({
+await generateFileSizeReport({
   transformations: {
     raw,
     trim: (buffer) => String(buffer).trim(),
@@ -346,7 +361,7 @@ _filesOrdering_ parameter is a string used to decide the order of the files disp
 
 _runLink_ parameter allow to put a link to the workflow run in the generated comment body. It is used to indicates where file size impact was runned.
 
-![screenshot of pull request comment where runlink is highlighted](./docs/runlink-highlighted.png)
+![screenshot of pull request comment where runlink is highlighted](./docs/comment_run_link_highlighted.png)
 
 This parameter is returned by [readGitHubWorkflowEnv](#readGitHubWorkflowEnv) meaning it comes for free inside a GitHub workflow.
 
@@ -363,6 +378,12 @@ await reportFileSizeImpact({
 })
 ```
 
+# commitInGeneratedByInfo
+
+_commitInGeneratedByInfo_ parameter is a boolean controlling if a link to the commit where size impact was performed appears in the comment. This parameter is optional and enabled by default.
+
+![screenshot of pull request comment where link to commit is highlighted](./docs/comment_commit_link_highlighted.png)
+
 # readGitHubWorkflowEnv
 
 _readGitHubWorkflowEnv_ is a function meant to be runned inside a GitHub workflow. It returns an object meant to be forwarded to [reportFileSizeImpact](#reportFileSizeImpact).

package/src/{getFileSizeReport.js → generateFileSizeReport.js}

@@ -10,9 +10,11 @@ import {
 import { transform as rawTransform } from "./rawTransformation.js"
 import { jsenvTrackingConfig } from "./jsenvTrackingConfig.js"
 import { applyTrackingConfig } from "./internal/applyTrackingConfig.js"
+import { formatFileSizeReportForLog } from "./internal/formatFileSizeReportForLog.js"
 
-export const getFileSizeReport = async ({
+export const generateFileSizeReport = async ({
   cancellationToken,
+  log,
   logLevel,
   projectDirectoryUrl,
   trackingConfig = jsenvTrackingConfig,
@@ -60,6 +62,10 @@ export const getFileSizeReport = async ({
     groups,
   }
 
+  if (log) {
+    logger.info(formatFileSizeReportForLog(fileSizeReport))
+  }
+
   return fileSizeReport
 }
 

package/src/internal/compareTwoFileSizeReports.js

@@ -1,4 +1,6 @@
-import { resolveUrl, comparePathnames, urlToRelativeUrl } from "@jsenv/filesystem"
+import { comparePathnames } from "@jsenv/filesystem"
+
+import { manifestToMappings } from "./manifest.js"
 
 export const compareTwoFileSizeReports = ({
   afterMergeFileSizeReport,
@@ -146,31 +148,6 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
   }
 }
 
-const ABSTRACT_DIRECTORY_URL = "file:///directory/"
-
-const manifestToMappings = (manifestMap) => {
-  const mappings = {}
-  Object.keys(manifestMap).forEach((manifestRelativeUrl) => {
-    const manifest = manifestMap[manifestRelativeUrl]
-    const manifestAbstractUrl = resolveUrl(manifestRelativeUrl, ABSTRACT_DIRECTORY_URL)
-    Object.keys(manifest).forEach((manifestKey) => {
-      const manifestValue = manifest[manifestKey]
-      const manifestKeyAsAbstractUrl = resolveUrl(manifestKey, manifestAbstractUrl)
-      const manifestValueAsAbstractUrl = resolveUrl(manifestValue, manifestAbstractUrl)
-      const manifestKeyAsRelativeUrl = urlToRelativeUrl(
-        manifestKeyAsAbstractUrl,
-        ABSTRACT_DIRECTORY_URL,
-      )
-      const manifestValueAsRelativeUrl = urlToRelativeUrl(
-        manifestValueAsAbstractUrl,
-        ABSTRACT_DIRECTORY_URL,
-      )
-      mappings[manifestKeyAsRelativeUrl] = manifestValueAsRelativeUrl
-    })
-  })
-  return mappings
-}
-
 const manifestKeyFromRelativeUrl = (relativeUrl, mappings) => {
   return Object.keys(mappings).find((keyCandidate) => {
     return mappings[keyCandidate] === relativeUrl

package/src/{logFileSizeReport.js → internal/formatFileSizeReportForLog.js}

@@ -1,23 +1,26 @@
-import { formatSize } from "./internal/formatSize.js"
+import { formatSize } from "./formatSize.js"
+import { manifestToMappings } from "./manifest.js"
 
-export const logFileSizeReport = (fileSizeReport) => {
+export const formatFileSizeReportForLog = (fileSizeReport) => {
   const { groups } = fileSizeReport
 
   const groupMessages = Object.keys(groups).map((groupName) => {
-    const { fileMap } = groups[groupName]
+    const { fileMap, manifestMap } = groups[groupName]
 
+    const mappings = manifestToMappings(manifestMap)
     const fileMessages = Object.keys(fileMap).map((fileRelativeUrl) => {
+      const fileDisplayed = mappings[fileRelativeUrl] || fileRelativeUrl
       const file = fileMap[fileRelativeUrl]
       const { sizeMap } = file
       const sizeNames = Object.keys(sizeMap)
       if (sizeNames.length === 1) {
-        return `${fileRelativeUrl}: ${formatSize(sizeMap[sizeNames[0]])}`
+        return `${fileDisplayed}: ${formatSize(sizeMap[sizeNames[0]])}`
       }
 
       const sizesFormatted = sizeNames.map((sizeName) => {
         return `${sizeName}: ${formatSize(sizeMap[sizeName])}`
       })
-      return `${fileRelativeUrl}: { ${sizesFormatted.join(`, `)} }`
+      return `${fileDisplayed}: { ${sizesFormatted.join(`, `)} }`
     })
 
     return `${groupName}
@@ -32,5 +35,5 @@ ${groupMessages.join(`
 `)}
 `
 
-  console.log(message)
+  return message
 }

package/src/internal/jsenvCommentParameters.js

@@ -108,7 +108,13 @@ export const jsenvCommentParameters = {
 const formatSizeImpactAsPercentage = ({ sizeBeforeMerge, sizeAfterMerge }) => {
   const sizeDiff = sizeAfterMerge - sizeBeforeMerge
   const sizeDiffRatio =
-    sizeBeforeMerge === 0 ? 1 : sizeAfterMerge === 0 ? -1 : sizeDiff / sizeBeforeMerge
+    sizeDiff === 0
+      ? 0
+      : sizeBeforeMerge === 0
+      ? 1
+      : sizeAfterMerge === 0
+      ? -1
+      : sizeDiff / sizeBeforeMerge
   const sizeDiffAsPercentage = sizeDiffRatio * 100
   const sizeDiffAsPercentageFormatted = `${sizeDiffAsPercentage < 0 ? `-` : "+"}${Math.abs(
     limitDecimals(sizeDiffAsPercentage, 2),

package/src/internal/manifest.js

@@ -0,0 +1,26 @@
+import { resolveUrl, urlToRelativeUrl } from "@jsenv/filesystem"
+
+export const manifestToMappings = (manifestMap) => {
+  const mappings = {}
+  Object.keys(manifestMap).forEach((manifestRelativeUrl) => {
+    const manifest = manifestMap[manifestRelativeUrl]
+    const manifestAbstractUrl = resolveUrl(manifestRelativeUrl, ABSTRACT_DIRECTORY_URL)
+    Object.keys(manifest).forEach((manifestKey) => {
+      const manifestValue = manifest[manifestKey]
+      const manifestKeyAsAbstractUrl = resolveUrl(manifestKey, manifestAbstractUrl)
+      const manifestValueAsAbstractUrl = resolveUrl(manifestValue, manifestAbstractUrl)
+      const manifestKeyAsRelativeUrl = urlToRelativeUrl(
+        manifestKeyAsAbstractUrl,
+        ABSTRACT_DIRECTORY_URL,
+      )
+      const manifestValueAsRelativeUrl = urlToRelativeUrl(
+        manifestValueAsAbstractUrl,
+        ABSTRACT_DIRECTORY_URL,
+      )
+      mappings[manifestKeyAsRelativeUrl] = manifestValueAsRelativeUrl
+    })
+  })
+  return mappings
+}
+
+const ABSTRACT_DIRECTORY_URL = "file:///directory/"

package/src/reportFileSizeImpact.js

@@ -1,21 +1,10 @@
-import { Worker } from "node:worker_threads"
-import {
-  assertAndNormalizeDirectoryUrl,
-  fileSystemPathToUrl,
-  isFileSystemPath,
-  resolveUrl,
-  urlToFileSystemPath,
-} from "@jsenv/filesystem"
+import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
 import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
+import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
 import { formatComment } from "./internal/formatComment.js"
 import { jsenvCommentParameters } from "./internal/jsenvCommentParameters.js"
 
-const workerFileUrl = resolveUrl(
-  "./internal/worker_generating_file_size_report.js",
-  import.meta.url,
-)
-
 export const reportFileSizeImpact = async ({
   logLevel,
   commandLogs,
@@ -29,7 +18,7 @@ export const reportFileSizeImpact = async ({
   pullRequestNumber,
   installCommand = "npm install",
   buildCommand = "npm run-script build",
-  fileSizeModulePath,
+  fileSizeReportModulePath,
 
   // We could just to ...jsenvCommentParameters but explicitely passing params
   // helps autocompletion in vscode for dev using the function.
@@ -59,14 +48,13 @@ export const reportFileSizeImpact = async ({
     throw new TypeError(`buildCommand must be a string but received ${buildCommand}`)
   }
 
-  if (typeof fileSizeModulePath !== "string") {
-    throw new TypeError(`fileSizeModulePath must be a string but received ${fileSizeModulePath}`)
+  if (typeof fileSizeReportModulePath !== "string") {
+    throw new TypeError(
+      `fileSizeReportModulePath must be a string but received ${fileSizeReportModulePath}`,
+    )
   }
   projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
-  const fileSizeModuleUrl = isFileSystemPath(fileSizeModulePath)
-    ? fileSystemPathToUrl(fileSizeModulePath)
-    : resolveUrl(fileSizeModulePath, projectDirectoryUrl)
-  const workerFilePath = urlToFileSystemPath(workerFileUrl)
+  const fileSizeReportModuleUrl = resolveUrl(fileSizeReportModulePath, projectDirectoryUrl)
 
   return commentGitHubPullRequestImpact({
     logLevel,
@@ -83,14 +71,7 @@ export const reportFileSizeImpact = async ({
     collectInfo: async ({ execCommandInProjectDirectory }) => {
       if (installCommand) await execCommandInProjectDirectory(installCommand)
       if (buildCommand) await execCommandInProjectDirectory(buildCommand)
-
-      const worker = new Worker(workerFilePath)
-      const { fileSizeReport } = await new Promise((resolve, reject) => {
-        worker.postMessage({ fileSizeModuleUrl })
-        worker.on("message", resolve)
-        worker.on("error", reject)
-      })
-
+      const fileSizeReport = await importOneExportFromFile(fileSizeReportModuleUrl)
       return { version: 1, data: fileSizeReport }
     },
     commentIdentifier: `<!-- Generated by @jsenv/file-size-impact -->`,

package/src/internal/worker_generating_file_size_report.js

@@ -1,17 +0,0 @@
-import { parentPort } from "node:worker_threads"
-
-parentPort.on("message", async ({ fileSizeModuleUrl }) => {
-  const { generateFileSizeReport } = await import(fileSizeModuleUrl)
-
-  if (typeof generateFileSizeReport !== "function") {
-    throw new TypeError(
-      `generateFileSizeReport export must be a function, got ${generateFileSizeReport}`,
-    )
-  }
-
-  const fileSizeReport = await generateFileSizeReport()
-
-  parentPort.postMessage({
-    fileSizeReport,
-  })
-})