@nestia/benchmark 14.0.1 → 14.0.2

package/lib/internal/DynamicBenchmarkStatistics.d.ts

@@ -0,0 +1,25 @@
+import type { DynamicBenchmarker } from "../DynamicBenchmarker";
+import type { IBenchmarkEvent } from "../IBenchmarkEvent";
+/**
+ * Statistics of benchmarked events.
+ *
+ * @evidence contracts/common.md#principled-implementation The success count uses one reduction without retaining a filtered event array, while mean, population standard deviation, minimum and maximum share one pass over event start/completion durations. Both operations are linear in the event population.
+ * @evidence contracts/common.md#clear-and-simple-design One namespace with one exported function; the elapsed-time measures are a private helper of it.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts The formulas are standard statistics without tuning to any benchmark result.
+ * @evidence contracts/common.md#meaningful-documentation The comment states its single job.
+ */
+export declare namespace DynamicBenchmarkStatistics {
+    /**
+     * Summarizes events into counts and elapsed-time statistics.
+     *
+     * Durations are milliseconds. The empty set has `null` measures, and the
+     * standard deviation is the population deviation computed with Welford's
+     * update.
+     *
+     * @evidence contracts/common.md#principled-implementation Welford's update accumulates deviations from a running mean, avoiding the subtraction of nearly equal large squared averages that caused cancellation in constant durations. The variance divisor is the population count; floating-point arithmetic remains approximate rather than a claim of exact arithmetic for every possible input.
+     * @evidence contracts/common.md#clear-and-simple-design One shared pass computes the elapsed measures, a separate reduction counts successes, and the empty elapsed population is answered before the loop.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The method is the recognized single-pass algorithm rather than a compensating clamp.
+     * @evidence contracts/common.md#meaningful-documentation The comment states the unit, the empty-set convention, and the algorithm.
+     */
+    const of: (events: IBenchmarkEvent[]) => DynamicBenchmarker.IReport.IStatistics;
+}

package/lib/internal/DynamicBenchmarkStatistics.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DynamicBenchmarkStatistics = void 0;
+/**
+ * Statistics of benchmarked events.
+ *
+ * @evidence contracts/common.md#principled-implementation The success count uses one reduction without retaining a filtered event array, while mean, population standard deviation, minimum and maximum share one pass over event start/completion durations. Both operations are linear in the event population.
+ * @evidence contracts/common.md#clear-and-simple-design One namespace with one exported function; the elapsed-time measures are a private helper of it.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts The formulas are standard statistics without tuning to any benchmark result.
+ * @evidence contracts/common.md#meaningful-documentation The comment states its single job.
+ */
+var DynamicBenchmarkStatistics;
+(function (DynamicBenchmarkStatistics) {
+    /**
+     * Summarizes events into counts and elapsed-time statistics.
+     *
+     * Durations are milliseconds. The empty set has `null` measures, and the
+     * standard deviation is the population deviation computed with Welford's
+     * update.
+     *
+     * @evidence contracts/common.md#principled-implementation Welford's update accumulates deviations from a running mean, avoiding the subtraction of nearly equal large squared averages that caused cancellation in constant durations. The variance divisor is the population count; floating-point arithmetic remains approximate rather than a claim of exact arithmetic for every possible input.
+     * @evidence contracts/common.md#clear-and-simple-design One shared pass computes the elapsed measures, a separate reduction counts successes, and the empty elapsed population is answered before the loop.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The method is the recognized single-pass algorithm rather than a compensating clamp.
+     * @evidence contracts/common.md#meaningful-documentation The comment states the unit, the empty-set convention, and the algorithm.
+     */
+    DynamicBenchmarkStatistics.of = (events) => (Object.assign({ count: events.length, success: events.reduce((count, event) => count + Number(event.success), 0) }, elapsed(events)));
+    const elapsed = (events) => {
+        if (events.length === 0)
+            return { mean: null, stdev: null, minimum: null, maximum: null };
+        // Welford's single pass keeps the sum of squared deviations from the
+        // running mean, so it stays non-negative where the difference between the
+        // mean of squares and the squared mean cancels to a negative value and the
+        // square root returns NaN.
+        let count = 0;
+        let mean = 0;
+        let deviations = 0;
+        let minimum = Number.POSITIVE_INFINITY;
+        let maximum = Number.NEGATIVE_INFINITY;
+        for (const event of events) {
+            const value = new Date(event.completed_at).getTime() -
+                new Date(event.started_at).getTime();
+            const delta = value - mean;
+            mean += delta / ++count;
+            deviations += delta * (value - mean);
+            minimum = Math.min(minimum, value);
+            maximum = Math.max(maximum, value);
+        }
+        return { mean, stdev: Math.sqrt(deviations / count), minimum, maximum };
+    };
+})(DynamicBenchmarkStatistics || (exports.DynamicBenchmarkStatistics = DynamicBenchmarkStatistics = {}));
+//# sourceMappingURL=DynamicBenchmarkStatistics.js.map

