diff --git a/MIGRATION.md b/MIGRATION.md index e315bf77ccfd..626d95bb88cd 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -1,3 +1,11 @@ +# Upgrading from 7.x to 8.x + +## Removal of Severity Enum + +In v7 we deprecated the `Severity` enum in favor of using the `SeverityLevel` type. In v8 we removed the `Severity` +enum. If you were using the `Severity` enum, you should replace it with the `SeverityLevel` type. See +[below](#severity-severitylevel-and-severitylevels) for code snippet examples + # Deprecations in 7.x You can use the **Experimental** [@sentry/migr8](https://www.npmjs.com/package/@sentry/migr8) to automatically update diff --git a/packages/browser/src/client.ts b/packages/browser/src/client.ts index 2f1c5ba2fdbb..97ea8e3b5e0c 100644 --- a/packages/browser/src/client.ts +++ b/packages/browser/src/client.ts @@ -9,7 +9,6 @@ import type { EventHint, Options, ParameterizedString, - Severity, SeverityLevel, UserFeedback, } from '@sentry/types'; @@ -76,8 +75,7 @@ export class BrowserClient extends BaseClient { */ public eventFromMessage( message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel = 'info', + level: SeverityLevel = 'info', hint?: EventHint, ): PromiseLike { return eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace); diff --git a/packages/browser/src/eventbuilder.ts b/packages/browser/src/eventbuilder.ts index 9e72fb288cb4..2956006b0ac7 100644 --- a/packages/browser/src/eventbuilder.ts +++ b/packages/browser/src/eventbuilder.ts @@ -4,7 +4,6 @@ import type { EventHint, Exception, ParameterizedString, - Severity, SeverityLevel, StackFrame, StackParser, @@ -178,8 +177,7 @@ export function eventFromException( export function eventFromMessage( stackParser: StackParser, message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel = 'info', + level: SeverityLevel = 'info', hint?: EventHint, attachStacktrace?: boolean, ): PromiseLike { diff --git a/packages/browser/src/exports.ts b/packages/browser/src/exports.ts index e9e947de8559..496fbc3a9644 100644 --- a/packages/browser/src/exports.ts +++ b/packages/browser/src/exports.ts @@ -6,8 +6,6 @@ export type { Event, EventHint, Exception, - // eslint-disable-next-line deprecation/deprecation - Severity, SeverityLevel, StackFrame, Stacktrace, diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts index b51083052c8b..f1958c53404d 100644 --- a/packages/bun/src/index.ts +++ b/packages/bun/src/index.ts @@ -8,8 +8,6 @@ export type { EventHint, Exception, Session, - // eslint-disable-next-line deprecation/deprecation - Severity, SeverityLevel, Span, StackFrame, diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts index b7f00e14baef..2c08ba45e20d 100644 --- a/packages/core/src/baseclient.ts +++ b/packages/core/src/baseclient.ts @@ -23,7 +23,6 @@ import type { SdkMetadata, Session, SessionAggregates, - Severity, SeverityLevel, StartSpanOptions, Transaction, @@ -186,8 +185,7 @@ export abstract class BaseClient implements Client { */ public captureMessage( message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, + level?: SeverityLevel, hint?: EventHint, scope?: Scope, ): string | undefined { @@ -876,8 +874,7 @@ export abstract class BaseClient implements Client { */ public abstract eventFromMessage( _message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - _level?: Severity | SeverityLevel, + _level?: SeverityLevel, _hint?: EventHint, ): PromiseLike; } diff --git a/packages/core/src/exports.ts b/packages/core/src/exports.ts index e1fc9a6102ac..22dd5f26a3ba 100644 --- a/packages/core/src/exports.ts +++ b/packages/core/src/exports.ts @@ -15,7 +15,6 @@ import type { Scope as ScopeInterface, Session, SessionContext, - Severity, SeverityLevel, Span, TransactionContext, @@ -56,11 +55,7 @@ export function captureException( * @param captureContext Define the level of the message or pass in additional data to attach to the message. * @returns the id of the captured message. */ -export function captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - captureContext?: CaptureContext | Severity | SeverityLevel, -): string { +export function captureMessage(message: string, captureContext?: CaptureContext | SeverityLevel): string { // This is necessary to provide explicit scopes upgrade, without changing the original // arity of the `captureMessage(message, level)` method. const level = typeof captureContext === 'string' ? captureContext : undefined; diff --git a/packages/core/src/hub.ts b/packages/core/src/hub.ts index d0f7c1cf4430..2a343b320f1b 100644 --- a/packages/core/src/hub.ts +++ b/packages/core/src/hub.ts @@ -14,7 +14,6 @@ import type { Primitive, Session, SessionContext, - Severity, SeverityLevel, Transaction, TransactionContext, @@ -320,12 +319,7 @@ export class Hub implements HubInterface { * * @deprecated Use `Sentry.captureMessage()` instead. */ - public captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - ): string { + public captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string { const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4()); const syntheticException = new Error(message); // eslint-disable-next-line deprecation/deprecation diff --git a/packages/core/src/scope.ts b/packages/core/src/scope.ts index 01546a84be25..9298637fae68 100644 --- a/packages/core/src/scope.ts +++ b/packages/core/src/scope.ts @@ -18,7 +18,6 @@ import type { ScopeContext, ScopeData, Session, - Severity, SeverityLevel, Span, Transaction, @@ -86,8 +85,7 @@ export class Scope implements ScopeInterface { protected _fingerprint?: string[]; /** Severity */ - // eslint-disable-next-line deprecation/deprecation - protected _level?: Severity | SeverityLevel; + protected _level?: SeverityLevel; /** * Transaction Name @@ -283,10 +281,7 @@ export class Scope implements ScopeInterface { /** * @inheritDoc */ - public setLevel( - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel, - ): this { + public setLevel(level: SeverityLevel): this { this._level = level; this._notifyScopeListeners(); return this; diff --git a/packages/core/src/server-runtime-client.ts b/packages/core/src/server-runtime-client.ts index aed69369fc5d..b415a392d4cc 100644 --- a/packages/core/src/server-runtime-client.ts +++ b/packages/core/src/server-runtime-client.ts @@ -8,7 +8,6 @@ import type { MonitorConfig, ParameterizedString, SerializedCheckIn, - Severity, SeverityLevel, TraceContext, } from '@sentry/types'; @@ -70,8 +69,7 @@ export class ServerRuntimeClient< */ public eventFromMessage( message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel = 'info', + level: SeverityLevel = 'info', hint?: EventHint, ): PromiseLike { return resolvedSyncPromise( diff --git a/packages/core/test/mocks/client.ts b/packages/core/test/mocks/client.ts index 7cb1e08cecba..ad47a50fceb8 100644 --- a/packages/core/test/mocks/client.ts +++ b/packages/core/test/mocks/client.ts @@ -7,7 +7,6 @@ import type { Outcome, ParameterizedString, Session, - Severity, SeverityLevel, } from '@sentry/types'; import { resolvedSyncPromise } from '@sentry/utils'; @@ -76,11 +75,7 @@ export class TestClient extends BaseClient { return resolvedSyncPromise(event); } - public eventFromMessage( - message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel = 'info', - ): PromiseLike { + public eventFromMessage(message: ParameterizedString, level: SeverityLevel = 'info'): PromiseLike { return resolvedSyncPromise({ message, level }); } diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts index d42ad97fedb8..82ce6004ece6 100644 --- a/packages/deno/src/index.ts +++ b/packages/deno/src/index.ts @@ -8,8 +8,6 @@ export type { EventHint, Exception, Session, - // eslint-disable-next-line deprecation/deprecation - Severity, SeverityLevel, Span, StackFrame, diff --git a/packages/node-experimental/src/sdk/api.ts b/packages/node-experimental/src/sdk/api.ts index ae8450d58a7c..c4a0f3858111 100644 --- a/packages/node-experimental/src/sdk/api.ts +++ b/packages/node-experimental/src/sdk/api.ts @@ -12,7 +12,6 @@ import type { Extra, Extras, Primitive, - Severity, SeverityLevel, User, } from '@sentry/types'; @@ -120,11 +119,7 @@ export function captureException(exception: unknown, hint?: ExclusiveEventHintOr } /** Record a message and send it to Sentry. */ -export function captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - captureContext?: CaptureContext | Severity | SeverityLevel, -): string { +export function captureMessage(message: string, captureContext?: CaptureContext | SeverityLevel): string { // This is necessary to provide explicit scopes upgrade, without changing the original // arity of the `captureMessage(message, level)` method. const level = typeof captureContext === 'string' ? captureContext : undefined; diff --git a/packages/node-experimental/src/sdk/hub.ts b/packages/node-experimental/src/sdk/hub.ts index b2ffaa16b364..cce73a81d71f 100644 --- a/packages/node-experimental/src/sdk/hub.ts +++ b/packages/node-experimental/src/sdk/hub.ts @@ -5,7 +5,6 @@ import type { Hub, Integration, IntegrationClass, - Severity, SeverityLevel, TransactionContext, } from '@sentry/types'; @@ -68,12 +67,7 @@ export function getCurrentHub(): Hub { captureException: (exception: unknown, hint?: EventHint) => { return getCurrentScope().captureException(exception, hint); }, - captureMessage: ( - message: string, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - ) => { + captureMessage: (message: string, level?: SeverityLevel, hint?: EventHint) => { return getCurrentScope().captureMessage(message, level, hint); }, captureEvent, diff --git a/packages/node-experimental/src/sdk/scope.ts b/packages/node-experimental/src/sdk/scope.ts index e55667992839..dfe19e63fdbe 100644 --- a/packages/node-experimental/src/sdk/scope.ts +++ b/packages/node-experimental/src/sdk/scope.ts @@ -1,6 +1,6 @@ import { getGlobalScope as _getGlobalScope, setGlobalScope } from '@sentry/core'; import { OpenTelemetryScope } from '@sentry/opentelemetry'; -import type { Breadcrumb, Client, Event, EventHint, Severity, SeverityLevel } from '@sentry/types'; +import type { Breadcrumb, Client, Event, EventHint, SeverityLevel } from '@sentry/types'; import { uuid4 } from '@sentry/utils'; import { getGlobalCarrier } from './globals'; @@ -140,12 +140,7 @@ export class Scope extends OpenTelemetryScope implements ScopeInterface { } /** Capture a message for this scope. */ - public captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - ): string { + public captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string { const eventId = hint && hint.event_id ? hint.event_id : uuid4(); const syntheticException = new Error(message); diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts index 8d0a82ecbfe6..44630d871260 100644 --- a/packages/node/src/index.ts +++ b/packages/node/src/index.ts @@ -8,8 +8,6 @@ export type { EventHint, Exception, Session, - // eslint-disable-next-line deprecation/deprecation - Severity, SeverityLevel, Span, StackFrame, diff --git a/packages/types/src/breadcrumb.ts b/packages/types/src/breadcrumb.ts index 9f9b36bd6dcb..21a6a481fbec 100644 --- a/packages/types/src/breadcrumb.ts +++ b/packages/types/src/breadcrumb.ts @@ -1,10 +1,9 @@ -import type { Severity, SeverityLevel } from './severity'; +import type { SeverityLevel } from './severity'; /** JSDoc */ export interface Breadcrumb { type?: string; - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel; + level?: SeverityLevel; event_id?: string; category?: string; message?: string; diff --git a/packages/types/src/client.ts b/packages/types/src/client.ts index 5db008b0ba37..6c4409185e2d 100644 --- a/packages/types/src/client.ts +++ b/packages/types/src/client.ts @@ -14,7 +14,7 @@ import type { ParameterizedString } from './parameterize'; import type { Scope } from './scope'; import type { SdkMetadata } from './sdkmetadata'; import type { Session, SessionAggregates } from './session'; -import type { Severity, SeverityLevel } from './severity'; +import type { SeverityLevel } from './severity'; import type { StartSpanOptions } from './startSpanOptions'; import type { Transaction } from './transaction'; import type { Transport, TransportMakeRequestResponse } from './transport'; @@ -48,13 +48,7 @@ export interface Client { * @param scope An optional scope containing event metadata. * @returns The event id */ - captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - scope?: Scope, - ): string | undefined; + captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, scope?: Scope): string | undefined; /** * Captures a manually created event and sends it to Sentry. @@ -175,12 +169,7 @@ export interface Client { eventFromException(exception: any, hint?: EventHint): PromiseLike; /** Creates an {@link Event} from primitive inputs to `captureMessage`. */ - eventFromMessage( - message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - ): PromiseLike; + eventFromMessage(message: ParameterizedString, level?: SeverityLevel, hint?: EventHint): PromiseLike; /** Submits the event to Sentry */ sendEvent(event: Event, hint?: EventHint): void; diff --git a/packages/types/src/event.ts b/packages/types/src/event.ts index 50322f18fbc6..cfddd6bef471 100644 --- a/packages/types/src/event.ts +++ b/packages/types/src/event.ts @@ -10,7 +10,7 @@ import type { Primitive } from './misc'; import type { Request } from './request'; import type { CaptureContext } from './scope'; import type { SdkInfo } from './sdkinfo'; -import type { Severity, SeverityLevel } from './severity'; +import type { SeverityLevel } from './severity'; import type { Span, SpanJSON } from './span'; import type { Thread } from './thread'; import type { TransactionSource } from './transaction'; @@ -26,8 +26,7 @@ export interface Event { }; timestamp?: number; start_timestamp?: number; - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel; + level?: SeverityLevel; platform?: string; logger?: string; server_name?: string; diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts index 0656d55644f8..3f46b88da498 100644 --- a/packages/types/src/hub.ts +++ b/packages/types/src/hub.ts @@ -6,7 +6,7 @@ import type { Integration, IntegrationClass } from './integration'; import type { Primitive } from './misc'; import type { Scope } from './scope'; import type { Session } from './session'; -import type { Severity, SeverityLevel } from './severity'; +import type { SeverityLevel } from './severity'; import type { CustomSamplingContext, Transaction, TransactionContext } from './transaction'; import type { User } from './user'; @@ -116,12 +116,7 @@ export interface Hub { * * @deprecated Use `Sentry.captureMessage()` instead. */ - captureMessage( - message: string, - // eslint-disable-next-line deprecation/deprecation - level?: Severity | SeverityLevel, - hint?: EventHint, - ): string; + captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string; /** * Captures a manually created event and sends it to Sentry. diff --git a/packages/types/src/index.ts b/packages/types/src/index.ts index 5970383febc3..0504803c49a1 100644 --- a/packages/types/src/index.ts +++ b/packages/types/src/index.ts @@ -87,8 +87,7 @@ export type { SerializedSession, } from './session'; -// eslint-disable-next-line deprecation/deprecation -export type { Severity, SeverityLevel } from './severity'; +export type { SeverityLevel } from './severity'; export type { Span, SpanContext, diff --git a/packages/types/src/scope.ts b/packages/types/src/scope.ts index fd51eae8e5c4..2a6d01f7caa0 100644 --- a/packages/types/src/scope.ts +++ b/packages/types/src/scope.ts @@ -7,7 +7,7 @@ import type { EventProcessor } from './eventprocessor'; import type { Extra, Extras } from './extra'; import type { Primitive } from './misc'; import type { RequestSession, Session } from './session'; -import type { Severity, SeverityLevel } from './severity'; +import type { SeverityLevel } from './severity'; import type { Span } from './span'; import type { PropagationContext } from './tracing'; import type { Transaction } from './transaction'; @@ -19,8 +19,7 @@ export type CaptureContext = Scope | Partial | ((scope: Scope) => /** JSDocs */ export interface ScopeContext { user: User; - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel; + level: SeverityLevel; extra: Extras; contexts: Contexts; tags: { [key: string]: Primitive }; @@ -119,10 +118,7 @@ export interface Scope { * Sets the level on the scope for future events. * @param level string {@link SeverityLevel} */ - setLevel( - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel, - ): this; + setLevel(level: SeverityLevel): this; /** * Sets the transaction name on the scope for future events. diff --git a/packages/types/src/severity.ts b/packages/types/src/severity.ts index de13f2a02b99..78d1a6f5dd73 100644 --- a/packages/types/src/severity.ts +++ b/packages/types/src/severity.ts @@ -1,22 +1,3 @@ -/** - * @deprecated Please use a `SeverityLevel` string instead of the `Severity` enum. Acceptable values are 'fatal', - * 'error', 'warning', 'log', 'info', and 'debug'. - */ -export enum Severity { - /** JSDoc */ - Fatal = 'fatal', - /** JSDoc */ - Error = 'error', - /** JSDoc */ - Warning = 'warning', - /** JSDoc */ - Log = 'log', - /** JSDoc */ - Info = 'info', - /** JSDoc */ - Debug = 'debug', -} - // Note: If this is ever changed, the `validSeverityLevels` array in `@sentry/utils` needs to be changed, also. (See // note there for why we can't derive one from the other.) export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug'; diff --git a/packages/utils/src/eventbuilder.ts b/packages/utils/src/eventbuilder.ts index 74b5aff6538e..5391723dfe57 100644 --- a/packages/utils/src/eventbuilder.ts +++ b/packages/utils/src/eventbuilder.ts @@ -7,7 +7,6 @@ import type { Hub, Mechanism, ParameterizedString, - Severity, SeverityLevel, StackFrame, StackParser, @@ -133,8 +132,7 @@ export function eventFromUnknownInput( export function eventFromMessage( stackParser: StackParser, message: ParameterizedString, - // eslint-disable-next-line deprecation/deprecation - level: Severity | SeverityLevel = 'info', + level: SeverityLevel = 'info', hint?: EventHint, attachStacktrace?: boolean, ): Event { diff --git a/packages/utils/src/severity.ts b/packages/utils/src/severity.ts index 6d631b590a88..983ec1ae08ae 100644 --- a/packages/utils/src/severity.ts +++ b/packages/utils/src/severity.ts @@ -1,5 +1,4 @@ -/* eslint-disable deprecation/deprecation */ -import type { Severity, SeverityLevel } from '@sentry/types'; +import type { SeverityLevel } from '@sentry/types'; // Note: Ideally the `SeverityLevel` type would be derived from `validSeverityLevels`, but that would mean either // @@ -13,18 +12,6 @@ import type { Severity, SeverityLevel } from '@sentry/types'; export const validSeverityLevels = ['fatal', 'error', 'warning', 'log', 'info', 'debug']; -/** - * Converts a string-based level into a member of the deprecated {@link Severity} enum. - * - * @deprecated `severityFromString` is deprecated. Please use `severityLevelFromString` instead. - * - * @param level String representation of Severity - * @returns Severity - */ -export function severityFromString(level: Severity | SeverityLevel | string): Severity { - return severityLevelFromString(level) as Severity; -} - /** * Converts a string-based level into a `SeverityLevel`, normalizing it along the way. * diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/src/index.ts index 8288c8ca5374..98910cbd754a 100644 --- a/packages/vercel-edge/src/index.ts +++ b/packages/vercel-edge/src/index.ts @@ -8,8 +8,6 @@ export type { EventHint, Exception, Session, - // eslint-disable-next-line deprecation/deprecation - Severity, SeverityLevel, Span, StackFrame,