Skip to content
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.

Sign up for GitHub

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

feat(core): Add new transports to base backend #4752

Merged
merged 8 commits into from
Mar 23, 2022
Merged

feat(core): Add new transports to base backend #4752

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c7e59cc
ref(utils): Introduce getEnvelopeType helper
AbhiPrasad Mar 22, 2022
9343899
add cast
AbhiPrasad Mar 22, 2022
5f0b1d0
yarn fix
AbhiPrasad Mar 22, 2022
9a03821
fix category
AbhiPrasad Mar 22, 2022
8179e31
Merge branch 'master' into abhi-get-env-type
AbhiPrasad Mar 23, 2022
2326bb9
feat(core): Add new transports to base backend
AbhiPrasad Mar 22, 2022
26db35b
remove _setupNewTransport
AbhiPrasad Mar 23, 2022
297c3e9
Merge branch 'master' into abhi-new-transport-in-client
AbhiPrasad Mar 23, 2022
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
46 changes: 40 additions & 6 deletions packages/core/src/basebackend.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import { Event, EventHint, Options, Session, Severity, Transport } from '@sentry/types';
import { isDebugBuild, logger, SentryError } from '@sentry/utils';

import { initAPIDetails } from './api';
import { createEventEnvelope, createSessionEnvelope } from './request';
import { NewTransport } from './transports/base';
import { NoopTransport } from './transports/noop';

/**
Expand Down Expand Up @@ -63,6 +66,9 @@ export abstract class BaseBackend<O extends Options> implements Backend {
/** Cached transport used internally. */
protected _transport: Transport;

/** New v7 Transport that is initialized alongside the old one */
protected _newTransport?: NewTransport;

