Skip to content

ref(types): deprecate status enum #4298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Dec 16, 2021
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/browser/src/exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ export {
SdkInfo,
Event,
EventHint,
EventStatus,
Exception,
Response,
SeverityLevel,
StackFrame,
Stacktrace,
Status,
Thread,
User,
} from '@sentry/types';
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/src/transports/base.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,12 @@ import {
Outcome,
Response as SentryResponse,
SentryRequestType,
Status,
Transport,
TransportOptions,
} from '@sentry/types';
import {
dateTimestampInSeconds,
eventStatusFromHttpCode,
getGlobalObject,
logger,
parseRetryAfterHeader,
Expand Down Expand Up @@ -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
Expand All @@ -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;
}
Expand Down
6 changes: 3 additions & 3 deletions packages/browser/test/unit/mocks/simpletransport.ts
Original file line number Diff line number Diff line change
@@ -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),
}),
);
}
Expand Down
26 changes: 13 additions & 13 deletions packages/browser/test/unit/transports/fetch.test.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
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://[email protected]/42';
const storeUrl = 'https://sentry.io/api/42/store/?sentry_key=123&sentry_version=7';
Expand Down Expand Up @@ -61,7 +61,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',
Expand Down Expand Up @@ -149,7 +149,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: {
Expand All @@ -176,7 +176,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',
Expand Down Expand Up @@ -232,7 +232,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);
});

Expand Down Expand Up @@ -275,7 +275,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 {
Expand All @@ -290,7 +290,7 @@ describe('FetchTransport', () => {
}

const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(fetch).toHaveBeenCalledTimes(3);
});

Expand Down Expand Up @@ -357,11 +357,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);
});

Expand Down Expand Up @@ -428,11 +428,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);
});

Expand Down Expand Up @@ -460,7 +460,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 {
Expand All @@ -477,7 +477,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);
});

Expand Down
24 changes: 12 additions & 12 deletions packages/browser/test/unit/transports/xhr.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Outcome } from '@sentry/types';
import { SentryError } from '@sentry/utils';
import { fakeServer, SinonFakeServer } from 'sinon';

import { Event, Response, Status, Transports } from '../../../src';
import { Event, Response, Transports } from '../../../src';

