add deprecation warning to toTraceparent and alias to private method

Author: lobsterkatie

packages/tracing/src/span.ts

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 import { getCurrentHub } from '@sentry/hub';
 import { Hub, Primitive, Span as SpanInterface, SpanContext, TraceHeaders } from '@sentry/types';
-import { dropUndefinedKeys, timestampWithMs, uuid4 } from '@sentry/utils';
+import { dropUndefinedKeys, logger, timestampWithMs, uuid4 } from '@sentry/utils';
 
 import { SpanStatus } from './spanstatus';
 import { Transaction } from './transaction';
@@ -242,11 +242,9 @@ export class Span implements SpanInterface {
    * @inheritDoc
    */
   public toTraceparent(): string {
-    let sampledString = '';
-    if (this.sampled !== undefined) {
-      sampledString = this.sampled ? '-1' : '-0';
-    }
-    return `${this.traceId}-${this.spanId}${sampledString}`;
+    logger.warn('Direct use of `span.toTraceparent` is deprecated. Use `span.getTraceHeaders` instead.');
+
+    return this._toSentrytrace();
   }
 
   /**
@@ -294,7 +292,7 @@ export class Span implements SpanInterface {
     const tracestate = this._toTracestate();
 
     return {
-      'sentry-trace': this.toTraceparent(),
+      'sentry-trace': this._toSentrytrace(),
       ...(tracestate && { tracestate }),
     };
   }
@@ -383,6 +381,17 @@ export class Span implements SpanInterface {
     })}`;
   }
 
+  /**
+   * Return a tracestate-compatible header string.
+   */
+  private _toSentrytrace(): string {
+    let sampledString = '';
+    if (this.sampled !== undefined) {
+      sampledString = this.sampled ? '-1' : '-0';
+    }
+    return `${this.traceId}-${this.spanId}${sampledString}`;
+  }
+
   /**
    * Return a tracestate-compatible header string. Returns undefined if there is no client or no DSN.
    */

packages/tracing/test/span.test.ts

@@ -95,10 +95,10 @@ describe('Span', () => {
 
   describe('toTraceparent', () => {
     test('simple', () => {
-      expect(new Span().toTraceparent()).toMatch(SENTRY_TRACE_REGEX);
+      expect(new Span().getTraceHeaders()['sentry-trace']).toMatch(SENTRY_TRACE_REGEX);
     });
     test('with sample', () => {
-      expect(new Span({ sampled: true }).toTraceparent()).toMatch(SENTRY_TRACE_REGEX);
+      expect(new Span({ sampled: true }).getTraceHeaders()['sentry-trace']).toMatch(SENTRY_TRACE_REGEX);
     });
   });
 
@@ -159,7 +159,7 @@ describe('Span', () => {
 
       const headers = span.getTraceHeaders();
 
-      expect(headers['sentry-trace']).toEqual(span.toTraceparent());
+      expect(headers['sentry-trace']).toEqual(`${span.traceId}-${span.spanId}-1`);
       expect(headers.tracestate).toEqual(transaction.metadata?.tracestate?.sentry);
     });
   });

packages/types/src/span.ts

@@ -152,7 +152,7 @@ export interface Span extends SpanContext {
   /**
    * Return a traceparent-compatible header string
    *
-   * NOTE: Do not use `span.toTraceparnt` directly. Use `span.getTraceHeaders` instead.
+   * @deprecated Do not use `span.toTraceparnt` directly. Use `span.getTraceHeaders` instead.
    */
   toTraceparent(): string; // TODO (kmclb) make this private