refactor: adjust metadata implementation

Author: BioPhoton

packages/utils/src/lib/profiler/trace-file-utils.ts

@@ -281,15 +281,18 @@ export const deserializeTraceEvent = (json: string): TraceEvent =>
  * @param metadata - Optional additional metadata to merge into the trace metadata
  * @returns TraceMetadata object with source, startTime, and merged custom metadata
  */
-export function getTraceMetadata(
-  startDate?: Date,
-  metadata?: Record<string, unknown>,
-): TraceMetadata {
+export function getTraceMetadata({
+  startDate,
+  ...metadata
+}: Partial<TraceMetadata> = {}): TraceMetadata {
+  const parsedStartDate = (
+    startDate instanceof Date ? startDate : new Date()
+  ).toISOString();
   return {
     source: 'DevTools',
-    startTime: startDate?.toISOString() ?? new Date().toISOString(),
-    hardwareConcurrency: 1,
+    startTime: parsedStartDate,
     dataOrigin: 'TraceEvents',
+    hardwareConcurrency: navigator.hardwareConcurrency,
     ...metadata,
   };
 }
@@ -301,13 +304,9 @@ export function getTraceMetadata(
  */
 export const createTraceFile = (opt: {
   traceEvents: TraceEvent[];
-  startTime?: string;
   metadata?: Partial<TraceMetadata>;
 }): TraceEventContainer => ({
   traceEvents: opt.traceEvents.map(encodeEvent),
   displayTimeUnit: 'ms',
-  metadata: getTraceMetadata(
-    opt.startTime ? new Date(opt.startTime) : new Date(),
-    opt.metadata,
-  ),
+  metadata: getTraceMetadata(opt.metadata),
 });

packages/utils/src/lib/profiler/trace-file-utils.unit.test.ts

@@ -62,7 +62,9 @@ describe('getTraceFile', () => {
   it('should use custom startTime when provided', () => {
     const result = createTraceFile({
       traceEvents: [],
-      startTime: '2023-01-01T00:00:00.000Z',
+      metadata: {
+        startTime: '2023-01-01T00:00:00.000Z',
+      },
     });
 
     expect(result).toHaveProperty(
@@ -520,14 +522,14 @@ describe('getTraceMetadata', () => {
 
   it('should use provided startDate', () => {
     const startDate = new Date('2023-01-01T00:00:00.000Z');
-    const metadata = getTraceMetadata(startDate);
+    const metadata = getTraceMetadata({ startDate });
 
     expect(metadata.startTime).toBe('2023-01-01T00:00:00.000Z');
   });
 
   it('should merge custom metadata', () => {
     const customMetadata = { version: '1.0.0', platform: 'node' };
-    const metadata = getTraceMetadata(undefined, customMetadata);
+    const metadata = getTraceMetadata(customMetadata);
 
     expect(metadata).toStrictEqual({
       source: 'DevTools',

packages/utils/src/lib/profiler/wal-json-trace.ts

@@ -5,11 +5,10 @@ import {
   complete,
   createTraceFile,
   deserializeTraceEvent,
-  encodeEvent,
   getInstantEventTracingStartedInBrowser,
   serializeTraceEvent,
 } from './trace-file-utils.js';
-import type { TraceEvent } from './trace-file.type.js';
+import type { TraceEvent, TraceMetadata } from './trace-file.type.js';
 
 /** Name for the trace start margin event */
 const TRACE_START_MARGIN_NAME = '[trace padding start]';
@@ -22,40 +21,37 @@ const TRACE_MARGIN_DURATION_US = 20_000;
 
 export function generateTraceContent(
   events: TraceEvent[],
-  metadata?: Record<string, unknown>,
+  metadata?: Partial<TraceMetadata>,
 ): string {
-  const traceContainer = createTraceFile({
-    traceEvents: events,
-    startTime: new Date().toISOString(),
-    metadata: {
-      ...metadata,
-      generatedAt: new Date().toISOString(),
-    },
-  });
-
   const fallbackTs = defaultClock.epochNowUs();
   const sortedEvents =
     events.length > 0 ? [...events].sort((a, b) => a.ts - b.ts) : [];
 
   const firstTs = sortedEvents.at(0)?.ts ?? fallbackTs;
   const lastTs = sortedEvents.at(-1)?.ts ?? fallbackTs;
 
-  return JSON.stringify({
-    ...traceContainer,
-    traceEvents: [
-      getInstantEventTracingStartedInBrowser({
-        ts: firstTs - TRACE_MARGIN_US,
-        url: events.length > 0 ? 'generated-trace' : 'empty-trace',
-      }),
-      complete(TRACE_START_MARGIN_NAME, TRACE_MARGIN_DURATION_US, {
-        ts: firstTs - TRACE_MARGIN_US,
-      }),
-      ...sortedEvents.map(encodeEvent),
-      complete(TRACE_END_MARGIN_NAME, TRACE_MARGIN_DURATION_US, {
-        ts: lastTs + TRACE_MARGIN_US,
-      }),
-    ],
-  });
+  return JSON.stringify(
+    createTraceFile({
+      traceEvents: [
+        getInstantEventTracingStartedInBrowser({
+          ts: firstTs - TRACE_MARGIN_US,
+          // TODO: add the stringifies command of the process that was traced when sharded WAL is implemented in profiler
+          url: events.length > 0 ? 'generated-trace' : 'empty-trace',
+        }),
+        complete(TRACE_START_MARGIN_NAME, TRACE_MARGIN_DURATION_US, {
+          ts: firstTs - TRACE_MARGIN_US,
+        }),
+        ...sortedEvents,
+        complete(TRACE_END_MARGIN_NAME, TRACE_MARGIN_DURATION_US, {
+          ts: lastTs + TRACE_MARGIN_US,
+        }),
+      ],
+      metadata: {
+        ...metadata,
+        startTime: new Date(firstTs / 1000).toISOString(),
+      },
+    }),
+  );
 }
 
 /**
@@ -79,7 +75,7 @@ export function traceEventWalFormat() {
     finalExtension: '.json',
     codec: traceEventCodec,
     finalizer: (
-      records: (TraceEvent | InvalidEntry<string>)[],
+      records: (TraceEvent | InvalidEntry)[],
       metadata?: Record<string, unknown>,
     ) =>
       generateTraceContent(

packages/utils/src/lib/profiler/wal-json-trace.unit.test.ts

@@ -154,31 +154,28 @@ describe('traceEventCodec', () => {
   describe('encode direction (memory object → JSON string)', () => {
     it('should encode instant event to JSON string', () => {
       const encoded = traceEventCodec.encode(instantEvent);
-      expect(typeof encoded).toBe('string');
       const parsed = JSON.parse(encoded);
       expect(parsed.args.detail).toBe(JSON.stringify({ custom: 'data' }));
       expect(parsed.args.data.detail).toBe(JSON.stringify({ nested: 'value' }));
     });
 
     it('should encode span begin event to JSON string', () => {
       const encoded = traceEventCodec.encode(spanBeginEvent);
-      expect(typeof encoded).toBe('string');
       const decoded = traceEventCodec.decode(encoded);
       expect(decoded).toStrictEqual(spanBeginEvent);
     });
 
     it('should encode span end event to JSON string', () => {
       const encoded = traceEventCodec.encode(spanEndEvent);
-      expect(typeof encoded).toBe('string');
       const decoded = traceEventCodec.decode(encoded);
       expect(decoded).toStrictEqual(spanEndEvent);
     });
 
     it('should encode nested detail objects as JSON strings', () => {
       const encoded = traceEventCodec.encode(instantEvent);
       const parsed = JSON.parse(encoded);
-      expect(typeof parsed.args.detail).toBe('string');
-      expect(typeof parsed.args.data.detail).toBe('string');
+      expect(parsed.args.detail).toBeString();
+      expect(parsed.args.data.detail).toBeString();
       expect(JSON.parse(parsed.args.detail)).toStrictEqual({ custom: 'data' });
       expect(JSON.parse(parsed.args.data.detail)).toStrictEqual({
         nested: 'value',
@@ -221,7 +218,7 @@ describe('traceEventCodec', () => {
 describe('generateTraceContent', () => {
   it('should generate trace content for empty events array', () => {
     const events: TraceEvent[] = [];
-    const metadata = { version: '1.0.0', generatedAt: '2024-01-01T00:00:00Z' };
+    const metadata = { version: '1.0.0' };
 
     const result = generateTraceContent(events, metadata);
 
@@ -262,7 +259,6 @@ describe('generateTraceContent', () => {
         hardwareConcurrency: 1,
         dataOrigin: 'TraceEvents',
         version: '1.0.0',
-        generatedAt: expect.any(String),
       },
     });
   });
@@ -336,7 +332,6 @@ describe('generateTraceContent', () => {
         startTime: expect.any(String),
         hardwareConcurrency: 1,
         dataOrigin: 'TraceEvents',
-        generatedAt: expect.any(String),
       },
     });
   });
@@ -471,7 +466,6 @@ describe('traceEventWalFormat', () => {
     };
 
     const encoded = format.codec.encode(testEvent);
-    expect(typeof encoded).toBe('string');
 
     const decoded = format.codec.decode(encoded);
     expect(decoded).toStrictEqual(testEvent);
@@ -519,25 +513,9 @@ describe('traceEventWalFormat', () => {
 
     const result = format.finalizer(records);
 
-    expect(typeof result).toBe('string');
     const parsed = JSON.parse(result);
     expect(parsed).toHaveProperty('traceEvents');
     expect(parsed).toHaveProperty('metadata');
     expect(parsed.traceEvents).toBeArray();
   });
-
-  it('should include generatedAt in finalizer metadata', () => {
-    const format = traceEventWalFormat();
-    const records: TraceEvent[] = [];
-
-    const result = format.finalizer(records);
-    const parsed = JSON.parse(result);
-
-    expect(parsed.metadata).toHaveProperty('generatedAt');
-    expect(typeof parsed.metadata.generatedAt).toBe('string');
-    // Should be recent timestamp
-    expect(new Date(parsed.metadata.generatedAt).getTime()).toBeGreaterThan(
-      Date.now() - 10_000,
-    );
-  });
 });

testing/test-setup-config/src/lib/vitest-setup-files.ts

@@ -27,6 +27,7 @@ const UNIT_TEST_SETUP_FILES = [
   '../../testing/test-setup/src/lib/performance.setup-file.ts',
   '../../testing/test-setup/src/lib/portal-client.mock.ts',
   '../../testing/test-setup/src/lib/process.setup-file.ts',
+  '../../testing/test-setup/src/lib/navigator.setup-file.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
 

testing/test-setup/src/lib/navigator.setup-file.ts

@@ -0,0 +1,5 @@
+beforeEach(() => {
+  vi.stubGlobal('navigator', {
+    hardwareConcurrency: 1,
+  });
+});