ref(types): deprecate status enum

packages/browser/src/exports.ts

@@ -5,12 +5,12 @@ export {
  SdkInfo,
  Event,
  EventHint,
+ EventStatus,
  Exception,
  Response,
  SeverityLevel,
  StackFrame,
  Stacktrace,
- Status,
  Thread,
  User,
 } from '@sentry/types';

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;
  }

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;
  });

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;
  });

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),
  }),
  );
  }

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,

packages/browser/test/unit/transports/fetch.test.ts

@@ -1,7 +1,6 @@
-import { Outcome } from '@sentry/types';
 import { SentryError } from '@sentry/utils';
 
-import { Event, Response, Status, Transports } from '../../../src';
+import { Event, Response, Transports } from '../../../src';
 
 const testDsn = 'https://123@sentry.io/42';
 const storeUrl = 'https://sentry.io/api/42/store/?sentry_key=123&sentry_version=7';
@@ -61,7 +60,7 @@ describe('FetchTransport', () => {
 
  const res = await transport.sendEvent(eventPayload);
 
- expect((res as Response).status).toBe(Status.Success);
+ expect((res as Response).status).toBe('success');
  expect(fetch).toHaveBeenCalledWith(storeUrl, {
  body: JSON.stringify(eventPayload),
  method: 'POST',
@@ -117,7 +116,7 @@ describe('FetchTransport', () => {
  try {
  await transport.sendEvent(eventPayload);
  } catch (_) {
- expect(spy).toHaveBeenCalledWith(Outcome.NetworkError, 'event');
+ expect(spy).toHaveBeenCalledWith('network_error', 'event');
  }
  });
 
@@ -129,7 +128,7 @@ describe('FetchTransport', () => {
  try {
  await transport.sendEvent(transactionPayload);
  } catch (_) {
- expect(spy).toHaveBeenCalledWith(Outcome.QueueOverflow, 'transaction');
+ expect(spy).toHaveBeenCalledWith('queue_overflow', 'transaction');
  }
  });
 
@@ -149,7 +148,7 @@ describe('FetchTransport', () => {
 
  const res = await transport.sendEvent(eventPayload);
 
- expect((res as Response).status).toBe(Status.Success);
+ expect((res as Response).status).toBe('success');
  expect(fetch).toHaveBeenCalledWith(storeUrl, {
  body: JSON.stringify(eventPayload),
  headers: {
@@ -176,7 +175,7 @@ describe('FetchTransport', () => {
 
  const res = await transport.sendEvent(eventPayload);
 
- expect((res as Response).status).toBe(Status.Success);
+ expect((res as Response).status).toBe('success');
  expect(fetch).toHaveBeenCalledWith(storeUrl, {
  body: JSON.stringify(eventPayload),
  credentials: 'include',
@@ -232,7 +231,7 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
 
  const eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(2);
  });
 
@@ -275,7 +274,7 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
 
  const transactionRes = await transport.sendEvent(transactionPayload);
- expect(transactionRes.status).toBe(Status.Success);
+ expect(transactionRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(2);
 
  try {
@@ -290,7 +289,7 @@ describe('FetchTransport', () => {
  }
 
  const eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(3);
  });
 
@@ -357,11 +356,11 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
 
  const eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(2);
 
  const transactionRes = await transport.sendEvent(transactionPayload);
- expect(transactionRes.status).toBe(Status.Success);
+ expect(transactionRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(3);
  });
 
@@ -428,11 +427,11 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
 
  const eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(2);
 
  const transactionRes = await transport.sendEvent(transactionPayload);
- expect(transactionRes.status).toBe(Status.Success);
+ expect(transactionRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(3);
  });
 
@@ -460,7 +459,7 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers }));
 
  let eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalled();
 
  try {
@@ -477,7 +476,7 @@ describe('FetchTransport', () => {
  window.fetch.mockImplementation(() => Promise.resolve({ status: 200, headers: new Headers() }));
 
  eventRes = await transport.sendEvent(eventPayload);
- expect(eventRes.status).toBe(Status.Success);
+ expect(eventRes.status).toBe('success');
  expect(fetch).toHaveBeenCalledTimes(2);
  });
 
@@ -490,13 +489,13 @@ describe('FetchTransport', () => {
  try {
  await transport.sendEvent(eventPayload);
  } catch (_) {
- expect(spy).toHaveBeenCalledWith(Outcome.RateLimitBackoff, 'event');
+ expect(spy).toHaveBeenCalledWith('ratelimit_backoff', 'event');
  }
 
  try {
  await transport.sendEvent(transactionPayload);
  } catch (_) {
- expect(spy).toHaveBeenCalledWith(Outcome.RateLimitBackoff, 'transaction');
+ expect(spy).toHaveBeenCalledWith('ratelimit_backoff', 'transaction');
  }
  });
  });