standardize naming

Author: lobsterkatie

packages/node/src/handlers.ts

@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 /* eslint-disable @typescript-eslint/no-explicit-any */
 import { captureException, getCurrentHub, startTransaction, withScope } from '@sentry/core';
-import { extractTraceparentData, Span } from '@sentry/tracing';
+import { extractSentrytraceData, Span } from '@sentry/tracing';
 import { Event, ExtractedNodeRequestData, Transaction } from '@sentry/types';
 import { forget, isPlainObject, isString, logger, normalize, stripUrlQueryAndFragment } from '@sentry/utils';
 import * as cookie from 'cookie';
@@ -58,7 +58,7 @@ export function tracingHandler(): (
     // If there is a trace header set, we extract the data from it (parentSpanId, traceId, and sampling decision)
     let traceparentData;
     if (req.headers && isString(req.headers['sentry-trace'])) {
-      traceparentData = extractTraceparentData(req.headers['sentry-trace'] as string);
+      traceparentData = extractSentrytraceData(req.headers['sentry-trace'] as string);
     }
 
     const transaction = startTransaction(

packages/tracing/src/browser/browsertracing.ts

@@ -5,7 +5,7 @@ import { getGlobalObject, logger } from '@sentry/utils';
 import { startIdleTransaction } from '../hubextensions';
 import { DEFAULT_IDLE_TIMEOUT, IdleTransaction } from '../idletransaction';
 import { SpanStatus } from '../spanstatus';
-import { extractTraceparentData, secToMs } from '../utils';
+import { extractSentrytraceData, secToMs } from '../utils';
 import { registerBackgroundTabDetection } from './backgroundtab';
 import { MetricsInstrumentation } from './metrics';
 import {
@@ -237,7 +237,7 @@ export class BrowserTracing implements Integration {
 export function getHeaderContext(): Partial<TransactionContext> | undefined {
   const header = getMetaContent('sentry-trace');
   if (header) {
-    return extractTraceparentData(header);
+    return extractSentrytraceData(header);
   }
 
   return undefined;

packages/tracing/src/index.ts

@@ -22,9 +22,9 @@ addExtensionMethods();
 export { addExtensionMethods };
 
 export {
-  extractTraceparentData,
+  extractSentrytraceData,
   getActiveTransaction,
   hasTracingEnabled,
+  SENTRY_TRACE_REGEX,
   stripUrlQueryAndFragment,
-  TRACEPARENT_REGEXP,
 } from './utils';

packages/tracing/src/utils.ts

@@ -2,7 +2,7 @@ import { getCurrentHub, Hub } from '@sentry/hub';
 import { Options, TraceparentData, Transaction } from '@sentry/types';
 import { SentryError, unicodeToBase64 } from '@sentry/utils';
 
-export const TRACEPARENT_REGEXP = new RegExp(
+export const SENTRY_TRACE_REGEX = new RegExp(
   '^[ \\t]*' + // whitespace
   '([0-9a-f]{32})?' + // trace_id
   '-?([0-9a-f]{16})?' + // span_id
@@ -22,12 +22,12 @@ export function hasTracingEnabled(options: Options): boolean {
 /**
  * Extract transaction context data from a `sentry-trace` header.
  *
- * @param traceparent Traceparent string
+ * @param header Traceparent string
  *
  * @returns Object containing data from the header, or undefined if traceparent string is malformed
  */
-export function extractTraceparentData(traceparent: string): TraceparentData | undefined {
-  const matches = traceparent.match(TRACEPARENT_REGEXP);
+export function extractSentrytraceData(header: string): TraceparentData | undefined {
+  const matches = header.match(SENTRY_TRACE_REGEX);
   if (matches) {
     let parentSampled: boolean | undefined;
     if (matches[3] === '1') {
@@ -68,7 +68,7 @@ export function secToMs(time: number): number {
 // so it can be used in manual instrumentation without necessitating a hard dependency on @sentry/utils
 export { stripUrlQueryAndFragment } from '@sentry/utils';
 
-type TracestateData = {
+type SentryTracestateData = {
   trace_id: string;
   environment: string | undefined | null;
   release: string | undefined | null;
@@ -81,7 +81,7 @@ type TracestateData = {
  * @throws SentryError (because using the logger creates a circular dependency)
  * @returns the base64-encoded header value
  */
-export function computeTracestateValue(data: TracestateData): string {
+export function computeTracestateValue(data: SentryTracestateData): string {
   // `JSON.stringify` will drop keys with undefined values, but not ones with null values
   data.environment = data.environment || null;
   data.release = data.release || null;

packages/tracing/test/hub.test.ts

@@ -9,7 +9,7 @@ import { logger } from '@sentry/utils';
 import { BrowserTracing } from '../src/browser/browsertracing';
 import { addExtensionMethods } from '../src/hubextensions';
 import { Transaction } from '../src/transaction';
-import { computeTracestateValue, extractTraceparentData, TRACEPARENT_REGEXP } from '../src/utils';
+import { computeTracestateValue, extractSentrytraceData, TRACEPARENT_REGEXP } from '../src/utils';
 import { addDOMPropertiesToGlobal, getSymbolObjectKeyByName, testOnlyIfNodeVersionAtLeast } from './testutils';
 
 addExtensionMethods();
@@ -409,7 +409,7 @@ describe('Hub', () => {
 
           // check that sampling decision is passed down correctly
           expect(transaction.sampled).toBe(true);
-          expect(extractTraceparentData(headers['sentry-trace'])!.parentSampled).toBe(true);
+          expect(extractSentrytraceData(headers['sentry-trace'])!.parentSampled).toBe(true);
         },
       );
 
@@ -451,7 +451,7 @@ describe('Hub', () => {
 
           // check that sampling decision is passed down correctly
           expect(transaction.sampled).toBe(false);
-          expect(extractTraceparentData(headers['sentry-trace'])!.parentSampled).toBe(false);
+          expect(extractSentrytraceData(headers['sentry-trace'])!.parentSampled).toBe(false);
         },
       );
 

packages/tracing/test/utils.test.ts

@@ -1,8 +1,8 @@
-import { extractTraceparentData } from '../src/utils';
+import { extractSentrytraceData } from '../src/utils';
 
-describe('extractTraceparentData', () => {
+describe('extractSentrytraceData', () => {
   test('no sample', () => {
-    const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb') as any;
+    const data = extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb') as any;
 
     expect(data).toBeDefined();
     expect(data.parentSpanId).toEqual('bbbbbbbbbbbbbbbb');
@@ -11,21 +11,21 @@ describe('extractTraceparentData', () => {
   });
 
   test('sample true', () => {
-    const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-1') as any;
+    const data = extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-1') as any;
 
     expect(data).toBeDefined();
     expect(data.parentSampled).toBeTruthy();
   });
 
   test('sample false', () => {
-    const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
+    const data = extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
 
     expect(data).toBeDefined();
     expect(data.parentSampled).toBeFalsy();
   });
 
   test('just sample decision - false', () => {
-    const data = extractTraceparentData('0') as any;
+    const data = extractSentrytraceData('0') as any;
 
     expect(data).toBeDefined();
     expect(data.traceId).toBeUndefined();
@@ -34,7 +34,7 @@ describe('extractTraceparentData', () => {
   });
 
   test('just sample decision - true', () => {
-    const data = extractTraceparentData('1') as any;
+    const data = extractSentrytraceData('1') as any;
 
     expect(data).toBeDefined();
     expect(data.traceId).toBeUndefined();
@@ -44,21 +44,21 @@ describe('extractTraceparentData', () => {
 
   test('invalid', () => {
     // trace id wrong length
-    expect(extractTraceparentData('a-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
+    expect(extractSentrytraceData('a-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
 
     // parent span id wrong length
-    expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-b-1')).toBeUndefined();
+    expect(extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-b-1')).toBeUndefined();
 
     // parent sampling decision wrong length
-    expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-11')).toBeUndefined();
+    expect(extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-11')).toBeUndefined();
 
     // trace id invalid hex value
-    expect(extractTraceparentData('someStuffHereWhichIsNotAtAllHexy-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
+    expect(extractSentrytraceData('someStuffHereWhichIsNotAtAllHexy-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
 
     // parent span id invalid hex value
-    expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-alsoNotSuperHexy-1')).toBeUndefined();
+    expect(extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-alsoNotSuperHexy-1')).toBeUndefined();
 
     // bogus sampling decision
-    expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
+    expect(extractSentrytraceData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
   });
 });