feat: SpanContext to Span

Author: HazAT

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 - [opentracing] ref: Removed opentracing package
 - [integrations] feat: Add tracing integration
-- [hub] feat: Add tracing related function to scope and hub (`Scope.startSpan`, `Scope.setSpanContext`, `Hub.traceHeaders`)
+- [hub] feat: Add tracing related function to scope and hub (`Scope.startSpan`, `Scope.setSpan`, `Hub.traceHeaders`)
 - [hub] feat: Add new function to Scope `setContext`
 - [hub] feat: Add new function to Scope `setTransaction`
 

packages/hub/src/index.ts

@@ -1,4 +1,4 @@
 export { Carrier, Layer } from './interfaces';
 export { addGlobalEventProcessor, Scope } from './scope';
 export { getCurrentHub, getHubFromCarrier, getMainCarrier, Hub, makeMain, setHubOnCarrier } from './hub';
-export { SpanContext, TRACEPARENT_REGEX } from './spancontext';
+export { Span, TRACEPARENT_REGEXP } from './span';

packages/hub/src/scope.ts

@@ -1,7 +1,7 @@
 import { Breadcrumb, Event, EventHint, EventProcessor, Scope as ScopeInterface, Severity, User } from '@sentry/types';
 import { getGlobalObject, isThenable, normalize, SyncPromise } from '@sentry/utils';
 
-import { SpanContext } from './spancontext';
+import { Span } from './span';
 
 /**
  * Holds additional event information. {@link Scope.applyToEvent} will be
@@ -41,8 +41,8 @@ export class Scope implements ScopeInterface {
   /** Transaction */
   protected _transaction?: string;
 
-  /** SpanContext */
-  protected _span?: SpanContext;
+  /** Span */
+  protected _span?: Span;
 
   /**
    * Add internal on change listener. Used for sub SDKs that need to store the scope.
@@ -194,26 +194,26 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setSpanContext(spanContext?: SpanContext): this {
-    this._span = spanContext;
+  public setSpan(span?: Span): this {
+    this._span = span;
     this._notifyScopeListeners();
     return this;
   }
 
   /**
    * @inheritDoc
    */
