fix(types): move fromString to utils

Author: JonasBa

packages/browser/src/integrations/breadcrumbs.ts

@@ -1,14 +1,15 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 /* eslint-disable max-lines */
 import { getCurrentHub } from '@sentry/core';
-import { Event, Integration, Severity } from '@sentry/types';
+import { Event, Integration } from '@sentry/types';
 import {
   addInstrumentationHandler,
   getEventDescription,
   getGlobalObject,
   htmlTreeAsString,
   parseUrl,
   safeJoin,
+  severityFromString,
 } from '@sentry/utils';
 
 /** JSDoc */

packages/integrations/src/captureconsole.ts

@@ -1,5 +1,5 @@
-import { EventProcessor, Hub, Integration, Severity } from '@sentry/types';
-import { fill, getGlobalObject, safeJoin } from '@sentry/utils';
+import { EventProcessor, Hub, Integration } from '@sentry/types';
+import { fill, getGlobalObject, safeJoin, severityFromString } from '@sentry/utils';
 
 const global = getGlobalObject<Window | NodeJS.Global>();
 
@@ -48,7 +48,7 @@ export class CaptureConsole implements Integration {
 
         if (hub.getIntegration(CaptureConsole)) {
           hub.withScope(scope => {
-            scope.setLevel(Severity.fromString(level));
+            scope.setLevel(severityFromString(level));
             scope.setExtra('arguments', args);
             scope.addEventProcessor(event => {
               event.logger = 'console';

packages/node/src/integrations/console.ts

@@ -1,6 +1,6 @@
 import { getCurrentHub } from '@sentry/core';
-import { Integration, Severity } from '@sentry/types';
-import { fill } from '@sentry/utils';
+import { Integration } from '@sentry/types';
+import { fill, severityFromString } from '@sentry/utils';
 import * as util from 'util';
 
 /** Console module integration */
@@ -30,7 +30,7 @@ export class Console implements Integration {
  */
 function createConsoleWrapper(level: string): (originalConsoleMethod: () => void) => void {
   return function consoleWrapper(originalConsoleMethod: () => void): () => void {
-    const sentryLevel = Severity.fromString(level);
+    const sentryLevel = severityFromString(level);
 
     /* eslint-disable prefer-rest-params */
     return function(this: typeof console): void {

packages/types/src/index.ts

@@ -32,9 +32,9 @@ export {
   SessionFlusherLike,
 } from './session';
 
-// eslint-disable-next-line deprecation/deprecation
+/* eslint-disable deprecation/deprecation */
 export { Severity } from './severity';
-export { SeverityLevel } from './severity';
+export { SeverityLevel, SeverityLevels } from './severity';
 export { Span, SpanContext } from './span';
 export { StackFrame } from './stackframe';
 export { Stacktrace } from './stacktrace';

packages/types/src/severity.ts

@@ -19,22 +19,5 @@ 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 {
-  /**
-   * Converts a string-based level into a {@link Severity}.
-   *
-   * @param level string representation of Severity
-   * @returns Severity
-   */
-  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;
-  }
-}
+export const SeverityLevels = ['fatal', 'error', 'warning', 'log', 'info', 'debug', 'critical'] as const;
+export type SeverityLevel = typeof SeverityLevels[number];

packages/utils/src/index.ts

@@ -12,6 +12,7 @@ export * from './node';
 export * from './object';
 export * from './path';
 export * from './promisebuffer';
+export * from './severity';
 export * from './stacktrace';
 export * from './string';
 export * from './supports';

packages/utils/src/severity.ts

@@ -0,0 +1,18 @@
+import { SeverityLevel, SeverityLevels } from '@sentry/types';
+
+function isSupportedSeverity(level: string): level is SeverityLevel {
+  return SeverityLevels.indexOf(level as SeverityLevel) !== -1;
+}
+/**
+ * Converts a string-based level into a {@link Severity}.
+ *
+ * @param level string representation of Severity
+ * @returns Severity
+ */
+export function severityFromString(level: SeverityLevel | string): SeverityLevel {
+  if (level === 'warn') return 'warning';
+  if (isSupportedSeverity(level)) {
+    return level;
+  }
+  return 'log';
+}

packages/utils/test/severity.test.ts

@@ -0,0 +1,23 @@
+import { SeverityLevels } from '@sentry/types';
+import { severityFromString } from './../src/severity';
+
+describe('severityFromString()', () => {
+  describe('normalize warn and warning', () => {
+    test('handles warn and warning', () => {
+      expect(severityFromString('warn')).toBe('warning');
+      expect(severityFromString('warning')).toBe('warning');
+    });
+    test('handles warn and warning', () => {
+      expect(severityFromString('warn')).toBe('warning');
+      expect(severityFromString('warning')).toBe('warning');
+    });
+  });
+  describe('default to log', () => {
+    expect(severityFromString('foo')).toBe('log');
+  });
+  describe('allows ', () => {
+    for (const level of SeverityLevels) {
+      expect(severityFromString(level)).toBe(level);
+    }
+  });
+});