feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mydea merged 1 commit into from
Jan 9, 2024
Merged

feat(core): Deprecate scope.setTransactionName()#10113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down
20 changes: 16 additions & 4 deletions dev-packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
await page.evaluate(() => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
await page.evaluate(async () => {
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
});

const req0 = await transactionReq;
Expand Down
5 changes: 4 additions & 1 deletion ...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });
5 changes: 4 additions & 1 deletion dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
event.transaction = 'testTransactionDSC';
return event;
});
7 changes: 5 additions & 2 deletions packages/core/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
// eslint-disable-next-line deprecation/deprecation
protected _level?: Severity | SeverityLevel;

/** Transaction Name */
/**
* Transaction Name
*/
protected _transactionName?: string;

/** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
}

/**
* @inheritDoc
* Sets the transaction name on the scope for future events.
* @deprecated Use extra or tags instead.
*/
public setTransactionName(name?: string): this {
this._transactionName = name;
Expand Down
12 changes: 11 additions & 1 deletion packages/core/src/utils/applyScopeDataToEvent.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
eventProcessors,
attachments,
propagationContext,
// eslint-disable-next-line deprecation/deprecation
transactionName,
span,
} = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
}

if (transactionName) {
// eslint-disable-next-line deprecation/deprecation
data.transactionName = transactionName;
}

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
const { extra, tags, user, contexts, level, transactionName } = data;
const {
extra,
tags,
user,
contexts,
level,
// eslint-disable-next-line deprecation/deprecation
transactionName,
} = data;

