rename scope -> relation

Author: xnanodax

src/v3/TraceManagerWithFixtures.test.ts

@@ -13,11 +13,11 @@ import {
 } from './testUtility/fixtures/relationSchemas'
 import { shouldCompleteAndHaveInteractiveTime } from './testUtility/fixtures/shouldCompleteAndHaveInteractiveTime'
 import { shouldNotEndWithInteractiveTimeout } from './testUtility/fixtures/shouldNotEndWithInteractiveTimeout'
-import { ticketActivationDefinition } from './testUtility/fixtures/ticket.activation'
+import { ticketActivatedDefinition } from './testUtility/fixtures/ticket.activated'
 import { TraceManager } from './TraceManager'
 import type { AnyPossibleReportFn } from './types'
 
-interface TicketScope {
+interface TicketIdRelation {
   ticketId: string
 }
 
@@ -31,7 +31,7 @@ describe('TraceManager with Fixtures', () => {
   })
 
   beforeEach(() => {
-    reportFn = jest.fn<AnyPossibleReportFn<TicketScope>>()
+    reportFn = jest.fn<AnyPossibleReportFn<TicketIdRelation>>()
     generateId = jest.fn().mockReturnValue('trace-id')
     reportErrorFn = jest.fn()
   })
@@ -50,14 +50,14 @@ describe('TraceManager with Fixtures', () => {
     })
     const fixtureEntries = shouldCompleteAndHaveInteractiveTime
 
-    const scopeEntry = fixtureEntries.find(
+    const relatedToEntry = fixtureEntries.find(
       (entry) => 'relatedTo' in entry.span,
     )!
     const relatedTo = {
-      ticketId: scopeEntry.span.relatedTo!.ticketId!,
+      ticketId: relatedToEntry.span.relatedTo!.ticketId!,
     }
 
-    const tracer = traceManager.createTracer(ticketActivationDefinition)
+    const tracer = traceManager.createTracer(ticketActivatedDefinition)
     tracer.start({
       relatedTo,
       startTime: fixtureEntries[0]!.span.startTime,
@@ -114,7 +114,7 @@ describe('TraceManager with Fixtures', () => {
         "duration": 1504.4000000059605,
         "id": "trace-id",
         "interruptionReason": undefined,
-        "name": "ticket.activation",
+        "name": "ticket.activated",
         "relatedTo": {
           "ticketId": "74",
         },
@@ -139,13 +139,13 @@ describe('TraceManager with Fixtures', () => {
       reportErrorFn,
     })
     const fixtureEntries = shouldNotEndWithInteractiveTimeout
-    const scopeEntry = fixtureEntries.find(
+    const relatedToEntry = fixtureEntries.find(
       (entry) => 'relatedTo' in entry.span,
     )!
     const relatedTo = {
-      ticketId: scopeEntry.span.relatedTo!.ticketId!,
+      ticketId: relatedToEntry.span.relatedTo!.ticketId!,
     }
-    const tracer = traceManager.createTracer(ticketActivationDefinition)
+    const tracer = traceManager.createTracer(ticketActivatedDefinition)
     tracer.start({
       relatedTo,
       startTime: {
@@ -207,7 +207,7 @@ describe('TraceManager with Fixtures', () => {
         "duration": 1302.3999999910593,
         "id": "trace-id",
         "interruptionReason": undefined,
-        "name": "ticket.activation",
+        "name": "ticket.activated",
         "relatedTo": {
           "ticketId": "74",
         },

src/v3/convertToRum.ts

@@ -50,19 +50,19 @@ export interface RumTraceRecording<RelationSchemaT>
   [key: string]: unknown
 }
 
-export function isRenderEntry<ScopeT>(
-  entry: Span<ScopeT>,
-): entry is ComponentRenderSpan<ScopeT> {
+export function isRenderEntry<RelationSchemasT>(
+  entry: Span<RelationSchemasT>,
+): entry is ComponentRenderSpan<RelationSchemasT> {
   return (
     entry.type === 'component-render' ||
     entry.type === 'component-render-start' ||
     entry.type === 'component-unmount'
   )
 }
 
-function updateEmbeddedEntry<ScopeT>(
+function updateEmbeddedEntry<RelationSchemasT>(
   embeddedEntry: EmbeddedEntry,
-  spanAndAnnotation: SpanAndAnnotation<ScopeT>,
+  spanAndAnnotation: SpanAndAnnotation<RelationSchemasT>,
 ): EmbeddedEntry {
   const { annotation, span } = spanAndAnnotation
   return {
@@ -78,10 +78,10 @@ function updateEmbeddedEntry<ScopeT>(
   }
 }
 
-function createEmbeddedEntry<ScopeT>({
+function createEmbeddedEntry<RelationSchemasT>({
   span,
   annotation,
-}: SpanAndAnnotation<ScopeT>): EmbeddedEntry {
+}: SpanAndAnnotation<RelationSchemasT>): EmbeddedEntry {
   return {
     count: 1,
     totalDuration: span.duration,
@@ -94,8 +94,8 @@ function createEmbeddedEntry<ScopeT>({
   }
 }
 
-export const defaultEmbedSpanSelector = <ScopeT>(
-  spanAndAnnotation: SpanAndAnnotation<ScopeT>,
+export const defaultEmbedSpanSelector = <RelationSchemasT>(
+  spanAndAnnotation: SpanAndAnnotation<RelationSchemasT>,
 ) => {
   const { span } = spanAndAnnotation
   return isRenderEntry(span)

src/v3/hooksTypes.ts

@@ -14,8 +14,8 @@ export type BeaconConfig<RelationSchemasT, RequiredAttributesT = {}> = {
   ? { attributes?: Attributes }
   : { attributes: RequiredAttributesT & Attributes })
 
-export type UseBeacon<ScopeT, RequiredAttributesT> = (
-  beaconConfig: BeaconConfig<ScopeT, RequiredAttributesT>,
+export type UseBeacon<RelationSchemasT, RequiredAttributesT> = (
+  beaconConfig: BeaconConfig<RelationSchemasT, RequiredAttributesT>,
 ) => void
 
 export type GetRelationSchemasTFromTraceManager<

src/v3/idealApi.md

@@ -224,7 +224,7 @@ Valid state transitions:
 ## Datatypes
 
 ```ts
-interface TraceEntryInput<ScopeT extends object> {
+interface TraceEntryInput<RelationSchemasT extends object> {
   type:
     | NativePerformanceEntryType
     | 'component-render-start'
@@ -247,7 +247,7 @@ interface TraceEntryInput<ScopeT extends object> {
 
   status: 'ok' | 'error'
 
-  relatedTo: ScopeT
+  relatedTo: RelationSchemasT
 
   attributes: {
     [name: string]: unknown

src/v3/matchSpan.test.ts

@@ -335,7 +335,7 @@ describe('matchSpan', () => {
     })
   })
 
-  describe('scopeKeys', () => {
+  describe('matchingRelation', () => {
     it('should return true when relatedTo does match', () => {
       const matcher = matchSpan.withAllConditions<
         'ticket',

src/v3/matchSpan.ts

@@ -170,15 +170,16 @@ export function withMatchingRelations<
     // similarly, if the span doesn't have any relatedTo set
     const relatedToInput: Record<string, unknown> | undefined = r
     if (!span.relatedTo || !relatedToInput) return false
-    const spanScope: Record<string, unknown> = span.relatedTo
+    const spanRelatedTo: Record<string, unknown> = span.relatedTo
     const resolvedKeys =
       typeof keys === 'boolean' && keys
         ? Object.keys(relationSchema as object)
         : (keys as string[])
 
     if (!resolvedKeys) return false
     return resolvedKeys.every(
-      (key) => key in spanScope && spanScope[key] === relatedToInput[key],
+      (key) =>
+        key in spanRelatedTo && spanRelatedTo[key] === relatedToInput[key],
     )
   }
 }

src/v3/observePerformanceWithTraceManager.ts

@@ -32,12 +32,12 @@ export const observePerformanceWithTraceManager = <
   RelationSchemasT extends RelationSchemasBase<RelationSchemasT>,
 >({
   traceManager,
-  deriveScopeFromPerformanceEntry,
+  deriveRelationFromPerformanceEntry,
   entryTypes = getBestSupportedEntryTypes(),
   keep,
 }: {
   traceManager: TraceManager<RelationSchemasT>
-  deriveScopeFromPerformanceEntry?: DeriveRelationsFromPerformanceEntryFn<RelationSchemasT>
+  deriveRelationFromPerformanceEntry?: DeriveRelationsFromPerformanceEntryFn<RelationSchemasT>
   entryTypes?: NativePerformanceEntryType[]
   keep?: (entry: PerformanceEntry) => boolean
 }) => {
@@ -48,7 +48,7 @@ export const observePerformanceWithTraceManager = <
       }
       const traceEntry = getSpanFromPerformanceEntry<RelationSchemasT>(
         entry,
-        deriveScopeFromPerformanceEntry,
+        deriveRelationFromPerformanceEntry,
       )
       if (traceEntry !== undefined) {
         traceManager.processSpan(traceEntry)

src/v3/recordingComputeUtils.test.ts

@@ -11,13 +11,13 @@ import {
 } from './testUtility/createMockFactory'
 import type { CompleteTraceDefinition } from './types'
 
-interface AnyScope {
+interface AnyRelation {
   global: {}
 }
 
 const baseDefinitionFixture: CompleteTraceDefinition<
   'global',
-  AnyScope,
+  AnyRelation,
   'origin'
 > = {
   name: 'test-trace',
@@ -155,7 +155,7 @@ describe('recordingComputeUtils', () => {
   describe('getComputedSpans', () => {
     const baseDefinition: CompleteTraceDefinition<
       'global',
-      AnyScope,
+      AnyRelation,
       'origin'
     > = {
       ...baseDefinitionFixture,
@@ -195,16 +195,19 @@ describe('recordingComputeUtils', () => {
     })
 
     it('should handle operation-start and operation-end special matchers', () => {
-      const definition: CompleteTraceDefinition<'global', AnyScope, 'origin'> =
-        {
-          ...baseDefinition,
-          computedSpanDefinitions: {
-            'operation-span': {
-              startSpan: 'operation-start',
-              endSpan: 'operation-end',
-            },
+      const definition: CompleteTraceDefinition<
+        'global',
+        AnyRelation,
+        'origin'
+      > = {
+        ...baseDefinition,
+        computedSpanDefinitions: {
+          'operation-span': {
+            startSpan: 'operation-start',
+            endSpan: 'operation-end',
           },
-        }
+        },
+      }
 
       const markedCompleteSpan = createMockSpanAndAnnotation(200, {
         name: 'end-span',
@@ -233,7 +236,7 @@ describe('recordingComputeUtils', () => {
   describe('getComputedValues', () => {
     const baseDefinition: CompleteTraceDefinition<
       'global',
-      AnyScope,
+      AnyRelation,
       'origin'
     > = {
       ...baseDefinitionFixture,
@@ -266,20 +269,23 @@ describe('recordingComputeUtils', () => {
     })
 
     it('should handle multiple matches in computeValueFromMatches', () => {
-      const definition: CompleteTraceDefinition<'global', AnyScope, 'origin'> =
-        {
-          ...baseDefinition,
-          computedValueDefinitions: {
-            'status-counts': {
-              matches: [
-                ({ span }) => span.status === 'error',
-                ({ span }) => span.status === 'ok',
-              ],
-              computeValueFromMatches: (errors, oks) =>
-                errors.length + oks.length,
-            },
+      const definition: CompleteTraceDefinition<
+        'global',
+        AnyRelation,
+        'origin'
+      > = {
+        ...baseDefinition,
+        computedValueDefinitions: {
+          'status-counts': {
+            matches: [
+              ({ span }) => span.status === 'error',
+              ({ span }) => span.status === 'ok',
+            ],
+            computeValueFromMatches: (errors, oks) =>
+              errors.length + oks.length,
           },
-        }
+        },
+      }
 
       const result = getComputedValues({
         definition,

src/v3/recordingComputeUtils.ts

@@ -192,7 +192,7 @@ function getComputedRenderBeaconSpans<
     }
   >()
 
-  const scopeKeys = Object.keys(input.relatedTo)
+  const relatedToKey = Object.keys(input.relatedTo)
 
   // Group render spans by beacon and compute firstStart and lastEnd
   for (const entry of recordedItems) {
@@ -213,12 +213,12 @@ function getComputedRenderBeaconSpans<
     const relatedTo = r as Record<string, unknown> | undefined
     const inputRelatedTo: Record<string, unknown> = input.relatedTo
 
-    const scopeMatch = scopeKeys.every(
+    const relationMatch = relatedToKey.every(
       (key) =>
         relatedTo?.[key] === undefined ||
         inputRelatedTo[key] === relatedTo[key],
     )
-    if (!scopeMatch) continue
+    if (!relationMatch) continue
 
     const start = startTime.now
     const contentfulRenderEnd =

src/v3/spanTypes.ts

@@ -83,7 +83,7 @@ export interface SpanBase<RelationSchemasT> {
   startTime: Timestamp
 
   // for non performance entries, relatedTo is set explicitly in the span, something like ticket id or user id
-  // performance entries can derive relatedTo based using `deriveScopeFromPerformanceEntry`
+  // performance entries can derive relatedTo based using `deriveRelationFromPerformanceEntry`
   relatedTo?: RelationsOnASpan<RelationSchemasT>
 
   attributes: Attributes

src/v3/testUtility/createMockFactory.ts

@@ -9,10 +9,10 @@ export const createTimestamp = (now: number): Timestamp => ({
   now,
 })
 
-export type AnyScope = Record<string, unknown>
+export type AnyRelation = Record<string, unknown>
 
 export const createAnnotation = (
-  span: Span<AnyScope>,
+  span: Span<AnyRelation>,
   traceStartTime: Timestamp,
   partial: Partial<SpanAnnotation> = {},
 ): SpanAnnotation => ({
@@ -26,7 +26,7 @@ export const createAnnotation = (
   ...partial,
 })
 
-export const createMockSpan = <TSpan extends Span<AnyScope>>(
+export const createMockSpan = <TSpan extends Span<AnyRelation>>(
   startTimeNow: number,
   partial: Partial<TSpan>,
 ): TSpan =>

src/v3/testUtility/fixtures/shouldNotEndWithInteractiveTimeout.ts

@@ -1,9 +1,9 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-nocheck
 import type { SpanAndAnnotation } from '../spanAnnotationTypes'
-import type { TicketIdScope } from './fixtures/ticket.activation'
+import type { TicketAndUserAndGlobalRelationSchemasFixture } from './relationSchemas'
 
-export const shouldNotEndWithInteractiveTimeout: SpanAndAnnotation<TicketIdScope>[] =
+export const shouldNotEndWithInteractiveTimeout: SpanAndAnnotation<TicketAndUserAndGlobalRelationSchemasFixture>[] =
   [
     {
       span: {

src/v3/testUtility/fixtures/shouldNotEndWithInterruption.ts

@@ -1,9 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-nocheck
-import type { SpanAndAnnotation } from '../spanAnnotationTypes'
-import type { TicketIdScope } from './fixtures/ticket.activation'
 
-export const shouldNotEndWithInterruption: SpanAndAnnotation<TicketIdScope>[] =
+import type { SpanAndAnnotation } from '../../spanAnnotationTypes'
+import type { TicketAndUserAndGlobalRelationSchemasFixture } from './relationSchemas'
+
+export const shouldNotEndWithInterruption: SpanAndAnnotation<TicketAndUserAndGlobalRelationSchemasFixture>[] =
   [
     {
       span: {