@jsenv/performance-impact 2.3.0 → 3.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/performance-impact",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "Report pull request impacts on performance metrics",
   "license": "MIT",
   "author": {
@@ -23,28 +23,22 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./main.js"
+      "import": "./src/main.js"
     },
     "./*": "./*"
   },
-  "main": "./main.js",
+  "main": "./src/main.js",
   "files": [
-    "/src/",
-    "/main.js"
+    "/src/"
   ],
   "scripts": {
-    "eslint": "npx eslint . --ext=.js,.mjs",
-    "snapshot": "node ./test/comment_snapshot/generate_comment_snapshot_file.mjs",
-    "test": "node ./script/test/test.mjs",
-    "test-with-coverage": "npm run test -- --coverage",
-    "prettier": "prettier --write ."
+    "snapshot": "node ./tests/comment_snapshot/generate_comment_snapshot_file.mjs",
+    "test": "node ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/dynamic-import-worker": "1.0.1",
-    "@jsenv/filesystem": "3.1.0",
-    "@jsenv/github-pull-request-impact": "1.6.11",
-    "@jsenv/logger": "4.0.1",
-    "bytes": "3.1.1",
-    "humanize-duration": "3.27.1"
+    "@jsenv/dynamic-import-worker": "1.1.0",
+    "@jsenv/filesystem": "4.1.0",
+    "@jsenv/github-pull-request-impact": "1.7.0",
+    "@jsenv/log": "2.1.0"
   }
 }

package/src/importMetricFromFiles.js

@@ -1,5 +1,5 @@
-import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
-import { createLogger } from "@jsenv/logger"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
+import { createLogger } from "@jsenv/log"
 import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
 import { measureMultipleTimes } from "./internal/measureMultipleTimes.js"
