Skip to content
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
// <reference lib="deno.ns" />

import { tracingChannel } from 'node:diagnostics_channel';
import type { Span, TransactionEvent } from '@sentry/core';
import type { DenoClient } from '@sentry/deno';
import {
getActiveSpan,
getCurrentScope,
getGlobalScope,
getIsolationScope,
init,
startSpan,
startSpanManual,
} from '@sentry/deno';
import { assert } from 'https://deno.land/std@0.212.0/assert/assert.ts';
import { assertEquals } from 'https://deno.land/std@0.212.0/assert/assert_equals.ts';
import { assertExists } from 'https://deno.land/std@0.212.0/assert/assert_exists.ts';

function resetGlobals(): void {
getCurrentScope().clear();
getCurrentScope().setClient(undefined);
getIsolationScope().clear();
getGlobalScope().clear();
}

/** See deno-redis.test.ts — same sink shape, deduped for clarity. */
function transactionSink(): {
beforeSendTransaction: (event: TransactionEvent) => null;
waitFor: (predicate: (event: TransactionEvent) => boolean) => Promise<TransactionEvent>;
} {
const transactions: TransactionEvent[] = [];
const waiters: { predicate: (e: TransactionEvent) => boolean; resolve: (e: TransactionEvent) => void }[] = [];
return {
beforeSendTransaction(event) {
transactions.push(event);
for (let i = waiters.length - 1; i >= 0; i--) {
const w = waiters[i]!;
if (w.predicate(event)) {
waiters.splice(i, 1);
w.resolve(event);
}
}
return null;
},
waitFor(predicate) {
const already = transactions.find(predicate);
if (already) return Promise.resolve(already);
return new Promise<TransactionEvent>(resolve => {
waiters.push({ predicate, resolve });
});
},
};
}

function withTimeout<T>(p: Promise<T>, ms: number, what: string): Promise<T> {
let timer: ReturnType<typeof setTimeout> | undefined;
const timeout = new Promise<T>((_, reject) => {
timer = setTimeout(() => reject(new Error(`Timed out waiting for ${what} after ${ms}ms`)), ms);
});
return Promise.race([p, timeout]).finally(() => {
if (timer !== undefined) clearTimeout(timer);
});
}

Deno.test('lru-memoizer instrumentation: included in default integrations (Deno 2.8.0+)', () => {
resetGlobals();
const client = init({ dsn: 'https://username@domain/123' }) as DenoClient;
const names = client.getOptions().integrations.map(i => i.name);
assert(names.includes('LruMemoizer'), `LruMemoizer should be in defaults, got ${names.join(', ')}`);
});

// lru-memoizer creates no span of its own; it restores the caller's scope onto
// the memoized callback (which it fires from a detached `setImmediate`). We drive
// `start` while a parent span is active (capturing the caller's context), then
// drive `asyncStart` from a detached context where that span is NOT active — as
// happens when the callback fires later. Without the restore, work there starts a
// new trace; with it, the parent is active again and a span nests under it.
Deno.test('lru-memoizer instrumentation: restores the caller scope onto the memoized callback', async () => {
resetGlobals();
const sink = transactionSink();
init({
dsn: 'https://username@domain/123',
tracesSampleRate: 1,
beforeSendTransaction: sink.beforeSendTransaction,
});

const channel = tracingChannel('orchestrion:lru-memoizer:load');
const ctx = { arguments: [] };

let parentSpan: Span | undefined;
// `startSpanManual` leaves the span open after the callback but deactivates it,
// so the `asyncStart` below runs with no active span — a genuine detached context.
startSpanManual({ name: 'parent', op: 'test', forceTransaction: true }, span => {
parentSpan = span;
channel.start.runStores(ctx, () => undefined);
});

// Detached: no active span here.
assertEquals(getActiveSpan(), undefined);

let restoredActive: Span | undefined;
channel.asyncStart.runStores(ctx, () => {
restoredActive = getActiveSpan();
startSpan({ name: 'memoized-work', op: 'test' }, () => undefined);
});
channel.asyncEnd.publish(ctx);
parentSpan!.end();

// The callback saw the caller's span restored.
assertEquals(restoredActive, parentSpan);

const parent = await withTimeout(
sink.waitFor(t => t.transaction === 'parent'),
5000,
"'parent' transaction",
);

// The span created in the restored callback nested under the caller, not a new trace.
const child = parent.spans?.find(s => s.description === 'memoized-work');
assertExists(
child,
`expected memoized-work nested under parent, got: ${parent.spans?.map(s => s.description).join(', ')}`,
);
});
1 change: 1 addition & 0 deletions packages/deno/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export {
genericPoolChannelIntegration,
knexChannelIntegration,
koaChannelIntegration,
lruMemoizerChannelIntegration,
mongodbChannelIntegration,
mongooseChannelIntegration,
mysqlChannelIntegration,
Expand Down
2 changes: 2 additions & 0 deletions packages/deno/src/sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
amqplibChannelIntegration,
genericPoolChannelIntegration,
koaChannelIntegration,
lruMemoizerChannelIntegration,
mongodbChannelIntegration,
mongooseChannelIntegration,
mysqlChannelIntegration,
Expand Down Expand Up @@ -78,6 +79,7 @@ export function getDefaultIntegrations(_options: Options): Integration[] {
amqplibChannelIntegration(),
genericPoolChannelIntegration(),
koaChannelIntegration(),
lruMemoizerChannelIntegration(),
mongodbChannelIntegration(),
mongooseChannelIntegration(),
mysqlChannelIntegration(),
Expand Down
4 changes: 4 additions & 0 deletions packages/deno/test/__snapshots__/mod.test.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ snapshot[`captureException 1`] = `
"Amqplib",
"GenericPool",
"Koa",
"LruMemoizer",
"Mongo",
"Mongoose",
"Mysql",
Expand Down Expand Up @@ -203,6 +204,7 @@ snapshot[`captureMessage 1`] = `
"Amqplib",
"GenericPool",
"Koa",
"LruMemoizer",
"Mongo",
"Mongoose",
"Mysql",
Expand Down Expand Up @@ -295,6 +297,7 @@ snapshot[`captureMessage twice 1`] = `
"Amqplib",
"GenericPool",
"Koa",
"LruMemoizer",
"Mongo",
"Mongoose",
"Mysql",
Expand Down Expand Up @@ -394,6 +397,7 @@ snapshot[`captureMessage twice 2`] = `
"Amqplib",
"GenericPool",
"Koa",
"LruMemoizer",
"Mongo",
"Mongoose",
"Mysql",
Expand Down
Loading