fix: Update span, Update trace header (#2128)

* fix: Update span, Update trace header

* meta: Changelog

Author: HazAT

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- [core] feat: Expose `Span` class
+
 ## 5.4.2
 
 - [core] fix: Allow Integration<T> constructor to have arguments

packages/browser/src/index.ts

@@ -30,6 +30,7 @@ export {
   setTag,
   setTags,
   setUser,
+  Span,
   withScope,
 } from '@sentry/core';
 

packages/core/src/index.ts

@@ -12,7 +12,7 @@ export {
   setUser,
   withScope,
 } from '@sentry/minimal';
-export { addGlobalEventProcessor, getCurrentHub, Hub, getHubFromCarrier, Scope } from '@sentry/hub';
+export { addGlobalEventProcessor, getCurrentHub, getHubFromCarrier, Hub, Scope, Span } from '@sentry/hub';
 export { API } from './api';
 export { BaseClient } from './baseclient';
 export { BackendClass, BaseBackend } from './basebackend';

packages/hub/src/scope.ts

@@ -203,8 +203,9 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public startSpan(): Span {
+  public startSpan(parentSpan?: Span): Span {
     const span = new Span();
+    span.setParent(parentSpan);
     this.setSpan(span);
     return span;
   }

packages/hub/src/span.ts

@@ -1,7 +1,7 @@
 import { Span as SpanInterface } from '@sentry/types';
 import { uuid4 } from '@sentry/utils';
 
-export const TRACEPARENT_REGEXP = /([0-9a-f]{2})-([0-9a-f]{32})-([0-9a-f]{16})-([0-9a-f]{2})/;
+export const TRACEPARENT_REGEXP = /^[ \t]*([0-9a-f]{32})?-?([0-9a-f]{16})?-?([01])?[ \t]*$/;
 
 /**
  * Span containg all data about a span
@@ -10,19 +10,41 @@ 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?: Span,
+    private _sampled?: boolean,
+    private _parent?: Span,
   ) {}
 
+  /**
+   * Setter for parent
+   */
+  public setParent(parent: Span | undefined): this {
+    this._parent = parent;
+    return this;
+  }
+
+  /**
+   * Setter for sampled
+   */
+  public setSampled(sampled: boolean | undefined): this {
+    this._sampled = sampled;
+    return this;
+  }
+
   /**
    * Continues a trace
    * @param traceparent Traceparent string
    */
   public static fromTraceparent(traceparent: string): Span | undefined {
     const matches = traceparent.match(TRACEPARENT_REGEXP);
     if (matches) {
-      const parent = new Span(matches[2], matches[3], matches[4] === '01' ? true : false);
-      return new Span(matches[2], undefined, undefined, parent);
+      let sampled;
+      if (matches[3] === '1') {
+        sampled = true;
+      } else if (matches[3] === '0') {
+        sampled = false;
+      }
+      const parent = new Span(matches[1], matches[2], sampled);
+      return new Span(matches[1], undefined, sampled, parent);
     }
     return undefined;
   }
@@ -31,7 +53,14 @@ export class Span implements SpanInterface {
    * @inheritDoc
    */
   public toTraceparent(): string {
-    return `00-${this._traceId}-${this._spanId}-${this._recorded ? '01' : '00'}`;
+    let sampled = '';
+    if (this._sampled === true) {
+      sampled = '-1';
+    } else if (this._sampled === false) {
+      sampled = '-0';
+    }
+
+    return `${this._traceId}-${this._spanId}${sampled}`;
   }
 
   /**
@@ -40,6 +69,7 @@ export class Span implements SpanInterface {
   public toJSON(): object {
     return {
       parent: (this._parent && this._parent.toJSON()) || undefined,
+      sampled: this._sampled,
       span_id: this._spanId,
       trace_id: this._traceId,
     };

packages/hub/test/span.test.ts

@@ -0,0 +1,45 @@
+import { Span, TRACEPARENT_REGEXP } from '../src';
+
+describe('Span', () => {
+  test('toTraceparent', () => {
+    expect(new Span().toTraceparent()).toMatch(TRACEPARENT_REGEXP);
+  });
+
+  describe('fromTraceparent', () => {
+    test('no sample', () => {
+      const from = Span.fromTraceparent('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb') 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');
+      expect(from._sampled).toBeUndefined();
+    });
+    test('sample true', () => {
+      const from = Span.fromTraceparent('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-1') as any;
+      expect(from._sampled).toBeTruthy();
+    });
+
+    test('sample false', () => {
+      const from = Span.fromTraceparent('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
+      expect(from._sampled).toBeFalsy();
+    });
+  });
+
+  test('fromTraceparent - invalid', () => {
+    expect(Span.fromTraceparent('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
+  });
+
+  test('toJSON', () => {
+    expect(JSON.stringify(new Span('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa', 'bbbbbbbbbbbbbbbb'))).toEqual(
+      `{"span_id":"bbbbbbbbbbbbbbbb","trace_id":"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"}`,
+    );
+  });
+
+  test('toJSON with parent', () => {
+    const spanA = new Span('a', 'b');
+    const spanB = new Span('c', 'd', false, spanA);
+    expect(JSON.stringify(spanB)).toEqual(
+      `{"parent":{"span_id":"b","trace_id":"a"},"sampled":false,"span_id":"d","trace_id":"c"}`,
+    );
+  });
+});

packages/hub/test/spancontext.test.ts

@@ -30,6 +30,7 @@ export {
   setTag,
   setTags,
   setUser,
+  Span,
   withScope,
 } from '@sentry/core';