accept SeverityLevel wherever we accept Severity

lobsterkatie · lobsterkatie · commit 925d5a80bf7c · 2022-04-12T15:21:41.000-07:00
diff --git a/packages/browser/src/client.ts b/packages/browser/src/client.ts
@@ -1,5 +1,5 @@
 import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
-import { Event, EventHint, Options, Severity, Transport, TransportOptions } from '@sentry/types';
+import { Event, EventHint, Options, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
 import { getGlobalObject, logger, stackParserFromOptions, supportsFetch } from '@sentry/utils';
 
 import { eventFromException, eventFromMessage } from './eventbuilder';
@@ -89,7 +89,11 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
   /**
    * @inheritDoc
    */
-  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+  public eventFromMessage(
+    message: string,
+    level: Severity | SeverityLevel = Severity.Info,
+    hint?: EventHint,
+  ): PromiseLike<Event> {
     return eventFromMessage(
       stackParserFromOptions(this._options),
       message,
diff --git a/packages/browser/src/eventbuilder.ts b/packages/browser/src/eventbuilder.ts
@@ -1,4 +1,4 @@
-import { Event, EventHint, Exception, Severity, StackFrame, StackParser } from '@sentry/types';
+import { Event, EventHint, Exception, Severity, SeverityLevel, StackFrame, StackParser } from '@sentry/types';
 import {
   addExceptionMechanism,
   addExceptionTypeValue,
@@ -164,7 +164,7 @@ export function eventFromException(
 export function eventFromMessage(
   stackParser: StackParser,
   message: string,
-  level: Severity = Severity.Info,
+  level: Severity | SeverityLevel = Severity.Info,
   hint?: EventHint,
   attachStacktrace?: boolean,
 ): PromiseLike<Event> {
diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts
@@ -9,6 +9,7 @@ import {
   IntegrationClass,
   Options,
   Severity,
+  SeverityLevel,
   Transport,
 } from '@sentry/types';
 import {
@@ -131,7 +132,12 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
   /**
    * @inheritDoc
    */
-  public captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined {
+  public captureMessage(
+    message: string,
+    level?: Severity | SeverityLevel,
+    hint?: EventHint,
+    scope?: Scope,
+  ): string | undefined {
     let eventId: string | undefined = hint && hint.event_id;
 
     const promisedEvent = isPrimitive(message)
@@ -685,7 +691,11 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
   /**
    * @inheritDoc
    */
-  public abstract eventFromMessage(_message: string, _level?: Severity, _hint?: EventHint): PromiseLike<Event>;
+  public abstract eventFromMessage(
+    _message: string,
+    _level?: Severity | SeverityLevel,
+    _hint?: EventHint,
+  ): PromiseLike<Event>;
 }
 
 /**
diff --git a/packages/core/test/mocks/client.ts b/packages/core/test/mocks/client.ts
@@ -1,5 +1,5 @@
 import { Session } from '@sentry/hub';
-import { Event, Options, Severity, Transport } from '@sentry/types';
+import { Event, Options, Severity, SeverityLevel, Transport } from '@sentry/types';
 import { resolvedSyncPromise } from '@sentry/utils';
 
 import { BaseClient } from '../../src/baseclient';
@@ -38,7 +38,7 @@ export class TestClient extends BaseClient<TestOptions> {
     });
   }
 
-  public eventFromMessage(message: string, level: Severity = Severity.Info): PromiseLike<Event> {
+  public eventFromMessage(message: string, level: Severity | SeverityLevel = Severity.Info): PromiseLike<Event> {
     return resolvedSyncPromise({ message, level });
   }
 
diff --git a/packages/hub/src/hub.ts b/packages/hub/src/hub.ts
@@ -14,6 +14,7 @@ import {
   Primitive,
   SessionContext,
   Severity,
+  SeverityLevel,
   Transaction,
   TransactionContext,
   User,
@@ -213,7 +214,7 @@ export class Hub implements HubInterface {
   /**
    * @inheritDoc
    */
-  public captureMessage(message: string, level?: Severity, hint?: EventHint): string {
+  public captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string {
     const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
     let finalHint = hint;
 
diff --git a/packages/hub/src/scope.ts b/packages/hub/src/scope.ts
@@ -14,6 +14,7 @@ import {
   Scope as ScopeInterface,
   ScopeContext,
   Severity,
+  SeverityLevel,
   Span,
   Transaction,
   User,
@@ -61,7 +62,7 @@ export class Scope implements ScopeInterface {
   protected _fingerprint?: string[];
 
   /** Severity */
-  protected _level?: Severity;
+  protected _level?: Severity | SeverityLevel;
 
   /** Transaction Name */
   protected _transactionName?: string;
@@ -208,7 +209,7 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setLevel(level: Severity): this {
+  public setLevel(level: Severity | SeverityLevel): this {
     this._level = level;
     this._notifyScopeListeners();
     return this;
diff --git a/packages/minimal/src/index.ts b/packages/minimal/src/index.ts
@@ -8,6 +8,7 @@ import {
   Extras,
   Primitive,
   Severity,
+  SeverityLevel,
   Transaction,
   TransactionContext,
   User,
@@ -52,7 +53,7 @@ export function captureException(exception: any, captureContext?: CaptureContext
  * @param Severity Define the level of the message.
  * @returns The generated eventId.
  */
-export function captureMessage(message: string, captureContext?: CaptureContext | Severity): string {
+export function captureMessage(message: string, captureContext?: CaptureContext | Severity | SeverityLevel): string {
   const syntheticException = new Error(message);
 
   // This is necessary to provide explicit scopes upgrade, without changing the original
diff --git a/packages/node/src/client.ts b/packages/node/src/client.ts
@@ -1,6 +1,6 @@
 import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
 import { SessionFlusher } from '@sentry/hub';
-import { Event, EventHint, Severity, Transport, TransportOptions } from '@sentry/types';
+import { Event, EventHint, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
 import { logger, makeDsn, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';
 
 import { eventFromMessage, eventFromUnknownInput } from './eventbuilder';
@@ -118,7 +118,11 @@ export class NodeClient extends BaseClient<NodeOptions> {
   /**
    * @inheritDoc
    */
-  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+  public eventFromMessage(
+    message: string,
+    level: Severity | SeverityLevel = Severity.Info,
+    hint?: EventHint,
+  ): PromiseLike<Event> {
     return resolvedSyncPromise(
       eventFromMessage(stackParserFromOptions(this._options), message, level, hint, this._options.attachStacktrace),
     );
diff --git a/packages/node/src/eventbuilder.ts b/packages/node/src/eventbuilder.ts
@@ -1,5 +1,14 @@
 import { getCurrentHub } from '@sentry/hub';
-import { Event, EventHint, Exception, Mechanism, Severity, StackFrame, StackParser } from '@sentry/types';
+import {
+  Event,
+  EventHint,
+  Exception,
+  Mechanism,
+  Severity,
+  SeverityLevel,
+  StackFrame,
+  StackParser,
+} from '@sentry/types';
 import {
   addExceptionMechanism,
   addExceptionTypeValue,
@@ -90,7 +99,7 @@ export function eventFromUnknownInput(stackParser: StackParser, exception: unkno
 export function eventFromMessage(
   stackParser: StackParser,
   message: string,
-  level: Severity = Severity.Info,
+  level: Severity | SeverityLevel = Severity.Info,
   hint?: EventHint,
   attachStacktrace?: boolean,
 ): Event {
diff --git a/packages/types/src/breadcrumb.ts b/packages/types/src/breadcrumb.ts
@@ -1,9 +1,9 @@
-import { Severity } from './severity';
+import { Severity, SeverityLevel } from './severity';
 
 /** JSDoc */
 export interface Breadcrumb {
   type?: string;
-  level?: Severity;
+  level?: Severity | SeverityLevel;
   event_id?: string;
   category?: string;
   message?: string;
diff --git a/packages/types/src/client.ts b/packages/types/src/client.ts
@@ -4,7 +4,7 @@ import { Integration, IntegrationClass } from './integration';
 import { Options } from './options';
 import { Scope } from './scope';
 import { Session } from './session';
-import { Severity } from './severity';
+import { Severity, SeverityLevel } from './severity';
 import { Transport } from './transport';
 
 /**
@@ -36,7 +36,12 @@ export interface Client<O extends Options = Options> {
    * @param scope An optional scope containing event metadata.
    * @returns The event id
    */
-  captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined;
+  captureMessage(
+    message: string,
+    level?: Severity | SeverityLevel,
+    hint?: EventHint,
+    scope?: Scope,
+  ): string | undefined;
 
   /**
    * Captures a manually created event and sends it to Sentry.
@@ -99,7 +104,7 @@ export interface Client<O extends Options = Options> {
   eventFromException(exception: any, hint?: EventHint): PromiseLike<Event>;
 
   /** Creates an {@link Event} from primitive inputs to `captureMessage`. */
-  eventFromMessage(message: string, level?: Severity, hint?: EventHint): PromiseLike<Event>;
+  eventFromMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): PromiseLike<Event>;
 
   /** Submits the event to Sentry */
   sendEvent(event: Event): void;
diff --git a/packages/types/src/event.ts b/packages/types/src/event.ts
@@ -7,7 +7,7 @@ import { Primitive } from './misc';
 import { Request } from './request';
 import { CaptureContext } from './scope';
 import { SdkInfo } from './sdkinfo';
-import { Severity } from './severity';
+import { Severity, SeverityLevel } from './severity';
 import { Span } from './span';
 import { Measurements } from './transaction';
 import { User } from './user';
@@ -18,7 +18,7 @@ export interface Event {
   message?: string;
   timestamp?: number;
   start_timestamp?: number;
-  level?: Severity;
+  level?: Severity | SeverityLevel;
   platform?: string;
   logger?: string;
   server_name?: string;
diff --git a/packages/types/src/hub.ts b/packages/types/src/hub.ts
@@ -6,7 +6,7 @@ import { Integration, IntegrationClass } from './integration';
 import { Primitive } from './misc';
 import { Scope } from './scope';
 import { Session, SessionContext } from './session';
-import { Severity } from './severity';
+import { Severity, SeverityLevel } from './severity';
 import { CustomSamplingContext, Transaction, TransactionContext } from './transaction';
 import { User } from './user';
 
@@ -87,7 +87,7 @@ export interface Hub {
    * @param hint May contain additional information about the original exception.
    * @returns The generated eventId.
    */
-  captureMessage(message: string, level?: Severity, hint?: EventHint): string;
+  captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string;
 
   /**
    * Captures a manually created event and sends it to Sentry.
diff --git a/packages/types/src/scope.ts b/packages/types/src/scope.ts
@@ -4,7 +4,7 @@ import { EventProcessor } from './eventprocessor';
 import { Extra, Extras } from './extra';
 import { Primitive } from './misc';
 import { RequestSession, Session } from './session';
-import { Severity } from './severity';
+import { Severity, SeverityLevel } from './severity';
 import { Span } from './span';
 import { Transaction } from './transaction';
 import { User } from './user';
@@ -15,7 +15,7 @@ export type CaptureContext = Scope | Partial<ScopeContext> | ((scope: Scope) =>
 /** JSDocs */
 export interface ScopeContext {
   user: User;
-  level: Severity;
+  level: Severity | SeverityLevel;
   extra: Extras;
   contexts: Contexts;
   tags: { [key: string]: Primitive };
@@ -79,9 +79,9 @@ export interface Scope {
 
   /**
    * Sets the level on the scope for future events.
-   * @param level string {@link Severity}
+   * @param level string {@link SeverityLevel}
    */
-  setLevel(level: Severity): this;
+  setLevel(level: Severity | SeverityLevel): this;
 
   /**
    * Sets the transaction name on the scope for future events.

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import { Session } from '@sentry/hub';`
`2`		`-import { Event, Options, Severity, Transport } from '@sentry/types';`
	`2`	`+import { Event, Options, Severity, SeverityLevel, Transport } from '@sentry/types';`
`3`	`3`	`import { resolvedSyncPromise } from '@sentry/utils';`
`4`	`4`
`5`	`5`	`import { BaseClient } from '../../src/baseclient';`
`@@ -38,7 +38,7 @@ export class TestClient extends BaseClient<TestOptions> {`
`38`	`38`	`});`
`39`	`39`	`}`
`40`	`40`
`41`		`- public eventFromMessage(message: string, level: Severity = Severity.Info): PromiseLike<Event> {`
	`41`	`+ public eventFromMessage(message: string, level: Severity \| SeverityLevel = Severity.Info): PromiseLike<Event> {`
`42`	`42`	`return resolvedSyncPromise({ message, level });`
`43`	`43`	`}`
`44`	`44`