@@ -27,7 +27,7 @@ export const importMetricFromFiles = async ({
         iterations,
         msToWaitBetweenEachIteration = 100,
       } = metricsDescription
-      const url = resolveUrl(file, directoryUrl)
+      const url = new URL(file, directoryUrl).href
 
       const measure = async () => {
         const metrics = await importOneExportFromFile(url)

package/src/internal/assertions.js

@@ -1,8 +1,10 @@
-import { createDetailedMessage } from "@jsenv/logger"
+import { createDetailedMessage } from "@jsenv/log"
 
 export const assertPerformanceReport = (performanceReport) => {
   if (typeof performanceReport !== "object" || performanceReport === null) {
-    throw new TypeError(`performanceReport must be an object, received ${performanceReport}.`)
+    throw new TypeError(
+      `performanceReport must be an object, received ${performanceReport}.`,
+    )
   }
 
   Object.keys(performanceReport).forEach((groupName) => {
@@ -23,12 +25,16 @@ export const assertMetrics = (metrics, metricsTrace) => {
   Object.keys(metrics).forEach((metricName) => {
     const metric = metrics[metricName]
     if (typeof metric !== "object") {
-      throw new TypeError(`metric must be an object, got ${metric} for ${metricName}`)
+      throw new TypeError(
+        `metric must be an object, got ${metric} for ${metricName}`,
+      )
     }
 
     const { value } = metric
     if (typeof value !== "number") {
-      throw new TypeError(`metric value must be a number, got ${value} for ${metricName}`)
+      throw new TypeError(
+        `metric value must be a number, got ${value} for ${metricName}`,
+      )
     }
 
     const { unit } = metric

package/src/internal/comment/formatImpact.js

@@ -1,7 +1,11 @@
 import { formatMetricValue } from "../formatMetricValue.js"
 import { formatRatioAsPercentage } from "../formatRatio.js"
 
-export const formatImpact = ({ metricValueBeforeMerge, metricValueAfterMerge, metricUnit }) => {
+export const formatImpact = ({
+  metricValueBeforeMerge,
+  metricValueAfterMerge,
+  metricUnit,
+}) => {
   const diff = metricValueAfterMerge - metricValueBeforeMerge
 
   if (diff === 0) {
@@ -16,7 +20,10 @@ export const formatImpact = ({ metricValueBeforeMerge, metricValueAfterMerge, me
   return diffFormatted
 }
 
-export const formatImpactAsPercentage = ({ metricValueBeforeMerge, metricValueAfterMerge }) => {
+export const formatImpactAsPercentage = ({
+  metricValueBeforeMerge,
+  metricValueAfterMerge,
+}) => {
   const diff = metricValueAfterMerge - metricValueBeforeMerge
   const diffRatio =
     metricValueBeforeMerge === 0

package/src/internal/comment/jsenvFormatGroupSummary.js

@@ -1,11 +1,18 @@
 import { formatRatioAsPercentage } from "../formatRatio.js"
 
-export const jsenvFormatGroupSummary = ({ groupName, beforeMergeMetrics, afterMergeMetrics }) => {
+export const jsenvFormatGroupSummary = ({
+  groupName,
+  beforeMergeMetrics,
+  afterMergeMetrics,
+}) => {
   if (!beforeMergeMetrics) {
     return `${groupName} (new)`
   }
 
-  const allRatios = getAllImpactRatios({ beforeMergeMetrics, afterMergeMetrics })
+  const allRatios = getAllImpactRatios({
+    beforeMergeMetrics,
+    afterMergeMetrics,
+  })
   const ratiosCount = allRatios.length
   if (ratiosCount === 0) {
     return `${groupName} (no impact)`
@@ -31,7 +38,11 @@ const getAllImpactRatios = ({ afterMergeMetrics, beforeMergeMetrics }) => {
     const metricValueBeforeMerge = metricBeforeMerge.value
     const metricValueAfterMerge = metricAfterMerge.value
     const metricDiff = metricValueAfterMerge - metricValueBeforeMerge
-    if (metricDiff === 0 && metricValueAfterMerge === 0 && metricValueBeforeMerge === 0) {
+    if (
+      metricDiff === 0 &&
+      metricValueAfterMerge === 0 &&
+      metricValueBeforeMerge === 0
+    ) {
       // there is no impact on a metric that is 0
       // we can ignore this metric
       return

package/src/internal/comment/jsenvIsPerformanceImpactBig.js

@@ -1,6 +1,10 @@
-export const jsenvIsPerformanceImpactBig = ({ metricValueBeforeMerge, metricValueDelta }) => {
+export const jsenvIsPerformanceImpactBig = ({
+  metricValueBeforeMerge,
+  metricValueDelta,
+}) => {
   const absoluteDelta = Math.abs(metricValueDelta)
-  const absoluteDeltaAsRatio = absoluteDelta === 0 ? 0 : absoluteDelta / metricValueBeforeMerge
+  const absoluteDeltaAsRatio =
+    absoluteDelta === 0 ? 0 : absoluteDelta / metricValueBeforeMerge
   const absoluteDeltaAsPercentage = absoluteDeltaAsRatio * 100
 
   // absolute diff as percentage is below 5% -> not big

package/src/internal/comment/renderGroupImpactTable.js

@@ -47,7 +47,9 @@ const renderPerfImpactTableBody = ({
     const metricNameDisplayed = truncateMetricName(metricName)
     const metric = afterMergeMetrics[metricName]
     const metricValueAfterMerge = metric.value
-    const metricBeforeMerge = beforeMergeMetrics ? beforeMergeMetrics[metricName] : undefined
+    const metricBeforeMerge = beforeMergeMetrics
+      ? beforeMergeMetrics[metricName]
+      : undefined
     if (!metricBeforeMerge) {
       lines.push([
         `<td nowrap>${metricNameDisplayed}</td>`,
@@ -84,14 +86,19 @@ const renderPerfImpactTableBody = ({
   })
   if (metricNames !== metricAllNames) {
     lines.push([
-      `<td colspan="5" align="center">... ${metricCount - MAX_METRIC_PER_GROUP} more ...</td>`,
+      `<td colspan="5" align="center">... ${
+        metricCount - MAX_METRIC_PER_GROUP
+      } more ...</td>`,
     ])
   }
 
   return renderTableLines(lines)
 }
 
-const renderEmojiCellContent = ({ metricValueAfterMerge, metricValueBeforeMerge }) => {
+const renderEmojiCellContent = ({
+  metricValueAfterMerge,
+  metricValueBeforeMerge,
+}) => {
   const delta = metricValueAfterMerge - metricValueBeforeMerge
   if (delta === 0) {
     return ":ghost:"

package/src/internal/formatMetricValue.js

@@ -1,12 +1,11 @@
-import { formatMs } from "./formatMs.js"
-import { formatByte } from "./formatByte.js"
+import { byteAsFileSize, msAsDuration } from "@jsenv/log"
 
 export const formatMetricValue = ({ value, unit }) => {
   return formatters[unit](value)
 }
 
 const formatters = {
-  ms: formatMs,
-  byte: formatByte,
+  ms: msAsDuration,
+  byte: byteAsFileSize,
   undefined: (value) => value,
 }

package/src/internal/formatRatio.js

@@ -1,6 +1,9 @@
-import { formatPercentage } from "./format_percentage.js"
+import { setRoundedPrecision } from "@jsenv/log"
 
 export const formatRatioAsPercentage = (ratio) => {
-  const asPercentageFormatted = formatPercentage(ratio * 100)
-  return asPercentageFormatted
+  const percentage = ratio * 100
+  return `${percentage < 0 ? `-` : "+"}${setRoundedPrecision(percentage, {
+    decimals: 0,
+    decimalsWhenSmall: 1,
+  })}%`
 }

package/src/internal/measureMultipleTimes.js

@@ -1,4 +1,4 @@
-import { createDetailedMessage } from "@jsenv/logger"
+import { createDetailedMessage } from "@jsenv/log"
 
 import { assertMetrics } from "./assertions.js"
 
@@ -11,14 +11,18 @@ export const measureMultipleTimes = async (
     throw new TypeError(`measure must be a function, received ${measure}`)
   }
   if (typeof iterationCount !== "number") {
-    throw new TypeError(`iterationCount must be a number, received ${iterationCount}`)
+    throw new TypeError(
+      `iterationCount must be a number, received ${iterationCount}`,
+    )
   }
 
   const firstIterationMetrics = await measure()
   assertMetrics(firstIterationMetrics)
   const firstIterationMetricNames = Object.keys(firstIterationMetrics)
   if (firstIterationMetricNames.length === 0) {
-    throw new Error(`measure must return a non empty object, received an object without key`)
+    throw new Error(
+      `measure must return a non empty object, received an object without key`,
+    )
   }
 
   const metricsWithIteration = {}
@@ -41,14 +45,20 @@ export const measureMultipleTimes = async (
     const currentMetrics = await measure()
     assertMetrics(currentMetrics)
     const currentIterationMetricNames = Object.keys(currentMetrics)
-    const missingMetricNamesInCurrentIteration = firstIterationMetricNames.filter(
-      (firstIterationMetricName) => !currentIterationMetricNames.includes(firstIterationMetricName),
-    )
-    const extraMetricNamesInCurrentIteration = currentIterationMetricNames.filter(
-      (currentIterationMetricName) =>
-        !firstIterationMetricNames.includes(currentIterationMetricName),
-    )
-    if (missingMetricNamesInCurrentIteration.length || extraMetricNamesInCurrentIteration.length) {
+    const missingMetricNamesInCurrentIteration =
+      firstIterationMetricNames.filter(
+        (firstIterationMetricName) =>
+          !currentIterationMetricNames.includes(firstIterationMetricName),
+      )
+    const extraMetricNamesInCurrentIteration =
+      currentIterationMetricNames.filter(
+        (currentIterationMetricName) =>
+          !firstIterationMetricNames.includes(currentIterationMetricName),
+      )
+    if (
+      missingMetricNamesInCurrentIteration.length ||
+      extraMetricNamesInCurrentIteration.length
+    ) {
       throw new Error(
         createVariableMetricNamesErrorMessage({
           missingMetricNamesInCurrentIteration,
@@ -63,11 +73,14 @@ export const measureMultipleTimes = async (
       const currentMetric = currentMetrics[metricName]
       if (currentMetric.unit !== metricWithIteration.unit) {
         throw new Error(
-          createDetailedMessage(`A metric unit has changed between iterations.`, {
-            "metric unit on first iteration": metricWithIteration.unit,
-            [`metric unit on iteration ${index + 1}`]: currentMetric.unit,
-            "metric name": metricName,
-          }),
+          createDetailedMessage(
+            `A metric unit has changed between iterations.`,
+            {
+              "metric unit on first iteration": metricWithIteration.unit,
+              [`metric unit on iteration ${index + 1}`]: currentMetric.unit,
+              "metric name": metricName,
+            },
+          ),
         )
       }
       metricWithIteration.values.push(currentMetric.value)

package/src/main.js

@@ -0,0 +1,5 @@
+export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
+
+export { startMeasures } from "./startMeasures.js"
+export { importMetricFromFiles } from "./importMetricFromFiles.js"
+export { reportPerformanceImpact } from "./reportPerformanceImpact.js"

package/src/reportPerformanceImpact.js

@@ -18,7 +18,7 @@ export const reportPerformanceImpact = async ({
   pullRequestNumber,
 
   installCommand = "npm install",
-  performanceReportPath,
+  performanceReportUrl,
   isPerformanceImpactBig = jsenvCommentParameters.isPerformanceImpactBig,
   formatGroupSummary = jsenvCommentParameters.formatGroupSummary,
   formatPerformanceImpactCell = jsenvCommentParameters.formatPerformanceImpactCell,
@@ -27,14 +27,12 @@ export const reportPerformanceImpact = async ({
   commitInGeneratedByInfo,
 }) => {
   rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  let performanceReportUrl
-  if (performanceReportPath === "string") {
-    performanceReportUrl = new URL(performanceReportPath, rootDirectoryUrl).href
-  } else if (performanceReportPath instanceof URL) {
-    performanceReportUrl = performanceReportPath.href
+  if (performanceReportUrl === "string") {
+    performanceReportUrl = new URL(performanceReportUrl, rootDirectoryUrl).href
+  } else if (performanceReportUrl instanceof URL) {
   } else {
     throw new TypeError(
-      `performanceReportPath must be a string or an url but received ${performanceReportPath}`,
+      `performanceReportUrl must be a string or an url but received ${performanceReportUrl}`,
     )
   }
 

package/src/startMeasures.js

@@ -34,7 +34,8 @@ export const startMeasures = ({
     const beforeRessourceUsage = resourceUsage()
     measures.push(() => {
       const afterRessourceUsage = resourceUsage()
-      const fileSystemReadOperationCount = afterRessourceUsage.fsRead - beforeRessourceUsage.fsRead
+      const fileSystemReadOperationCount =
+        afterRessourceUsage.fsRead - beforeRessourceUsage.fsRead
       const fileSystemWriteOperationCount =
         afterRessourceUsage.fsWrite - beforeRessourceUsage.fsWrite
       return {

package/main.js

@@ -1,5 +0,0 @@
-export { startMeasures } from "./src/startMeasures.js"
-export { importMetricFromFiles } from "./src/importMetricFromFiles.js"
-
-export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
-export { reportPerformanceImpact } from "./src/reportPerformanceImpact.js"

package/src/internal/formatByte.js

@@ -1,10 +0,0 @@
-import { createRequire } from "node:module"
-
-const require = createRequire(import.meta.url)
-
-// https://github.com/visionmedia/bytes.js/
-const bytes = require("bytes")
-
-export const formatByte = (metricValue) => {
-  return bytes(metricValue, { decimalPlaces: 2, unitSeparator: " " })
-}

package/src/internal/formatMs.js

@@ -1,13 +0,0 @@
-import { createRequire } from "node:module"
-
-const require = createRequire(import.meta.url)
-
-const humanizeDuration = require("humanize-duration")
-
-export const formatMs = (metricValue) => {
-  return humanizeDuration(metricValue, {
-    largest: 2,
-    maxDecimalPoints: metricValue < 1 ? 4 : metricValue < 1000 ? 3 : 2,
-    // units: ["s"]
-  })
-}

package/src/internal/format_percentage.js

@@ -1,30 +0,0 @@
-export const formatPercentage = (number) => {
-  const absoluteValue = Math.abs(number)
-  const valueRounded = roundNumber(
-    absoluteValue,
-    determineDecimals(absoluteValue),
-  )
-  return `${number < 0 ? `-` : "+"}${valueRounded}%`
-}
-const determineDecimals = (number) => {
-  if (number < 0.001) {
-    return 4
-  }
-  if (number < 0.01) {
-    return 3
-  }
-  if (number < 0.1) {
-    return 2
-  }
-  if (number < 1) {
-    return 1
-  }
-  return 0
-}
-
-const roundNumber = (value, maxDecimals) => {
-  const expValue = Math.pow(10, maxDecimals)
-  const roundedValue = Math.round(expValue * value) / expValue
-  const valueAsString = roundedValue.toFixed(maxDecimals)
-  return parseFloat(valueAsString)
-}