@vercel/devlow-bench 0.1.4 → 0.2.4

package/README.md

@@ -86,12 +86,12 @@ describe(
 import { measureTime, reportMeasurement } from "devlow-bench";
 
 // Measure a time
-measureTime("name of the timing", {
+await measureTime("name of the timing", {
   /* optional options */
 });
 
 // Report some other measurement
-reportMeasurement("name of the measurement", value, unit, {
+await reportMeasurement("name of the measurement", value, unit, {
   /* optional options */
 });
 ```

package/dist/browser.js

@@ -71,21 +71,21 @@ async function withRequestMetrics(metricName, page, fn) {
         await Promise.all(activePromises);
         let totalDownload = 0;
         for (const [extension, size] of sizeByExtension.entries()) {
-            reportMeasurement(`${metricName}/responseSizes/${extension}`, size, "bytes");
+            await reportMeasurement(`${metricName}/responseSizes/${extension}`, size, "bytes");
             totalDownload += size;
         }
-        reportMeasurement(`${metricName}/responseSizes`, totalDownload, "bytes");
+        await reportMeasurement(`${metricName}/responseSizes`, totalDownload, "bytes");
         let totalRequests = 0;
         for (const [extension, count] of requestsByExtension.entries()) {
-            reportMeasurement(`${metricName}/requests/${extension}`, count, "requests");
+            await reportMeasurement(`${metricName}/requests/${extension}`, count, "requests");
             totalRequests += count;
         }
-        reportMeasurement(`${metricName}/requests`, totalRequests, "requests");
-        reportMeasurement(`${metricName}/console/logs`, logCount, "messages");
-        reportMeasurement(`${metricName}/console/warnings`, warningCount, "messages");
-        reportMeasurement(`${metricName}/console/errors`, errorCount, "messages");
-        reportMeasurement(`${metricName}/console/uncaught`, uncaughtCount, "messages");
-        reportMeasurement(`${metricName}/console`, logCount + warningCount + errorCount + uncaughtCount, "messages");
+        await reportMeasurement(`${metricName}/requests`, totalRequests, "requests");
+        await reportMeasurement(`${metricName}/console/logs`, logCount, "messages");
+        await reportMeasurement(`${metricName}/console/warnings`, warningCount, "messages");
+        await reportMeasurement(`${metricName}/console/errors`, errorCount, "messages");
+        await reportMeasurement(`${metricName}/console/uncaught`, uncaughtCount, "messages");
+        await reportMeasurement(`${metricName}/console`, logCount + warningCount + errorCount + uncaughtCount, "messages");
     }
     finally {
         page.off("response", responseHandler);

package/dist/describe.d.ts

@@ -11,9 +11,9 @@ export declare function measureTime(name: string, options?: {
     scenario?: string;
     props?: Record<string, string | number | null>;
     offset?: number;
-}): void;
+}): Promise<void>;
 export declare function reportMeasurement(name: string, value: number, unit: string, options?: {
     relativeTo?: string | typeof PREVIOUS;
     scenario?: string;
     props?: Record<string, string | number | null>;
-}): void;
+}): Promise<void>;

package/dist/describe.js

@@ -56,14 +56,32 @@ export function withCurrent(current, fn) {
     });
 }
 export const PREVIOUS = Symbol("previous measurement with that unit");
-export function measureTime(name, options = {}) {
+export async function measureTime(name, options = {}) {
     const end = Date.now() - (options.offset || 0);
-    reportMeasurement(name, end, "ms", { relativeTo: PREVIOUS, ...options });
+    await reportMeasurement(name, end, "ms", {
+        relativeTo: PREVIOUS,
+        ...options,
+    });
 }
-export function reportMeasurement(name, value, unit, options = {}) {
+export async function reportMeasurement(name, value, unit, options = {}) {
     if (!currentScenario) {
         throw new Error("reportMeasurement() must be called inside of describe()");
     }
+    if (typeof name !== "string") {
+        throw new Error("reportMeasurement() must be called with a name that is a string");
+    }
+    if (typeof value !== "number") {
+        throw new Error("reportMeasurement() must be called with a value that is a number");
+    }
+    if (isNaN(value)) {
+        throw new Error("reportMeasurement() must be called with a value that is not NaN");
+    }
+    if (!isFinite(value)) {
+        throw new Error("reportMeasurement() must be called with a value that is finite");
+    }
+    if (typeof unit !== "string") {
+        throw new Error("reportMeasurement() must be called with a unit that is a string");
+    }
     let { relativeTo, scenario, props } = options;
     if (relativeTo === PREVIOUS) {
         relativeTo = "previous";
@@ -83,12 +101,12 @@ export function reportMeasurement(name, value, unit, options = {}) {
         if (!prev) {
             throw new Error(`No measurement named ${relativeTo} found`);
         }
-        if (prev.unit !== "ms") {
+        if (prev.unit !== unit) {
             throw new Error(`Measurement ${relativeTo} is not a "${unit}" measurement`);
         }
         reportedValue -= prev.value;
     }
-    currentScenario.iface.measurement(scenario ?? currentScenario.scenario.scenario.name, props
+    await currentScenario.iface.measurement(scenario ?? currentScenario.scenario.scenario.name, props
         ? {
             ...currentScenario.scenario.props,
             ...props,

package/dist/shell.js

@@ -91,7 +91,7 @@ class CommandImpl {
                 .filter((x) => x)
                 .map((x) => x.memory)
                 .reduce((a, b) => a + b, 0);
-            reportMeasurement(metricName, memUsage, "bytes", options);
+            await reportMeasurement(metricName, memUsage, "bytes", options);
         }
         catch (e) {
             // ignore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/devlow-bench",
-  "version": "0.1.4",
+  "version": "0.2.4",
   "description": "Benchmarking tool for the developer workflow",
   "type": "module",
   "main": "dist/index.js",
@@ -25,7 +25,8 @@
     "@types/inquirer": "^9.0.3",
     "@types/minimist": "^1.2.2",
     "@types/node": "^20.3.0",
-    "@types/split2": "^4.2.0"
+    "@types/split2": "^4.2.0",
+    "@turbo/eslint-config": "0.0.0"
   },
   "dependencies": {
     "@datadog/datadog-api-client": "^1.13.0",
@@ -38,6 +39,7 @@
     "tree-kill": "^1.2.2"
   },
   "scripts": {
+    "lint": "eslint src/",
     "prerelease": "pnpm run build:ts",
     "build:ts": "tsc"
   }