Skip to content

ref: Remove critical severity #5032

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 1 commit into from
May 4, 2022
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions MIGRATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ For our efforts to reduce bundle size of the SDK we had to remove and refactor p
- Remove deprecated `whitelistUrls` and `blacklistUrls` options from `Sentry.init`. They have been superseded by `allowUrls` and `denyUrls` specifically. See [our docs page on inclusive language](https://develop.sentry.dev/inclusion/) for more details.
- Gatsby SDK: Remove `Sentry` from `window` object.
- Remove deprecated `Status`, `SessionStatus`, and `RequestSessionStatus` enums. These were only part of an internal API. If you are using these enums, we encourage you to to look at [b177690d](https://github.com/getsentry/sentry-javascript/commit/b177690d89640aef2587039113c614672c07d2be), [5fc3147d](https://github.com/getsentry/sentry-javascript/commit/5fc3147dfaaf1a856d5923e4ba409479e87273be), and [f99bdd16](https://github.com/getsentry/sentry-javascript/commit/f99bdd16539bf6fac14eccf1a974a4988d586b28) to to see the changes we've made to our code as result. We generally recommend using string literals instead of the removed enums.
- Remove 'critical' severity.
- Remove deprecated `getActiveDomain` method and `DomainAsCarrier` type from `@sentry/hub`.
- Rename `registerRequestInstrumentation` to `instrumentOutgoingRequests` in `@sentry/tracing`.
- Remove `Backend` and port its functionality into `Client` (see
Expand Down
10 changes: 5 additions & 5 deletions packages/hub/test/scope.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ describe('Scope', () => {

test('setLevel', () => {
const scope = new Scope();
scope.setLevel('critical');
expect((scope as any)._level).toEqual('critical');
scope.setLevel('fatal');
expect((scope as any)._level).toEqual('fatal');
});

test('setTransactionName', () => {
Expand Down Expand Up @@ -137,8 +137,8 @@ describe('Scope', () => {

test('chaining', () => {
const scope = new Scope();
scope.setLevel('critical').setUser({ id: '1' });
expect((scope as any)._level).toEqual('critical');
scope.setLevel('fatal').setUser({ id: '1' });
expect((scope as any)._level).toEqual('fatal');
expect((scope as any)._user).toEqual({ id: '1' });
});
});
Expand Down Expand Up @@ -296,7 +296,7 @@ describe('Scope', () => {
const scope = new Scope();
scope.setLevel('warning');
const event: Event = {};
event.level = 'critical';
event.level = 'fatal';
return scope.applyToEvent(event).then(processedEvent => {
expect(processedEvent!.level).toEqual('warning');
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ Sentry.captureMessage('info_message', 'info');
Sentry.captureMessage('warning_message', 'warning');
Sentry.captureMessage('error_message', 'error');
Sentry.captureMessage('fatal_message', 'fatal');
Sentry.captureMessage('critical_message', 'critical');
Sentry.captureMessage('log_message', 'log');
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { getMultipleSentryEnvelopeRequests } from '../../../../utils/helpers';
sentryTest('should capture with different severity levels', async ({ getLocalTestPath, page }) => {
const url = await getLocalTestPath({ testDir: __dirname });

const events = await getMultipleSentryEnvelopeRequests<Event>(page, 7, { url });
const events = await getMultipleSentryEnvelopeRequests<Event>(page, 6, { url });

expect(events[0].message).toBe('debug_message');
expect(events[0].level).toBe('debug');
Expand All @@ -24,9 +24,6 @@ sentryTest('should capture with different severity levels', async ({ getLocalTes
expect(events[4].message).toBe('fatal_message');
expect(events[4].level).toBe('fatal');

expect(events[5].message).toBe('critical_message');
expect(events[5].level).toBe('critical');

expect(events[6].message).toBe('log_message');
expect(events[6].level).toBe('log');
expect(events[5].message).toBe('log_message');
expect(events[5].level).toBe('log');
});
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Sentry.init({
Sentry.addBreadcrumb({
category: 'foo',
message: 'bar',
level: 'critical',
level: 'fatal',
});

Sentry.addBreadcrumb({
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ test('should add multiple breadcrumbs', async () => {
{
category: 'foo',
message: 'bar',
level: 'critical',
level: 'fatal',
},
{
category: 'qux',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Sentry.init({
Sentry.addBreadcrumb({
category: 'foo',
message: 'bar',
level: 'critical',
level: 'fatal',
});

Sentry.captureMessage('test_simple');
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ test('should add a simple breadcrumb', async () => {
{
category: 'foo',
message: 'bar',
level: 'critical',
level: 'fatal',
},
],
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,4 @@ Sentry.captureMessage('info_message', 'info');
Sentry.captureMessage('warning_message', 'warning');
Sentry.captureMessage('error_message', 'error');
Sentry.captureMessage('fatal_message', 'fatal');
Sentry.captureMessage('critical_message', 'critical');
Sentry.captureMessage('log_message', 'log');
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { assertSentryEvent, getMultipleEnvelopeRequest, runServer } from '../../

test('should capture with different severity levels', async () => {
const url = await runServer(__dirname);
const envelopes = await getMultipleEnvelopeRequest(url, 14);
const envelopes = await getMultipleEnvelopeRequest(url, 12);

assertSentryEvent(envelopes[1][2], {
message: 'debug_message',
Expand Down Expand Up @@ -30,11 +30,6 @@ test('should capture with different severity levels', async () => {
});

assertSentryEvent(envelopes[11][2], {
message: 'critical_message',
level: 'critical',
});

assertSentryEvent(envelopes[13][2], {
message: 'log_message',
level: 'log',
});
Expand Down
6 changes: 2 additions & 4 deletions packages/types/src/severity.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* @deprecated Please use a `SeverityLevel` string instead of the `Severity` enum. Acceptable values are 'fatal',
* 'critical', 'error', 'warning', 'log', 'info', and 'debug'.
* 'error', 'warning', 'log', 'info', and 'debug'.
*/
export enum Severity {
/** JSDoc */
Expand All @@ -15,10 +15,8 @@ export enum Severity {
Info = 'info',
/** JSDoc */
Debug = 'debug',
/** JSDoc */
Critical = 'critical',
}

// Note: If this is ever changed, the `validSeverityLevels` array in `@sentry/utils` needs to be changed, also. (See
// note there for why we can't derive one from the other.)
export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug' | 'critical';
export type SeverityLevel = 'fatal' | 'error' | 'warning' | 'log' | 'info' | 'debug';
2 changes: 1 addition & 1 deletion packages/utils/src/severity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { Severity, SeverityLevel } from '@sentry/types';
// create a circular dependency between `@sentry/types` and `@sentry/utils` (also not good). So a TODO accompanying the
// type, reminding anyone who changes it to change this list also, will have to do.

export const validSeverityLevels = ['fatal', 'error', 'warning', 'log', 'info', 'debug', 'critical'];
export const validSeverityLevels = ['fatal', 'error', 'warning', 'log', 'info', 'debug'];

/**
* Converts a string-based level into a member of the deprecated {@link Severity} enum.
Expand Down