@jsenv/performance-impact 2.0.0 → 2.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/performance-impact",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "description": "Report pull request impacts on performance metrics",
   "license": "MIT",
   "author": {
@@ -16,8 +16,7 @@
     "node": ">=14.17.0"
   },
   "publishConfig": {
-    "access": "public",
-    "registry": "https://registry.npmjs.org"
+    "access": "public"
   },
   "type": "module",
   "exports": {
@@ -44,6 +43,7 @@
     "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",

package/src/internal/assertions.js

@@ -5,13 +5,8 @@ export const assertPerformanceReport = (performanceReport) => {
     throw new TypeError(`performanceReport must be an object, received ${performanceReport}.`)
   }
 
-  const { groups } = performanceReport
-  if (typeof groups !== "object" || groups === null) {
-    throw new TypeError(`performanceReport.groups must be an object, found ${groups}.`)
-  }
-
-  Object.keys(groups).forEach((groupName) => {
-    const metrics = groups[groupName]
+  Object.keys(performanceReport).forEach((groupName) => {
+    const metrics = performanceReport[groupName]
     assertMetrics(metrics)
   })
 }

package/src/internal/comment/createPerfImpactComment.js

@@ -13,11 +13,11 @@ export const createPerfImpactComment = ({
 
   // here we have are sure beforeMergeData and afterMergeData are valid
   // because we assert their shape is correct in reportPerformanceImpact.js#collectInfo()
-  // for the measures that where in before merge but are no longer here, we will ignore them.
-  // for the measurers that are new we'll show them without doing the diff
+  // for metrics here before merge but are no longer in afetr merge, we will ignore them
+  // for new metrics we'll show them without doing the diff
 
-  const afterMergeGroups = afterMergeData.groups
-  const beforeMergeGroups = beforeMergeData.groups
+  const beforeMergeGroups = beforeMergeData
+  const afterMergeGroups = afterMergeData
 
   const groupNames = Object.keys(afterMergeGroups)
   const metricCount = groupNames.reduce((previous, groupName) => {

package/src/internal/comment/jsenvFormatGroupSummary.js

@@ -5,16 +5,21 @@ export const jsenvFormatGroupSummary = ({ groupName, beforeMergeMetrics, afterMe
     return `${groupName} (new)`
   }
 
-  const totalImpactRatio = getTotalImpactRatio({ beforeMergeMetrics, afterMergeMetrics })
-  if (totalImpactRatio === 0) {
+  const allRatios = getAllImpactRatios({ beforeMergeMetrics, afterMergeMetrics })
+  if (allRatios.length === 0) {
     return `${groupName} (no impact)`
   }
 
-  return `${groupName} (${formatRatioAsPercentage(totalImpactRatio)})`
+  const ratioSum = allRatios.reduce((previous, ratio) => previous + ratio, 0)
+  if (ratioSum === 0) {
+    return `${groupName} (no impact)`
+  }
+
+  return `${groupName} (${formatRatioAsPercentage(ratioSum)})`
 }
 
-const getTotalImpactRatio = ({ afterMergeMetrics, beforeMergeMetrics }) => {
-  let totalRatio = 0
+const getAllImpactRatios = ({ afterMergeMetrics, beforeMergeMetrics }) => {
+  let allRatios = []
   Object.keys(afterMergeMetrics).forEach((metricName) => {
     const metricBeforeMerge = beforeMergeMetrics[metricName]
     if (!metricBeforeMerge) {
@@ -33,7 +38,7 @@ const getTotalImpactRatio = ({ afterMergeMetrics, beforeMergeMetrics }) => {
         : metricValueAfterMerge === 0
         ? -1
         : metricDiff / metricValueBeforeMerge
-    totalRatio += metricDiffRatio
+    allRatios.push(metricDiffRatio)
   })
-  return totalRatio
+  return allRatios
 }

package/src/startMeasures.js

@@ -8,20 +8,17 @@ export const startMeasures = ({
   filesystemUsage = false,
   gc = false,
 } = {}) => {
-  const measures = []
-
-  if (gc) {
-    if (!global.gc) {
-      v8.setFlagsFromString("--expose_gc")
-      global.gc = runInNewContext("gc")
-      emitWarning(`node must be started with --expose-gc`, {
-        CODE: "EXPOSE_GC_IS_MISSING",
-        detail: "global.gc forced with v8.setFlagsFromString",
-      })
-    }
-    global.gc()
+  if (gc && !global.gc) {
+    v8.setFlagsFromString("--expose_gc")
+    global.gc = runInNewContext("gc")
+    emitWarning(`node must be started with --expose-gc`, {
+      CODE: "EXPOSE_GC_IS_MISSING",
+      detail: "global.gc forced with v8.setFlagsFromString",
+    })
   }
 
+  const measures = []
+
   if (duration) {
     const beforeMs = Date.now()
     measures.push(() => {
@@ -33,17 +30,6 @@ export const startMeasures = ({
     })
   }
 
-  if (memoryHeapUsage) {
-    const beforeHeapUsed = memoryUsage().heapUsed
-    measures.push(() => {
-      const afterHeapUsed = memoryUsage().heapUsed
-      const heapUsed = afterHeapUsed - beforeHeapUsed
-      return {
-        heapUsed,
-      }
-    })
-  }
-
   if (filesystemUsage) {
     const beforeRessourceUsage = resourceUsage()
     measures.push(() => {
@@ -58,11 +44,24 @@ export const startMeasures = ({
     })
   }
 
-  const stop = () => {
+  if (memoryHeapUsage) {
     if (gc) {
       global.gc()
     }
+    const beforeHeapUsed = memoryUsage().heapUsed
+    measures.push(() => {
+      if (gc) {
+        global.gc()
+      }
+      const afterHeapUsed = memoryUsage().heapUsed
+      const heapUsed = afterHeapUsed - beforeHeapUsed
+      return {
+        heapUsed,
+      }
+    })
+  }
 
+  const stop = () => {
     let metrics = {}
     measures.forEach((measure) => {
       metrics = {

package/src/internal/collectOneExportFromFile.js

@@ -1,64 +0,0 @@
-// TODO: This deserves its own npm package
-
-import { Worker } from "node:worker_threads"
-import { existsSync } from "node:fs"
-import { fileURLToPath } from "node:url"
-
-// we use a worker to bypass node cache on dynamic import
-const WORKER_COLLECTING_ON_EXPORT_FILE_URL = new URL(
-  "./worker_collecting_one_export.js",
-  import.meta.url,
-)
-
-export const collectOneExportFromFile = async (fileUrl) => {
-  const { hash, urlWithoutHash } = extractHashFromUrl(fileUrl)
-  if (!hash) {
-    throw new Error(`no hash found in fileUrl ${fileUrl}`)
-  }
-
-  const url = urlWithoutHash
-  const exportName = hash.slice(1)
-
-  const exists = existsSync(fileURLToPath(new URL(url)))
-  if (!exists) {
-    throw new Error(`File not found at ${url}`)
-  }
-
-  const worker = new Worker(WORKER_COLLECTING_ON_EXPORT_FILE_URL, {
-    workerData: {
-      url,
-      exportName,
-    },
-  })
-
-  let errorData
-  let messageData
-  await new Promise((resolve) => {
-    worker.once("message", (message) => {
-      messageData = message
-    })
-    worker.once("error", (error) => {
-      errorData = error
-    })
-    worker.once("exit", () => {
-      resolve()
-    })
-  })
-
-  if (errorData) {
-    const error = new Error(errorData.message)
-    error.name = errorData.name
-    error.stack = errorData.stack
-    throw error
-  }
-
-  return messageData
-}
-
-const extractHashFromUrl = (url) => {
-  const urlObject = new URL(url)
-  const { hash } = urlObject
-  urlObject.hash = ""
-  const urlWithoutHash = String(urlObject)
-  return { hash, urlWithoutHash }
-}

package/src/internal/worker_collecting_one_export.js

@@ -1,17 +0,0 @@
-import { parentPort, workerData } from "node:worker_threads"
-
-const { url, exportName } = workerData
-const namespace = await import(url)
-
-if (!Object.prototype.hasOwnProperty.call(namespace, exportName)) {
-  throw new Error(`No export named "${exportName}" in ${url}`)
-}
-
-const exportValue = namespace[exportName]
-if (typeof exportValue === "function") {
-  const metrics = await exportValue()
-  parentPort.postMessage(metrics)
-} else {
-  const metrics = exportValue
-  parentPort.postMessage(metrics)
-}