Skip to content

Commit be0cc01

Browse files
authored
feat(v8): Remove Severity enum (#10551)
1 parent f34503f commit be0cc01

File tree

26 files changed

+37
-142
lines changed

26 files changed

+37
-142
lines changed

MIGRATION.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
# Upgrading from 7.x to 8.x
2+
3+
## Removal of Severity Enum
4+
5+
In v7 we deprecated the `Severity` enum in favor of using the `SeverityLevel` type. In v8 we removed the `Severity`
6+
enum. If you were using the `Severity` enum, you should replace it with the `SeverityLevel` type. See
7+
[below](#severity-severitylevel-and-severitylevels) for code snippet examples
8+
19
# Deprecations in 7.x
210

311
You can use the **Experimental** [@sentry/migr8](https://www.npmjs.com/package/@sentry/migr8) to automatically update

packages/browser/src/client.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import type {
99
EventHint,
1010
Options,
1111
ParameterizedString,
12-
Severity,
1312
SeverityLevel,
1413
UserFeedback,
1514
} from '@sentry/types';
@@ -76,8 +75,7 @@ export class BrowserClient extends BaseClient<BrowserClientOptions> {
7675
*/
7776
public eventFromMessage(
7877
message: ParameterizedString,
79-
// eslint-disable-next-line deprecation/deprecation
80-
level: Severity | SeverityLevel = 'info',
78+
level: SeverityLevel = 'info',
8179
hint?: EventHint,
8280
): PromiseLike<Event> {
8381
return eventFromMessage(this._options.stackParser, message, level, hint, this._options.attachStacktrace);

packages/browser/src/eventbuilder.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import type {
44
EventHint,
55
Exception,
66
ParameterizedString,
7-
Severity,
87
SeverityLevel,
98
StackFrame,
109
StackParser,
@@ -178,8 +177,7 @@ export function eventFromException(
178177
export function eventFromMessage(
179178
stackParser: StackParser,
180179
message: ParameterizedString,
181-
// eslint-disable-next-line deprecation/deprecation
182-
level: Severity | SeverityLevel = 'info',
180+
level: SeverityLevel = 'info',
183181
hint?: EventHint,
184182
attachStacktrace?: boolean,
185183
): PromiseLike<Event> {

packages/browser/src/exports.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@ export type {
66
Event,
77
EventHint,
88
Exception,
9-
// eslint-disable-next-line deprecation/deprecation
10-
Severity,
119
SeverityLevel,
1210
StackFrame,
1311
Stacktrace,

packages/bun/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ export type {
88
EventHint,
99
Exception,
1010
Session,
11-
// eslint-disable-next-line deprecation/deprecation
12-
Severity,
1311
SeverityLevel,
1412
Span,
1513
StackFrame,

packages/core/src/baseclient.ts

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ import type {
2323
SdkMetadata,
2424
Session,
2525
SessionAggregates,
26-
Severity,
2726
SeverityLevel,
2827
StartSpanOptions,
2928
Transaction,
@@ -186,8 +185,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
186185
*/
187186
public captureMessage(
188187
message: ParameterizedString,
189-
// eslint-disable-next-line deprecation/deprecation
190-
level?: Severity | SeverityLevel,
188+
level?: SeverityLevel,
191189
hint?: EventHint,
192190
scope?: Scope,
193191
): string | undefined {
@@ -876,8 +874,7 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
876874
*/
877875
public abstract eventFromMessage(
878876
_message: ParameterizedString,
879-
// eslint-disable-next-line deprecation/deprecation
880-
_level?: Severity | SeverityLevel,
877+
_level?: SeverityLevel,
881878
_hint?: EventHint,
882879
): PromiseLike<Event>;
883880
}

packages/core/src/exports.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ import type {
1515
Scope as ScopeInterface,
1616
Session,
1717
SessionContext,
18-
Severity,
1918
SeverityLevel,
2019
Span,
2120
TransactionContext,
@@ -56,11 +55,7 @@ export function captureException(
5655
* @param captureContext Define the level of the message or pass in additional data to attach to the message.
5756
* @returns the id of the captured message.
5857
*/
59-
export function captureMessage(
60-
message: string,
61-
// eslint-disable-next-line deprecation/deprecation
62-
captureContext?: CaptureContext | Severity | SeverityLevel,
63-
): string {
58+
export function captureMessage(message: string, captureContext?: CaptureContext | SeverityLevel): string {
6459
// This is necessary to provide explicit scopes upgrade, without changing the original
6560
// arity of the `captureMessage(message, level)` method.
6661
const level = typeof captureContext === 'string' ? captureContext : undefined;

packages/core/src/hub.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import type {
1414
Primitive,
1515
Session,
1616
SessionContext,
17-
Severity,
1817
SeverityLevel,
1918
Transaction,
2019
TransactionContext,
@@ -320,12 +319,7 @@ export class Hub implements HubInterface {
320319
*
321320
* @deprecated Use `Sentry.captureMessage()` instead.
322321
*/
323-
public captureMessage(
324-
message: string,
325-
// eslint-disable-next-line deprecation/deprecation
326-
level?: Severity | SeverityLevel,
327-
hint?: EventHint,
328-
): string {
322+
public captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string {
329323
const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
330324
const syntheticException = new Error(message);
331325
// eslint-disable-next-line deprecation/deprecation

packages/core/src/scope.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ import type {
1818
ScopeContext,
1919
ScopeData,
2020
Session,
21-
Severity,
2221
SeverityLevel,
2322
Span,
2423
Transaction,
@@ -86,8 +85,7 @@ export class Scope implements ScopeInterface {
8685
protected _fingerprint?: string[];
8786

8887
/** Severity */
89-
// eslint-disable-next-line deprecation/deprecation
90-
protected _level?: Severity | SeverityLevel;
88+
protected _level?: SeverityLevel;
9189

9290
/**
9391
* Transaction Name
@@ -283,10 +281,7 @@ export class Scope implements ScopeInterface {
283281
/**
284282
* @inheritDoc
285283
*/
286-
public setLevel(
287-
// eslint-disable-next-line deprecation/deprecation
288-
level: Severity | SeverityLevel,
289-
): this {
284+
public setLevel(level: SeverityLevel): this {
290285
this._level = level;
291286
this._notifyScopeListeners();
292287
return this;

packages/core/src/server-runtime-client.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import type {
88
MonitorConfig,
99
ParameterizedString,
1010
SerializedCheckIn,
11-
Severity,
1211
SeverityLevel,
1312
TraceContext,
1413
} from '@sentry/types';
@@ -70,8 +69,7 @@ export class ServerRuntimeClient<
7069
*/
7170
public eventFromMessage(
7271
message: ParameterizedString,
73-
// eslint-disable-next-line deprecation/deprecation
74-
level: Severity | SeverityLevel = 'info',
72+
level: SeverityLevel = 'info',
7573
hint?: EventHint,
7674
): PromiseLike<Event> {
7775
return resolvedSyncPromise(

packages/core/test/mocks/client.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ import type {
77
Outcome,
88
ParameterizedString,
99
Session,
10-
Severity,
1110
SeverityLevel,
1211
} from '@sentry/types';
1312
import { resolvedSyncPromise } from '@sentry/utils';
@@ -76,11 +75,7 @@ export class TestClient extends BaseClient<TestClientOptions> {
7675
return resolvedSyncPromise(event);
7776
}
7877

79-
public eventFromMessage(
80-
message: ParameterizedString,
81-
// eslint-disable-next-line deprecation/deprecation
82-
level: Severity | SeverityLevel = 'info',
83-
): PromiseLike<Event> {
78+
public eventFromMessage(message: ParameterizedString, level: SeverityLevel = 'info'): PromiseLike<Event> {
8479
return resolvedSyncPromise({ message, level });
8580
}
8681

packages/deno/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ export type {
88
EventHint,
99
Exception,
1010
Session,
11-
// eslint-disable-next-line deprecation/deprecation
12-
Severity,
1311
SeverityLevel,
1412
Span,
1513
StackFrame,

packages/node-experimental/src/sdk/api.ts

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import type {
1212
Extra,
1313
Extras,
1414
Primitive,
15-
Severity,
1615
SeverityLevel,
1716
User,
1817
} from '@sentry/types';
@@ -120,11 +119,7 @@ export function captureException(exception: unknown, hint?: ExclusiveEventHintOr
120119
}
121120

122121
/** Record a message and send it to Sentry. */
123-
export function captureMessage(
124-
message: string,
125-
// eslint-disable-next-line deprecation/deprecation
126-
captureContext?: CaptureContext | Severity | SeverityLevel,
127-
): string {
122+
export function captureMessage(message: string, captureContext?: CaptureContext | SeverityLevel): string {
128123
// This is necessary to provide explicit scopes upgrade, without changing the original
129124
// arity of the `captureMessage(message, level)` method.
130125
const level = typeof captureContext === 'string' ? captureContext : undefined;

packages/node-experimental/src/sdk/hub.ts

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ import type {
55
Hub,
66
Integration,
77
IntegrationClass,
8-
Severity,
98
SeverityLevel,
109
TransactionContext,
1110
} from '@sentry/types';
@@ -68,12 +67,7 @@ export function getCurrentHub(): Hub {
6867
captureException: (exception: unknown, hint?: EventHint) => {
6968
return getCurrentScope().captureException(exception, hint);
7069
},
71-
captureMessage: (
72-
message: string,
73-
// eslint-disable-next-line deprecation/deprecation
74-
level?: Severity | SeverityLevel,
75-
hint?: EventHint,
76-
) => {
70+
captureMessage: (message: string, level?: SeverityLevel, hint?: EventHint) => {
7771
return getCurrentScope().captureMessage(message, level, hint);
7872
},
7973
captureEvent,

packages/node-experimental/src/sdk/scope.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { getGlobalScope as _getGlobalScope, setGlobalScope } from '@sentry/core';
22
import { OpenTelemetryScope } from '@sentry/opentelemetry';
3-
import type { Breadcrumb, Client, Event, EventHint, Severity, SeverityLevel } from '@sentry/types';
3+
import type { Breadcrumb, Client, Event, EventHint, SeverityLevel } from '@sentry/types';
44
import { uuid4 } from '@sentry/utils';
55

66
import { getGlobalCarrier } from './globals';
@@ -140,12 +140,7 @@ export class Scope extends OpenTelemetryScope implements ScopeInterface {
140140
}
141141

142142
/** Capture a message for this scope. */
143-
public captureMessage(
144-
message: string,
145-
// eslint-disable-next-line deprecation/deprecation
146-
level?: Severity | SeverityLevel,
147-
hint?: EventHint,
148-
): string {
143+
public captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string {
149144
const eventId = hint && hint.event_id ? hint.event_id : uuid4();
150145
const syntheticException = new Error(message);
151146

packages/node/src/index.ts

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ export type {
88
EventHint,
99
Exception,
1010
Session,
11-
// eslint-disable-next-line deprecation/deprecation
12-
Severity,
1311
SeverityLevel,
1412
Span,
1513
StackFrame,

packages/types/src/breadcrumb.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
import type { Severity, SeverityLevel } from './severity';
1+
import type { SeverityLevel } from './severity';
22

33
/** JSDoc */
44
export interface Breadcrumb {
55
type?: string;
6-
// eslint-disable-next-line deprecation/deprecation
7-
level?: Severity | SeverityLevel;
6+
level?: SeverityLevel;
87
event_id?: string;
98
category?: string;
109
message?: string;

packages/types/src/client.ts

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import type { ParameterizedString } from './parameterize';
1414
import type { Scope } from './scope';
1515
import type { SdkMetadata } from './sdkmetadata';
1616
import type { Session, SessionAggregates } from './session';
17-
import type { Severity, SeverityLevel } from './severity';
17+
import type { SeverityLevel } from './severity';
1818
import type { StartSpanOptions } from './startSpanOptions';
1919
import type { Transaction } from './transaction';
2020
import type { Transport, TransportMakeRequestResponse } from './transport';
@@ -48,13 +48,7 @@ export interface Client<O extends ClientOptions = ClientOptions> {
4848
* @param scope An optional scope containing event metadata.
4949
* @returns The event id
5050
*/
51-
captureMessage(
52-
message: string,
53-
// eslint-disable-next-line deprecation/deprecation
54-
level?: Severity | SeverityLevel,
55-
hint?: EventHint,
56-
scope?: Scope,
57-
): string | undefined;
51+
captureMessage(message: string, level?: SeverityLevel, hint?: EventHint, scope?: Scope): string | undefined;
5852

5953
/**
6054
* Captures a manually created event and sends it to Sentry.
@@ -175,12 +169,7 @@ export interface Client<O extends ClientOptions = ClientOptions> {
175169
eventFromException(exception: any, hint?: EventHint): PromiseLike<Event>;
176170

177171
/** Creates an {@link Event} from primitive inputs to `captureMessage`. */
178-
eventFromMessage(
179-
message: ParameterizedString,
180-
// eslint-disable-next-line deprecation/deprecation
181-
level?: Severity | SeverityLevel,
182-
hint?: EventHint,
183-
): PromiseLike<Event>;
172+
eventFromMessage(message: ParameterizedString, level?: SeverityLevel, hint?: EventHint): PromiseLike<Event>;
184173

185174
/** Submits the event to Sentry */
186175
sendEvent(event: Event, hint?: EventHint): void;

packages/types/src/event.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import type { Primitive } from './misc';
1010
import type { Request } from './request';
1111
import type { CaptureContext } from './scope';
1212
import type { SdkInfo } from './sdkinfo';
13-
import type { Severity, SeverityLevel } from './severity';
13+
import type { SeverityLevel } from './severity';
1414
import type { Span, SpanJSON } from './span';
1515
import type { Thread } from './thread';
1616
import type { TransactionSource } from './transaction';
@@ -26,8 +26,7 @@ export interface Event {
2626
};
2727
timestamp?: number;
2828
start_timestamp?: number;
29-
// eslint-disable-next-line deprecation/deprecation
30-
level?: Severity | SeverityLevel;
29+
level?: SeverityLevel;
3130
platform?: string;
3231
logger?: string;
3332
server_name?: string;

packages/types/src/hub.ts

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import type { Integration, IntegrationClass } from './integration';
66
import type { Primitive } from './misc';
77
import type { Scope } from './scope';
88
import type { Session } from './session';
9-
import type { Severity, SeverityLevel } from './severity';
9+
import type { SeverityLevel } from './severity';
1010
import type { CustomSamplingContext, Transaction, TransactionContext } from './transaction';
1111
import type { User } from './user';
1212

@@ -116,12 +116,7 @@ export interface Hub {
116116
*
117117
* @deprecated Use `Sentry.captureMessage()` instead.
118118
*/
119-
captureMessage(
120-
message: string,
121-
// eslint-disable-next-line deprecation/deprecation
122-
level?: Severity | SeverityLevel,
123-
hint?: EventHint,
124-
): string;
119+
captureMessage(message: string, level?: SeverityLevel, hint?: EventHint): string;
125120

126121
/**
127122
* Captures a manually created event and sends it to Sentry.

packages/types/src/index.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,8 +87,7 @@ export type {
8787
SerializedSession,
8888
} from './session';
8989

90-
// eslint-disable-next-line deprecation/deprecation
91-
export type { Severity, SeverityLevel } from './severity';
90+
export type { SeverityLevel } from './severity';
9291
export type {
9392
Span,
9493
SpanContext,

0 commit comments

Comments
 (0)