Skip to content

feat: Add makeSimpleMultiplexedTransport #10798

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

Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open
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
2 changes: 2 additions & 0 deletions packages/browser/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ export {
getSpanStatusFromHttpCode,
setHttpStatus,
makeMultiplexedTransport,
makeSimpleMultiplexedTransport,
SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY,
moduleMetadataIntegration,
zodErrorsIntegration,
thirdPartyErrorFilterIntegration,
Expand Down
6 changes: 5 additions & 1 deletion packages/core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,11 @@ export { ServerRuntimeClient } from './server-runtime-client';
export { initAndBind, setCurrentClient } from './sdk';
export { createTransport } from './transports/base';
export { makeOfflineTransport } from './transports/offline';
export { makeMultiplexedTransport } from './transports/multiplexed';
export {
makeMultiplexedTransport,
SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY,
makeSimpleMultiplexedTransport,
} from './transports/multiplexed';
export {
getIntegrationsToSetup,
addIntegration,
Expand Down
25 changes: 25 additions & 0 deletions packages/core/src/transports/multiplexed.ts
Original file line number Diff line number Diff line change
Expand Up @@ -158,3 +158,28 @@ export function makeMultiplexedTransport<TO extends BaseTransportOptions>(
};
};
}

export const SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY = 'SIMPLE_MULTIPLEXED_TRANSPORT_ROUTE_TO';

/**
* Creates a transport that will send events to all DSNs provided in `event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY]`,
* which should contain values in the format of `Array<{ dsn: string;, release: string; }>`.
*
* If the value is `undefined` or `[]`, the event will be sent to the `dsn` value provided in your Sentry SDK initialization options as a fallback mechanism.
*/
export function makeSimpleMultiplexedTransport<TO extends BaseTransportOptions>(
transportGenerator: (options: TO) => Transport,
): (options: TO) => Transport {
return makeMultiplexedTransport(transportGenerator, args => {
const event = args.getEvent();
if (
event &&
event.extra &&
SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY in event.extra &&
Array.isArray(event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY])
) {
return event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY];
}
return [];
});
}
100 changes: 90 additions & 10 deletions packages/core/test/lib/transports/multiplexed.test.ts
Original file line number Diff line number Diff line change
@@ -1,23 +1,24 @@
import type {
BaseTransportOptions,
ClientReport,
Envelope,
EventEnvelope,
EventItem,
TransactionEvent,
Transport,
} from '../../../src/types-hoist';

import {
SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY,
createClientReportEnvelope,
createEnvelope,
createTransport,
dsnFromString,
getEnvelopeEndpointWithUrlEncodedAuth,
makeMultiplexedTransport,
makeSimpleMultiplexedTransport,
parseEnvelope,
} from '../../../src';
import { eventFromEnvelope } from '../../../src/transports/multiplexed';
import type {
BaseTransportOptions,
ClientReport,
Envelope,
EventEnvelope,
EventItem,
TransactionEvent,
Transport,
} from '../../../src/types-hoist';

const DSN1 = 'https://1234@5678.ingest.sentry.io/4321';
const DSN1_URL = getEnvelopeEndpointWithUrlEncodedAuth(dsnFromString(DSN1)!);
Expand Down Expand Up @@ -247,3 +248,82 @@ describe('makeMultiplexedTransport', () => {
await transport.send(TRANSACTION_ENVELOPE);
});
});

describe('makeSimpleMultiplexedTransport()', () => {
it('sends events to targets provided in event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY]', async () => {
expect.assertions(2);

const makeTransport = makeSimpleMultiplexedTransport(
createTestTransport(
url => {
expect(url).toBe(DSN1_URL);
},
url => {
expect(url).toBe(DSN2_URL);
},
),
);

const envelope = createEnvelope<EventEnvelope>({ event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2', sent_at: '123' }, [
[
{ type: 'event' },
{
event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2',
extra: {
[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY]: [DSN1, DSN2],
},
},
] as EventItem,
]);

const transport = makeTransport({ url: DSN1_URL, ...transportOptions });
await transport.send(envelope);
});

it('sends events to default DSN if event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY] is not set', async () => {
expect.assertions(1);

const makeTransport = makeSimpleMultiplexedTransport(
createTestTransport(url => {
expect(url).toBe(DSN1_URL);
}),
);

const envelope = createEnvelope<EventEnvelope>({ event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2', sent_at: '123' }, [
[
{ type: 'event' },
{
event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2',
},
] as EventItem,
]);

const transport = makeTransport({ url: DSN1_URL, ...transportOptions });
await transport.send(envelope);
});

it('sends events to default DSN if event.extra[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY] is an empty array', async () => {
expect.assertions(1);

const makeTransport = makeSimpleMultiplexedTransport(
createTestTransport(url => {
expect(url).toBe(DSN1_URL);
}),
);

const envelope = createEnvelope<EventEnvelope>({ event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2', sent_at: '123' }, [
[
{ type: 'event' },
{
event_id: 'aa3ff046696b4bc6b609ce6d28fde9e2',
extra: {
[SIMPLE_MULTIPLEXED_TRANSPORT_EXTRA_ROUTING_KEY]: [],
},
},
] as EventItem,
]);

const transport = makeTransport({ url: DSN1_URL, ...transportOptions });
await transport.send(envelope);
});
});
Loading