measure-fn 3.7.0 → 3.8.0

package/README.md

@@ -125,6 +125,7 @@ The first argument can be a label string, or an options object:
 | `label` | `string` | Display name (required if object) |
 | `timeout` | `number` | Aborts after N ms (returns `null`) |
 | `budget` | `number` | Warns if slower than N ms (doesn't abort) |
+| `maxResultLength` | `number` | Override result truncation (0 = unlimited, inherits to children) |
 | any other | `any` | Logged inline as context metadata |
 
 **Timeout** (enforce):
@@ -236,7 +237,7 @@ import { configure } from 'measure-fn';
 configure({
   silent: true,            // suppress all output
   timestamps: true,        // prepend [HH:MM:SS.mmm]
-  maxResultLength: 200,    // truncate results (default: 80)
+  maxResultLength: 200,    // truncate results (default: 200, 0 = unlimited)
   dotEndLabel: false,      // show full label on end lines (default: true = dots)
   dotChar: '.',            // character for dot fill (default: '·')
   logger: (event) => {     // custom event handler

package/index.test.ts

@@ -21,7 +21,7 @@ function captureConsole() {
 describe("measure (async)", () => {
     beforeEach(() => {
         resetCounter();
-        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 80 });
+        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 200 });
     });
 
     test("runs and returns result", async () => {
@@ -115,7 +115,7 @@ describe("measure (async)", () => {
 describe("measureSync", () => {
     beforeEach(() => {
         resetCounter();
-        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 80 });
+        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 200 });
     });
 
     test("leaf = single line with result", () => {
@@ -178,7 +178,7 @@ describe("formatDuration", () => {
 describe("safeStringify", () => {
     beforeEach(() => {
         resetCounter();
-        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 80 });
+        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 200 });
     });
 
     test("circular handled", () => {
@@ -247,7 +247,7 @@ describe("timestamps", () => {
 describe("configurable truncation", () => {
     beforeEach(() => {
         resetCounter();
-        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 80 });
+        configure({ silent: false, logger: null, timestamps: false, maxResultLength: 200 });
     });
 
     test("shorter truncation", () => {
@@ -265,6 +265,52 @@ describe("configurable truncation", () => {
         out.restore();
         expect(out.logs[0]).not.toContain("…");
     });
+
+    test("per-label maxResultLength overrides global", () => {
+        configure({ maxResultLength: 500 });
+        const out = captureConsole();
+        measureSync({ label: "op", maxResultLength: 15 }, () => ({ d: "x".repeat(50) }));
+        out.restore();
+        expect(out.logs[0]).toContain("…");
+    });
+
+    test("per-label maxResultLength inherits to children", () => {
+        const out = captureConsole();
+        measureSync({ label: "parent", maxResultLength: 15 }, (m) => {
+            m("child", () => ({ d: "x".repeat(50) }));
+            return 1;
+        });
+        out.restore();
+        const childLine = out.logs[1]; // [a-a] line
+        expect(childLine).toContain("…");
+    });
+
+    test("child can override inherited maxResultLength", () => {
+        const out = captureConsole();
+        measureSync({ label: "parent", maxResultLength: 15 }, (m) => {
+            m({ label: "child", maxResultLength: 500 }, () => ({ d: "x".repeat(50) }));
+            return 1;
+        });
+        out.restore();
+        const childLine = out.logs[1]; // child line
+        expect(childLine).not.toContain("…");
+    });
+
+    test("maxResultLength: 0 means unlimited", () => {
+        const out = captureConsole();
+        measureSync({ label: "op", maxResultLength: 0 }, () => ({ d: "x".repeat(500) }));
+        out.restore();
+        expect(out.logs[0]).not.toContain("…");
+        expect(out.logs[0]).toContain("x".repeat(500));
+    });
+
+    test("maxResultLength not shown in meta", () => {
+        const out = captureConsole();
+        measureSync({ label: "op", maxResultLength: 50 }, (m) => { return 1; });
+        out.restore();
+        expect(out.logs[0]).toBe("[a] ... op");
+        expect(out.logs[0]).not.toContain("maxResultLength");
+    });
 });
 
 // ─── Budget ──────────────────────────────────────────────────────────

package/index.ts

@@ -12,9 +12,10 @@ const toAlpha = (num: number): string => {
 
 // ─── Safe Stringify ──────────────────────────────────────────────────
 
-let maxResultLen = 80;
+let maxResultLen = 200;
 
-export const safeStringify = (value: unknown): string => {
+export const safeStringify = (value: unknown, limit?: number): string => {
+  const cap = limit ?? maxResultLen;
   if (value === undefined) return '';
   if (value === null) return 'null';
   if (typeof value === 'number' || typeof value === 'boolean') return String(value);
@@ -22,7 +23,8 @@ export const safeStringify = (value: unknown): string => {
   if (typeof value === 'symbol') return value.toString();
   if (typeof value === 'string') {
     const q = JSON.stringify(value);
-    return q.length > maxResultLen ? q.slice(0, maxResultLen - 1) + '…"' : q;
+    if (cap === 0) return q;
+    return q.length > cap ? q.slice(0, cap - 1) + '…"' : q;
   }
   try {
     const seen = new WeakSet();
@@ -35,7 +37,8 @@ export const safeStringify = (value: unknown): string => {
       if (typeof val === 'bigint') return `${val}n`;
       return val;
     });
-    return str.length > maxResultLen ? str.slice(0, maxResultLen) + '…' : str;
+    if (cap === 0) return str;
+    return str.length > cap ? str.slice(0, cap) + '…' : str;
   } catch {
     return String(value);
   }
@@ -78,6 +81,7 @@ export type MeasureEvent = {
   error?: unknown;
   meta?: Record<string, unknown>;
   budget?: number;
+  maxResultLength?: number;
 };
 
 // ─── Configuration ───────────────────────────────────────────────────
@@ -128,11 +132,18 @@ const extractTimeout = (actionInternal: string | object): number | undefined =>
   return undefined;
 };
 
+const extractMaxResultLength = (actionInternal: string | object): number | undefined => {
+  if (typeof actionInternal !== 'object' || actionInternal === null) return undefined;
+  if ('maxResultLength' in actionInternal) return Number((actionInternal as any).maxResultLength);
+  return undefined;
+};
+
 const extractMeta = (actionInternal: string | object): Record<string, unknown> | undefined => {
   if (typeof actionInternal !== 'object' || actionInternal === null) return undefined;
   const details = { ...actionInternal };
   if ('label' in details) delete (details as any).label;
   if ('budget' in details) delete (details as any).budget;
+  if ('maxResultLength' in details) delete (details as any).maxResultLength;
   if (Object.keys(details).length === 0) return undefined;
   return details as Record<string, unknown>;
 };
@@ -165,7 +176,7 @@ const defaultLogger = (event: MeasureEvent, prefix?: string) => {
       break;
     case 'success': {
       const endLabel = dotEndLabel ? dotChar.repeat(event.label.length) : event.label;
-      const resultStr = event.result !== undefined ? safeStringify(event.result) : '';
+      const resultStr = event.result !== undefined ? safeStringify(event.result, event.maxResultLength) : '';
       const arrow = resultStr ? ` → ${resultStr}` : '';
       const budgetWarn = event.budget && event.duration! > event.budget
         ? ` ⚠ OVER BUDGET (${formatDuration(event.budget)})`
@@ -229,8 +240,9 @@ const createNestedResolver = (
   fullIdChain: string[],
   childCounterRef: { value: number },
   depth: number,
-  resolver: <U>(fn: any, action: any, chain: (string | number)[], depth: number, onError?: (error: unknown) => any) => Promise<U | null> | (U | null),
-  prefix?: string
+  resolver: <U>(fn: any, action: any, chain: (string | number)[], depth: number, onError?: (error: unknown) => any, inheritedMaxLen?: number) => Promise<U | null> | (U | null),
+  prefix?: string,
+  inheritedMaxLen?: number
 ) => {
   return (...args: any[]) => {
     const label = args[0];
@@ -239,7 +251,7 @@ const createNestedResolver = (
 
     if (typeof fn === 'function') {
       const childParentChain = [...fullIdChain, childCounterRef.value++];
-      return resolver(fn, label, childParentChain, depth + 1, typeof onError === 'function' ? onError : undefined);
+      return resolver(fn, label, childParentChain, depth + 1, typeof onError === 'function' ? onError : undefined, inheritedMaxLen);
     } else {
       emit({
         type: 'annotation',
@@ -272,13 +284,16 @@ const createMeasureImpl = (prefix?: string, counterRef?: { value: number }) => {
     actionInternal: string | object,
     parentIdChain: (string | number)[],
     depth: number,
-    onError?: (error: unknown) => any
+    onError?: (error: unknown) => any,
+    inheritedMaxLen?: number
   ): Promise<U | null> => {
     const start = performance.now();
     const childCounterRef = { value: 0 };
     const label = buildActionLabel(actionInternal);
     const budget = extractBudget(actionInternal);
     const timeout = extractTimeout(actionInternal);
+    const localMaxLen = extractMaxResultLength(actionInternal);
+    const effectiveMaxLen = localMaxLen ?? inheritedMaxLen;
 
     const currentId = toAlpha(parentIdChain.pop() ?? 0);
     const fullIdChain = [...parentIdChain, currentId];
@@ -292,7 +307,7 @@ const createMeasureImpl = (prefix?: string, counterRef?: { value: number }) => {
       meta: extractMeta(actionInternal),
     }, prefix);
 
-    const measureForNextLevel = createNestedResolver(true, fullIdChain, childCounterRef, depth, _measureInternal, prefix);
+    const measureForNextLevel = createNestedResolver(true, fullIdChain, childCounterRef, depth, _measureInternal, prefix, effectiveMaxLen);
 
     try {
       let result: U;
@@ -307,17 +322,17 @@ const createMeasureImpl = (prefix?: string, counterRef?: { value: number }) => {
         result = await fnInternal(measureForNextLevel as MeasureFn);
       }
       const duration = performance.now() - start;
-      emit({ type: 'success', id: idStr, label, depth, duration, result, budget }, prefix);
+      emit({ type: 'success', id: idStr, label, depth, duration, result, budget, maxResultLength: effectiveMaxLen }, prefix);
       return result;
     } catch (error) {
       const duration = performance.now() - start;
-      emit({ type: 'error', id: idStr, label, depth, duration, error, budget }, prefix);
+      emit({ type: 'error', id: idStr, label, depth, duration, error, budget, maxResultLength: effectiveMaxLen }, prefix);
       _lastError = error;
       if (onError) {
         try {
           return onError(error);
         } catch (onErrorError) {
-          emit({ type: 'error', id: idStr, label: `${label} (onError)`, depth, duration: performance.now() - start, error: onErrorError, budget }, prefix);
+          emit({ type: 'error', id: idStr, label: `${label} (onError)`, depth, duration: performance.now() - start, error: onErrorError, budget, maxResultLength: effectiveMaxLen }, prefix);
           _lastError = onErrorError;
           return null;
         }
@@ -330,13 +345,17 @@ const createMeasureImpl = (prefix?: string, counterRef?: { value: number }) => {
     fnInternal: (measure: MeasureSyncFn) => U,
     actionInternal: string | object,
     parentIdChain: (string | number)[],
-    depth: number
+    depth: number,
+    _onError?: undefined,
+    inheritedMaxLen?: number
   ): U | null => {
     const start = performance.now();
     const childCounterRef = { value: 0 };
     const label = buildActionLabel(actionInternal);
     const hasNested = fnInternal.length > 0;
     const budget = extractBudget(actionInternal);
+    const localMaxLen = extractMaxResultLength(actionInternal);
+    const effectiveMaxLen = localMaxLen ?? inheritedMaxLen;
 
     const currentId = toAlpha(parentIdChain.pop() ?? 0);
     const fullIdChain = [...parentIdChain, currentId];
@@ -352,16 +371,16 @@ const createMeasureImpl = (prefix?: string, counterRef?: { value: number }) => {
       }, prefix);
     }
 
-    const measureForNextLevel = createNestedResolver(false, fullIdChain, childCounterRef, depth, _measureInternalSync, prefix);
+    const measureForNextLevel = createNestedResolver(false, fullIdChain, childCounterRef, depth, _measureInternalSync, prefix, effectiveMaxLen);
 
     try {
       const result = fnInternal(measureForNextLevel as MeasureSyncFn);
       const duration = performance.now() - start;
-      emit({ type: 'success', id: idStr, label, depth, duration, result, budget }, prefix);
+      emit({ type: 'success', id: idStr, label, depth, duration, result, budget, maxResultLength: effectiveMaxLen }, prefix);
       return result;
     } catch (error) {
       const duration = performance.now() - start;
-      emit({ type: 'error', id: idStr, label, depth, duration, error, budget }, prefix);
+      emit({ type: 'error', id: idStr, label, depth, duration, error, budget, maxResultLength: effectiveMaxLen }, prefix);
       _lastError = error;
       return null;
     }

package/package.json

@@ -3,7 +3,7 @@
   "module": "index.ts",
   "main": "./index.ts",
   "types": "./index.ts",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "type": "module",
   "private": false,
   "description": "Zero-dependency function performance measurement with hierarchical logging",