Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Closed
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: 1 addition & 1 deletion .size-limit.js
Original file line numberDiff line numberDiff line change
Expand Up@@ -477,7 +477,7 @@ module.exports = [
ignore: [...builtinModules, ...nodePrefixedBuiltinModules],
gzip: false,
brotli: false,
limit: '524 KiB',
limit: '529 KiB',
disablePlugins: ['@size-limit/webpack'],
webpack: false,
modifyEsbuildConfig: function (config) {
Expand Down
23 changes: 22 additions & 1 deletion dev-packages/cloudflare-integration-tests/runner.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,7 @@ import { inspect } from 'util';
import { expect } from 'vitest';

const CLEANUP_STEPS = new Set<() => void>();
const STRICT_ENVELOPE_QUIET_WINDOW_MS = 250;

export function cleanupChildProcesses(): void {
for (const step of CLEANUP_STEPS) {
Expand DownExpand Up@@ -161,6 +162,7 @@ export function createRunner(...paths: string[]) {

// controls whether envelopes are expected in predefined order or not
let unordered = false;
let strict = false;

if (!existsSync(testPath)) {
throw new Error(`Test scenario not found: ${testPath}`);
Expand DownExpand Up@@ -195,6 +197,10 @@ export function createRunner(...paths: string[]) {
unordered = true;
return this;
},
strict: function () {
strict = true;
return this;
},
ignore: function (...types: EnvelopeItemType[]) {
types.forEach(t => ignored.add(t));
return this;
Expand DownExpand Up@@ -238,10 +244,19 @@ export function createRunner(...paths: string[]) {
function expectCallbackCalled(): void {
envelopeCount++;
if (envelopeCount === expectedEnvelopeCount) {
resolve();
if (strict) {
// Keep the server open briefly so envelopes emitted just after the final match cannot escape cardinality checks.
setTimeout(resolve, STRICT_ENVELOPE_QUIET_WINDOW_MS);
} else {
resolve();
}
}
}

function rejectUnexpectedEnvelope(envelopeItemType: EnvelopeItemType): void {
reject(new Error(`Received unexpected ${envelopeItemType} envelope in strict mode`));
}

function waitForEnvelope(expected: Expected): Promise<void> {
return new Promise((resolveWaiter, rejectWaiter) => {
envelopeWaiters.push({ expected, resolve: resolveWaiter, reject: rejectWaiter });
Expand DownExpand Up@@ -297,6 +312,9 @@ export function createRunner(...paths: string[]) {

// no match found
if (matchIndex < 0) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand All@@ -307,6 +325,9 @@ export function createRunner(...paths: string[]) {
const expected = expectedEnvelopes.shift();

if (!expected) {
if (strict) {
rejectUnexpectedEnvelope(envelopeItemType);
}
return;
}

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
import * as Sentry from '@sentry/cloudflare';

interface Env {
SENTRY_DSN: string;
}

export default Sentry.withSentry(
(env: Env) => ({
dsn: env.SENTRY_DSN,
traceLifecycle: 'static',
tracesSampleRate: 1,
}),
{
async fetch(_request, _env, context) {
const lateSpan = Sentry.startInactiveSpan({
name: 'late waitUntil child',
op: 'test.wait_until',
});

context.waitUntil(
new Promise<void>(resolve => {
setTimeout(() => {
lateSpan.end();
resolve();
}, 25);
}),
);

return new Response(null, { status: 204 });
},
} satisfies ExportedHandler<Env>,
);
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import type { TransactionEvent } from '@sentry/core';
import { expect, it } from 'vitest';
import { createRunner } from '../../../runner';

it('preserves a static child span that ends in waitUntil after the response', async ({ signal }) => {
let requestTraceId: string | undefined;
let requestSpanId: string | undefined;
let lateTraceId: string | undefined;
let lateParentSpanId: string | undefined;

const runner = createRunner(__dirname)
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('GET /late-child');
expect(transaction.contexts?.trace?.op).toBe('http.server');
expect(transaction.spans).toHaveLength(0);

requestTraceId = transaction.contexts?.trace?.trace_id;
requestSpanId = transaction.contexts?.trace?.span_id;
})
.expect(envelope => {
expect(envelope[1]).toHaveLength(1);
expect(envelope[1][0]?.[0].type).toBe('transaction');

const transaction = envelope[1][0]?.[1] as TransactionEvent;
expect(transaction.transaction).toBe('late waitUntil child');
expect(transaction.contexts?.trace?.op).toBe('test.wait_until');
expect(transaction.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
expect(transaction.spans).toHaveLength(0);

lateTraceId = transaction.contexts?.trace?.trace_id;
lateParentSpanId = transaction.contexts?.trace?.parent_span_id;
})
.unordered()
.strict()
.start(signal);

const response = await runner.makeRequest('get', '/late-child');
expect(response).toBe('');
await runner.completed();

expect(requestTraceId).toBeDefined();
expect(lateTraceId).toBe(requestTraceId);
expect(requestSpanId).toBeDefined();
expect(lateParentSpanId).toBe(requestSpanId);
});
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
{
"name": "late-static-child",
"compatibility_date": "2025-06-17",
"main": "index.ts",
"compatibility_flags": ["nodejs_compat"],
}
5 changes: 5 additions & 0 deletions packages/cloudflare/src/client.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
import type { ClientOptions, Options, ServerRuntimeClientOptions } from '@sentry/core';
import {
_INTERNAL_clearAiProviderSkips,
_INTERNAL_setDeferSegmentSpanCapture,
applySdkMetadata,
debug,
ServerRuntimeClient,
Expand DownExpand Up@@ -47,6 +48,10 @@ export class CloudflareClient extends ServerRuntimeClient {
super(clientOptions);
this._flushLock = flushLock;

// Durable Object and waitUntil work can end after the request segment. Deferring static capture
// preserves those late children; the strategy is inert for Cloudflare's default stream lifecycle.
_INTERNAL_setDeferSegmentSpanCapture(this);

// Track span lifecycle to know when to flush
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -255,7 +257,9 @@ describe('instrumentEmail', () => {
);

const emailMessage = createMockEmailMessage();
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.email?.(emailMessage, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`Handle Email ${emailMessage.to}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -268,7 +270,9 @@ describe('instrumentQueue', () => {
);

const batch = createMockQueueBatch();
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.queue?.(batch, MOCK_ENV, createMockExecutionContext(waitUntilPromises));
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual(`process ${batch.queue}`);
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,9 +17,11 @@ const MOCK_ENV_WITHOUT_DSN = {
SENTRY_RELEASE: '1.1.1',
};

function createMockExecutionContext(): ExecutionContext {
function createMockExecutionContext(waitUntilPromises: Promise<unknown>[] = []): ExecutionContext {
return {
waitUntil: vi.fn(),
waitUntil: vi.fn(promise => {
waitUntilPromises.push(promise);
}),
passThroughOnException: vi.fn(),
};
}
Expand DownExpand Up@@ -249,7 +251,13 @@ describe('instrumentScheduled', () => {
handler,
);

await wrappedHandler.scheduled?.(createMockScheduledController(), MOCK_ENV, createMockExecutionContext());
const waitUntilPromises: Promise<unknown>[] = [];
await wrappedHandler.scheduled?.(
createMockScheduledController(),
MOCK_ENV,
createMockExecutionContext(waitUntilPromises),
);
await Promise.all(waitUntilPromises);

expect(sentryEvent.transaction).toEqual('Scheduled Cron 0 0 0 * * *');
expect(sentryEvent.spans).toHaveLength(0);
Expand Down
120 changes: 120 additions & 0 deletions packages/cloudflare/test/staticSpanCapture.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
import {
type Event,
setCurrentClient,
spanStreamingIntegration,
startInactiveSpan,
withActiveSpan,
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from '@sentry/server-utils/no-diagnostic-channels';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { CloudflareClient, type CloudflareClientOptions } from '../src/client';
import { flushAndDispose } from '../src/flush';
import { resetSdk } from './testUtils';

const dsn = 'https://public@dsn.ingest.sentry.io/1337';

function createClient(options: Partial<CloudflareClientOptions> = {}): {
client: CloudflareClient;
send: ReturnType<typeof vi.fn>;
} {
const send = vi.fn().mockResolvedValue({});
const client = new CloudflareClient({
dsn,
stackParser: () => [],
integrations: [],
tracesSampleRate: 1,
traceLifecycle: 'static',
transport: () => ({
send,
flush: vi.fn().mockResolvedValue(true),
}),
...options,
});
setCurrentClient(client);
client.init();
return { client, send };
}

describe('CloudflareClient static span capture', () => {
beforeEach(() => {
resetSdk();
setAsyncLocalStorageAsyncContextStrategy();
});

afterEach(() => {
vi.useRealTimers();
vi.restoreAllMocks();
resetSdk();
});

it('preserves a child that ends after its segment was sent', () => {
vi.useFakeTimers();
const transactions: Event[] = [];
const { client } = createClient();
client.on('beforeSendEvent', event => {
transactions.push(event);
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'background agent work' }));

root.end();
vi.advanceTimersByTime(100);
child.end();
vi.advanceTimersByTime(100);

expect(transactions).toHaveLength(2);
expect(transactions.map(transaction => transaction.transaction)).toEqual([
'cloudflare request',
'background agent work',
]);
expect(transactions[1]?.contexts?.trace?.data?.['sentry.parent_span_already_sent']).toBe(true);
});

it('drains a deferred transaction before disposing the client', async () => {
const { client, send } = createClient();
const root = startInactiveSpan({ name: 'cloudflare request' });

root.end();

expect(send).not.toHaveBeenCalled();

await flushAndDispose(client, 3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(client.getTransport()).toBeUndefined();
});

it('does not duplicate spans that use the streaming lifecycle', async () => {
const { client, send } = createClient({
integrations: [spanStreamingIntegration()],
traceLifecycle: 'stream',
});
const root = startInactiveSpan({ name: 'cloudflare request' });
const child = withActiveSpan(root, () => startInactiveSpan({ name: 'streamed child' }));

child.end();
root.end();
await client.flush(3_000);

expect(send).toHaveBeenCalledTimes(1);
expect(send).toHaveBeenCalledWith([
expect.any(Object),
[
[
{
type: 'span',
item_count: 2,
content_type: 'application/vnd.sentry.items.span.v2+json',
},
{
version: 2,
items: [
expect.objectContaining({ name: 'streamed child' }),
expect.objectContaining({ name: 'cloudflare request' }),
],
},
],
],
]);
});
});
Loading