Skip to content
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

ref(api): Remove lastEventId deprecation warnings (#11951) #12042

Merged
merged 1 commit into from
May 15, 2024
Merged

ref(api): Remove lastEventId deprecation warnings (#11951) #12042

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

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 2 additions & 51 deletions MIGRATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ If you are using the `Hub` right now, see the following table on how to migrate
| captureException() | `Sentry.captureException()` |
| captureMessage() | `Sentry.captureMessage()` |
| captureEvent() | `Sentry.captureEvent()` |
| lastEventId() | REMOVED - Use event processors or beforeSend instead |
| lastEventId() | `Sentry.lastEventId()` |
| addBreadcrumb() | `Sentry.addBreadcrumb()` |
| setUser() | `Sentry.setUser()` |
| setTags() | `Sentry.setTags()` |
Expand Down Expand Up @@ -381,36 +381,6 @@ app.get('/your-route', req => {
});
```

## Deprecate `Sentry.lastEventId()` and `hub.lastEventId()`

`Sentry.lastEventId()` sometimes causes race conditions, so we are deprecating it in favour of the `beforeSend`
callback.

```js
// Before

Sentry.init({
beforeSend(event, hint) {
const lastCapturedEventId = Sentry.lastEventId();

// Do something with `lastCapturedEventId` here

return event;
},
});

// After
Sentry.init({
beforeSend(event, hint) {
const lastCapturedEventId = event.event_id;

// Do something with `lastCapturedEventId` here

return event;
},
});
```

## Deprecated fields on `Span` and `Transaction`

In v8, the Span class is heavily reworked. The following properties & methods are thus deprecated:
Expand Down Expand Up @@ -478,25 +448,6 @@ Instead, import this directly from `@sentry/utils`.
Generally, in most cases you should probably use `continueTrace` instead, which abstracts this away from you and handles
scope propagation for you.

## Deprecate `lastEventId()`

Instead, if you need the ID of a recently captured event, we recommend using `beforeSend` instead:

```ts
import * as Sentry from '@sentry/browser';

Sentry.init({
dsn: '__DSN__',
beforeSend(event, hint) {
const lastCapturedEventId = event.event_id;

// Do something with `lastCapturedEventId` here

return event;
},
});
```

## Deprecate `timestampWithMs` export - #7878

The `timestampWithMs` util is deprecated in favor of using `timestampInSeconds`.
Expand Down Expand Up @@ -621,7 +572,7 @@ This is no longer used.

## Deprecate @sentry/hub (since 7.15.0) - #5823

This release deprecates `@sentry/hub` and all of it's exports. All of the `@sentry/hub` exports have moved to
This release deprecates `@sentry/hub` and all of its exports. All of the `@sentry/hub` exports have moved to
`@sentry/core`. `@sentry/hub` will be removed in the next major release.

# Upgrading Sentry Replay (beta, 7.24.0)
Expand Down
1 change: 0 additions & 1 deletion packages/astro/src/index.server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ export {
defaultIntegrations,
getDefaultIntegrations,
defaultStackParser,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
flush,
close,
Expand Down
4 changes: 0 additions & 4 deletions packages/astro/src/index.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,6 @@ export declare const defaultStackParser: StackParser;

export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;

/**
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
export declare function lastEventId(): string | undefined;

export default sentryAstro;
1 change: 0 additions & 1 deletion packages/browser/src/exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ export {
getCurrentScope,
// eslint-disable-next-line deprecation/deprecation
Hub,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
// eslint-disable-next-line deprecation/deprecation
Expand Down
2 changes: 0 additions & 2 deletions packages/browser/src/sdk.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,6 @@ export const showReportDialog: ShowReportDialogFunction = (
};
}

// TODO(v8): Remove this entire if statement. `eventId` will be a required option.
// eslint-disable-next-line deprecation/deprecation
if (!options.eventId) {
// eslint-disable-next-line deprecation/deprecation
options.eventId = hub.lastEventId();
Expand Down
1 change: 0 additions & 1 deletion packages/bun/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ export {
getIsolationScope,
// eslint-disable-next-line deprecation/deprecation
Hub,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
makeMain,
Expand Down
1 change: 0 additions & 1 deletion packages/core/src/exports.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,6 @@ export async function close(timeout?: number): Promise<boolean> {
* This is the getter for lastEventId.
*
* @returns The last event id of a captured event.
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
export function lastEventId(): string | undefined {
// eslint-disable-next-line deprecation/deprecation
Expand Down
1 change: 0 additions & 1 deletion packages/core/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ export {
// eslint-disable-next-line deprecation/deprecation
configureScope,
flush,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
startTransaction,
Expand Down
1 change: 0 additions & 1 deletion packages/deno/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export {
getIsolationScope,
// eslint-disable-next-line deprecation/deprecation
Hub,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
makeMain,
Expand Down
1 change: 0 additions & 1 deletion packages/node-experimental/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ export {
captureMessage,
addGlobalEventProcessor,
addEventProcessor,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
setContext,
setExtra,
Expand Down
2 changes: 0 additions & 2 deletions packages/node-experimental/src/sdk/api.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,10 +99,8 @@ export function withIsolationScope<T>(callback: (isolationScope: Scope) => T): T

/**
* Get the ID of the last sent error event.
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
export function lastEventId(): string | undefined {
// eslint-disable-next-line deprecation/deprecation
return getCurrentScope().lastEventId();
}

Expand Down
3 changes: 0 additions & 3 deletions packages/node-experimental/src/sdk/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@ export interface Scope extends BaseScope {
isolationScope: typeof this | undefined;
// @ts-expect-error typeof this is what we want here
clone(scope?: Scope): typeof this;
/**
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
lastEventId(): string | undefined;
getScopeData(): ScopeData;
}
Expand Down
1 change: 0 additions & 1 deletion packages/node/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export {
getIsolationScope,
// eslint-disable-next-line deprecation/deprecation
Hub,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
makeMain,
Expand Down
1 change: 0 additions & 1 deletion packages/remix/src/index.server.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ export {
defaultIntegrations,
getDefaultIntegrations,
defaultStackParser,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
flush,
close,
Expand Down
5 changes: 0 additions & 5 deletions packages/remix/src/index.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,4 @@ declare const runtime: 'client' | 'server';

export const close = runtime === 'client' ? clientSdk.close : serverSdk.close;
export const flush = runtime === 'client' ? clientSdk.flush : serverSdk.flush;

/**
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
// eslint-disable-next-line deprecation/deprecation
export const lastEventId = runtime === 'client' ? clientSdk.lastEventId : serverSdk.lastEventId;
1 change: 0 additions & 1 deletion packages/serverless/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,6 @@ export {
flush,
getSentryRelease,
init,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
DEFAULT_USER_INCLUDES,
addRequestDataToEvent,
Expand Down
4 changes: 0 additions & 4 deletions packages/sveltekit/src/index.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,4 @@ export declare const defaultStackParser: StackParser;

export declare function close(timeout?: number | undefined): PromiseLike<boolean>;
export declare function flush(timeout?: number | undefined): PromiseLike<boolean>;

/**
* @deprecated This function will be removed in the next major version of the Sentry SDK.
*/
export declare function lastEventId(): string | undefined;
1 change: 0 additions & 1 deletion packages/sveltekit/src/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,6 @@ export {
defaultIntegrations,
getDefaultIntegrations,
defaultStackParser,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
flush,
close,
Expand Down
1 change: 0 additions & 1 deletion packages/vercel-edge/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,6 @@ export {
getIsolationScope,
// eslint-disable-next-line deprecation/deprecation
Hub,
// eslint-disable-next-line deprecation/deprecation
lastEventId,
// eslint-disable-next-line deprecation/deprecation
makeMain,
Expand Down
Loading