/** Creates a new backend instance. */
public constructor(options: O) {
this._options = options;
Expand Down Expand Up @@ -91,9 +97,23 @@ export abstract class BaseBackend<O extends Options> implements Backend {
* @inheritDoc
*/
public sendEvent(event: Event): void {
void this._transport.sendEvent(event).then(null, reason => {
isDebugBuild() && logger.error('Error while sending event:', reason);
});
// TODO(v7): Remove the if-else
if (
this._newTransport &&
this._options.dsn &&
this._options._experiments &&
this._options._experiments.newTransport
) {
const api = initAPIDetails(this._options.dsn, this._options._metadata, this._options.tunnel);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's annoying to do this, but considering that the client has access to API, won't be needed in the future!

const env = createEventEnvelope(event, api);
void this._newTransport.send(env).then(null, reason => {
isDebugBuild() && logger.error('Error while sending event:', reason);
});
} else {
void this._transport.sendEvent(event).then(null, reason => {
isDebugBuild() && logger.error('Error while sending event:', reason);
});
}
}

/**
Expand All @@ -105,9 +125,23 @@ export abstract class BaseBackend<O extends Options> implements Backend {
return;
}

void this._transport.sendSession(session).then(null, reason => {
isDebugBuild() && logger.error('Error while sending session:', reason);
});
// TODO(v7): Remove the if-else
if (
this._newTransport &&
this._options.dsn &&
this._options._experiments &&
this._options._experiments.newTransport
) {
const api = initAPIDetails(this._options.dsn, this._options._metadata, this._options.tunnel);
const [env] = createSessionEnvelope(session, api);
void this._newTransport.send(env).then(null, reason => {
isDebugBuild() && logger.error('Error while sending session:', reason);
});
} else {
void this._transport.sendSession(session).then(null, reason => {
isDebugBuild() && logger.error('Error while sending session:', reason);
});
}
}

/**
Expand Down
41 changes: 39 additions & 2 deletions packages/core/src/request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,11 @@ function enhanceEventWithSdkInfo(event: Event, sdkInfo?: SdkInfo): Event {
return event;
}

/** Creates a SentryRequest from a Session. */
export function sessionToSentryRequest(session: Session | SessionAggregates, api: APIDetails): SentryRequest {
/** Creates an envelope from a Session */
export function createSessionEnvelope(
session: Session | SessionAggregates,
api: APIDetails,
): [SessionEnvelope, SentryRequestType] {
const sdkInfo = getSdkMetadataForEnvelopeHeader(api);
const envelopeHeaders = {
sent_at: new Date().toISOString(),
Expand All @@ -54,13 +57,47 @@ export function sessionToSentryRequest(session: Session | SessionAggregates, api
// TODO (v7) Have to cast type because envelope items do not accept a `SentryRequestType`
const envelopeItem = [{ type } as { type: 'session' | 'sessions' }, session] as SessionItem;
const envelope = createEnvelope<SessionEnvelope>(envelopeHeaders, [envelopeItem]);

return [envelope, type];
}

/** Creates a SentryRequest from a Session. */
export function sessionToSentryRequest(session: Session | SessionAggregates, api: APIDetails): SentryRequest {
const [envelope, type] = createSessionEnvelope(session, api);
return {
body: serializeEnvelope(envelope),
type,
url: getEnvelopeEndpointWithUrlEncodedAuth(api.dsn, api.tunnel),
};
}

/**
* Create an Envelope from an event. Note that this is duplicated from below,
* but on purpose as this will be refactored in v7.
*/
export function createEventEnvelope(event: Event, api: APIDetails): EventEnvelope {
const sdkInfo = getSdkMetadataForEnvelopeHeader(api);
const eventType = event.type || 'event';

const { transactionSampling } = event.sdkProcessingMetadata || {};
const { method: samplingMethod, rate: sampleRate } = transactionSampling || {};

const envelopeHeaders = {
event_id: event.event_id as string,
sent_at: new Date().toISOString(),
...(sdkInfo && { sdk: sdkInfo }),
...(!!api.tunnel && { dsn: dsnToString(api.dsn) }),
};
const eventItem: EventItem = [
{
type: eventType,
sample_rates: [{ id: samplingMethod, rate: sampleRate }],
},
event,
];
return createEnvelope<EventEnvelope>(envelopeHeaders, [eventItem]);
}

/** Creates a SentryRequest from an event. */
export function eventToSentryRequest(event: Event, api: APIDetails): SentryRequest {
const sdkInfo = getSdkMetadataForEnvelopeHeader(api);
Expand Down
13 changes: 6 additions & 7 deletions packages/core/src/transports/base.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { Envelope, EventStatus } from '@sentry/types';
import {
disabledUntil,
eventStatusFromHttpCode,
getEnvelopeType,
isRateLimited,
makePromiseBuffer,
PromiseBuffer,
Expand Down Expand Up @@ -68,6 +69,7 @@ export interface BrowserTransportOptions extends BaseTransportOptions {

// TODO: Move into Node transport
export interface NodeTransportOptions extends BaseTransportOptions {
headers?: Record<string, string>;
// Set a HTTP proxy that should be used for outbound requests.
httpProxy?: string;
// Set a HTTPS proxy that should be used for outbound requests.
Expand All @@ -77,11 +79,7 @@ export interface NodeTransportOptions extends BaseTransportOptions {
}

export interface NewTransport {
// If `$` is set, we know that this is a new transport.
// TODO(v7): Remove this as we will no longer have split between
// old and new transports.
$: boolean;
send(request: Envelope, category: TransportCategory): PromiseLike<TransportResponse>;
send(request: Envelope): PromiseLike<TransportResponse>;
flush(timeout?: number): PromiseLike<boolean>;
}

Expand All @@ -104,7 +102,9 @@ export function createTransport(

const flush = (timeout?: number): PromiseLike<boolean> => buffer.drain(timeout);

function send(envelope: Envelope, category: TransportCategory): PromiseLike<TransportResponse> {
function send(envelope: Envelope): PromiseLike<TransportResponse> {
const envCategory = getEnvelopeType(envelope);
const category = envCategory === 'event' ? 'error' : (envCategory as TransportCategory);
const request: TransportRequest = {
category,
body: serializeEnvelope(envelope),
Expand Down Expand Up @@ -140,7 +140,6 @@ export function createTransport(
}

return {
$: true,
send,
flush,
};
Expand Down
49 changes: 22 additions & 27 deletions packages/core/test/lib/transports/base.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ const TRANSACTION_ENVELOPE = createEnvelope<EventEnvelope>(
);

describe('createTransport', () => {
it('has $ property', () => {
const transport = createTransport({}, _ => resolvedSyncPromise({ statusCode: 200 }));
expect(transport.$).toBeDefined();
});

it('flushes the buffer', async () => {
const mockBuffer: PromiseBuffer<TransportResponse> = {
$: [],
Expand All @@ -47,7 +42,7 @@ describe('createTransport', () => {
expect(req.body).toEqual(serializeEnvelope(ERROR_ENVELOPE));
return resolvedSyncPromise({ statusCode: 200, reason: 'OK' });
});
const res = await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
const res = await transport.send(ERROR_ENVELOPE);
expect(res.status).toBe('success');
expect(res.reason).toBe('OK');
});
Expand All @@ -59,7 +54,7 @@ describe('createTransport', () => {
return resolvedSyncPromise({ statusCode: 400, reason: 'Bad Request' });
});
try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('invalid');
expect(res.reason).toBe('Bad Request');
Expand All @@ -73,7 +68,7 @@ describe('createTransport', () => {
return resolvedSyncPromise({ statusCode: 500 });
});
try {
await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
await transport.send(TRANSACTION_ENVELOPE);
} catch (res) {
expect(res.status).toBe('failed');
expect(res.reason).toBe('Unknown transport error');
Expand Down Expand Up @@ -135,7 +130,7 @@ describe('createTransport', () => {
});

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
Expand All @@ -144,13 +139,13 @@ describe('createTransport', () => {
setTransportResponse({ statusCode: 200 });

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

const res = await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
const res = await transport.send(ERROR_ENVELOPE);
expect(res.status).toBe('success');
});

Expand Down Expand Up @@ -181,7 +176,7 @@ describe('createTransport', () => {
});

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
Expand All @@ -190,20 +185,20 @@ describe('createTransport', () => {
setTransportResponse({ statusCode: 200 });

try {
await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
await transport.send(TRANSACTION_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

const res = await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
const res = await transport.send(TRANSACTION_ENVELOPE);
expect(res.status).toBe('success');
});

Expand Down Expand Up @@ -234,21 +229,21 @@ describe('createTransport', () => {
});

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
await transport.send(TRANSACTION_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(
Expand All @@ -258,10 +253,10 @@ describe('createTransport', () => {

setTransportResponse({ statusCode: 200 });

const eventRes = await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
const eventRes = await transport.send(ERROR_ENVELOPE);
expect(eventRes.status).toBe('success');

const transactionRes = await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
const transactionRes = await transport.send(TRANSACTION_ENVELOPE);
expect(transactionRes.status).toBe('success');
});

Expand Down Expand Up @@ -296,21 +291,21 @@ describe('createTransport', () => {
});

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
await transport.send(TRANSACTION_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(
Expand All @@ -320,10 +315,10 @@ describe('createTransport', () => {

setTransportResponse({ statusCode: 200 });

const eventRes = await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
const eventRes = await transport.send(ERROR_ENVELOPE);
expect(eventRes.status).toBe('success');

const transactionRes = await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
const transactionRes = await transport.send(TRANSACTION_ENVELOPE);
expect(transactionRes.status).toBe('success');
});

Expand Down Expand Up @@ -352,14 +347,14 @@ describe('createTransport', () => {
});

try {
await transport.send(ERROR_ENVELOPE, ERROR_TRANSPORT_CATEGORY);
await transport.send(ERROR_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(`Too many error requests, backing off until: ${new Date(afterLimit).toISOString()}`);
}

try {
await transport.send(TRANSACTION_ENVELOPE, TRANSACTION_TRANSPORT_CATEGORY);
await transport.send(TRANSACTION_ENVELOPE);
} catch (res) {
expect(res.status).toBe('rate_limit');
expect(res.reason).toBe(
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/envelope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ type BaseEnvelope<EH extends BaseEnvelopeHeaders, I extends BaseEnvelopeItem<Bas

type EventItemHeaders = {
type: 'event' | 'transaction';
sample_rates: [{ id?: TransactionSamplingMethod; rate?: number }];
sample_rates?: [{ id?: TransactionSamplingMethod; rate?: number }];
};
type AttachmentItemHeaders = { type: 'attachment'; filename: string };
type UserFeedbackItemHeaders = { type: 'user_report' };
Expand Down
8 changes: 8 additions & 0 deletions packages/utils/src/envelope.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ export function addItemToEnvelope<E extends Envelope>(envelope: E, newItem: E[1]
return [headers, [...items, newItem]] as E;
}

/**
* Get the type of the envelope. Grabs the type from the first envelope item.
*/
export function getEnvelopeType<E extends Envelope>(envelope: E): string {
const [, [[firstItemHeader]]] = envelope;
return firstItemHeader.type;
}

/**
* Serializes an envelope into a string.
*/
Expand Down
Loading