Skip to content

Commit

Permalink
accept SeverityLevel wherever we accept Severity
Browse files Browse the repository at this point in the history
  • Loading branch information
lobsterkatie committed Apr 12, 2022
1 parent 05494ec commit 925d5a8
Show file tree
Hide file tree
Showing 14 changed files with 64 additions and 29 deletions.
8 changes: 6 additions & 2 deletions packages/browser/src/client.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
import { Event, EventHint, Options, Severity, Transport, TransportOptions } from '@sentry/types';
import { Event, EventHint, Options, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
import { getGlobalObject, logger, stackParserFromOptions, supportsFetch } from '@sentry/utils';

import { eventFromException, eventFromMessage } from './eventbuilder';
Expand Down Expand Up @@ -89,7 +89,11 @@ export class BrowserClient extends BaseClient<BrowserOptions> {
/**
* @inheritDoc
*/
public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
public eventFromMessage(
message: string,
level: Severity | SeverityLevel = Severity.Info,
hint?: EventHint,
): PromiseLike<Event> {
return eventFromMessage(
stackParserFromOptions(this._options),
message,
Expand Down
4 changes: 2 additions & 2 deletions packages/browser/src/eventbuilder.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Event, EventHint, Exception, Severity, StackFrame, StackParser } from '@sentry/types';
import { Event, EventHint, Exception, Severity, SeverityLevel, StackFrame, StackParser } from '@sentry/types';
import {
addExceptionMechanism,
addExceptionTypeValue,
Expand Down Expand Up @@ -164,7 +164,7 @@ export function eventFromException(
export function eventFromMessage(
stackParser: StackParser,
message: string,
level: Severity = Severity.Info,
level: Severity | SeverityLevel = Severity.Info,
hint?: EventHint,
attachStacktrace?: boolean,
): PromiseLike<Event> {
Expand Down
14 changes: 12 additions & 2 deletions packages/core/src/baseclient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import {
IntegrationClass,
Options,
Severity,
SeverityLevel,
Transport,
} from '@sentry/types';
import {
Expand Down Expand Up @@ -131,7 +132,12 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
/**
* @inheritDoc
*/
public captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined {
public captureMessage(
message: string,
level?: Severity | SeverityLevel,
hint?: EventHint,
scope?: Scope,
): string | undefined {
let eventId: string | undefined = hint && hint.event_id;

const promisedEvent = isPrimitive(message)
Expand Down Expand Up @@ -685,7 +691,11 @@ export abstract class BaseClient<O extends Options> implements Client<O> {
/**
* @inheritDoc
*/
public abstract eventFromMessage(_message: string, _level?: Severity, _hint?: EventHint): PromiseLike<Event>;
public abstract eventFromMessage(
_message: string,
_level?: Severity | SeverityLevel,
_hint?: EventHint,
): PromiseLike<Event>;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions packages/core/test/mocks/client.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Session } from '@sentry/hub';
import { Event, Options, Severity, Transport } from '@sentry/types';
import { Event, Options, Severity, SeverityLevel, Transport } from '@sentry/types';
import { resolvedSyncPromise } from '@sentry/utils';

import { BaseClient } from '../../src/baseclient';
Expand Down Expand Up @@ -38,7 +38,7 @@ export class TestClient extends BaseClient<TestOptions> {
});
}

public eventFromMessage(message: string, level: Severity = Severity.Info): PromiseLike<Event> {
public eventFromMessage(message: string, level: Severity | SeverityLevel = Severity.Info): PromiseLike<Event> {
return resolvedSyncPromise({ message, level });
}

Expand Down
3 changes: 2 additions & 1 deletion packages/hub/src/hub.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
Primitive,
SessionContext,
Severity,
SeverityLevel,
Transaction,
TransactionContext,
User,
Expand Down Expand Up @@ -213,7 +214,7 @@ export class Hub implements HubInterface {
/**
* @inheritDoc
*/
public captureMessage(message: string, level?: Severity, hint?: EventHint): string {
public captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string {
const eventId = (this._lastEventId = hint && hint.event_id ? hint.event_id : uuid4());
let finalHint = hint;

Expand Down
5 changes: 3 additions & 2 deletions packages/hub/src/scope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import {
Scope as ScopeInterface,
ScopeContext,
Severity,
SeverityLevel,
Span,
Transaction,
User,
Expand Down Expand Up @@ -61,7 +62,7 @@ export class Scope implements ScopeInterface {
protected _fingerprint?: string[];

/** Severity */
protected _level?: Severity;
protected _level?: Severity | SeverityLevel;

/** Transaction Name */
protected _transactionName?: string;
Expand Down Expand Up @@ -208,7 +209,7 @@ export class Scope implements ScopeInterface {
/**
* @inheritDoc
*/
public setLevel(level: Severity): this {
public setLevel(level: Severity | SeverityLevel): this {
this._level = level;
this._notifyScopeListeners();
return this;
Expand Down
3 changes: 2 additions & 1 deletion packages/minimal/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import {
Extras,
Primitive,
Severity,
SeverityLevel,
Transaction,
TransactionContext,
User,
Expand Down Expand Up @@ -52,7 +53,7 @@ export function captureException(exception: any, captureContext?: CaptureContext
* @param Severity Define the level of the message.
* @returns The generated eventId.
*/
export function captureMessage(message: string, captureContext?: CaptureContext | Severity): string {
export function captureMessage(message: string, captureContext?: CaptureContext | Severity | SeverityLevel): string {
const syntheticException = new Error(message);

// This is necessary to provide explicit scopes upgrade, without changing the original
Expand Down
8 changes: 6 additions & 2 deletions packages/node/src/client.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import { BaseClient, getEnvelopeEndpointWithUrlEncodedAuth, initAPIDetails, Scope, SDK_VERSION } from '@sentry/core';
import { SessionFlusher } from '@sentry/hub';
import { Event, EventHint, Severity, Transport, TransportOptions } from '@sentry/types';
import { Event, EventHint, Severity, SeverityLevel, Transport, TransportOptions } from '@sentry/types';
import { logger, makeDsn, resolvedSyncPromise, stackParserFromOptions } from '@sentry/utils';

import { eventFromMessage, eventFromUnknownInput } from './eventbuilder';
Expand Down Expand Up @@ -118,7 +118,11 @@ export class NodeClient extends BaseClient<NodeOptions> {
/**
* @inheritDoc
*/
public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
public eventFromMessage(
message: string,
level: Severity | SeverityLevel = Severity.Info,
hint?: EventHint,
): PromiseLike<Event> {
return resolvedSyncPromise(
eventFromMessage(stackParserFromOptions(this._options), message, level, hint, this._options.attachStacktrace),
);
Expand Down
13 changes: 11 additions & 2 deletions packages/node/src/eventbuilder.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
import { getCurrentHub } from '@sentry/hub';
import { Event, EventHint, Exception, Mechanism, Severity, StackFrame, StackParser } from '@sentry/types';
import {
Event,
EventHint,
Exception,
Mechanism,
Severity,
SeverityLevel,
StackFrame,
StackParser,
} from '@sentry/types';
import {
addExceptionMechanism,
addExceptionTypeValue,
Expand Down Expand Up @@ -90,7 +99,7 @@ export function eventFromUnknownInput(stackParser: StackParser, exception: unkno
export function eventFromMessage(
stackParser: StackParser,
message: string,
level: Severity = Severity.Info,
level: Severity | SeverityLevel = Severity.Info,
hint?: EventHint,
attachStacktrace?: boolean,
): Event {
Expand Down
4 changes: 2 additions & 2 deletions packages/types/src/breadcrumb.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import { Severity } from './severity';
import { Severity, SeverityLevel } from './severity';

/** JSDoc */
export interface Breadcrumb {
type?: string;
level?: Severity;
level?: Severity | SeverityLevel;
event_id?: string;
category?: string;
message?: string;
Expand Down
11 changes: 8 additions & 3 deletions packages/types/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Integration, IntegrationClass } from './integration';
import { Options } from './options';
import { Scope } from './scope';
import { Session } from './session';
import { Severity } from './severity';
import { Severity, SeverityLevel } from './severity';
import { Transport } from './transport';

/**
Expand Down Expand Up @@ -36,7 +36,12 @@ export interface Client<O extends Options = Options> {
* @param scope An optional scope containing event metadata.
* @returns The event id
*/
captureMessage(message: string, level?: Severity, hint?: EventHint, scope?: Scope): string | undefined;
captureMessage(
message: string,
level?: Severity | SeverityLevel,
hint?: EventHint,
scope?: Scope,
): string | undefined;

/**
* Captures a manually created event and sends it to Sentry.
Expand Down Expand Up @@ -99,7 +104,7 @@ export interface Client<O extends Options = Options> {
eventFromException(exception: any, hint?: EventHint): PromiseLike<Event>;

/** Creates an {@link Event} from primitive inputs to `captureMessage`. */
eventFromMessage(message: string, level?: Severity, hint?: EventHint): PromiseLike<Event>;
eventFromMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): PromiseLike<Event>;

/** Submits the event to Sentry */
sendEvent(event: Event): void;
Expand Down
4 changes: 2 additions & 2 deletions packages/types/src/event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { Primitive } from './misc';
import { Request } from './request';
import { CaptureContext } from './scope';
import { SdkInfo } from './sdkinfo';
import { Severity } from './severity';
import { Severity, SeverityLevel } from './severity';
import { Span } from './span';
import { Measurements } from './transaction';
import { User } from './user';
Expand All @@ -18,7 +18,7 @@ export interface Event {
message?: string;
timestamp?: number;
start_timestamp?: number;
level?: Severity;
level?: Severity | SeverityLevel;
platform?: string;
logger?: string;
server_name?: string;
Expand Down
4 changes: 2 additions & 2 deletions packages/types/src/hub.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { Integration, IntegrationClass } from './integration';
import { Primitive } from './misc';
import { Scope } from './scope';
import { Session, SessionContext } from './session';
import { Severity } from './severity';
import { Severity, SeverityLevel } from './severity';
import { CustomSamplingContext, Transaction, TransactionContext } from './transaction';
import { User } from './user';

Expand Down Expand Up @@ -87,7 +87,7 @@ export interface Hub {
* @param hint May contain additional information about the original exception.
* @returns The generated eventId.
*/
captureMessage(message: string, level?: Severity, hint?: EventHint): string;
captureMessage(message: string, level?: Severity | SeverityLevel, hint?: EventHint): string;

/**
* Captures a manually created event and sends it to Sentry.
Expand Down
8 changes: 4 additions & 4 deletions packages/types/src/scope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { EventProcessor } from './eventprocessor';
import { Extra, Extras } from './extra';
import { Primitive } from './misc';
import { RequestSession, Session } from './session';
import { Severity } from './severity';
import { Severity, SeverityLevel } from './severity';
import { Span } from './span';
import { Transaction } from './transaction';
import { User } from './user';
Expand All @@ -15,7 +15,7 @@ export type CaptureContext = Scope | Partial<ScopeContext> | ((scope: Scope) =>
/** JSDocs */
export interface ScopeContext {
user: User;
level: Severity;
level: Severity | SeverityLevel;
extra: Extras;
contexts: Contexts;
tags: { [key: string]: Primitive };
Expand Down Expand Up @@ -79,9 +79,9 @@ export interface Scope {

/**
* Sets the level on the scope for future events.
* @param level string {@link Severity}
* @param level string {@link SeverityLevel}
*/
setLevel(level: Severity): this;
setLevel(level: Severity | SeverityLevel): this;

/**
* Sets the transaction name on the scope for future events.
Expand Down

0 comments on commit 925d5a8

Please sign in to comment.