const testDsn = 'https://[email protected]/42';
const storeUrl = 'https://sentry.io/api/42/store/?sentry_key=123&sentry_version=7';
Expand Down Expand Up @@ -41,7 +41,7 @@ describe('XHRTransport', () => {

const res = await transport.sendEvent(eventPayload);

expect((res as Response).status).toBe(Status.Success);
expect((res as Response).status).toBe('success');
const request = server.requests[0];
expect(server.requests.length).toBe(1);
expect(request.method).toBe('POST');
Expand Down Expand Up @@ -107,7 +107,7 @@ describe('XHRTransport', () => {
const res = await transport.sendEvent(eventPayload);
const request = server.requests[0];

expect((res as Response).status).toBe(Status.Success);
expect((res as Response).status).toBe('success');
const requestHeaders: { [key: string]: string } = request.requestHeaders as { [key: string]: string };
expect(requestHeaders['Accept']).toBe('application/json');
});
Expand Down Expand Up @@ -157,7 +157,7 @@ describe('XHRTransport', () => {
server.respondWith('POST', storeUrl, [200, {}, '']);

const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(2);
});

Expand Down Expand Up @@ -197,7 +197,7 @@ describe('XHRTransport', () => {
}

const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(transactionRes.status).toBe('success');
expect(server.requests.length).toBe(2);

try {
Expand All @@ -214,7 +214,7 @@ describe('XHRTransport', () => {
server.respondWith('POST', storeUrl, [200, {}, '']);

const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(3);
});

Expand Down Expand Up @@ -285,11 +285,11 @@ describe('XHRTransport', () => {
server.respondWith('POST', envelopeUrl, [200, {}, '']);

const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(2);

const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(transactionRes.status).toBe('success');
expect(server.requests.length).toBe(3);
});

Expand Down Expand Up @@ -356,11 +356,11 @@ describe('XHRTransport', () => {
server.respondWith('POST', envelopeUrl, [200, {}, '']);

const eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(2);

const transactionRes = await transport.sendEvent(transactionPayload);
expect(transactionRes.status).toBe(Status.Success);
expect(transactionRes.status).toBe('success');
expect(server.requests.length).toBe(3);
});

Expand All @@ -386,7 +386,7 @@ describe('XHRTransport', () => {
.mockImplementationOnce(() => afterLimit);

let eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(1);

try {
Expand All @@ -403,7 +403,7 @@ describe('XHRTransport', () => {
server.respondWith('POST', storeUrl, [200, {}, '']);

eventRes = await transport.sendEvent(eventPayload);
expect(eventRes.status).toBe(Status.Success);
expect(eventRes.status).toBe('success');
expect(server.requests.length).toBe(2);
});

Expand Down
4 changes: 2 additions & 2 deletions packages/core/src/transports/noop.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Event, Response, Status, Transport } from '@sentry/types';
import { Event, Response, Transport } from '@sentry/types';
import { SyncPromise } from '@sentry/utils';

/** Noop transport */
Expand All @@ -9,7 +9,7 @@ export class NoopTransport implements Transport {
public sendEvent(_: Event): PromiseLike<Response> {
return SyncPromise.resolve({
reason: `NoopTransport: Event has been skipped because no Dsn is configured.`,
status: Status.Skipped,
status: 'skipped',
});
}

Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/mocks/transport.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Event, Response, Status, Transport } from '@sentry/types';
import { Event, Response, Transport } from '@sentry/types';
import { PromiseBuffer, SyncPromise } from '@sentry/utils';

async function sleep(delay: number): Promise<void> {
Expand All @@ -20,7 +20,7 @@ export class FakeTransport implements Transport {
new SyncPromise(async res => {
await sleep(this.delay);
this.sentCount += 1;
res({ status: Status.Success });
res({ status: 'success' });
}),
);
}
Expand Down
4 changes: 2 additions & 2 deletions packages/hub/test/sessionflusher.test.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { RequestSessionStatus, Status } from '@sentry/types';
import { RequestSessionStatus } from '@sentry/types';

import { SessionFlusher } from '../src/sessionflusher';

Expand All @@ -12,7 +12,7 @@ describe('Session Flusher', () => {

beforeEach(() => {
jest.useFakeTimers();
sendSession = jest.fn(() => Promise.resolve({ status: Status.Success }));
sendSession = jest.fn(() => Promise.resolve({ status: 'success' }));
transport = {
sendEvent: jest.fn(),
sendSession,
Expand Down
2 changes: 1 addition & 1 deletion packages/node/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ export {
SdkInfo,
Event,
EventHint,
EventStatus,
Exception,
Response,
SeverityLevel,
StackFrame,
Stacktrace,
Status,
Thread,
User,
} from '@sentry/types';
Expand Down
7 changes: 3 additions & 4 deletions packages/node/src/transports/base/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ import {
SentryRequestType,
Session,
SessionAggregates,
Status,
Transport,
TransportOptions,
} from '@sentry/types';
import { logger, parseRetryAfterHeader, PromiseBuffer, SentryError } from '@sentry/utils';
import { eventStatusFromHttpCode, logger, parseRetryAfterHeader, PromiseBuffer, SentryError } from '@sentry/utils';
import * as fs from 'fs';
import * as http from 'http';
import * as https from 'https';
Expand Down Expand Up @@ -209,7 +208,7 @@ export abstract class BaseTransport implements Transport {
const options = this._getRequestOptions(this.urlParser(sentryRequest.url));
const req = this.module.request(options, res => {
const statusCode = res.statusCode || 500;
const status = Status.fromHttpCode(statusCode);
const status = eventStatusFromHttpCode(statusCode);

res.setEncoding('utf8');

Expand All @@ -236,7 +235,7 @@ export abstract class BaseTransport implements Transport {
)}`,
);

if (status === Status.Success) {
if (status === 'success') {
resolve({ status });
} else {
let rejectionMessage = `HTTP Error (${statusCode})`;
Expand Down
Loading