fix: update process performance entry after pairing

Author: xnanodax

src/v3/getSpanFromPerformanceEntry.ts

@@ -0,0 +1,75 @@
+import { getCommonUrlForTracing } from "../main";
+import { ensureTimestamp } from "./ensureTimestamp";
+import { Attributes, EntryType, InitiatorType, ScopeBase, Timestamp, TraceEntry } from "./types"
+
+/**
+ * Maps Performance Entry to Trace Entry
+ * @param inputEntry - The performance entry event.
+ * @returns {TraceEntry} The trace entry.
+ */
+export function getSpanFromPerformanceEntry<ScopeT extends ScopeBase>(
+  inputEntry: PerformanceEntry,
+): TraceEntry<ScopeT> | undefined {
+
+  // react in dev mode generates hundreds of these marks, ignore them
+  if (inputEntry.entryType === 'mark' && inputEntry.name.startsWith('--')) {
+    return undefined
+  }
+
+  const attributes =
+    'details' in inputEntry && typeof inputEntry.detail === 'object' && inputEntry.details !== null
+      ? inputEntry.details as Attributes
+      : {}
+
+  const type = inputEntry.entryType as EntryType;
+  let { name } = inputEntry;
+
+  if (inputEntry.entryType === 'resource' || inputEntry.entryType === 'navigation') {
+    const { commonUrl, query, hash } = getCommonUrlForTracing(inputEntry.name)
+    name = commonUrl
+
+    // write a function in lotus to extract from datadog's SDK rather than hardcoding the implementation
+    if (inputEntry.entryType === 'resource') {
+      const resourceTiming = inputEntry as PerformanceResourceTiming
+
+      return {
+        type,
+        name,
+        startTime: ensureTimestamp({ now: inputEntry.startTime }),
+        attributes,
+        duration: inputEntry.duration,
+        // status,
+        performanceEntry: inputEntry,
+        resourceDetails: {
+          initiatorType: resourceTiming.initiatorType as InitiatorType,
+          query,
+          hash
+        }
+      }
+    }
+  } else if (inputEntry.entryType !== 'mark' && inputEntry.entryType !== 'measure') {
+    name = `${inputEntry.entryType}${inputEntry.name &&
+      inputEntry.name !== 'unknown' &&
+      inputEntry.name.length > 0 &&
+      inputEntry.entryType !== inputEntry.name
+      ? `/${inputEntry.name}`
+      : ''
+      }`
+  }
+
+  const timestamp: Partial<Timestamp> = {
+    now: inputEntry.startTime
+  }
+
+  const traceEntry: TraceEntry<ScopeT> = {
+    type,
+    name,
+    startTime: ensureTimestamp(timestamp),
+    attributes,
+    duration: inputEntry.duration,
+    // status,
+    performanceEntry: inputEntry,
+  }
+
+  return traceEntry
+}

src/v3/processPerformanceEntry.ts

@@ -1,7 +1,7 @@
 // import { Trace } from './Trace'
 import { ActiveTrace } from './ActiveTrace'
 import { ensureTimestamp } from './ensureTimestamp'
-import { processPerformanceEntry } from './processPerformanceEntry'
+import { getSpanFromPerformanceEntry } from './getSpanFromPerformanceEntry'
 import type {
   CompleteTraceDefinition,
   ComputedSpanDefinition,
@@ -119,11 +119,10 @@ const observePerformanceWithTraceManager = <ScopeT extends ScopeBase>(traceManag
 
   const observer = new PerformanceObserver((entryList) => {
     entryList.getEntries().forEach((entry) => {
-      const traceEntry = processPerformanceEntry<ScopeT>(entry)
+      const traceEntry = getSpanFromPerformanceEntry<ScopeT>(entry)
       if (traceEntry !== undefined) {
         traceManager.processEntry(traceEntry)
       }
-
     })
   })
 

src/v3/traceManager.ts

@@ -26,7 +26,7 @@ export type ComponentLifecycleEntryType =
   | 'component-render'
   | 'component-unmount'
 
-export type EntryType = NativePerformanceEntryType | ComponentLifecycleEntryType | 'asset' | 'iframe'
+export type EntryType = NativePerformanceEntryType | ComponentLifecycleEntryType
 
 export interface Timestamp {
   // absolute count of ms from epoch
@@ -61,34 +61,6 @@ export interface ActiveTraceConfig<ScopeT extends ScopeBase>
 export type TraceEntryStatus = 'ok' | 'error'
 
 export interface Attributes {
-  resource?: {
-    type?:
-    | 'document'
-    | 'xhr'
-    | 'beacon'
-    | 'fetch'
-    | 'css'
-    | 'js'
-    | 'image'
-    | 'font'
-    | 'media'
-    | 'other'
-    | 'native'
-    method?:
-    | 'POST'
-    | 'GET'
-    | 'HEAD'
-    | 'PUT'
-    | 'DELETE'
-    | 'PATCH'
-    | 'TRACE'
-    | 'OPTIONS'
-    | 'CONNECT'
-    status?: number | undefined
-  }
-  resourceQuery?: Record<string, string | string[]>
-  resourceHash?: string
-
   [key: string]: unknown
 }
 
@@ -103,7 +75,9 @@ export interface TraceEntryBase<ScopeT extends ScopeBase> {
 
   startTime: Timestamp
 
-  scope: ScopeT
+  // non performance entries, scope would be coming from outside like ticket id or user id
+  // performance entries, there is no scope OR scope is in performance detail
+  scope?: ScopeT
 
   attributes: Attributes
 
@@ -117,7 +91,8 @@ export interface TraceEntryBase<ScopeT extends ScopeBase> {
   /**
    * Status of the trace entry ('error' or 'ok').
    */
-  status: TraceEntryStatus
+  // TODO: come back to this decision
+  status?: TraceEntryStatus
 
   /**
    * The original PerformanceEntry from which the TraceEntry
@@ -137,12 +112,45 @@ export interface ComponentRenderTraceEntry<ScopeT extends ScopeBase>
   errorInfo?: ErrorInfo
 }
 
+export type InitiatorType =
+  | 'audio'
+  | 'beacon'
+  | 'body'
+  | 'css'
+  | 'early-hint'
+  | 'embed'
+  | 'fetch'
+  | 'frame'
+  | 'iframe'
+  | 'icon'
+  | 'image'
+  | 'img'
+  | 'input'
+  | 'link'
+  | 'navigation'
+  | 'object'
+  | 'ping'
+  | 'script'
+  | 'track'
+  | 'video'
+  | 'xmlhttprequest'
+  | 'other';
+
+export interface ResourceSpan<ScopeT extends ScopeBase> extends TraceEntryBase<ScopeT> {
+  resourceDetails: {
+    initiatorType: InitiatorType
+    query: Record<string, string | string[]>
+    hash: string
+  }
+}
+
 /**
  * All possible trace entries
  */
 export type TraceEntry<ScopeT extends ScopeBase> =
   | TraceEntryBase<ScopeT>
   | ComponentRenderTraceEntry<ScopeT>
+  | ResourceSpan<ScopeT>
 
 /**
  * Criteria for matching performance entries.