-  public startSpan(): SpanContext {
-    const span = new SpanContext();
-    this.setSpanContext(span);
+  public startSpan(): Span {
+    const span = new Span();
+    this.setSpan(span);
     return span;
   }
 
   /**
-   * Internal getter for SpanContext, used in Hub.
+   * Internal getter for Span, used in Hub.
    * @hidden
    */
-  public getSpan(): SpanContext | undefined {
+  public getSpan(): Span | undefined {
     return this._span;
   }
 

packages/hub/src/spancontext.ts renamed to packages/hub/src/span.ts

@@ -1,28 +1,28 @@
-import { SpanContext as SpanContextInterface } from '@sentry/types';
+import { Span as SpanInterface } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
-export const TRACEPARENT_REGEX = /([0-9a-f]{2})-([0-9a-f]{32})-([0-9a-f]{16})-([0-9a-f]{2})/;
+export const TRACEPARENT_REGEXP = /([0-9a-f]{2})-([0-9a-f]{32})-([0-9a-f]{16})-([0-9a-f]{2})/;
 
 /**
- * SpanContext containg all data about a span
+ * Span containg all data about a span
  */
-export class SpanContext implements SpanContextInterface {
+export class Span implements SpanInterface {
   public constructor(
     private readonly _traceId: string = uuid4(),
     private readonly _spanId: string = uuid4().substring(16),
     private readonly _recorded: boolean = false,
-    private readonly _parent?: SpanContext,
+    private readonly _parent?: Span,
   ) {}
 
   /**
    * Continues a trace
    * @param traceparent Traceparent string
    */
-  public static fromTraceparent(traceparent: string): SpanContext | undefined {
-    const matches = traceparent.match(TRACEPARENT_REGEX);
+  public static fromTraceparent(traceparent: string): Span | undefined {
+    const matches = traceparent.match(TRACEPARENT_REGEXP);
     if (matches) {
-      const parent = new SpanContext(matches[2], matches[3], matches[4] === '01' ? true : false);
-      return new SpanContext(matches[2], undefined, undefined, parent);
+      const parent = new Span(matches[2], matches[3], matches[4] === '01' ? true : false);
+      return new Span(matches[2], undefined, undefined, parent);
     }
     return undefined;
   }

packages/hub/test/spancontext.test.ts

@@ -1,24 +1,24 @@
-import { SpanContext, TRACEPARENT_REGEX } from '../src';
+import { Span, TRACEPARENT_REGEXP } from '../src';
 
-describe('SpanContext', () => {
+describe('Span', () => {
   test('toTraceparent', () => {
-    expect(new SpanContext().toTraceparent()).toMatch(TRACEPARENT_REGEX);
+    expect(new Span().toTraceparent()).toMatch(TRACEPARENT_REGEXP);
   });
 
   test('fromTraceparent', () => {
-    const from = SpanContext.fromTraceparent('00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00') as any;
+    const from = Span.fromTraceparent('00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-00') as any;
     expect(from._parent._traceId).toEqual('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
     expect(from._parent._spanId).toEqual('bbbbbbbbbbbbbbbb');
     expect(from._traceId).toEqual('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
     expect(from._spanId).not.toEqual('bbbbbbbbbbbbbbbb');
   });
 
   test('fromTraceparent - invalid', () => {
-    expect(SpanContext.fromTraceparent('00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
+    expect(Span.fromTraceparent('00-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
   });
 
   test('toJSON', () => {
-    expect(JSON.stringify(new SpanContext('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbb'))).toEqual(
+    expect(JSON.stringify(new Span('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbb'))).toEqual(
       `{"span_id":"bbbbbbbbbbbbbbbb","trace_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}`,
     );
   });

packages/node/src/handlers.ts

@@ -1,5 +1,5 @@
 import { captureException, getCurrentHub, withScope } from '@sentry/core';
-import { SpanContext } from '@sentry/hub';
+import { Span } from '@sentry/hub';
 import { Event } from '@sentry/types';
 import { forget, isString, logger, normalize } from '@sentry/utils';
 import * as cookie from 'cookie';
@@ -295,8 +295,8 @@ export function errorHandler(): (
     }
     withScope(scope => {
       if (isString(_req.headers['sentry-trace'])) {
-        const span = SpanContext.fromTraceparent(_req.headers['sentry-trace'] as string);
-        scope.setSpanContext(span);
+        const span = Span.fromTraceparent(_req.headers['sentry-trace'] as string);
+        scope.setSpan(span);
       }
       const eventId = captureException(error);
       (_res as any).sentry = eventId;

packages/types/src/index.ts

@@ -16,7 +16,7 @@ export { Response } from './response';
 export { Scope } from './scope';
 export { SdkInfo } from './sdkinfo';
 export { Severity } from './severity';
-export { SpanContext } from './spancontext';
+export { Span } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';
 export { Status } from './status';

packages/types/src/scope.ts

@@ -1,7 +1,7 @@
 import { Breadcrumb } from './breadcrumb';
 import { EventProcessor } from './eventprocessor';
 import { Severity } from './severity';
-import { SpanContext } from './spancontext';
+import { Span } from './span';
 import { User } from './user';
 
 /**
@@ -71,15 +71,15 @@ export interface Scope {
   setContext(name: string, context: { [key: string]: any } | null): this;
 
   /**
-   * Sets the SpanContext on the scope.
-   * @param spanContext SpanContext
+   * Sets the Span on the scope.
+   * @param span Span
    */
-  setSpanContext(spanContext?: SpanContext): this;
+  setSpan(span?: Span): this;
 
   /**
    * Starts a new Span.
    */
-  startSpan(): SpanContext;
+  startSpan(): Span;
 
   /** Clears the current scope and resets its properties. */
   clear(): this;

packages/types/src/spancontext.ts renamed to packages/types/src/span.ts

@@ -1,5 +1,5 @@
-/** SpanContext holding trace_id, span_id */
-export interface SpanContext {
+/** Span holding trace_id, span_id */
+export interface Span {
   /** Return a traceparent compatible header string */
   toTraceparent(): string;
   /** Convert the object to JSON */