fix: onEnd accepts Context + TraceContext name

Author: bbrzoska

src/main.ts

@@ -57,7 +57,6 @@ export type * from './v3/hooksTypes'
 import * as match from './v3/matchSpan'
 export { match }
 export type {
-  Context,
   NameMatcher,
   SpanMatch,
   SpanMatchDefinition,

src/v3/ActiveTrace.ts

@@ -12,7 +12,6 @@ import {
   createCPUIdleProcessor,
 } from './firstCPUIdle'
 import { getSpanKey } from './getSpanKey'
-import { Context } from './matchSpan'
 import { createTraceRecording } from './recordingComputeUtils'
 import type {
   SpanAndAnnotation,
@@ -26,6 +25,7 @@ import type {
   SpanDeduplicationStrategy,
   TraceInterruptionReason,
 } from './types'
+import { TraceContext } from './types'
 import type {
   DistributiveOmit,
   KeysOfUnion,
@@ -111,7 +111,7 @@ type EntryType<AllPossibleScopesT> = PerformanceEntryLike & {
 interface StateMachineContext<
   TracerScopeKeysT extends KeysOfUnion<AllPossibleScopesT>,
   AllPossibleScopesT,
-> extends Context<TracerScopeKeysT, AllPossibleScopesT> {
+> extends TraceContext<TracerScopeKeysT, AllPossibleScopesT> {
   readonly requiredToEndIndexChecklist: Set<number>
 }
 
@@ -766,7 +766,7 @@ export class ActiveTrace<
         },
         transition,
       )
-      this.input.onEnd(traceRecording)
+      this.input.onEnd(traceRecording, this)
 
       // memory clean-up in case something retains the ActiveTrace instance
       this.recordedItems = []

src/v3/convertToRum.ts

@@ -1,10 +1,10 @@
 /* eslint-disable @typescript-eslint/consistent-indexed-object-style */
 import { getSpanKey } from './getSpanKey'
-import type { Context, SpanMatcherFn } from './matchSpan'
+import type { SpanMatcherFn } from './matchSpan'
 import { SpanAndAnnotation } from './spanAnnotationTypes'
 import { ComponentRenderSpan, Span } from './spanTypes'
 import { TraceRecording, TraceRecordingBase } from './traceRecordingTypes'
-import type { SelectScopeByKey } from './types'
+import type { SelectScopeByKey, TraceContext } from './types'
 import type { KeysOfUnion } from './typeUtils'
 
 export interface EmbeddedEntry {
@@ -94,7 +94,7 @@ export function convertTraceToRUM<
   AllPossibleScopesT,
 >(
   traceRecording: TraceRecording<TracerScopeKeysT, AllPossibleScopesT>,
-  context: Context<TracerScopeKeysT, AllPossibleScopesT>,
+  context: TraceContext<TracerScopeKeysT, AllPossibleScopesT>,
   embedSpanSelector: SpanMatcherFn<
     TracerScopeKeysT,
     AllPossibleScopesT

src/v3/matchSpan.ts

@@ -1,30 +1,12 @@
 import type { SpanAndAnnotation } from './spanAnnotationTypes'
-import type {
-  ActiveTraceContext,
-  Attributes,
-  SpanStatus,
-  SpanType,
-} from './spanTypes'
-import type { CompleteTraceDefinition, SelectScopeByKey } from './types'
+import type { Attributes, SpanStatus, SpanType } from './spanTypes'
+import type { SelectScopeByKey, TraceContext } from './types'
 import type { KeysOfUnion } from './typeUtils'
 
 export interface SpanMatcherTags {
   isIdle?: boolean
 }
 
-export interface Context<
-  TracerScopeKeysT extends KeysOfUnion<AllPossibleScopesT>,
-  AllPossibleScopesT,
-> {
-  readonly definition: CompleteTraceDefinition<
-    TracerScopeKeysT,
-    AllPossibleScopesT
-  >
-  readonly input: ActiveTraceContext<
-    SelectScopeByKey<TracerScopeKeysT, AllPossibleScopesT>
-  >
-}
-
 /**
  * Function type for matching performance entries.
  */
@@ -34,7 +16,7 @@ export interface SpanMatcherFn<
 > extends SpanMatcherTags {
   (
     spanAndAnnotation: SpanAndAnnotation<AllPossibleScopesT>,
-    context: Context<TracerScopeKeysT, AllPossibleScopesT>,
+    context: TraceContext<TracerScopeKeysT, AllPossibleScopesT>,
   ): boolean
 }
 

src/v3/spanTypes.ts

@@ -1,7 +1,11 @@
 import type { ErrorInfo } from 'react'
 import type { BeaconConfig } from './hooksTypes'
-import type { TraceRecording } from './traceRecordingTypes'
-import type { ScopeOnASpan, SelectScopeByKey, Timestamp } from './types'
+import type {
+  ScopeOnASpan,
+  SelectScopeByKey,
+  SingleTraceReportFn,
+  Timestamp,
+} from './types'
 import type { KeysOfUnion } from './typeUtils'
 
 export type NativePerformanceEntryType =
@@ -37,12 +41,7 @@ export interface StartTraceConfig<TracerScopeT> {
   attributes?: Attributes
 }
 
-export type OnEndFn<
-  TracerScopeKeysT extends KeysOfUnion<AllPossibleScopesT>,
-  AllPossibleScopesT,
-> = (trace: TraceRecording<TracerScopeKeysT, AllPossibleScopesT>) => void
-
-export interface ActiveTraceContext<TracerScopeT>
+export interface ActiveTraceInput<TracerScopeT>
   extends StartTraceConfig<TracerScopeT> {
   id: string
   startTime: Timestamp
@@ -51,10 +50,10 @@ export interface ActiveTraceContext<TracerScopeT>
 export interface ActiveTraceConfig<
   TracerScopeKeysT extends KeysOfUnion<AllPossibleScopesT>,
   AllPossibleScopesT,
-> extends ActiveTraceContext<
+> extends ActiveTraceInput<
     SelectScopeByKey<TracerScopeKeysT, AllPossibleScopesT>
   > {
-  onEnd: OnEndFn<TracerScopeKeysT, AllPossibleScopesT>
+  onEnd: SingleTraceReportFn<TracerScopeKeysT, AllPossibleScopesT>
 }
 
 // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style

src/v3/traceManager.ts

@@ -7,9 +7,10 @@ import {
 import { ensureTimestamp } from './ensureTimestamp'
 import { type SpanMatcherFn } from './matchSpan'
 import type { SpanAnnotationRecord } from './spanAnnotationTypes'
-import type { Span, StartTraceConfig } from './spanTypes'
+import type { ActiveTraceInput, Span, StartTraceConfig } from './spanTypes'
 import type { TraceRecording } from './traceRecordingTypes'
 import type {
+  type TraceContext,
   CompleteTraceDefinition,
   ComputedSpanDefinition,
   ComputedValueDefinition,
@@ -157,6 +158,18 @@ export class TraceManager<
 
     const id = input.id ?? this.generateId()
 
+    const activeTraceContext: TraceContext<
+      TracerScopeKeysT,
+      AllPossibleScopesT
+    > = {
+      definition,
+      input: {
+        ...input,
+        startTime: ensureTimestamp(input.startTime),
+        id,
+      },
+    }
+
     const onEnd = (
       traceRecording: TraceRecording<TracerScopeKeysT, AllPossibleScopesT>,
     ) => {
@@ -169,17 +182,12 @@ export class TraceManager<
           TracerScopeKeysT,
           AllPossibleScopesT
         >
-      )(traceRecording)
+      )(traceRecording, activeTraceContext)
     }
 
     const activeTrace = new ActiveTrace<TracerScopeKeysT, AllPossibleScopesT>(
       definition,
-      {
-        ...input,
-        startTime: ensureTimestamp(input.startTime),
-        id,
-        onEnd,
-      },
+      { ...activeTraceContext.input, onEnd },
       this.performanceEntryDeduplicationStrategy,
     )
 

src/v3/types.ts

@@ -1,12 +1,13 @@
 import type { CPUIdleProcessorOptions } from './firstCPUIdle'
-import type {
-  Context,
-  SpanMatch,
-  SpanMatchDefinition,
-  SpanMatcherFn,
-} from './matchSpan'
+import type { SpanMatch, SpanMatchDefinition, SpanMatcherFn } from './matchSpan'
 import type { SpanAndAnnotation } from './spanAnnotationTypes'
-import type { Span, SpanStatus, SpanType, StartTraceConfig } from './spanTypes'
+import type {
+  ActiveTraceInput,
+  Span,
+  SpanStatus,
+  SpanType,
+  StartTraceConfig,
+} from './spanTypes'
 import type { TraceRecording } from './traceRecordingTypes'
 import type {
   ArrayWithAtLeastOneElement,
@@ -52,7 +53,7 @@ export type SingleTraceReportFn<
   AllPossibleScopesT,
 > = (
   trace: TraceRecording<TracerScopeKeysT, AllPossibleScopesT>,
-  context: Context<TracerScopeKeysT, AllPossibleScopesT>,
+  context: TraceContext<TracerScopeKeysT, AllPossibleScopesT>,
 ) => void
 
 export type ReportFn<
@@ -372,3 +373,16 @@ export type SelectScopeByKey<
 export type DeriveScopeFromPerformanceEntryFn<AllPossibleScopesT> = (
   entry: PerformanceEntry,
 ) => ScopeOnASpan<AllPossibleScopesT> | undefined
+
+export interface TraceContext<
+  TracerScopeKeysT extends KeysOfUnion<AllPossibleScopesT>,
+  AllPossibleScopesT,
+> {
+  readonly definition: CompleteTraceDefinition<
+    TracerScopeKeysT,
+    AllPossibleScopesT
+  >
+  readonly input: ActiveTraceInput<
+    SelectScopeByKey<TracerScopeKeysT, AllPossibleScopesT>
+  >
+}