@magield/collectors 0.21.0 → 0.23.0

package/dist/run.js

@@ -44,6 +44,8 @@ export async function runCollectors(env, options = {}) {
     const signals = {};
     const skipped = [];
     const errors = [];
+    const timings = {};
+    const waveTimings = {};
     const startedAll = now();
     let expected = 0;
     let obtained = 0;
@@ -80,6 +82,7 @@ export async function runCollectors(env, options = {}) {
                 skipped.push(collector.id);
                 continue;
             }
+            const collectorStarted = now();
             try {
                 // Bounded by what is left of the wave, not merely checked before it
                 // starts. The budget is "a protected action is never delayed by
@@ -93,6 +96,7 @@ export async function runCollectors(env, options = {}) {
                 // hostile-runtime event rather than an exotic one.
                 const remaining = budget - (now() - waveStarted);
                 const result = await withDeadline(collector.collect(env), remaining);
+                timings[collector.id] = Math.round(now() - collectorStarted);
                 if (result === TIMED_OUT) {
                     skipped.push(collector.id);
                     errors.push(`${collector.id}: exceeded the ${wave} budget`);
@@ -113,10 +117,12 @@ export async function runCollectors(env, options = {}) {
                 // One broken collector must never cost the whole bundle. Browsers are
                 // a hostile runtime: extensions remove APIs, hardening throws on
                 // property access, and a page can be closed mid-collection.
+                timings[collector.id] = Math.round(now() - collectorStarted);
                 skipped.push(collector.id);
                 errors.push(`${collector.id}: ${err.message}`);
             }
         }
+        waveTimings[wave] = Math.round(now() - waveStarted);
     }
     return {
         signals,
@@ -124,5 +130,7 @@ export async function runCollectors(env, options = {}) {
         skipped,
         errors,
         confidence: expected === 0 ? 0 : Number((obtained / expected).toFixed(3)),
+        timings,
+        waves: waveTimings,
     };
 }

package/dist/types.d.ts

@@ -51,4 +51,12 @@ export interface CollectionResult {
     readonly errors: readonly string[];
     /** 0..1 — how much of the expected signal set was actually obtained. */
     readonly confidence: number;
+    /**
+     * Milliseconds each collector that ran took, by id, including one that was
+     * cut off by its wave's budget (then the time it was waited for). Collectors
+     * that were never started are absent.
+     */
+    readonly timings?: Readonly<Record<string, number>>;
+    /** Milliseconds each wave that ran took, by wave. */
+    readonly waves?: Readonly<Partial<Record<Wave, number>>>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magield/collectors",
-  "version": "0.21.0",
+  "version": "0.23.0",
   "description": "Browser signal collectors used by the Magic Shield web SDK",
   "license": "SEE LICENSE IN LICENSE",
   "files": [