Skip to content

feat(core): Set default scope for BaseClient methods #11775

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
merged 2 commits into from
Apr 25, 2024
Merged

feat(core): Set default scope for BaseClient methods #11775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90f168b
feat(core): Set default scope for BaseClient methods
timfish Apr 24, 2024
41ec3bd
Instead add docs
timfish Apr 25, 2024
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
30 changes: 15 additions & 15 deletions packages/core/src/baseclient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import type {
Integration,
Outcome,
ParameterizedString,
Scope,
SdkMetadata,
Session,
SessionAggregates,
Expand Down Expand Up @@ -52,7 +53,6 @@ import { createEventEnvelope, createSessionEnvelope } from './envelope';
import type { IntegrationIndex } from './integration';
import { afterSetupIntegrations } from './integration';
import { setupIntegration, setupIntegrations } from './integration';
import type { Scope } from './scope';
import { updateSession } from './session';
import { getDynamicSamplingContextFromClient } from './tracing/dynamicSamplingContext';
import { parseSampleRate } from './utils/parseSampleRate';
Expand Down Expand Up @@ -151,7 +151,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
* @inheritDoc
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
public captureException(exception: any, hint?: EventHint, scope?: Scope): string | undefined {
public captureException(exception: any, hint?: EventHint, currentScope?: Scope): string | undefined {
// ensure we haven't captured this very object before
if (checkOrSetAlreadyCaught(exception)) {
DEBUG_BUILD && logger.log(ALREADY_SEEN_ERROR);
Expand All @@ -162,7 +162,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {

this._process(
this.eventFromException(exception, hint)
.then(event => this._captureEvent(event, hint, scope))
.then(event => this._captureEvent(event, hint, currentScope))
.then(result => {
eventId = result;
}),
Expand All @@ -178,7 +178,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
message: ParameterizedString,
level?: SeverityLevel,
hint?: EventHint,
scope?: Scope,
currentScope?: Scope,
): string | undefined {
let eventId: string | undefined = hint && hint.event_id;

Expand All @@ -190,7 +190,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {

this._process(
promisedEvent
.then(event => this._captureEvent(event, hint, scope))
.then(event => this._captureEvent(event, hint, currentScope))
.then(result => {
eventId = result;
}),
Expand All @@ -202,7 +202,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
/**
* @inheritDoc
*/
public captureEvent(event: Event, hint?: EventHint, scope?: Scope): string | undefined {
public captureEvent(event: Event, hint?: EventHint, currentScope?: Scope): string | undefined {
// ensure we haven't captured this very object before
if (hint && hint.originalException && checkOrSetAlreadyCaught(hint.originalException)) {
DEBUG_BUILD && logger.log(ALREADY_SEEN_ERROR);
Expand All @@ -215,7 +215,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
const capturedSpanScope: Scope | undefined = sdkProcessingMetadata.capturedSpanScope;

this._process(
this._captureEvent(event, hint, capturedSpanScope || scope).then(result => {
this._captureEvent(event, hint, capturedSpanScope || currentScope).then(result => {
eventId = result;
}),
);
Expand Down Expand Up @@ -629,13 +629,13 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
*
* @param event The original event.
* @param hint May contain additional information about the original exception.
* @param scope A scope containing event metadata.
* @param currentScope A scope containing event metadata.
* @returns A new event with more information.
*/
protected _prepareEvent(
event: Event,
hint: EventHint,
scope?: Scope,
currentScope?: Scope,
isolationScope = getIsolationScope(),
): PromiseLike<Event | null> {
const options = this.getOptions();
Expand All @@ -646,14 +646,14 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {

this.emit('preprocessEvent', event, hint);

return prepareEvent(options, event, hint, scope, this, isolationScope).then(evt => {
return prepareEvent(options, event, hint, currentScope, this, isolationScope).then(evt => {
if (evt === null) {
return evt;
}

const propagationContext = {
...isolationScope.getPropagationContext(),
...(scope ? scope.getPropagationContext() : undefined),
...(currentScope ? currentScope.getPropagationContext() : undefined),
};

const trace = evt.contexts && evt.contexts.trace;
Expand Down Expand Up @@ -716,10 +716,10 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
*
* @param event The event to send to Sentry.
* @param hint May contain additional information about the original exception.
* @param scope A scope containing event metadata.
* @param currentScope A scope containing event metadata.
* @returns A SyncPromise that resolves with the event or rejects in case event was/will not be send.
*/
protected _processEvent(event: Event, hint: EventHint, scope?: Scope): PromiseLike<Event> {
protected _processEvent(event: Event, hint: EventHint, currentScope?: Scope): PromiseLike<Event> {
const options = this.getOptions();
const { sampleRate } = options;

Expand Down Expand Up @@ -747,7 +747,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
const sdkProcessingMetadata = event.sdkProcessingMetadata || {};
const capturedSpanIsolationScope: Scope | undefined = sdkProcessingMetadata.capturedSpanIsolationScope;

return this._prepareEvent(event, hint, scope, capturedSpanIsolationScope)
return this._prepareEvent(event, hint, currentScope, capturedSpanIsolationScope)
.then(prepared => {
if (prepared === null) {
this.recordDroppedEvent('event_processor', dataCategory, event);
Expand All @@ -768,7 +768,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
throw new SentryError(`${beforeSendLabel} returned \`null\`, will not send event.`, 'log');
}

const session = scope && scope.getSession();
const session = currentScope && currentScope.getSession();
if (!isTransaction && session) {
this._updateSessionFromEvent(session, processedEvent);
}
Expand Down
18 changes: 12 additions & 6 deletions packages/types/src/client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,33 +31,39 @@ export interface Client<O extends ClientOptions = ClientOptions> {
/**
* Captures an exception event and sends it to Sentry.
*
* Unlike `captureException` exported from every SDK, this method requires that you pass it the current scope.
*
* @param exception An exception-like object.
* @param hint May contain additional information about the original exception.
* @param scope An optional scope containing event metadata.
* @param currentScope An optional scope containing event metadata.
* @returns The event id
*/
captureException(exception: any, hint?: EventHint, scope?: Scope): string | undefined;
captureException(exception: any, hint?: EventHint, currentScope?: Scope): string | undefined;

/**
* Captures a message event and sends it to Sentry.
*
* Unlike `captureMessage` exported from every SDK, this method requires that you pass it the current scope.
*
* @param message The message to send to Sentry.
* @param level Define the level of the message.
* @param hint May contain additional information about the original exception.
* @param scope An optional scope containing event metadata.
* @param currentScope An optional scope containing event metadata.
* @returns The event id
*/
captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, scope?: Scope): string | undefined;
captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, currentScope?: Scope): string | undefined;

/**
* Captures a manually created event and sends it to Sentry.
*
* Unlike `captureEvent` exported from every SDK, this method requires that you pass it the current scope.
*
* @param event The event to send to Sentry.
* @param hint May contain additional information about the original exception.
* @param scope An optional scope containing event metadata.
* @param currentScope An optional scope containing event metadata.
* @returns The event id
*/
captureEvent(event: Event, hint?: EventHint, scope?: Scope): string | undefined;
captureEvent(event: Event, hint?: EventHint, currentScope?: Scope): string | undefined;

/**
* Captures a session
Expand Down
Loading