fix(types): use SeverityLevel

Author: JonasBa

packages/hub/src/scope.ts

@@ -13,7 +13,7 @@ import {
   RequestSession,
   Scope as ScopeInterface,
   ScopeContext,
-  Severity,
+  SeverityLevel,
   Span,
   Transaction,
   User,
@@ -61,7 +61,7 @@ export class Scope implements ScopeInterface {
   protected _fingerprint?: string[];
 
   /** Severity */
-  protected _level?: Severity;
+  protected _level?: SeverityLevel;
 
   /** Transaction Name */
   protected _transactionName?: string;
@@ -202,7 +202,7 @@ export class Scope implements ScopeInterface {
   /**
    * @inheritDoc
    */
-  public setLevel(level: Severity): this {
+  public setLevel(level: SeverityLevel): this {
     this._level = level;
     this._notifyScopeListeners();
     return this;

packages/minimal/src/index.ts

@@ -7,7 +7,7 @@ import {
   Extra,
   Extras,
   Primitive,
-  Severity,
+  SeverityLevel,
   Transaction,
   TransactionContext,
   User,
@@ -53,10 +53,10 @@ export function captureException(exception: any, captureContext?: CaptureContext
  * Captures a message event and sends it to Sentry.
  *
  * @param message The message to send to Sentry.
- * @param level Define the level of the message.
+ * @param SeverityLevel 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 | SeverityLevel): string {
   let syntheticException: Error;
   try {
     throw new Error(message);

packages/node/src/backend.ts

@@ -1,5 +1,5 @@
 import { BaseBackend, getCurrentHub } from '@sentry/core';
-import { Event, EventHint, Mechanism, Severity, Transport, TransportOptions } from '@sentry/types';
+import { Event, EventHint, Mechanism, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
 import {
   addExceptionMechanism,
   addExceptionTypeValue,
@@ -73,7 +73,7 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
   /**
    * @inheritDoc
    */
-  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+  public eventFromMessage(message: string, level: SeverityLevel = 'info', hint?: EventHint): PromiseLike<Event> {
     const event: Event = {
       event_id: hint && hint.event_id,
       level,

packages/node/src/integrations/console.ts

@@ -30,24 +30,7 @@ export class Console implements Integration {
  */
 function createConsoleWrapper(level: string): (originalConsoleMethod: () => void) => void {
   return function consoleWrapper(originalConsoleMethod: () => void): () => void {
-    let sentryLevel: Severity;
-
-    switch (level) {
-      case 'debug':
-        sentryLevel = Severity.Debug;
-        break;
-      case 'error':
-        sentryLevel = Severity.Error;
-        break;
-      case 'info':
-        sentryLevel = Severity.Info;
-        break;
-      case 'warn':
-        sentryLevel = Severity.Warning;
-        break;
-      default:
-        sentryLevel = Severity.Log;
-    }
+    const sentryLevel = Severity.fromString(level);
 
     /* eslint-disable prefer-rest-params */
     return function(this: typeof console): void {

packages/node/src/integrations/onuncaughtexception.ts

@@ -1,5 +1,5 @@
 import { getCurrentHub, Scope } from '@sentry/core';
-import { Integration, Severity } from '@sentry/types';
+import { Integration } from '@sentry/types';
 import { logger } from '@sentry/utils';
 
 import { NodeClient } from '../client';
@@ -77,7 +77,7 @@ export class OnUncaughtException implements Integration {
 
         if (hub.getIntegration(OnUncaughtException)) {
           hub.withScope((scope: Scope) => {
-            scope.setLevel(Severity.Fatal);
+            scope.setLevel('fatal');
             hub.captureException(error, {
               originalException: error,
               data: { mechanism: { handled: false, type: 'onuncaughtexception' } },

packages/serverless/src/awslambda.ts

@@ -6,7 +6,6 @@ import {
   flush,
   getCurrentHub,
   Scope,
-  Severity,
   startTransaction,
   withScope,
 } from '@sentry/node';
@@ -275,7 +274,7 @@ export function wrapHandler<TEvent, TResult>(
       timeoutWarningTimer = setTimeout(() => {
         withScope(scope => {
           scope.setTag('timeout', humanReadableTimeout);
-          captureMessage(`Possible function timeout: ${context.functionName}`, Severity.Warning);
+          captureMessage(`Possible function timeout: ${context.functionName}`, 'warning');
         });
       }, timeoutWarningDelay);
     }

packages/types/src/breadcrumb.ts

@@ -1,9 +1,9 @@
-import { Severity } from './severity';
+import { SeverityLevel } from './severity';
 
 /** JSDoc */
 export interface Breadcrumb {
   type?: string;
-  level?: Severity;
+  level?: SeverityLevel;
   event_id?: string;
   category?: string;
   message?: string;

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 { SeverityLevel } from './severity';
 import { Span } from './span';
 import { Stacktrace } from './stacktrace';
 import { Measurements } from './transaction';
@@ -19,7 +19,7 @@ export interface Event {
   message?: string;
   timestamp?: number;
   start_timestamp?: number;
-  level?: Severity;
+  level?: SeverityLevel;
   platform?: string;
   logger?: string;
   server_name?: string;

packages/types/src/index.ts

@@ -31,7 +31,7 @@ export {
   RequestSessionStatus,
   SessionFlusherLike,
 } from './session';
-export { Severity } from './severity';
+export { Severity, SeverityLevel } from './severity';
 export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';

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 { 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: SeverityLevel;
   extra: Extras;
   contexts: Contexts;
   tags: { [key: string]: Primitive };
@@ -82,7 +82,7 @@ export interface Scope {
    * Sets the level on the scope for future events.
    * @param level string {@link Severity}
    */
-  setLevel(level: Severity): this;
+  setLevel(level: SeverityLevel): this;
 
   /**
    * Sets the transaction name on the scope for future events.

packages/types/src/severity.ts

@@ -1,4 +1,6 @@
-/** JSDoc */
+/** JSDoc
+ * @deprecated use string literals - if you require a type, use SeverityLevel instead.
+ */
 // eslint-disable-next-line import/export
 export enum Severity {
   /** JSDoc */
@@ -17,6 +19,9 @@ export enum Severity {
   Critical = 'critical',
 }
 
+const levels = ['fatal', 'error', 'warning', 'log', 'info', 'debug', 'critical'] as const;
+export type SeverityLevel = typeof levels[number];
+
 // eslint-disable-next-line @typescript-eslint/no-namespace, import/export
 export namespace Severity {
   /**
@@ -25,24 +30,11 @@ export namespace Severity {
    * @param level string representation of Severity
    * @returns Severity
    */
-  export function fromString(level: string): Severity {
-    switch (level) {
-      case 'debug':
-        return Severity.Debug;
-      case 'info':
-        return Severity.Info;
-      case 'warn':
-      case 'warning':
-        return Severity.Warning;
-      case 'error':
-        return Severity.Error;
-      case 'fatal':
-        return Severity.Fatal;
-      case 'critical':
-        return Severity.Critical;
-      case 'log':
-      default:
-        return Severity.Log;
+  export function fromString(level: SeverityLevel | string): SeverityLevel {
+    if (level === 'warn') return 'warning';
+    if (levels.indexOf(level as SeverityLevel) === -1) {
+      return 'log';
     }
+    return level as SeverityLevel;
   }
 }