if (extra && Object.keys(extra).length) {
event.extra = { ...extra, ...event.extra };
Expand Down
5 changes: 4 additions & 1 deletion packages/serverless/src/awslambda.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
* @param context AWS Lambda context that will be used to extract some part of the data
*/
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
scope.setTransactionName(context.functionName);
scope.addEventProcessor(event => {
event.transaction = context.functionName;
return event;
});
scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down
2 changes: 0 additions & 2 deletions packages/serverless/test/__mocks__/@sentry/node.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
addEventProcessor: jest.fn(),
setTransactionName: jest.fn(),
setTag: jest.fn(),
setContext: jest.fn(),
setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
fakeSpan.setHttpStatus.mockClear();

fakeScope.addEventProcessor.mockClear();
fakeScope.setTransactionName.mockClear();
fakeScope.setTag.mockClear();
fakeScope.setContext.mockClear();
fakeScope.setSpan.mockClear();
Expand Down
25 changes: 16 additions & 9 deletions packages/serverless/test/awslambda.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
// @ts-expect-error see "Why @ts-expect-error" note
expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
// Test than an event processor to add `transaction` is registered for the scope
// @ts-expect-error see "Why @ts-expect-error" note
const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
const event: Event = {};
eventProcessor(event);
expect(event).toEqual({ transaction: 'functionName' });

// @ts-expect-error see "Why @ts-expect-error" note
expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
// @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

// @ts-expect-error see "Why @ts-expect-error" note
expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
// @ts-expect-error see "Why @ts-expect-error" note
expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

describe('wrapHandler() on sync handler', () => {
test('successful execution', async () => {
expect.assertions(9);
expect.assertions(10);

const handler: Handler = (_event, _context, callback) => {
callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
});

test('unsuccessful execution', async () => {
expect.assertions(9);
expect.assertions(10);

const error = new Error('sorry');
const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
});

test('capture error', async () => {
expect.assertions(9);
expect.assertions(10);

const error = new Error('wat');
const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

describe('wrapHandler() on async handler', () => {
test('successful execution', async () => {
expect.assertions(9);
expect.assertions(10);

const handler: Handler = async (_event, _context) => {
return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
});

test('capture error', async () => {
expect.assertions(9);
expect.assertions(10);

const error = new Error('wat');
const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
test('successful execution', async () => {
expect.assertions(9);
expect.assertions(10);

const handler: Handler = async (_event, _context, _callback) => {
return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
});

test('capture error', async () => {
expect.assertions(9);
expect.assertions(10);

const error = new Error('wat');
const handler: Handler = async (_event, _context, _callback) => {
Expand Down
2 changes: 2 additions & 0 deletions packages/types/src/scope.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
sdkProcessingMetadata: { [key: string]: unknown };
fingerprint: string[];
level?: SeverityLevel;
/** @deprecated This will be removed in v8. */
transactionName?: string;
span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

/**
* Sets the transaction name on the scope for future events.
* @deprecated Use extra or tags instead.
*/
setTransactionName(name?: string): this;

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(core): Deprecate scope.setTransactionName()#10113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

mydea
merged 1 commit into

from

Jan 9, 2024
 Merged


feat(core): Deprecate scope.setTransactionName()#10113
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
MIGRATION.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,10 @@ npx @sentry/migr8@latest

This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!

## Deprecate `scope.setTransactionName()`

Instead, either set this as attributes or tags, or use an event processor to set `event.transaction`.

## Deprecate `scope.getTransaction()` and `getActiveTransaction()`

Instead, you should not rely on the active transaction, but just use `startSpan()` APIs, which handle this for you.
Expand Down

20 changes: 16 additions & 4 deletions
dev-packages/browser-integration-tests/suites/replay/dsc/test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -78,7 +81,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -135,7 +141,10 @@ sentryTest(
 await page.evaluate(() => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand DownExpand Up@@ -183,7 +192,10 @@ sentryTest(
 await page.evaluate(async () => {
 const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
 scope.setUser({ id: 'user123', segment: 'segmentB' });
 scope.setTransactionName('testTransactionDSC');
 scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
 });
 });

 const req0 = await transactionReq;
Expand Down

5 changes: 4 additions & 1 deletion
...ackages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,5 +13,8 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});
scope.getTransaction().setMetadata({ source: 'custom' });

5 changes: 4 additions & 1 deletion
dev-packages/browser-integration-tests/suites/tracing/envelope-header/init.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,4 +13,7 @@ Sentry.init({

const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.addEventProcessor(event => {
 event.transaction = 'testTransactionDSC';
 return event;
});

7 changes: 5 additions & 2 deletions
packages/core/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -89,7 +89,9 @@ export class Scope implements ScopeInterface {
 // eslint-disable-next-line deprecation/deprecation
 protected _level?: Severity | SeverityLevel;

 /** Transaction Name */
 /**
 * Transaction Name
 */
 protected _transactionName?: string;

 /** Span */
Expand DownExpand Up@@ -281,7 +283,8 @@ export class Scope implements ScopeInterface {
 }

 /**
 * @inheritDoc
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 public setTransactionName(name?: string): this {
 this._transactionName = name;
Expand Down

12 changes: 11 additions & 1 deletion
packages/core/src/utils/applyScopeDataToEvent.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 eventProcessors,
 attachments,
 propagationContext,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 span,
 } = mergeData;
Expand All@@ -52,6 +53,7 @@ export function mergeScopeData(data: ScopeData, mergeData: ScopeData): void {
 }

 if (transactionName) {
 // eslint-disable-next-line deprecation/deprecation
 data.transactionName = transactionName;
 }

Expand DownExpand Up@@ -122,7 +124,15 @@ export function mergeArray<Prop extends 'breadcrumbs' | 'fingerprint'>(
}

function applyDataToEvent(event: Event, data: ScopeData): void {
 const { extra, tags, user, contexts, level, transactionName } = data;
 const {
 extra,
 tags,
 user,
 contexts,
 level,
 // eslint-disable-next-line deprecation/deprecation
 transactionName,
 } = data;

 if (extra && Object.keys(extra).length) {
 event.extra = { ...extra, ...event.extra };
Expand Down

5 changes: 4 additions & 1 deletion
packages/serverless/src/awslambda.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -224,7 +224,10 @@ function enhanceScopeWithEnvironmentData(scope: Scope, context: Context, startTi
 * @param context AWS Lambda context that will be used to extract some part of the data
 */
function enhanceScopeWithTransactionData(scope: Scope, context: Context): void {
 scope.setTransactionName(context.functionName);
 scope.addEventProcessor(event => {
 event.transaction = context.functionName;
 return event;
 });
 scope.setTag('server_name', process.env._AWS_XRAY_DAEMON_ADDRESS || process.env.SENTRY_NAME || hostname());
 scope.setTag('url', `awslambda:///${context.functionName}`);
}
Expand Down

2 changes: 0 additions & 2 deletions
packages/serverless/test/__mocks__/@sentry/node.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,6 @@ export const continueTrace = origSentry.continueTrace;

export const fakeScope = {
 addEventProcessor: jest.fn(),
 setTransactionName: jest.fn(),
 setTag: jest.fn(),
 setContext: jest.fn(),
 setSpan: jest.fn(),
Expand DownExpand Up@@ -46,7 +45,6 @@ export const resetMocks = (): void => {
 fakeSpan.setHttpStatus.mockClear();

 fakeScope.addEventProcessor.mockClear();
 fakeScope.setTransactionName.mockClear();
 fakeScope.setTag.mockClear();
 fakeScope.setContext.mockClear();
 fakeScope.setSpan.mockClear();
Expand Down

25 changes: 16 additions & 9 deletions
packages/serverless/test/awslambda.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -42,7 +42,14 @@ const fakeCallback: Callback = (err, result) => {

function expectScopeSettings() {
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledWith('functionName');
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(1);
 // Test than an event processor to add `transaction` is registered for the scope
 // @ts-expect-error see "Why @ts-expect-error" note
 const eventProcessor = SentryNode.fakeScope.addEventProcessor.mock.calls[0][0];
 const event: Event = {};
 eventProcessor(event);
 expect(event).toEqual({ transaction: 'functionName' });

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledWith('server_name', expect.anything());
 // @ts-expect-error see "Why @ts-expect-error" note
Expand DownExpand Up@@ -186,7 +193,7 @@ describe('AWSLambda', () => {
 await wrappedHandler(fakeEvent, fakeContext, fakeCallback);

 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTransactionName).toBeCalledTimes(0);
 expect(SentryNode.fakeScope.addEventProcessor).toBeCalledTimes(0);
 // @ts-expect-error see "Why @ts-expect-error" note
 expect(SentryNode.fakeScope.setTag).toBeCalledTimes(0);
 expect(SentryNode.startSpanManual).toBeCalledTimes(0);
Expand All@@ -195,7 +202,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on sync handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = (_event, _context, callback) => {
 callback(null, 42);
Expand All@@ -222,7 +229,7 @@ describe('AWSLambda', () => {
 });

 test('unsuccessful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('sorry');
 const handler: Handler = (_event, _context, callback) => {
Expand DownExpand Up@@ -301,7 +308,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = (_event, _context, _callback) => {
Expand DownExpand Up@@ -338,7 +345,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context) => {
 return 42;
Expand DownExpand Up@@ -376,7 +383,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context) => {
Expand DownExpand Up@@ -424,7 +431,7 @@ describe('AWSLambda', () => {

 describe('wrapHandler() on async handler with a callback method (aka incorrect usage)', () => {
 test('successful execution', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const handler: Handler = async (_event, _context, _callback) => {
 return 42;
Expand DownExpand Up@@ -462,7 +469,7 @@ describe('AWSLambda', () => {
 });

 test('capture error', async () => {
 expect.assertions(9);
 expect.assertions(10);

 const error = new Error('wat');
 const handler: Handler = async (_event, _context, _callback) => {
Expand Down

2 changes: 2 additions & 0 deletions
packages/types/src/scope.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ export interface ScopeData {
 sdkProcessingMetadata: { [key: string]: unknown };
 fingerprint: string[];
 level?: SeverityLevel;
 /** @deprecated This will be removed in v8. */
 transactionName?: string;
 span?: Span;
}
Expand DownExpand Up@@ -125,6 +126,7 @@ export interface Scope {

 /**
 * Sets the transaction name on the scope for future events.
 * @deprecated Use extra or tags instead.
 */
 setTransactionName(name?: string): this;

Expand Down