ref(types): deprecate severity enum (#4280)

* fix(types): use SeverityLevel * fix(types): remove other references to the enum * fix(types): disable deprecation warning * fix(types): move fromString to utils * packages(types): fix exports * fix(rebase): fix conflicts * ref(types): deprecate status enum (#4298) * ref(types): deprecate enum and export type * ref(types): fix fromHttpCode usage to statusFromHttpCode * ref(types): remove enum usage * fix(types): fix mistake on span * fix: fmt * ref(types): do not export the status enum * ref(types): fix all imports * ref(utils): consistent naming * ref(types): deprecate span status enum (#4299) * ref(span): deprecate span status enum * ts(span): widen type * ref(span): avoid reexporting the enum * ref(types): fix all imports * fix(test): remove extra space * fix(test): import extension methods * ref(types): deprecate transactionmethod enum (#4314) * ref(types): deprecate transactionmethod enum * fix(types): drop transactionsamplingmethod * ref(types): deprecate outcome enum (#4315) * ref(types): deprecate outcome enum * fix(types): drop transportoutcome * ref(types): deprecate request status enum (#4316) * ref(types): deprecate request status * ref(types): deprecate session status * ref(types): remove unused logLevel (#4317) (#4320) Co-authored-by: Armin Ronacher <armin.ronacher@active-4.com> Co-authored-by: Armin Ronacher <armin.ronacher@active-4.com>
getsentry · Dec 16, 2021 · caba96e · caba96e
1 parent b8dc945
commit caba96e
Show file tree

Hide file tree

Showing 81 changed files with 526 additions and 514 deletions.
diff --git a/packages/browser/src/backend.ts b/packages/browser/src/backend.ts
@@ -1,5 +1,5 @@
 import { BaseBackend } from '@sentry/core';
-import { Event, EventHint, Options, Severity, Transport } from '@sentry/types';
+import { Event, EventHint, Options, SeverityLevel, Transport } from '@sentry/types';
 import { supportsFetch } from '@sentry/utils';
 
 import { eventFromException, eventFromMessage } from './eventbuilder';
@@ -45,7 +45,7 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
   /**
    * @inheritDoc
    */
-  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+  public eventFromMessage(message: string, level: SeverityLevel = 'info', hint?: EventHint): PromiseLike<Event> {
     return eventFromMessage(this._options, message, level, hint);
   }
 

diff --git a/packages/browser/src/eventbuilder.ts b/packages/browser/src/eventbuilder.ts
@@ -1,4 +1,4 @@
-import { Event, EventHint, Options, Severity } from '@sentry/types';
+import { Event, EventHint, Options, SeverityLevel } from '@sentry/types';
 import {
   addExceptionMechanism,
   addExceptionTypeValue,
@@ -24,7 +24,7 @@ export function eventFromException(options: Options, exception: unknown, hint?:
     attachStacktrace: options.attachStacktrace,
   });
   addExceptionMechanism(event); // defaults to { type: 'generic', handled: true }
-  event.level = Severity.Error;
+  event.level = 'error';
   if (hint && hint.event_id) {
     event.event_id = hint.event_id;
   }
@@ -38,7 +38,7 @@ export function eventFromException(options: Options, exception: unknown, hint?:
 export function eventFromMessage(
   options: Options,
   message: string,
-  level: Severity = Severity.Info,
+  level: SeverityLevel = 'info',
   hint?: EventHint,
 ): PromiseLike<Event> {
   const syntheticException = (hint && hint.syntheticException) || undefined;

diff --git a/packages/browser/src/exports.ts b/packages/browser/src/exports.ts
@@ -5,12 +5,12 @@ export {
   SdkInfo,
   Event,
   EventHint,
+  EventStatus,
   Exception,
   Response,
-  Severity,
+  SeverityLevel,
   StackFrame,
   Stacktrace,
-  Status,
   Thread,
   User,
 } from '@sentry/types';

diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/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 */
@@ -171,7 +172,7 @@ function _consoleBreadcrumb(handlerData: { [key: string]: any }): void {
       arguments: handlerData.args,
       logger: 'console',
     },
-    level: Severity.fromString(handlerData.level),
+    level: severityFromString(handlerData.level),
     message: safeJoin(handlerData.args, ' '),
   };
 
@@ -244,7 +245,7 @@ function _fetchBreadcrumb(handlerData: { [key: string]: any }): void {
       {
         category: 'fetch',
         data: handlerData.fetchData,
-        level: Severity.Error,
+        level: 'error',
         type: 'http',
       },
       {

diff --git a/packages/browser/src/integrations/globalhandlers.ts b/packages/browser/src/integrations/globalhandlers.ts
@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import { getCurrentHub } from '@sentry/core';
-import { Event, EventHint, Hub, Integration, Primitive, Severity } from '@sentry/types';
+import { Event, EventHint, Hub, Integration, Primitive } from '@sentry/types';
 import {
   addExceptionMechanism,
   addInstrumentationHandler,
@@ -146,7 +146,7 @@ function _installGlobalOnUnhandledRejectionHandler(): void {
             rejection: true,
           });
 
-      event.level = Severity.Error;
+      event.level = 'error';
 
       addMechanismAndCapture(hub, error, event, 'onunhandledrejection');
       return;

diff --git a/packages/browser/src/transports/base.ts b/packages/browser/src/transports/base.ts
@@ -9,12 +9,12 @@ import {
   Outcome,
   Response as SentryResponse,
   SentryRequestType,
-  Status,
   Transport,
   TransportOptions,
 } from '@sentry/types';
 import {
   dateTimestampInSeconds,
+  eventStatusFromHttpCode,
   getGlobalObject,
   logger,
   parseRetryAfterHeader,
@@ -155,7 +155,7 @@ export abstract class BaseTransport implements Transport {
     resolve: (value?: SentryResponse | PromiseLike<SentryResponse> | null | undefined) => void;
     reject: (reason?: unknown) => void;
   }): void {
-    const status = Status.fromHttpCode(response.status);
+    const status = eventStatusFromHttpCode(response.status);
     /**
      * "The name is case-insensitive."
      * https://developer.mozilla.org/en-US/docs/Web/API/Headers/get
@@ -164,7 +164,7 @@ export abstract class BaseTransport implements Transport {
     if (limited)
       logger.warn(`Too many ${requestType} requests, backing off until: ${this._disabledUntil(requestType)}`);
 
-    if (status === Status.Success) {
+    if (status === 'success') {
       resolve({ status });
       return;
     }

diff --git a/packages/browser/src/transports/fetch.ts b/packages/browser/src/transports/fetch.ts
@@ -1,5 +1,5 @@
 import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
-import { Event, Outcome, Response, SentryRequest, Session, TransportOptions } from '@sentry/types';
+import { Event, Response, SentryRequest, Session, TransportOptions } from '@sentry/types';
 import { SentryError, supportsReferrerPolicy, SyncPromise } from '@sentry/utils';
 
 import { BaseTransport } from './base';
@@ -37,7 +37,7 @@ export class FetchTransport extends BaseTransport {
    */
   private _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
     if (this._isRateLimited(sentryRequest.type)) {
-      this.recordLostEvent(Outcome.RateLimitBackoff, sentryRequest.type);
+      this.recordLostEvent('ratelimit_backoff', sentryRequest.type);
 
       return Promise.reject({
         event: originalPayload,
@@ -89,9 +89,9 @@ export class FetchTransport extends BaseTransport {
       .then(undefined, reason => {
         // It's either buffer rejection or any other xhr/fetch error, which are treated as NetworkError.
         if (reason instanceof SentryError) {
-          this.recordLostEvent(Outcome.QueueOverflow, sentryRequest.type);
+          this.recordLostEvent('queue_overflow', sentryRequest.type);
         } else {
-          this.recordLostEvent(Outcome.NetworkError, sentryRequest.type);
+          this.recordLostEvent('network_error', sentryRequest.type);
         }
         throw reason;
       });

diff --git a/packages/browser/src/transports/xhr.ts b/packages/browser/src/transports/xhr.ts
@@ -1,5 +1,5 @@
 import { eventToSentryRequest, sessionToSentryRequest } from '@sentry/core';
-import { Event, Outcome, Response, SentryRequest, Session } from '@sentry/types';
+import { Event, Response, SentryRequest, Session } from '@sentry/types';
 import { SentryError, SyncPromise } from '@sentry/utils';
 
 import { BaseTransport } from './base';
@@ -26,7 +26,7 @@ export class XHRTransport extends BaseTransport {
    */
   private _sendRequest(sentryRequest: SentryRequest, originalPayload: Event | Session): PromiseLike<Response> {
     if (this._isRateLimited(sentryRequest.type)) {
-      this.recordLostEvent(Outcome.RateLimitBackoff, sentryRequest.type);
+      this.recordLostEvent('ratelimit_backoff', sentryRequest.type);
 
       return Promise.reject({
         event: originalPayload,
@@ -66,9 +66,9 @@ export class XHRTransport extends BaseTransport {
       .then(undefined, reason => {
         // It's either buffer rejection or any other xhr/fetch error, which are treated as NetworkError.
         if (reason instanceof SentryError) {
-          this.recordLostEvent(Outcome.QueueOverflow, sentryRequest.type);
+          this.recordLostEvent('queue_overflow', sentryRequest.type);
         } else {
-          this.recordLostEvent(Outcome.NetworkError, sentryRequest.type);
+          this.recordLostEvent('network_error', sentryRequest.type);
         }
         throw reason;
       });

diff --git a/packages/browser/test/unit/mocks/simpletransport.ts b/packages/browser/test/unit/mocks/simpletransport.ts
@@ -1,13 +1,13 @@
-import { SyncPromise } from '@sentry/utils';
+import { eventStatusFromHttpCode, SyncPromise } from '@sentry/utils';
 
-import { Event, Response, Status } from '../../../src';
+import { Event, Response } from '../../../src';
 import { BaseTransport } from '../../../src/transports';
 
 export class SimpleTransport extends BaseTransport {
   public sendEvent(_: Event): PromiseLike<Response> {
     return this._buffer.add(() =>
       SyncPromise.resolve({
-        status: Status.fromHttpCode(200),
+        status: eventStatusFromHttpCode(200),
       }),
     );
   }

diff --git a/packages/browser/test/unit/transports/base.test.ts b/packages/browser/test/unit/transports/base.test.ts
@@ -1,5 +1,3 @@
-import { Outcome } from '@sentry/types';
-
 import { BaseTransport } from '../../../src/transports/base';
 
 const testDsn = 'https://123@sentry.io/42';
@@ -44,12 +42,12 @@ describe('BaseTransport', () => {
     it('sends beacon request when there are outcomes captured and visibility changed to `hidden`', () => {
       const transport = new SimpleTransport({ dsn: testDsn, sendClientReports: true });
 
-      transport.recordLostEvent(Outcome.BeforeSend, 'event');
+      transport.recordLostEvent('before_send', 'event');
 
       visibilityState = 'hidden';
       document.dispatchEvent(new Event('visibilitychange'));
 
-      const outcomes = [{ reason: Outcome.BeforeSend, category: 'error', quantity: 1 }];
+      const outcomes = [{ reason: 'before_send', category: 'error', quantity: 1 }];
 
       expect(sendBeaconSpy).toHaveBeenCalledWith(
         envelopeEndpoint,
@@ -59,7 +57,7 @@ describe('BaseTransport', () => {
 
     it('doesnt send beacon request when there are outcomes captured, but visibility state did not change to `hidden`', () => {
       const transport = new SimpleTransport({ dsn: testDsn, sendClientReports: true });
-      transport.recordLostEvent(Outcome.BeforeSend, 'event');
+      transport.recordLostEvent('before_send', 'event');
 
       visibilityState = 'visible';
       document.dispatchEvent(new Event('visibilitychange'));
@@ -70,21 +68,21 @@ describe('BaseTransport', () => {
     it('correctly serializes request with different categories/reasons pairs', () => {
       const transport = new SimpleTransport({ dsn: testDsn, sendClientReports: true });
 
-      transport.recordLostEvent(Outcome.BeforeSend, 'event');
-      transport.recordLostEvent(Outcome.BeforeSend, 'event');
-      transport.recordLostEvent(Outcome.SampleRate, 'transaction');
-      transport.recordLostEvent(Outcome.NetworkError, 'session');
-      transport.recordLostEvent(Outcome.NetworkError, 'session');
-      transport.recordLostEvent(Outcome.RateLimitBackoff, 'event');
+      transport.recordLostEvent('before_send', 'event');
+      transport.recordLostEvent('before_send', 'event');
+      transport.recordLostEvent('sample_rate', 'transaction');
+      transport.recordLostEvent('network_error', 'session');
+      transport.recordLostEvent('network_error', 'session');
+      transport.recordLostEvent('ratelimit_backoff', 'event');
 
       visibilityState = 'hidden';
       document.dispatchEvent(new Event('visibilitychange'));
 
       const outcomes = [
-        { reason: Outcome.BeforeSend, category: 'error', quantity: 2 },
-        { reason: Outcome.SampleRate, category: 'transaction', quantity: 1 },
-        { reason: Outcome.NetworkError, category: 'session', quantity: 2 },
-        { reason: Outcome.RateLimitBackoff, category: 'error', quantity: 1 },
+        { reason: 'before_send', category: 'error', quantity: 2 },
+        { reason: 'sample_rate', category: 'transaction', quantity: 1 },
+        { reason: 'network_error', category: 'session', quantity: 2 },
+        { reason: 'ratelimit_backoff', category: 'error', quantity: 1 },
       ];
 
       expect(sendBeaconSpy).toHaveBeenCalledWith(
@@ -97,12 +95,12 @@ describe('BaseTransport', () => {
       const tunnel = 'https://hello.com/world';
       const transport = new SimpleTransport({ dsn: testDsn, sendClientReports: true, tunnel });
 
-      transport.recordLostEvent(Outcome.BeforeSend, 'event');
+      transport.recordLostEvent('before_send', 'event');
 
       visibilityState = 'hidden';
       document.dispatchEvent(new Event('visibilitychange'));
 
-      const outcomes = [{ reason: Outcome.BeforeSend, category: 'error', quantity: 1 }];
+      const outcomes = [{ reason: 'before_send', category: 'error', quantity: 1 }];
 
       expect(sendBeaconSpy).toHaveBeenCalledWith(
         tunnel,