Skip to content

Commit 46a6458

Browse files
committed
accept SeverityLevel wherever we accept Severity
1 parent 4266086 commit 46a6458

File tree

14 files changed

+64
-29
lines changed

14 files changed

+64
-29
lines changed

packages/browser/src/client.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
2-
import { Event, EventHint, Options, Severity, Transport, TransportOptions } from '@sentry/types';
2+
import { Event, EventHint, Options, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
33
import { getGlobalObject, logger, stackParserFromOptions, supportsFetch } from '@sentry/utils';
44

55
import { eventFromException, eventFromMessage } from './eventbuilder';
@@ -89,7 +89,11 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
8989
/**
9090
* @inheritDoc
9191
*/
92-
public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
92+
public eventFromMessage(
93+
message: string,
94+
level: Severity | SeverityLevel = Severity.Info,
95+
hint?: EventHint,
96+
): PromiseLike<Event> {
9397
return eventFromMessage(
9498
stackParserFromOptions(this._options),
9599
message,

packages/browser/src/eventbuilder.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { Event, EventHint, Exception, Severity, StackFrame, StackParser } from '@sentry/types';
1+
import { Event, EventHint, Exception, Severity, SeverityLevel, StackFrame, StackParser } from '@sentry/types';
22
import {
33
addExceptionMechanism,
44
addExceptionTypeValue,
@@ -164,7 +164,7 @@ export function eventFromException(
164164
export function eventFromMessage(
165165
stackParser: StackParser,
166166
message: string,
167-
level: Severity = Severity.Info,
167+
level: Severity | SeverityLevel = Severity.Info,
168168
hint?: EventHint,
169169
attachStacktrace?: boolean,
170170
): PromiseLike<Event> {

packages/core/src/baseclient.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import {
99
IntegrationClass,
1010
Options,
1111
Severity,
12+
SeverityLevel,
1213
Transport,
1314
} from '@sentry/types';
1415
import {
@@ -131,7 +132,12 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
131132
/**
132133
* @inheritDoc
133134
*/
134-
public captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined {
135+
public captureMessage(
136+
message: string,
137+
level?: Severity | SeverityLevel,
138+
hint?: EventHint,
139+
scope?: Scope,
140+
): string | undefined {
135141
let eventId: string | undefined = hint && hint.event_id;
136142

137143
const promisedEvent = isPrimitive(message)
@@ -685,7 +691,11 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
685691
/**
686692
* @inheritDoc
687693
*/
688-
public abstract eventFromMessage(_message: string, _level?: Severity, _hint?: EventHint): PromiseLike<Event>;
694+
public abstract eventFromMessage(
695+
_message: string,
696+
_level?: Severity | SeverityLevel,
697+
_hint?: EventHint,
698+
): PromiseLike<Event>;
689699
}
690700

691701
/**

packages/core/test/mocks/client.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import { Session } from '@sentry/hub';
2-
import { Event, Options, Severity, Transport } from '@sentry/types';
2+
import { Event, Options, Severity, SeverityLevel, Transport } from '@sentry/types';
33
import { resolvedSyncPromise } from '@sentry/utils';
44

55
import { BaseClient } from '../../src/baseclient';
@@ -38,7 +38,7 @@ export class TestClient extends BaseClient<TestOptions> {
3838
});
3939
}
4040

41-
public eventFromMessage(message: string, level: Severity = Severity.Info): PromiseLike<Event> {
41+
public eventFromMessage(message: string, level: Severity | SeverityLevel = Severity.Info): PromiseLike<Event> {
4242
return resolvedSyncPromise({ message, level });
4343
}
4444

packages/hub/src/hub.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import {
1414
Primitive,
1515
SessionContext,
1616
Severity,
17+
SeverityLevel,
1718
Transaction,
1819
TransactionContext,
1920
User,
@@ -213,7 +214,7 @@ export class Hub implements HubInterface {
213214
/**
214215
* @inheritDoc
215216
*/
216-
public captureMessage(message: string, level?: Severity, hint?: EventHint): string {
217+
public captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string {
217218
const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
218219
let finalHint = hint;
219220

packages/hub/src/scope.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import {
1414
Scope as ScopeInterface,
1515
ScopeContext,
1616
Severity,
17+
SeverityLevel,
1718
Span,
1819
Transaction,
1920
User,
@@ -61,7 +62,7 @@ export class Scope implements ScopeInterface {
6162
protected _fingerprint?: string[];
6263

6364
/** Severity */
64-
protected _level?: Severity;
65+
protected _level?: Severity | SeverityLevel;
6566

6667
/** Transaction Name */
6768
protected _transactionName?: string;
@@ -208,7 +209,7 @@ export class Scope implements ScopeInterface {
208209
/**
209210
* @inheritDoc
210211
*/
211-
public setLevel(level: Severity): this {
212+
public setLevel(level: Severity | SeverityLevel): this {
212213
this._level = level;
213214
this._notifyScopeListeners();
214215
return this;

packages/minimal/src/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import {
88
Extras,
99
Primitive,
1010
Severity,
11+
SeverityLevel,
1112
Transaction,
1213
TransactionContext,
1314
User,
@@ -52,7 +53,7 @@ export function captureException(exception: any, captureContext?: CaptureContext
5253
* @param Severity Define the level of the message.
5354
* @returns The generated eventId.
5455
*/
55-
export function captureMessage(message: string, captureContext?: CaptureContext | Severity): string {
56+
export function captureMessage(message: string, captureContext?: CaptureContext | Severity | SeverityLevel): string {
5657
const syntheticException = new Error(message);
5758

5859
// This is necessary to provide explicit scopes upgrade, without changing the original

packages/node/src/client.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
22
import { SessionFlusher } from '@sentry/hub';
3-
import { Event, EventHint, Severity, Transport, TransportOptions } from '@sentry/types';
3+
import { Event, EventHint, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
44
import { logger, makeDsn, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';
55

66
import { eventFromMessage, eventFromUnknownInput } from './eventbuilder';
@@ -118,7 +118,11 @@ export class NodeClient extends BaseClient<NodeOptions> {
118118
/**
119119
* @inheritDoc
120120
*/
121-
public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
121+
public eventFromMessage(
122+
message: string,
123+
level: Severity | SeverityLevel = Severity.Info,
124+
hint?: EventHint,
125+
): PromiseLike<Event> {
122126
return resolvedSyncPromise(
123127
eventFromMessage(stackParserFromOptions(this._options), message, level, hint, this._options.attachStacktrace),
124128
);

packages/node/src/eventbuilder.ts

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
import { getCurrentHub } from '@sentry/hub';
2-
import { Event, EventHint, Exception, Mechanism, Severity, StackFrame, StackParser } from '@sentry/types';
2+
import {
3+
Event,
4+
EventHint,
5+
Exception,
6+
Mechanism,
7+
Severity,
8+
SeverityLevel,
9+
StackFrame,
10+
StackParser,
11+
} from '@sentry/types';
312
import {
413
addExceptionMechanism,
514
addExceptionTypeValue,
@@ -90,7 +99,7 @@ export function eventFromUnknownInput(stackParser: StackParser, exception: unkno
9099
export function eventFromMessage(
91100
stackParser: StackParser,
92101
message: string,
93-
level: Severity = Severity.Info,
102+
level: Severity | SeverityLevel = Severity.Info,
94103
hint?: EventHint,
95104
attachStacktrace?: boolean,
96105
): Event {

packages/types/src/breadcrumb.ts

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

33
/** JSDoc */
44
export interface Breadcrumb {
55
type?: string;
6-
level?: Severity;
6+
level?: Severity | SeverityLevel;
77
event_id?: string;
88
category?: string;
99
message?: string;

packages/types/src/client.ts

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { Integration, IntegrationClass } from './integration';
44
import { Options } from './options';
55
import { Scope } from './scope';
66
import { Session } from './session';
7-
import { Severity } from './severity';
7+
import { Severity, SeverityLevel } from './severity';
88
import { Transport } from './transport';
99

1010
/**
@@ -36,7 +36,12 @@ export interface Client<O extends Options = Options> {
3636
* @param scope An optional scope containing event metadata.
3737
* @returns The event id
3838
*/
39-
captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined;
39+
captureMessage(
40+
message: string,
41+
level?: Severity | SeverityLevel,
42+
hint?: EventHint,
43+
scope?: Scope,
44+
): string | undefined;
4045

4146
/**
4247
* Captures a manually created event and sends it to Sentry.
@@ -99,7 +104,7 @@ export interface Client<O extends Options = Options> {
99104
eventFromException(exception: any, hint?: EventHint): PromiseLike<Event>;
100105

101106
/** Creates an {@link Event} from primitive inputs to `captureMessage`. */
102-
eventFromMessage(message: string, level?: Severity, hint?: EventHint): PromiseLike<Event>;
107+
eventFromMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): PromiseLike<Event>;
103108

104109
/** Submits the event to Sentry */
105110
sendEvent(event: Event): void;

packages/types/src/event.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Primitive } from './misc';
77
import { Request } from './request';
88
import { CaptureContext } from './scope';
99
import { SdkInfo } from './sdkinfo';
10-
import { Severity } from './severity';
10+
import { Severity, SeverityLevel } from './severity';
1111
import { Span } from './span';
1212
import { Measurements } from './transaction';
1313
import { User } from './user';
@@ -18,7 +18,7 @@ export interface Event {
1818
message?: string;
1919
timestamp?: number;
2020
start_timestamp?: number;
21-
level?: Severity;
21+
level?: Severity | SeverityLevel;
2222
platform?: string;
2323
logger?: string;
2424
server_name?: string;

packages/types/src/hub.ts

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

@@ -87,7 +87,7 @@ export interface Hub {
8787
* @param hint May contain additional information about the original exception.
8888
* @returns The generated eventId.
8989
*/
90-
captureMessage(message: string, level?: Severity, hint?: EventHint): string;
90+
captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string;
9191

9292
/**
9393
* Captures a manually created event and sends it to Sentry.

packages/types/src/scope.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { EventProcessor } from './eventprocessor';
44
import { Extra, Extras } from './extra';
55
import { Primitive } from './misc';
66
import { RequestSession, Session } from './session';
7-
import { Severity } from './severity';
7+
import { Severity, SeverityLevel } from './severity';
88
import { Span } from './span';
99
import { Transaction } from './transaction';
1010
import { User } from './user';
@@ -15,7 +15,7 @@ export type CaptureContext = Scope | Partial<ScopeContext> | ((scope: Scope) =>
1515
/** JSDocs */
1616
export interface ScopeContext {
1717
user: User;
18-
level: Severity;
18+
level: Severity | SeverityLevel;
1919
extra: Extras;
2020
contexts: Contexts;
2121
tags: { [key: string]: Primitive };
@@ -79,9 +79,9 @@ export interface Scope {
7979

8080
/**
8181
* Sets the level on the scope for future events.
82-
* @param level string {@link Severity}
82+
* @param level string {@link SeverityLevel}
8383
*/
84-
setLevel(level: Severity): this;
84+
setLevel(level: Severity | SeverityLevel): this;
8585

8686
/**
8787
* Sets the transaction name on the scope for future events.

0 commit comments

Comments
 (0)