feat: Streamline isolation scope handling & reset in isolation scopes #22890
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| import { getClient, getCurrentScope, withIsolationScope } from './currentScopes'; | ||
| import { DEBUG_BUILD } from './debug-build'; | ||
| import { startNewTrace } from './tracing/trace'; | ||
| import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types/checkin'; | ||
| import { debug } from './utils/debug-logger'; | ||
| import { isThenable } from './utils/is'; | ||
| import { uuid4 } from './utils/misc'; | ||
| import { timestampInSeconds } from './utils/time'; | ||
| import { isContinuingTrace } from './utils/tracing'; | ||
|
|
||
| /** | ||
| * Wraps a callback with a cron monitor check in. The check in will be sent to Sentry when the callback finishes. | ||
| * | ||
| * @param monitorSlug The distinct slug of the monitor. | ||
| * @param callback Callback to be monitored | ||
| * @param upsertMonitorConfig An optional object that describes a monitor config. Use this if you want | ||
| * to create a monitor automatically when sending a check in. | ||
| */ | ||
| export function withMonitor<T>( | ||
| monitorSlug: CheckIn['monitorSlug'], | ||
| callback: () => T, | ||
| upsertMonitorConfig?: MonitorConfig, | ||
| ): T { | ||
| function runCallback(): T { | ||
| const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig); | ||
| const now = timestampInSeconds(); | ||
|
|
||
| function finishCheckIn(status: FinishedCheckIn['status']): void { | ||
| captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now }); | ||
| } | ||
| // Default behavior without isolateTrace | ||
| let maybePromiseResult: T; | ||
| try { | ||
| maybePromiseResult = callback(); | ||
| } catch (e) { | ||
| finishCheckIn('error'); | ||
| throw e; | ||
| } | ||
|
|
||
| if (isThenable(maybePromiseResult)) { | ||
| return maybePromiseResult.then( | ||
| r => { | ||
| finishCheckIn('ok'); | ||
| return r; | ||
| }, | ||
| e => { | ||
| finishCheckIn('error'); | ||
| throw e; | ||
| }, | ||
| ) as T; | ||
| } | ||
| finishCheckIn('ok'); | ||
|
|
||
| return maybePromiseResult; | ||
| } | ||
|
|
||
| // `withIsolationScope` gives the fork its own trace, so unless `isolateTrace` is set we restore the | ||
| // parent's trace below. Copied rather than aliased: sharing the object with the parent scope would | ||
| // let in-place writes inside the callback (e.g. the HTTP server integration assigning | ||
| // `propagationSpanId`) rewrite the parent's trace. | ||
| const oldPropagationContext = { ...getCurrentScope().getPropagationContext() }; | ||
|
|
||
| return withIsolationScope(() => { | ||
| if (upsertMonitorConfig?.isolateTrace) { | ||
| return startNewTrace(runCallback); | ||
| } | ||
|
|
||
| // Mirrors the reset condition in the async context strategies: only a fork that was given a fresh | ||
| // trace needs the parent's trace put back. | ||
| const scope = getCurrentScope(); | ||
| if (!isContinuingTrace(scope.getPropagationContext())) { | ||
| scope.setPropagationContext(oldPropagationContext); | ||
| } | ||
|
|
||
| return runCallback(); | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Create a cron monitor check in and send it to Sentry. | ||
| * | ||
| * @param checkIn An object that describes a check in. | ||
| * @param upsertMonitorConfig An optional object that describes a monitor config. Use this if you want | ||
| * to create a monitor automatically when sending a check in. | ||
| */ | ||
| export function captureCheckIn(checkIn: CheckIn, upsertMonitorConfig?: MonitorConfig): string { | ||
| const scope = getCurrentScope(); | ||
| const client = getClient(); | ||
| if (!client) { | ||
| DEBUG_BUILD && debug.warn('Cannot capture check-in. No client defined.'); | ||
| } else if (!client.captureCheckIn) { | ||
| DEBUG_BUILD && debug.warn('Cannot capture check-in. Client does not support sending check-ins.'); | ||
| } else { | ||
| return client.captureCheckIn(checkIn, upsertMonitorConfig, scope); | ||
| } | ||
|
|
||
| return uuid4(); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import { beforeEach, describe, expect, it } from 'vitest'; | ||
| import { getCurrentScope, getGlobalScope, getIsolationScope } from '../../src/currentScopes'; | ||
| import { withMonitor } from '../../src/monitor'; | ||
| import { setCurrentClient } from '../../src/sdk'; | ||
| import { getDefaultTestClientOptions, TestClient } from '../mocks/client'; | ||
|
|
||
| describe('withMonitor', () => { | ||
| beforeEach(() => { | ||
| getCurrentScope().clear(); | ||
| getIsolationScope().clear(); | ||
| getGlobalScope().clear(); | ||
|
|
||
| const client = new TestClient(getDefaultTestClientOptions({ dsn: 'https://username@domain/123' })); | ||
| setCurrentClient(client); | ||
| client.init(); | ||
| }); | ||
|
|
||
| it('keeps the parent trace when not isolating the trace', () => { | ||
| const parentTraceId = getCurrentScope().getPropagationContext().traceId; | ||
|
|
||
| withMonitor('cron-job', () => { | ||
| expect(getCurrentScope().getPropagationContext().traceId).toBe(parentTraceId); | ||
| }); | ||
| }); | ||
|
|
||
| it('starts a separate trace when isolateTrace is set', () => { | ||
| const parentTraceId = getCurrentScope().getPropagationContext().traceId; | ||
|
|
||
| withMonitor( | ||
| 'cron-job', | ||
| () => { | ||
| expect(getCurrentScope().getPropagationContext().traceId).not.toBe(parentTraceId); | ||
| }, | ||
| { schedule: { type: 'crontab', value: '* * * * *' }, isolateTrace: true }, | ||
| ); | ||
| }); | ||
|
|
||
| // The parent's propagation context is restored onto the monitor scope, so it | ||
| // must be copied rather than aliased. Several call sites mutate the | ||
| // propagation context in place (e.g. the Node HTTP server integration | ||
| // assigns `propagationSpanId`), which would otherwise rewrite the parent's | ||
| // trace from inside the callback. | ||
| it('does not let the callback mutate the parent propagation context', () => { | ||
| const parentScope = getCurrentScope(); | ||
| const parentPropagationContext = parentScope.getPropagationContext(); | ||
|
|
||
| withMonitor('cron-job', () => { | ||
| const propagationContext = getCurrentScope().getPropagationContext(); | ||
|
|
||
| expect(propagationContext).not.toBe(parentPropagationContext); | ||
| expect(propagationContext).toEqual(parentPropagationContext); | ||
|
|
||
| propagationContext.propagationSpanId = 'deadbeefdeadbeef'; | ||
| propagationContext.traceId = 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'; | ||
| }); | ||
|
|
||
| expect(parentScope.getPropagationContext()).toEqual(parentPropagationContext); | ||
| expect(parentPropagationContext.propagationSpanId).toBeUndefined(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.