Skip to content

Commit 49f5c05

Browse files
JonasBaJonasBa
committed
ref(span): deprecate span status enum
1 parent 37a1c24 commit 49f5c05

20 files changed

+138
-101
lines changed

‎packages/browser/test/unit/mocks/simpletransport.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import { SyncPromise, statusFromHttpCode } from '@sentry/utils';
1+
import { statusFromHttpCode, SyncPromise } from '@sentry/utils';
22

33
import { Event, Response } from '../../../src';
44
import { BaseTransport } from '../../../src/transports';

‎packages/node/test/handlers.test.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as sentryCore from '@sentry/core';
22
import { Hub } from '@sentry/hub';
33
import * as sentryHub from '@sentry/hub';
4-
import { SpanStatus, Transaction } from '@sentry/tracing';
4+
import { Transaction } from '@sentry/tracing';
55
import { RequestSessionStatus, Runtime } from '@sentry/types';
66
import * as http from 'http';
77
import * as net from 'net';
@@ -403,7 +403,7 @@ describe('tracingHandler', () => {
403403

404404
setImmediate(() => {
405405
expect(finishTransaction).toHaveBeenCalled();
406-
expect(transaction.status).toBe(SpanStatus.Ok);
406+
expect(transaction.status).toBe('ok');
407407
expect(transaction.tags).toEqual(expect.objectContaining({ 'http.status_code': '200' }));
408408
done();
409409
});

‎packages/tracing/src/browser/backgroundtab.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1+
import { SpanStatusType } from '@sentry/types';
12
import { getGlobalObject, logger } from '@sentry/utils';
23

34
import { FINISH_REASON_TAG, IDLE_TRANSACTION_FINISH_REASONS } from '../constants';
45
import { IdleTransaction } from '../idletransaction';
5-
import { SpanStatus } from '../spanstatus';
66
import { getActiveTransaction } from '../utils';
77

88
const global = getGlobalObject<Window>();
@@ -16,13 +16,14 @@ export function registerBackgroundTabDetection(): void {
1616
global.document.addEventListener('visibilitychange', () => {
1717
const activeTransaction = getActiveTransaction() as IdleTransaction;
1818
if (global.document.hidden && activeTransaction) {
19+
const status: SpanStatusType = 'cancelled';
1920
logger.log(
20-
`[Tracing] Transaction: ${SpanStatus.Cancelled} -> since tab moved to the background, op: ${activeTransaction.op}`,
21+
`[Tracing] Transaction: ${status} -> since tab moved to the background, op: ${activeTransaction.op}`,
2122
);
2223
// We should not set status if it is already set, this prevent important statuses like
2324
// error or data loss from being overwritten on transaction.
2425
if (!activeTransaction.status) {
25-
activeTransaction.setStatus(SpanStatus.Cancelled);
26+
activeTransaction.setStatus(status);
2627
}
2728
activeTransaction.setTag('visibilitychange', 'document.hidden');
2829
activeTransaction.setTag(FINISH_REASON_TAG, IDLE_TRANSACTION_FINISH_REASONS[2]);

‎packages/tracing/src/browser/browsertracing.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import { getGlobalObject, logger } from '@sentry/utils';
44

55
import { startIdleTransaction } from '../hubextensions';
66
import { DEFAULT_IDLE_TIMEOUT, IdleTransaction } from '../idletransaction';
7-
import { SpanStatus } from '../spanstatus';
87
import { extractTraceparentData, secToMs } from '../utils';
98
import { registerBackgroundTabDetection } from './backgroundtab';
109
import { MetricsInstrumentation } from './metrics';
@@ -269,7 +268,7 @@ function adjustTransactionDuration(maxDuration: number, transaction: IdleTransac
269268
const diff = endTimestamp - transaction.startTimestamp;
270269
const isOutdatedTransaction = endTimestamp && (diff > maxDuration || diff < 0);
271270
if (isOutdatedTransaction) {
272-
transaction.setStatus(SpanStatus.DeadlineExceeded);
271+
transaction.setStatus('deadline_exceeded');
273272
transaction.setTag('maxTransactionDurationExceeded', 'true');
274273
}
275274
}

‎packages/tracing/src/browser/request.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { addInstrumentationHandler, isInstanceOf, isMatchingPattern } from '@sentry/utils';
22

33
import { Span } from '../span';
4-
import { SpanStatus } from '../spanstatus';
54
import { getActiveTransaction, hasTracingEnabled } from '../utils';
65

76
export const DEFAULT_TRACING_ORIGINS = ['localhost', /^\//];
@@ -156,7 +155,7 @@ export function fetchCallback(
156155
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
157156
span.setHttpStatus(handlerData.response.status);
158157
} else if (handlerData.error) {
159-
span.setStatus(SpanStatus.InternalError);
158+
span.setStatus('internal_error');
160159
}
161160
span.finish();
162161

‎packages/tracing/src/errors.ts

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1+
import { SpanStatusType } from '@sentry/types';
12
import { addInstrumentationHandler, logger } from '@sentry/utils';
23

3-
import { SpanStatus } from './spanstatus';
44
import { getActiveTransaction } from './utils';
55

66
/**
@@ -23,7 +23,8 @@ export function registerErrorInstrumentation(): void {
2323
function errorCallback(): void {
2424
const activeTransaction = getActiveTransaction();
2525
if (activeTransaction) {
26-
logger.log(`[Tracing] Transaction: ${SpanStatus.InternalError} -> Global error occured`);
27-
activeTransaction.setStatus(SpanStatus.InternalError);
26+
const errorType: SpanStatusType = 'internal_error';
27+
logger.log(`[Tracing] Transaction: ${errorType} -> Global error occured`);
28+
activeTransaction.setStatus(errorType);
2829
}
2930
}

‎packages/tracing/src/idletransaction.ts

+2-3
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ import { logger, timestampWithMs } from '@sentry/utils';
44

55
import { FINISH_REASON_TAG, IDLE_TRANSACTION_FINISH_REASONS } from './constants';
66
import { Span, SpanRecorder } from './span';
7-
import { SpanStatus } from './spanstatus';
87
import { Transaction } from './transaction';
98

109
export const DEFAULT_IDLE_TIMEOUT = 1000;
@@ -125,7 +124,7 @@ export class IdleTransaction extends Transaction {
125124
// We cancel all pending spans with status "cancelled" to indicate the idle transaction was finished early
126125
if (!span.endTimestamp) {
127126
span.endTimestamp = endTimestamp;
128-
span.setStatus(SpanStatus.Cancelled);
127+
span.setStatus('cancelled');
129128
logger.log('[Tracing] cancelling span since transaction ended early', JSON.stringify(span, undefined, 2));
130129
}
131130

@@ -253,7 +252,7 @@ export class IdleTransaction extends Transaction {
253252

254253
if (this._heartbeatCounter >= 3) {
255254
logger.log(`[Tracing] Transaction finished because of no change for 3 heart beats`);
256-
this.setStatus(SpanStatus.DeadlineExceeded);
255+
this.setStatus('deadline_exceeded');
257256
this.setTag(FINISH_REASON_TAG, IDLE_TRANSACTION_FINISH_REASONS[0]);
258257
this.finish();
259258
} else {

‎packages/tracing/src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ export {
2929
RequestInstrumentationOptions,
3030
defaultRequestInstrumentationOptions,
3131
} from './browser';
32+
/* eslint-disable-next-line deprecation/deprecation */
3233
export { SpanStatus } from './spanstatus';
3334
export { IdleTransaction } from './idletransaction';
3435
export { startIdleTransaction } from './hubextensions';

‎packages/tracing/src/span.ts

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
/* eslint-disable max-lines */
2-
import { Primitive, Span as SpanInterface, SpanContext, Transaction } from '@sentry/types';
3-
import { dropUndefinedKeys, timestampWithMs, uuid4 } from '@sentry/utils';
4-
5-
import { SpanStatus } from './spanstatus';
2+
import { Primitive, Span as SpanInterface, SpanContext, SpanStatusType, Transaction } from '@sentry/types';
3+
import { dropUndefinedKeys, spanStatusfromHttpCode, timestampWithMs, uuid4 } from '@sentry/utils';
64

75
/**
86
* Keeps track of finished spans for a given transaction
@@ -56,7 +54,7 @@ export class Span implements SpanInterface {
5654
/**
5755
* Internal keeper of the status
5856
*/
59-
public status?: SpanStatus | string;
57+
public status?: SpanStatusType;
6058

6159
/**
6260
* @inheritDoc
@@ -204,7 +202,7 @@ export class Span implements SpanInterface {
204202
/**
205203
* @inheritDoc
206204
*/
207-
public setStatus(value: SpanStatus): this {
205+
public setStatus(value: SpanStatusType): this {
208206
this.status = value;
209207
return this;
210208
}
@@ -214,8 +212,8 @@ export class Span implements SpanInterface {
214212
*/
215213
public setHttpStatus(httpStatus: number): this {
216214
this.setTag('http.status_code', String(httpStatus));
217-
const spanStatus = SpanStatus.fromHttpCode(httpStatus);
218-
if (spanStatus !== SpanStatus.UnknownError) {
215+
const spanStatus = spanStatusfromHttpCode(httpStatus);
216+
if (spanStatus !== 'unknown_error') {
219217
this.setStatus(spanStatus);
220218
}
221219
return this;
@@ -225,7 +223,7 @@ export class Span implements SpanInterface {
225223
* @inheritDoc
226224
*/
227225
public isSuccess(): boolean {
228-
return this.status === SpanStatus.Ok;
226+
return this.status === 'ok';
229227
}
230228

231229
/**

‎packages/tracing/src/spanstatus.ts

+3-51
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
/** The status of an Span. */
2-
// eslint-disable-next-line import/export
1+
/** JSDoc
2+
* @deprecated Use string literals - if you require type casting, cast to SpanStatusType type
3+
*/
34
export enum SpanStatus {
45
/** The operation completed successfully. */
56
Ok = 'ok',
@@ -36,52 +37,3 @@ export enum SpanStatus {
3637
/** Unrecoverable data loss or corruption */
3738
DataLoss = 'data_loss',
3839
}
39-
40-
// eslint-disable-next-line @typescript-eslint/no-namespace, import/export
41-
export namespace SpanStatus {
42-
/**
43-
* Converts a HTTP status code into a {@link SpanStatus}.
44-
*
45-
* @param httpStatus The HTTP response status code.
46-
* @returns The span status or {@link SpanStatus.UnknownError}.
47-
*/
48-
export function fromHttpCode(httpStatus: number): SpanStatus {
49-
if (httpStatus < 400 && httpStatus >= 100) {
50-
return SpanStatus.Ok;
51-
}
52-
53-
if (httpStatus >= 400 && httpStatus < 500) {
54-
switch (httpStatus) {
55-
case 401:
56-
return SpanStatus.Unauthenticated;
57-
case 403:
58-
return SpanStatus.PermissionDenied;
59-
case 404:
60-
return SpanStatus.NotFound;
61-
case 409:
62-
return SpanStatus.AlreadyExists;
63-
case 413:
64-
return SpanStatus.FailedPrecondition;
65-
case 429:
66-
return SpanStatus.ResourceExhausted;
67-
default:
68-
return SpanStatus.InvalidArgument;
69-
}
70-
}
71-
72-
if (httpStatus >= 500 && httpStatus < 600) {
73-
switch (httpStatus) {
74-
case 501:
75-
return SpanStatus.Unimplemented;
76-
case 503:
77-
return SpanStatus.Unavailable;
78-
case 504:
79-
return SpanStatus.DeadlineExceeded;
80-
default:
81-
return SpanStatus.InternalError;
82-
}
83-
}
84-
85-
return SpanStatus.UnknownError;
86-
}
87-
}

‎packages/tracing/test/browser/backgroundtab.test.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { BrowserClient } from '@sentry/browser';
22
import { Hub, makeMain } from '@sentry/hub';
33
import { JSDOM } from 'jsdom';
44

5-
import { SpanStatus } from '../../src';
5+
import { SpanStatusType } from '../../../types/src/span';
66
import { registerBackgroundTabDetection } from '../../src/browser/backgroundtab';
77

88
describe('registerBackgroundTabDetection', () => {
@@ -49,7 +49,8 @@ describe('registerBackgroundTabDetection', () => {
4949
global.document.hidden = true;
5050
events.visibilitychange();
5151

52-
expect(transaction.status).toBe(SpanStatus.Cancelled);
52+
const status: SpanStatusType = 'cancelled';
53+
expect(transaction.status).toBe(status);
5354
expect(transaction.tags.visibilitychange).toBe('document.hidden');
5455
expect(transaction.endTimestamp).toBeDefined();
5556
});

‎packages/tracing/test/browser/browsertracing.test.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { Hub, makeMain } from '@sentry/hub';
33
import { getGlobalObject } from '@sentry/utils';
44
import { JSDOM } from 'jsdom';
55

6-
import { SpanStatus } from '../../src';
6+
import { SpanStatusType } from '../../../types/src/span';
77
import {
88
BrowserTracing,
99
BrowserTracingOptions,
@@ -273,7 +273,8 @@ describe('BrowserTracing', () => {
273273
const transaction = getActiveTransaction(hub) as IdleTransaction;
274274
transaction.finish(transaction.startTimestamp + secToMs(DEFAULT_MAX_TRANSACTION_DURATION_SECONDS) + 1);
275275

276-
expect(transaction.status).toBe(SpanStatus.DeadlineExceeded);
276+
const status: SpanStatusType = 'deadline_exceeded';
277+
expect(transaction.status).toBe(status);
277278
expect(transaction.tags.maxTransactionDurationExceeded).toBeDefined();
278279
});
279280

‎packages/tracing/test/browser/request.test.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { BrowserClient } from '@sentry/browser';
22
import { Hub, makeMain } from '@sentry/hub';
33
import * as utils from '@sentry/utils';
44

5-
import { Span, SpanStatus, Transaction } from '../../src';
5+
import { Span, Transaction } from '../../src';
66
import { fetchCallback, FetchData, instrumentOutgoingRequests, xhrCallback, XHRData } from '../../src/browser/request';
77
import { addExtensionMethods } from '../../src/hubextensions';
88
import * as tracingUtils from '../../src/utils';
@@ -176,7 +176,7 @@ describe('callbacks', () => {
176176
// triggered by response coming back
177177
fetchCallback(postRequestFetchHandlerData, alwaysCreateSpan, spans);
178178

179-
expect(newSpan!.status).toBe(SpanStatus.fromHttpCode(404));
179+
expect(newSpan!.status).toBe(utils.spanStatusfromHttpCode(404));
180180
});
181181

182182
it('adds sentry-trace header to fetch requests', () => {
@@ -267,7 +267,7 @@ describe('callbacks', () => {
267267
// triggered by response coming back
268268
xhrCallback(postRequestXHRHandlerData, alwaysCreateSpan, spans);
269269

270-
expect(newSpan!.status).toBe(SpanStatus.fromHttpCode(404));
270+
expect(newSpan!.status).toBe(utils.spanStatusfromHttpCode(404));
271271
});
272272
});
273273
});

‎packages/tracing/test/errors.test.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { BrowserClient } from '@sentry/browser';
22
import { Hub, makeMain } from '@sentry/hub';
33

4-
import { SpanStatus } from '../src';
4+
import { SpanStatusType } from '../../types/src/span';
55
import { registerErrorInstrumentation } from '../src/errors';
66
import { _addTracingExtensions } from '../src/hubextensions';
77

@@ -71,7 +71,8 @@ describe('registerErrorHandlers()', () => {
7171
hub.configureScope(scope => scope.setSpan(transaction));
7272

7373
mockErrorCallback();
74-
expect(transaction.status).toBe(SpanStatus.InternalError);
74+
const status: SpanStatusType = 'internal_error';
75+
expect(transaction.status).toBe(status);
7576

7677
transaction.finish();
7778
});
@@ -82,7 +83,8 @@ describe('registerErrorHandlers()', () => {
8283
hub.configureScope(scope => scope.setSpan(transaction));
8384

8485
mockUnhandledRejectionCallback();
85-
expect(transaction.status).toBe(SpanStatus.InternalError);
86+
const status: SpanStatusType = 'internal_error';
87+
expect(transaction.status).toBe(status);
8688
transaction.finish();
8789
});
8890
});

‎packages/tracing/test/idletransaction.test.ts

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { BrowserClient, Transports } from '@sentry/browser';
22
import { Hub } from '@sentry/hub';
3-
import { Outcome } from '@sentry/types';
3+
import { Outcome, SpanStatusType } from '@sentry/types';
44

55
import {
66
DEFAULT_IDLE_TIMEOUT,
@@ -9,7 +9,6 @@ import {
99
IdleTransactionSpanRecorder,
1010
} from '../src/idletransaction';
1111
import { Span } from '../src/span';
12-
import { SpanStatus } from '../src/spanstatus';
1312

1413
export class SimpleTransport extends Transports.BaseTransport {}
1514

@@ -160,7 +159,8 @@ describe('IdleTransaction', () => {
160159

161160
// Cancelled Span - has endtimestamp of transaction
162161
expect(spans[2].spanId).toBe(cancelledSpan.spanId);
163-
expect(spans[2].status).toBe(SpanStatus.Cancelled);
162+
const status: SpanStatusType = 'cancelled';
163+
expect(spans[2].status).toBe(status);
164164
expect(spans[2].endTimestamp).toBe(transaction.endTimestamp);
165165
}
166166
});
@@ -203,22 +203,23 @@ describe('IdleTransaction', () => {
203203
const transaction = new IdleTransaction({ name: 'foo' }, hub, 20000);
204204
const mockFinish = jest.spyOn(transaction, 'finish');
205205

206-
expect(transaction.status).not.toEqual(SpanStatus.DeadlineExceeded);
206+
const status: SpanStatusType = 'deadline_exceeded';
207+
expect(transaction.status).not.toEqual(status);
207208
expect(mockFinish).toHaveBeenCalledTimes(0);
208209

209210
// Beat 1
210211
jest.advanceTimersByTime(HEARTBEAT_INTERVAL);
211-
expect(transaction.status).not.toEqual(SpanStatus.DeadlineExceeded);
212+
expect(transaction.status).not.toEqual(status);
212213
expect(mockFinish).toHaveBeenCalledTimes(0);
213214

214215
// Beat 2
215216
jest.advanceTimersByTime(HEARTBEAT_INTERVAL);
216-
expect(transaction.status).not.toEqual(SpanStatus.DeadlineExceeded);
217+
expect(transaction.status).not.toEqual(status);
217218
expect(mockFinish).toHaveBeenCalledTimes(0);
218219

219220
// Beat 3
220221
jest.advanceTimersByTime(HEARTBEAT_INTERVAL);
221-
expect(transaction.status).not.toEqual(SpanStatus.DeadlineExceeded);
222+
expect(transaction.status).not.toEqual(status);
222223
expect(mockFinish).toHaveBeenCalledTimes(0);
223224
});
224225

0 commit comments

Comments
 (0)