Skip to content

Commit 4678aac

Browse files
AbhiPrasadAbhiPrasad
authored
feat(v8): Remove extractTraceparentData export (#10559)
Instead, import this directly from `@sentry/utils`. Should help when we move `@sentry/utils` into core.
1 parent 3399c4a commit 4678aac

File tree

16 files changed

+74
-118
lines changed

16 files changed

+74
-118
lines changed

‎packages/browser/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,6 @@ export {
6969
addTracingExtensions,
7070
setMeasurement,
7171
// eslint-disable-next-line deprecation/deprecation
72-
extractTraceparentData,
73-
// eslint-disable-next-line deprecation/deprecation
7472
getActiveTransaction,
7573
getSpanStatusFromHttpCode,
7674
setHttpStatus,

‎packages/bun/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,6 @@ export {
3232
captureMessage,
3333
close,
3434
createTransport,
35-
// eslint-disable-next-line deprecation/deprecation
36-
extractTraceparentData,
3735
flush,
3836
// eslint-disable-next-line deprecation/deprecation
3937
getActiveTransaction,

‎packages/core/src/tracing/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ export type { BeforeFinishCallback } from './idletransaction';
44
export { Span } from './span';
55
export { Transaction } from './transaction';
66
// eslint-disable-next-line deprecation/deprecation
7-
export { extractTraceparentData, getActiveTransaction } from './utils';
7+
export { getActiveTransaction } from './utils';
88
// eslint-disable-next-line deprecation/deprecation
99
export { SpanStatus } from './spanstatus';
1010
export {

‎packages/core/src/tracing/utils.ts

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import type { Transaction } from '@sentry/types';
2-
import { extractTraceparentData as _extractTraceparentData } from '@sentry/utils';
32

43
import type { Hub } from '../hub';
54
import { getCurrentHub } from '../hub';
@@ -20,17 +19,3 @@ export function getActiveTransaction<T extends Transaction>(maybeHub?: Hub): T |
2019

2120
// so it can be used in manual instrumentation without necessitating a hard dependency on @sentry/utils
2221
export { stripUrlQueryAndFragment } from '@sentry/utils';
23-
24-
/**
25-
* The `extractTraceparentData` function and `TRACEPARENT_REGEXP` constant used
26-
* to be declared in this file. It was later moved into `@sentry/utils` as part of a
27-
* move to remove `@sentry/tracing` dependencies from `@sentry/node` (`extractTraceparentData`
28-
* is the only tracing function used by `@sentry/node`).
29-
*
30-
* These exports are kept here for backwards compatability's sake.
31-
*
32-
* See https://github.com/getsentry/sentry-javascript/issues/4642 for more details.
33-
*
34-
* @deprecated Import this function from `@sentry/utils` instead
35-
*/
36-
export const extractTraceparentData = _extractTraceparentData;

‎packages/deno/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,6 @@ export {
3030
captureMessage,
3131
close,
3232
createTransport,
33-
// eslint-disable-next-line deprecation/deprecation
34-
extractTraceparentData,
3533
continueTrace,
3634
flush,
3735
// eslint-disable-next-line deprecation/deprecation

‎packages/node-experimental/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,6 @@ export {
6464
createGetModuleFromFilename,
6565
close,
6666
createTransport,
67-
// eslint-disable-next-line deprecation/deprecation
68-
extractTraceparentData,
6967
flush,
7068
Hub,
7169
runWithAsyncContext,

‎packages/node/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ export {
3131
captureMessage,
3232
close,
3333
createTransport,
34-
// eslint-disable-next-line deprecation/deprecation
35-
extractTraceparentData,
3634
flush,
3735
// eslint-disable-next-line deprecation/deprecation
3836
getActiveTransaction,

‎packages/remix/src/index.server.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,6 @@ export {
2323
captureMessage,
2424
createTransport,
2525
// eslint-disable-next-line deprecation/deprecation
26-
extractTraceparentData,
27-
// eslint-disable-next-line deprecation/deprecation
2826
getActiveTransaction,
2927
getHubFromCarrier,
3028
// eslint-disable-next-line deprecation/deprecation

‎packages/serverless/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,6 @@ export {
8282
getModuleFromFilename,
8383
createGetModuleFromFilename,
8484
metrics,
85-
// eslint-disable-next-line deprecation/deprecation
86-
extractTraceparentData,
8785
runWithAsyncContext,
8886
consoleIntegration,
8987
onUncaughtExceptionIntegration,

‎packages/sveltekit/src/server/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ export {
1616
withMonitor,
1717
createTransport,
1818
// eslint-disable-next-line deprecation/deprecation
19-
extractTraceparentData,
20-
// eslint-disable-next-line deprecation/deprecation
2119
getActiveTransaction,
2220
getHubFromCarrier,
2321
// eslint-disable-next-line deprecation/deprecation

‎packages/tracing-internal/src/exports/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
export {
2-
// eslint-disable-next-line deprecation/deprecation
3-
extractTraceparentData,
42
// eslint-disable-next-line deprecation/deprecation
53
getActiveTransaction,
64
hasTracingEnabled,

‎packages/tracing/src/index.ts

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ import {
1919
Transaction as TransactionT,
2020
addExtensionMethods as addExtensionMethodsT,
2121
defaultRequestInstrumentationOptions as defaultRequestInstrumentationOptionsT,
22-
extractTraceparentData as extractTraceparentDataT,
2322
getActiveTransaction as getActiveTransactionT,
2423
hasTracingEnabled as hasTracingEnabledT,
2524
instrumentOutgoingRequests as instrumentOutgoingRequestsT,
@@ -66,14 +65,6 @@ export const addExtensionMethods = addExtensionMethodsT;
6665
// eslint-disable-next-line deprecation/deprecation
6766
export const getActiveTransaction = getActiveTransactionT;
6867

69-
/**
70-
* @deprecated `@sentry/tracing` has been deprecated and will be moved to to `@sentry/node`, `@sentry/browser`, or your framework SDK in the next major version.
71-
*
72-
* `extractTraceparentData` can be imported from `@sentry/node`, `@sentry/browser`, or your framework SDK
73-
*/
74-
// eslint-disable-next-line deprecation/deprecation
75-
export const extractTraceparentData = extractTraceparentDataT;
76-
7768
/**
7869
* @deprecated `@sentry/tracing` has been deprecated and will be moved to to `@sentry/node`, `@sentry/browser`, or your framework SDK in the next major version.
7970
*

‎packages/tracing/test/hub.test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
import { BrowserClient } from '@sentry/browser';
44
import { Hub, SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE, makeMain } from '@sentry/core';
55
import * as utilsModule from '@sentry/utils'; // for mocking
6-
import { logger } from '@sentry/utils';
6+
import { extractTraceparentData, logger } from '@sentry/utils';
77

8-
import { BrowserTracing, TRACEPARENT_REGEXP, Transaction, addExtensionMethods, extractTraceparentData } from '../src';
8+
import { BrowserTracing, TRACEPARENT_REGEXP, Transaction, addExtensionMethods } from '../src';
99
import {
1010
addDOMPropertiesToGlobal,
1111
getDefaultBrowserClientOptions,

‎packages/tracing/test/utils.test.ts

Lines changed: 1 addition & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* eslint-disable deprecation/deprecation */
2-
import { extractTraceparentData, hasTracingEnabled } from '../src';
2+
import { hasTracingEnabled } from '../src';
33

44
describe('hasTracingEnabled (deprecated)', () => {
55
const tracesSampler = () => 1;
@@ -33,72 +33,3 @@ describe('hasTracingEnabled (deprecated)', () => {
3333
},
3434
);
3535
});
36-
37-
describe('extractTraceparentData', () => {
38-
test('no sample', () => {
39-
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb') as any;
40-
41-
expect(data).toBeDefined();
42-
expect(data.parentSpanId).toEqual('bbbbbbbbbbbbbbbb');
43-
expect(data.traceId).toEqual('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
44-
expect(data?.parentSampled).toBeUndefined();
45-
});
46-
47-
test('sample true', () => {
48-
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-1') as any;
49-
50-
expect(data).toBeDefined();
51-
expect(data.parentSampled).toBeTruthy();
52-
});
53-
54-
test('sample false', () => {
55-
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
56-
57-
expect(data).toBeDefined();
58-
expect(data.parentSampled).toBeFalsy();
59-
});
60-
61-
test('just sample decision - false', () => {
62-
const data = extractTraceparentData('0') as any;
63-
64-
expect(data).toBeDefined();
65-
expect(data.traceId).toBeUndefined();
66-
expect(data.spanId).toBeUndefined();
67-
expect(data.parentSampled).toBeFalsy();
68-
});
69-
70-
test('just sample decision - true', () => {
71-
const data = extractTraceparentData('1') as any;
72-
73-
expect(data).toBeDefined();
74-
expect(data.traceId).toBeUndefined();
75-
expect(data.spanId).toBeUndefined();
76-
expect(data.parentSampled).toBeTruthy();
77-
});
78-
79-
test('invalid', () => {
80-
// undefined
81-
expect(extractTraceparentData(undefined)).toBeUndefined();
82-
83-
// empty string
84-
expect(extractTraceparentData('')).toBeUndefined();
85-
86-
// trace id wrong length
87-
expect(extractTraceparentData('a-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
88-
89-
// parent span id wrong length
90-
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-b-1')).toBeUndefined();
91-
92-
// parent sampling decision wrong length
93-
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-11')).toBeUndefined();
94-
95-
// trace id invalid hex value
96-
expect(extractTraceparentData('someStuffHereWhichIsNotAtAllHexy-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
97-
98-
// parent span id invalid hex value
99-
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-alsoNotSuperHexy-1')).toBeUndefined();
100-
101-
// bogus sampling decision
102-
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
103-
});
104-
});

‎packages/utils/test/tracing.test.ts

Lines changed: 70 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { propagationContextFromHeaders, tracingContextFromHeaders } from '../src/tracing';
1+
import { extractTraceparentData, propagationContextFromHeaders, tracingContextFromHeaders } from '../src/tracing';
22

33
const EXAMPLE_SENTRY_TRACE = '12312012123120121231201212312012-1121201211212012-1';
44
const EXAMPLE_BAGGAGE = 'sentry-release=1.2.3,sentry-foo=bar,other=baz';
@@ -64,3 +64,72 @@ describe('propagationContextFromHeaders()', () => {
6464
});
6565
});
6666
});
67+
68+
describe('extractTraceparentData', () => {
69+
test('no sample', () => {
70+
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb') as any;
71+
72+
expect(data).toBeDefined();
73+
expect(data.parentSpanId).toEqual('bbbbbbbbbbbbbbbb');
74+
expect(data.traceId).toEqual('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa');
75+
expect(data?.parentSampled).toBeUndefined();
76+
});
77+
78+
test('sample true', () => {
79+
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-1') as any;
80+
81+
expect(data).toBeDefined();
82+
expect(data.parentSampled).toBeTruthy();
83+
});
84+
85+
test('sample false', () => {
86+
const data = extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-0') as any;
87+
88+
expect(data).toBeDefined();
89+
expect(data.parentSampled).toBeFalsy();
90+
});
91+
92+
test('just sample decision - false', () => {
93+
const data = extractTraceparentData('0') as any;
94+
95+
expect(data).toBeDefined();
96+
expect(data.traceId).toBeUndefined();
97+
expect(data.spanId).toBeUndefined();
98+
expect(data.parentSampled).toBeFalsy();
99+
});
100+
101+
test('just sample decision - true', () => {
102+
const data = extractTraceparentData('1') as any;
103+
104+
expect(data).toBeDefined();
105+
expect(data.traceId).toBeUndefined();
106+
expect(data.spanId).toBeUndefined();
107+
expect(data.parentSampled).toBeTruthy();
108+
});
109+
110+
test('invalid', () => {
111+
// undefined
112+
expect(extractTraceparentData(undefined)).toBeUndefined();
113+
114+
// empty string
115+
expect(extractTraceparentData('')).toBeUndefined();
116+
117+
// trace id wrong length
118+
expect(extractTraceparentData('a-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
119+
120+
// parent span id wrong length
121+
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-b-1')).toBeUndefined();
122+
123+
// parent sampling decision wrong length
124+
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-11')).toBeUndefined();
125+
126+
// trace id invalid hex value
127+
expect(extractTraceparentData('someStuffHereWhichIsNotAtAllHexy-bbbbbbbbbbbbbbbb-1')).toBeUndefined();
128+
129+
// parent span id invalid hex value
130+
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-alsoNotSuperHexy-1')).toBeUndefined();
131+
132+
// bogus sampling decision
133+
expect(extractTraceparentData('aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa-bbbbbbbbbbbbbbbb-x')).toBeUndefined();
134+
});
135+
});

‎packages/vercel-edge/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,6 @@ export {
3131
captureMessage,
3232
close,
3333
createTransport,
34-
// eslint-disable-next-line deprecation/deprecation
35-
extractTraceparentData,
3634
flush,
3735
// eslint-disable-next-line deprecation/deprecation
3836
getActiveTransaction,

0 commit comments

Comments
 (0)