make toTracestate private

Author: lobsterkatie

packages/tracing/src/span.ts

@@ -248,20 +248,6 @@ export class Span implements SpanInterface {
     return `${this.traceId}-${this.spanId}${sampledString}`;
   }
 
-  /**
-   * @inheritDoc
-   */
-  public toTracestate(): string | undefined {
-    const sentryTracestate = this.transaction?.metadata?.tracestate?.sentry || this._getNewTracestate();
-    let thirdpartyTracestate = this.transaction?.metadata?.tracestate?.thirdparty;
-
-    // if there's third-party data, add a leading comma; otherwise, convert from `undefined` to the empty string, so the
-    // end result doesn’t come out as `sentry=xxxxxundefined`
-    thirdpartyTracestate = thirdpartyTracestate ? `,${thirdpartyTracestate}` : '';
-
-    return `${sentryTracestate}${thirdpartyTracestate}`;
-  }
-
   /**
    * @inheritDoc
    */
@@ -304,7 +290,7 @@ export class Span implements SpanInterface {
    * @inheritDoc
    */
   public getTraceHeaders(): TraceHeaders {
-    const tracestate = this.toTracestate();
+    const tracestate = this._toTracestate();
 
     return {
       'sentry-trace': this.toTraceparent(),
@@ -395,4 +381,18 @@ export class Span implements SpanInterface {
       publicKey: dsn.publicKey!,
     })}`;
   }
+
+  /**
+   * Return a tracestate-compatible header string. Returns undefined if there is no client or no DSN.
+   */
+  private _toTracestate(): string | undefined {
+    const sentryTracestate = this.transaction?.metadata?.tracestate?.sentry || this._getNewTracestate();
+    let thirdpartyTracestate = this.transaction?.metadata?.tracestate?.thirdparty;
+
+    // if there's third-party data, add a leading comma; otherwise, convert from `undefined` to the empty string, so the
+    // end result doesn’t come out as `sentry=xxxxxundefined`
+    thirdpartyTracestate = thirdpartyTracestate ? `,${thirdpartyTracestate}` : '';
+
+    return `${sentryTracestate}${thirdpartyTracestate}`;
+  }
 }

packages/tracing/test/span.test.ts

@@ -124,23 +124,23 @@ describe('Span', () => {
       const transaction = new Transaction({ name: 'FETCH /ball', traceId }, hub);
       const span = transaction.startChild({ op: 'dig.hole' });
 
-      expect(span.toTracestate()).toEqual(computedTracestate);
+      expect(span.getTraceHeaders().tracestate).toEqual(computedTracestate);
     });
 
     test('third-party data', () => {
       const transaction = new Transaction({ name: 'FETCH /ball' }, hub);
       transaction.setMetadata({ tracestate: { sentry: computedTracestate, thirdparty: thirdpartyData } });
       const span = transaction.startChild({ op: 'dig.hole' });
 
-      expect(span.toTracestate()).toEqual(`${computedTracestate},${thirdpartyData}`);
+      expect(span.getTraceHeaders().tracestate).toEqual(`${computedTracestate},${thirdpartyData}`);
     });
 
     test('orphan span', () => {
       jest.spyOn(hubPackage, 'getCurrentHub').mockReturnValueOnce(hub);
       const span = new Span({ op: 'dig.hole' });
       span.traceId = traceId;
 
-      expect(span.toTracestate()).toEqual(computedTracestate);
+      expect(span.getTraceHeaders().tracestate).toEqual(computedTracestate);
     });
   });
 

packages/types/src/span.ts

@@ -149,11 +149,12 @@ export interface Span extends SpanContext {
    */
   isSuccess(): boolean;
 
-  /** Return a traceparent-compatible header string */
-  toTraceparent(): string;
-
-  /** Return a tracestate-compatible header string. Returns undefined if there is no client or no DSN. */
-  toTracestate(): string | undefined;
+  /**
+   * Return a traceparent-compatible header string
+   *
+   * NOTE: Do not use `span.toTraceparnt` directly. Use `span.getTraceHeaders` instead.
+   */
+  toTraceparent(): string; // TODO (kmclb) make this private
 
   /** Returns the current span properties as a `SpanContext` */
   toContext(): SpanContext;