@jsenv/performance-impact 4.1.4 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/performance-impact",
-  "version": "4.1.4",
+  "version": "4.2.1",
   "description": "Report pull request impacts on performance metrics",
   "license": "MIT",
   "author": {
@@ -35,9 +35,10 @@
     "test": "node ./scripts/test.mjs"
   },
   "dependencies": {
-    "@jsenv/dynamic-import-worker": "1.1.0",
-    "@jsenv/filesystem": "4.3.2",
-    "@jsenv/github-pull-request-impact": "1.7.4",
-    "@jsenv/log": "3.4.2"
+    "@jsenv/dynamic-import-worker": "1.2.1",
+    "@jsenv/filesystem": "4.6.6",
+    "@jsenv/github-pull-request-impact": "1.7.5",
+    "@jsenv/humanize": "1.1.0",
+    "@jsenv/log": "3.5.2"
   }
 }

package/readme.md

@@ -8,13 +8,13 @@
 
 Disclaimer: This tool should not be used to catch small performance variations because they are hard to distinguish from the natural variations of performance metrics (see [performance variability](#Performance-variability)).
 
-# Pull request comment
+## Pull request comment
 
 _Screenshot of a pull request comment_
 
 ![stuff](./docs/pull_request_comment.png)
 
-# Performance variability
+## Performance variability
 
 Performance metrics will change due to inherent variability, **even if there hasn't been a code change**.
 It can be mitigated by measuring performance multiple times.
@@ -22,18 +22,18 @@ But you should always keep in mind this variability before drawing conclusions a
 
 With time you'll be capable to recognize unusual variation in your performance metrics.
 
-# How to catch small performance impacts?
+## How to catch small performance impacts?
 
-Catching small to very small performance impacts with confidence requires a LOT of repetition and time. Both strategies means you will have to wait before knowing the real performance impact.
+Catching (very) small performance impacts with confidence requires repetition and time. You need to: 
 
-_How to catch small impacts with a lot of repetition?_
+1. Let your code be used a lot of times in a lot of scenarios and see the results. This could be scripts, real users or both.
 
-- Let your code be used a lot of times in a lot of scenarios and see the results. This could be scripts, real users or both.
+2. And or push your performance metrics in a tool like Kibana or DataDog and check the tendency of your performance metrics.
 
-- Push your performance metrics in a tool like Kibana or DataDog and check the tendency of your performance metrics.
+In any case it means you have to wait before knowing the real performance impact.
 
-In the end I would recommend the following approach:
+## Recommended approach to catch performance impacts
 
 1. measure some performance metrics
-2. Use `@jsenv/performance-impact` to anticipate big variations
+2. Big variations can be anticipated and catched by `@jsenv/performance-impact`
 3. For small variations, upload performance metrics to a dashboard. Then, periodically watch the dashboard to check performance metrics tendency over time

package/src/importMetricFromFiles.js

@@ -24,13 +24,15 @@ export const importMetricFromFiles = async ({
       const metricsDescription = metricsDescriptions[metricName];
       const {
         file,
+        env,
+        params,
         iterations,
         msToWaitBetweenEachIteration = 100,
       } = metricsDescription;
       const url = new URL(file, directoryUrl).href;
 
       const measure = async () => {
-        const metrics = await importOneExportFromFile(url);
+        const metrics = await importOneExportFromFile(url, { env, params });
         assertMetrics(metrics, `in ${file}`);
         return metrics;
       };

package/src/internal/formatMetricValue.js

@@ -1,11 +1,11 @@
-import { byteAsFileSize, msAsDuration } from "@jsenv/log";
+import { humanizeFileSize, humanizeDuration } from "@jsenv/humanize";
 
 export const formatMetricValue = ({ value, unit }) => {
   return formatters[unit](value);
 };
 
 const formatters = {
-  ms: msAsDuration,
-  byte: byteAsFileSize,
+  ms: humanizeDuration,
+  byte: humanizeFileSize,
   undefined: (value) => value,
 };

package/src/internal/formatRatio.js

@@ -1,4 +1,4 @@
-import { setRoundedPrecision } from "@jsenv/log";
+import { setRoundedPrecision } from "@jsenv/humanize/src/utils/decimals.js";
 
 export const formatRatioAsPercentage = (ratio) => {
   const percentage = ratio * 100;