package/lib/internal/DynamicBenchmarkStatistics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DynamicBenchmarkStatistics.js","sourceRoot":"","sources":["../../src/internal/DynamicBenchmarkStatistics.ts"],"names":[],"mappings":";;;AAGA;;;;;;;GAOG;AACH,IAAiB,0BAA0B,CAkD1C;AAlDD,WAAiB,0BAA0B;IACzC;;;;;;;;;;;OAWG;IACU,6BAAE,GAAG,CAChB,MAAyB,EACe,EAAE,CAAC,iBAC3C,KAAK,EAAE,MAAM,CAAC,MAAM,EACpB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,IACvE,OAAO,CAAC,MAAM,CAAC,EAClB,CAAC;IAEH,MAAM,OAAO,GAAG,CACd,MAAyB,EAIzB,EAAE;QACF,IAAI,MAAM,CAAC,MAAM,KAAK,CAAC;YACrB,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;QACnE,qEAAqE;QACrE,0EAA0E;QAC1E,2EAA2E;QAC3E,2BAA2B;QAC3B,IAAI,KAAK,GAAW,CAAC,CAAC;QACtB,IAAI,IAAI,GAAW,CAAC,CAAC;QACrB,IAAI,UAAU,GAAW,CAAC,CAAC;QAC3B,IAAI,OAAO,GAAW,MAAM,CAAC,iBAAiB,CAAC;QAC/C,IAAI,OAAO,GAAW,MAAM,CAAC,iBAAiB,CAAC;QAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;YAC3B,MAAM,KAAK,GACT,IAAI,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,OAAO,EAAE;gBACtC,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,EAAE,CAAC;YACvC,MAAM,KAAK,GAAW,KAAK,GAAG,IAAI,CAAC;YACnC,IAAI,IAAI,KAAK,GAAG,EAAE,KAAK,CAAC;YACxB,UAAU,IAAI,KAAK,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;YACrC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACnC,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACrC,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC;IAC1E,CAAC,CAAC;AACJ,CAAC,EAlDgB,0BAA0B,aAA1B,0BAA0B,GAA1B,0BAA0B,QAkD1C"}

package/lib/internal/IBenchmarkMaster.d.ts

@@ -1,4 +1,30 @@
+/**
+ * The operations a servant may call on the master through the worker
+ * connection.
+ *
+ * @evidence contracts/common.md#principled-implementation The interface lists the two calls the servant makes back to the master: whether to load a file and how many benchmark function invocations have completed.
+ * @evidence contracts/common.md#clear-and-simple-design Two members, one per callback, with no behavior in the type.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is the RPC contract of the master, not a test-specific seam.
+ * @evidence contracts/common.md#meaningful-documentation The comment states which side implements it.
+ */
 export interface IBenchmarkMaster {
+    /**
+     * Asks the master whether a benchmark file, by basename, may be imported.
+     *
+     * @evidence contracts/common.md#principled-implementation The servant asks before every import so the master's predicate decides which modules load.
+     * @evidence contracts/common.md#clear-and-simple-design One predicate over a file name.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The answer is the caller's filter, not a fixed list.
+     * @evidence contracts/common.md#meaningful-documentation The comment states the argument and the meaning of the answer.
+     */
     filter: (file: string) => boolean;
+    /**
+     * Reports the number of benchmark function invocations this servant has
+     * completed so far, independently of logged HTTP event count.
+     *
+     * @evidence contracts/common.md#principled-implementation A servant reports its own cumulative count, and the master sums the servants' counts.
+     * @evidence contracts/common.md#clear-and-simple-design One notification with one number.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The count is measured by the servant, not estimated.
+     * @evidence contracts/common.md#meaningful-documentation The comment states that the value is cumulative and per servant.
+     */
     progress: (current: number) => void;
 }

package/lib/internal/IBenchmarkServant.d.ts

@@ -1,5 +1,24 @@
 import { IBenchmarkEvent } from "../IBenchmarkEvent";
+/**
+ * The operations the master may call on a servant through the worker
+ * connection.
+ *
+ * @evidence contracts/common.md#principled-implementation The interface lists the one call the master makes: run a share of benchmark function invocations and return their logged HTTP events.
+ * @evidence contracts/common.md#clear-and-simple-design One member, no behavior in the type.
+ * @evidence contracts/common.md#prohibited-implementation-shortcuts It is the RPC contract of the servant, not a test-specific seam.
+ * @evidence contracts/common.md#meaningful-documentation The comment states which side implements it.
+ */
 export interface IBenchmarkServant {
+    /**
+     * Runs the requested number of benchmark function invocations with the given
+     * simultaneous budget and returns every logged HTTP event. One invocation can
+     * log zero, one or several events.
+     *
+     * @evidence contracts/common.md#principled-implementation The master gives each servant its share of the count and of the simultaneous budget, and the servant returns the events for its share.
+     * @evidence contracts/common.md#clear-and-simple-design One request-response operation with two numbers in and events out.
+     * @evidence contracts/common.md#prohibited-implementation-shortcuts The servant runs what the master assigned, without adjusting the budget.
+     * @evidence contracts/common.md#meaningful-documentation The comment states the arguments and the returned events.
+     */
     execute(props: {
         count: number;
         simultaneous: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestia/benchmark",
-  "version": "14.0.1",
+  "version": "14.0.2",
   "description": "NestJS Performance Benchmark Program",
   "main": "lib/index.js",
   "exports": {
@@ -30,7 +30,7 @@
   "dependencies": {
     "tgrid": "^1.2.1",
     "tstl": "^3.0.0",
-    "@nestia/fetcher": "^14.0.1"
+    "@nestia/fetcher": "^14.0.2"
   },
   "devDependencies": {
     "@types/node": "^25.3.3",
@@ -48,7 +48,8 @@
   },
   "scripts": {
     "build": "rimraf lib && ttsc",
-    "dev": "rimraf lib && ttsc --watch"
+    "dev": "rimraf lib && ttsc --watch",
+    "evidence": "evidence"
   },
   "types": "lib/index.d.ts"
 }