ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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 \u003e 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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading
, '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

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

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 4 commits into from
Dec 15, 2023
Merged

ref: Use getCurrentScope()/hub.getScope() instead of configureScope()#9846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
611e3af
ref: Use `getCurrentScope()`/`hub.getScope()` instead of `configureSc…
mydea Dec 14, 2023
0ce3c91
fix tests etc.
mydea Dec 14, 2023
384d6bf
fix linting
mydea Dec 14, 2023
e0a48c4
fix flaky test?
mydea Dec 14, 2023
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
6 changes: 2 additions & 4 deletions packages/astro/src/client/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { BrowserOptions } from '@sentry/browser';
import { BrowserTracing, init as initBrowserSdk } from '@sentry/browser';
import { configureScope, hasTracingEnabled } from '@sentry/core';
import { getCurrentScope, hasTracingEnabled } from '@sentry/core';
import { addOrUpdateIntegration } from '@sentry/utils';

import { applySdkMetadata } from '../common/metadata';
Expand All@@ -20,9 +20,7 @@ export function init(options: BrowserOptions): void {

initBrowserSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'browser');
});
getCurrentScope().setTag('runtime', 'browser');
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/middleware.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
import {
captureException,
configureScope,
continueTrace,
getCurrentHub,
getCurrentScope,
runWithAsyncContext,
startSpan,
} from '@sentry/node';
Expand DownExpand Up@@ -106,9 +106,7 @@ async function instrumentRequest(
}

if (options.trackClientIp) {
configureScope(scope => {
scope.setUser({ ip_address: ctx.clientAddress });
});
getCurrentScope().setUser({ ip_address: ctx.clientAddress });
}

try {
Expand Down
6 changes: 2 additions & 4 deletions packages/astro/src/server/sdk.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { configureScope } from '@sentry/core';
import { getCurrentScope } from '@sentry/core';
import type { NodeOptions } from '@sentry/node';
import { init as initNodeSdk } from '@sentry/node';

Expand All@@ -13,7 +13,5 @@ export function init(options: NodeOptions): void {

initNodeSdk(options);

configureScope(scope => {
scope.setTag('runtime', 'node');
});
getCurrentScope().setTag('runtime', 'node');
}
4 changes: 2 additions & 2 deletions packages/astro/test/server/middleware.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -172,7 +172,7 @@ describe('sentryMiddleware', () => {
it('attaches client IP and request headers if options are set', async () => {
const scope = { setUser: vi.fn(), setPropagationContext: vi.fn() };
// @ts-expect-error, only passing a partial Scope object
const configureScopeSpy = vi.spyOn(SentryNode, 'configureScope').mockImplementation(cb => cb(scope));
const getCurrentScopeSpy = vi.spyOn(SentryNode, 'getCurrentScope').mockImplementation(() => scope);

const middleware = handleRequest({ trackClientIp: true, trackHeaders: true });
const ctx = {
Expand All@@ -192,7 +192,7 @@ describe('sentryMiddleware', () => {
// @ts-expect-error, a partial ctx object is fine here
await middleware(ctx, next);

expect(configureScopeSpy).toHaveBeenCalledTimes(1);
expect(getCurrentScopeSpy).toHaveBeenCalledTimes(1);
expect(scope.setUser).toHaveBeenCalledWith({ ip_address: '192.168.0.1' });

expect(startSpanSpy).toHaveBeenCalledWith(
Expand Down
31 changes: 15 additions & 16 deletions packages/browser-integration-tests/suites/replay/dsc/test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -21,17 +21,19 @@ sentryTest(

const transactionReq = waitForTransactionRequest(page);

// Wait for this to be available
await page.waitForFunction('!!window.Replay');

await page.evaluate(() => {
(window as unknown as TestWindow).Replay.start();
});

await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -74,10 +76,9 @@ sentryTest(
await waitForReplayRunning(page);

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -132,10 +133,9 @@ sentryTest(
});

await page.evaluate(() => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand DownExpand Up@@ -181,10 +181,9 @@ sentryTest(
const transactionReq = waitForTransactionRequest(page);

await page.evaluate(async () => {
(window as unknown as TestWindow).Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = (window as unknown as TestWindow).Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});

const req0 = await transactionReq;
Expand Down
9 changes: 4 additions & 5 deletions packages/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@@ -11,8 +11,7 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
scope.getTransaction().setMetadata({ source: 'custom' });
7 changes: 3 additions & 4 deletions 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@@ -11,7 +11,6 @@ Sentry.init({
debug: true,
});

Sentry.configureScope(scope => {
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
});
const scope = Sentry.getCurrentScope();
scope.setUser({ id: 'user123', segment: 'segmentB' });
scope.setTransactionName('testTransactionDSC');
22 changes: 6 additions & 16 deletions packages/browser/test/unit/index.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,10 +12,10 @@ import {
captureEvent,
captureException,
captureMessage,
configureScope,
flush,
getClient,
getCurrentHub,
getCurrentScope,
init,
showReportDialog,
wrap,
Expand DownExpand Up@@ -58,27 +58,21 @@ describe('SentryBrowser', () => {

describe('getContext() / setContext()', () => {
it('should store/load extra', () => {
configureScope((scope: Scope) => {
scope.setExtra('abc', { def: [1] });
});
getCurrentScope().setExtra('abc', { def: [1] });
expect(global.__SENTRY__.hub._stack[1].scope._extra).toEqual({
abc: { def: [1] },
});
});

it('should store/load tags', () => {
configureScope((scope: Scope) => {
scope.setTag('abc', 'def');
});
getCurrentScope().setTag('abc', 'def');
expect(global.__SENTRY__.hub._stack[1].scope._tags).toEqual({
abc: 'def',
});
});

it('should store/load user', () => {
configureScope((scope: Scope) => {
scope.setUser({ id: 'def' });
});
getCurrentScope().setUser({ id: 'def' });
expect(global.__SENTRY__.hub._stack[1].scope._user).toEqual({
id: 'def',
});
Expand All@@ -95,9 +89,7 @@ describe('SentryBrowser', () => {
const options = getDefaultBrowserClientOptions({ dsn });
const client = new BrowserClient(options);
it('uses the user on the scope', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

showReportDialog();
Expand All@@ -110,9 +102,7 @@ describe('SentryBrowser', () => {
});

it('prioritizes options user over scope user', () => {
configureScope(scope => {
scope.setUser(EX_USER);
});
getCurrentScope().setUser(EX_USER);
getCurrentHub().bindClient(client);

const DIALOG_OPTION_USER = { email: 'option@example.com' };
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/tracing/idletransaction.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,7 +121,7 @@ export class IdleTransaction extends Transaction {
// We set the transaction here on the scope so error events pick up the trace
// context and attach it to the error.
DEBUG_BUILD && logger.log(`Setting idle transaction on scope. Span ID: ${this.spanId}`);
_idleHub.configureScope(scope => scope.setSpan(this));
_idleHub.getScope().setSpan(this);
}

this._restartIdleTimeout();
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/lib/hint.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
import { captureEvent, configureScope } from '@sentry/core';
import { captureEvent, getCurrentScope } from '@sentry/core';
import { GLOBAL_OBJ } from '@sentry/utils';

import { initAndBind } from '../../src/sdk';
Expand DownExpand Up@@ -109,7 +109,7 @@ describe('Hint', () => {
const options = getDefaultTestClientOptions({ dsn: PUBLIC_DSN });
initAndBind(TestClient, options);

configureScope(scope => scope.addAttachment({ filename: 'scope.file', data: 'great content!' }));
getCurrentScope().addAttachment({ filename: 'scope.file', data: 'great content!' });

captureEvent({}, { attachments: [{ filename: 'some-file.txt', data: 'Hello' }] });

Expand Down
6 changes: 3 additions & 3 deletions packages/core/test/lib/tracing/errors.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,7 +40,7 @@ describe('registerErrorHandlers()', () => {
});

afterEach(() => {
hub.configureScope(scope => scope.setSpan(undefined));
hub.getScope().setSpan(undefined);
});

it('registers error instrumentation', () => {
Expand All@@ -67,7 +67,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on error', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockErrorCallback({} as HandlerDataError);
expect(transaction.status).toBe('internal_error');
Expand All@@ -78,7 +78,7 @@ describe('registerErrorHandlers()', () => {
it('sets status for transaction on scope on unhandledrejection', () => {
registerErrorInstrumentation();
const transaction = hub.startTransaction({ name: 'test' });
hub.configureScope(scope => scope.setSpan(transaction));
hub.getScope().setSpan(transaction);

mockUnhandledRejectionCallback({});
expect(transaction.status).toBe('internal_error');
Expand Down
6 changes: 2 additions & 4 deletions packages/core/test/mocks/integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { Event, EventProcessor, Integration } from '@sentry/types';

import { configureScope, getCurrentHub } from '../../src';
import { getCurrentHub, getCurrentScope } from '../../src';

export class TestIntegration implements Integration {
public static id: string = 'TestIntegration';
Expand All@@ -18,9 +18,7 @@ export class TestIntegration implements Integration {

eventProcessor.id = this.name;

configureScope(scope => {
scope.addEventProcessor(eventProcessor);
});
getCurrentScope().addEventProcessor(eventProcessor);
}
}

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,7 @@ import type { NextApiRequest, NextApiResponse } from 'next';

export default function handler(req: NextApiRequest, res: NextApiResponse) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
2 changes: 1 addition & 1 deletion packages/e2e-tests/test-applications/node-express-app/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,7 +35,7 @@ app.get('/test-param/:param', function (req, res) {

app.get('/test-transaction', async function (req, res) {
const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
Sentry.getCurrentHub().configureScope(scope => scope.setSpan(transaction));
Sentry.getCurrentHub().getScope().setSpan(transaction);

const span = transaction.startChild();

Expand Down
21 changes: 10 additions & 11 deletions packages/nextjs/src/client/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@ import type { BrowserOptions } from '@sentry/react';
import {
BrowserTracing,
Integrations,
configureScope,
defaultRequestInstrumentationOptions,
getCurrentScope,
init as reactInit,
} from '@sentry/react';
import type { EventProcessor } from '@sentry/types';
Expand DownExpand Up@@ -56,17 +56,16 @@ export function init(options: BrowserOptions): void {

reactInit(opts);

configureScope(scope => {
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);
const scope = getCurrentScope();
scope.setTag('runtime', 'browser');
const filterTransactions: EventProcessor = event =>
event.type === 'transaction' && event.transaction === '/404' ? null : event;
filterTransactions.id = 'NextClient404Filter';
scope.addEventProcessor(filterTransactions);

if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
});
if (process.env.NODE_ENV === 'development') {
scope.addEventProcessor(devErrorSymbolicationEventProcessor);
}
}

function addClientIntegrations(options: BrowserOptions): void {
Expand Down
Loading