@contrail/util 1.1.15-alpha-3 → 1.1.15-alpha-5

package/lib/performance-util/example-usage.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/performance-util/example-usage.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const performance_util_1 = require("./performance-util");
+function demonstrateStartEndSpan() {
+    console.log('--- Demonstrating startSpan/endSpan functionality ---\n');
+    (0, performance_util_1.clearDefaultTimingProfile)();
+    console.log('Example 1: Simple span');
+    (0, performance_util_1.startSpan)('Data Processing');
+    const start1 = performance.now();
+    while (performance.now() < start1 + 100) {
+    }
+    (0, performance_util_1.endSpan)('Data Processing');
+    (0, performance_util_1.displayTimingTree)();
+    console.log('\nExample 2: Nested spans');
+    (0, performance_util_1.clearDefaultTimingProfile)();
+    (0, performance_util_1.startSpan)('Complete Task');
+    (0, performance_util_1.startSpan)('Initialization');
+    const start2 = performance.now();
+    while (performance.now() < start2 + 50) { }
+    (0, performance_util_1.endSpan)('Initialization');
+    (0, performance_util_1.startSpan)('Main Processing');
+    (0, performance_util_1.startSpan)('Sub-task 1');
+    const start3 = performance.now();
+    while (performance.now() < start3 + 30) { }
+    (0, performance_util_1.endSpan)('Sub-task 1');
+    (0, performance_util_1.startSpan)('Sub-task 2');
+    const start4 = performance.now();
+    while (performance.now() < start4 + 40) { }
+    (0, performance_util_1.endSpan)('Sub-task 2');
+    (0, performance_util_1.endSpan)('Main Processing');
+    (0, performance_util_1.startSpan)('Cleanup');
+    const start5 = performance.now();
+    while (performance.now() < start5 + 20) { }
+    (0, performance_util_1.endSpan)('Cleanup');
+    (0, performance_util_1.endSpan)('Complete Task');
+    (0, performance_util_1.displayTimingTree)();
+    console.log('\nExample 3: Multiple sequential spans');
+    (0, performance_util_1.clearDefaultTimingProfile)();
+    (0, performance_util_1.startSpan)('Phase 1');
+    const start6 = performance.now();
+    while (performance.now() < start6 + 60) { }
+    (0, performance_util_1.endSpan)('Phase 1');
+    (0, performance_util_1.startSpan)('Phase 2');
+    const start7 = performance.now();
+    while (performance.now() < start7 + 80) { }
+    (0, performance_util_1.endSpan)('Phase 2');
+    (0, performance_util_1.startSpan)('Phase 3');
+    const start8 = performance.now();
+    while (performance.now() < start8 + 40) { }
+    (0, performance_util_1.endSpan)('Phase 3');
+    (0, performance_util_1.displayTimingTree)();
+}
+function demonstrateWarningBehavior() {
+    console.log('\n--- Demonstrating Warning Behavior ---\n');
+    (0, performance_util_1.clearDefaultTimingProfile)();
+    console.log('Example 4: Warning behavior');
+    (0, performance_util_1.startSpan)('Test Span');
+    console.log('Started "Test Span"');
+    (0, performance_util_1.startSpan)('Test Span');
+    console.log('Attempted to start "Test Span" again (should see warning above)');
+    (0, performance_util_1.endSpan)('Test Span');
+    console.log('Ended "Test Span"');
+    (0, performance_util_1.endSpan)('Non-existent Span');
+    console.log('Attempted to end "Non-existent Span" (should see warning above)');
+    (0, performance_util_1.displayTimingTree)();
+}
+demonstrateStartEndSpan();
+demonstrateWarningBehavior();

package/lib/performance-util/performance-util.d.ts

@@ -5,13 +5,20 @@ type TimingNode = {
     durationMs: number;
     children: TimingNode[];
 };
+type ActiveSpan = {
+    node: TimingNode;
+    startTime: number;
+};
 type TimingProfile = {
     timingSpans: TimingSpans;
     timingStack: TimingStack;
+    activeSpans: Map<string, ActiveSpan>;
 };
 export declare function getDefaultTimingProfile(): TimingProfile;
 export declare function clearDefaultTimingProfile(): void;
 export declare function withTimingAsync<T>(label: string, fn: () => Promise<T>): Promise<T>;
 export declare function withTimingSync<T>(label: string, fn: () => T): T;
 export declare function displayTimingTree(nodes?: TimingSpans, depth?: number): string;
+export declare function startSpan(spanName: string): void;
+export declare function endSpan(spanName: string): void;
 export {};

package/lib/performance-util/performance-util.js

@@ -14,9 +14,12 @@ exports.clearDefaultTimingProfile = clearDefaultTimingProfile;
 exports.withTimingAsync = withTimingAsync;
 exports.withTimingSync = withTimingSync;
 exports.displayTimingTree = displayTimingTree;
+exports.startSpan = startSpan;
+exports.endSpan = endSpan;
 const DEFAULT_TIMING_PROFILE = {
     timingSpans: [],
     timingStack: [],
+    activeSpans: new Map(),
 };
 function getDefaultTimingProfile() {
     return DEFAULT_TIMING_PROFILE;
@@ -30,6 +33,7 @@ function getTimingSpans() {
 function clearDefaultTimingProfile() {
     DEFAULT_TIMING_PROFILE.timingSpans = [];
     DEFAULT_TIMING_PROFILE.timingStack = [];
+    DEFAULT_TIMING_PROFILE.activeSpans.clear();
 }
 function withTimingAsync(label, fn) {
     return __awaiter(this, void 0, void 0, function* () {
@@ -93,3 +97,43 @@ function displayTimingTree(nodes = DEFAULT_TIMING_PROFILE.timingSpans, depth = 0
     }
     return result;
 }
+function startSpan(spanName) {
+    if (DEFAULT_TIMING_PROFILE.activeSpans.has(spanName)) {
+        console.warn(`Span "${spanName}" is already active. Please end it before starting a new one with the same name.`);
+        return;
+    }
+    const startTime = performance.now();
+    const timingNode = { label: spanName, durationMs: 0, children: [] };
+    const parent = getTimingStack().length > 0 ? getTimingStack()[getTimingStack().length - 1] : null;
+    if (parent) {
+        parent.children.push(timingNode);
+    }
+    else {
+        getTimingSpans().push(timingNode);
+    }
+    getTimingStack().push(timingNode);
+    DEFAULT_TIMING_PROFILE.activeSpans.set(spanName, {
+        node: timingNode,
+        startTime: startTime,
+    });
+}
+function endSpan(spanName) {
+    const activeSpan = DEFAULT_TIMING_PROFILE.activeSpans.get(spanName);
+    if (!activeSpan) {
+        console.warn(`No active span found with name "${spanName}". Make sure to call startSpan() first.`);
+        return;
+    }
+    const endTime = performance.now();
+    activeSpan.node.durationMs = endTime - activeSpan.startTime;
+    const currentTop = getTimingStack()[getTimingStack().length - 1];
+    if (currentTop === activeSpan.node) {
+        getTimingStack().pop();
+    }
+    else {
+        const stackIndex = getTimingStack().findIndex(node => node === activeSpan.node);
+        if (stackIndex !== -1) {
+            getTimingStack().splice(stackIndex, 1);
+        }
+    }
+    DEFAULT_TIMING_PROFILE.activeSpans.delete(spanName);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/util",
-  "version": "1.1.15-alpha-3",
+  "version": "1.1.15-alpha-5",
   "description": "General JavaScript utilities",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",