Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e 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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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 \u003e 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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});
, '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
Merged
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
6 changes: 3 additions & 3 deletions packages/nextjs/src/common/captureRequestError.ts
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import type { RequestEventData } from '@sentry/core';
import { captureException, headersToDict, vercelWaitUntil, withScope } from '@sentry/core';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { captureException, headersToDict, withScope } from '@sentry/core';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';

type RequestInfo = {
path: string;
Expand DownExpand Up@@ -42,6 +42,6 @@ export function captureRequestError(error: unknown, request: RequestInfo, errorC
},
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
});
}
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
import { captureException, httpRequestToRequestData, vercelWaitUntil, withScope } from '@sentry/core';
import { captureException, httpRequestToRequestData, withScope } from '@sentry/core';
import type { NextPageContext } from 'next';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';

type ContextOrProps = {
req?: NextPageContext['req'];
Expand DownExpand Up@@ -54,5 +54,5 @@ export async function captureUnderscoreErrorException(contextOrProps: ContextOrP
});
});

vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,12 +10,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setHttpStatus,
startSpanManual,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import type { NextApiRequest } from 'next';
import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
import { flushSafelyWithTimeout } from '../utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../utils/responseEnd';
import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';

export type AugmentedNextApiRequest = NextApiRequest & {
Expand DownExpand Up@@ -95,7 +94,7 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
apply(target, thisArg, argArray) {
setHttpStatus(span, res.statusCode);
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
return target.apply(thisArg, argArray);
},
});
Expand Down
52 changes: 51 additions & 1 deletion packages/nextjs/src/common/utils/responseEnd.ts
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import type { Span } from '@sentry/core';
import { debug, fill, flush, setHttpStatus } from '@sentry/core';
import { debug, fill, flush, GLOBAL_OBJ, setHttpStatus, vercelWaitUntil } from '@sentry/core';
import type { ServerResponse } from 'http';
import { DEBUG_BUILD } from '../debug-build';
import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
Expand DownExpand Up@@ -54,3 +54,53 @@ export async function flushSafelyWithTimeout(): Promise<void> {
DEBUG_BUILD && debug.log('Error while flushing events:\n', e);
}
}

/**
* Uses platform-specific waitUntil function to wait for the provided task to complete without blocking.
*/
export function waitUntil(task: Promise<unknown>): void {
// If deployed on Cloudflare, use the Cloudflare waitUntil function to flush the events
if (isCloudflareWaitUntilAvailable()) {
cloudflareWaitUntil(task);
return;
}

// otherwise, use vercel's
vercelWaitUntil(task);
}

type MinimalCloudflareContext = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
waitUntil(promise: Promise<any>): void;
};

/**
* Gets the Cloudflare context from the global object.
* Relevant to opennext
* https://github.com/opennextjs/opennextjs-cloudflare/blob/b53a046bd5c30e94a42e36b67747cefbf7785f9a/packages/cloudflare/src/cli/templates/init.ts#L17
*/
function _getOpenNextCloudflareContext(): MinimalCloudflareContext | undefined {
const openNextCloudflareContextSymbol = Symbol.for('__cloudflare-context__');

return (
GLOBAL_OBJ as typeof GLOBAL_OBJ & {
[openNextCloudflareContextSymbol]?: {
ctx: MinimalCloudflareContext;
};
}
)[openNextCloudflareContextSymbol]?.ctx;
}

/**
* Function that delays closing of a Cloudflare lambda until the provided promise is resolved.
*/
export function cloudflareWaitUntil(task: Promise<unknown>): void {
_getOpenNextCloudflareContext()?.waitUntil(task);
}

/**
* Checks if the Cloudflare waitUntil function is available globally.
*/
export function isCloudflareWaitUntilAvailable(): boolean {
return typeof _getOpenNextCloudflareContext()?.waitUntil === 'function';
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,10 +11,9 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
SPAN_STATUS_ERROR,
startSpan,
vercelWaitUntil,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { DEBUG_BUILD } from './debug-build';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';

Expand DownExpand Up@@ -155,7 +154,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
},
);
} finally {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
},
);
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapMiddlewareWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,11 +9,10 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from '../edge/types';

/**
Expand DownExpand Up@@ -108,7 +107,7 @@ export function wrapMiddlewareWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapRouteHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,14 +12,13 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
setHttpStatus,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
import type { RouteHandlerContext } from './types';
import { flushSafelyWithTimeout } from './utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from './utils/responseEnd';
import { commonObjectToIsolationScope } from './utils/tracingUtils';

/**
Expand DownExpand Up@@ -96,7 +95,7 @@ export function wrapRouteHandlerWithSentry<F extends (...args: any[]) => any>(
}
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/common/wrapServerComponentWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,14 +13,13 @@ import {
SPAN_STATUS_ERROR,
SPAN_STATUS_OK,
startSpanManual,
vercelWaitUntil,
winterCGHeadersToDict,
withIsolationScope,
withScope,
} from '@sentry/core';
import { isNotFoundNavigationError, isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
import type { ServerComponentContext } from '../common/types';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';

Expand DownExpand Up@@ -117,7 +116,7 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
},
() => {
span.end();
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/index.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,6 @@ import {
setCapturedScopesOnSpan,
spanToJSON,
stripUrlQueryAndFragment,
vercelWaitUntil,
} from '@sentry/core';
import { getScopesFromContext } from '@sentry/opentelemetry';
import type { VercelEdgeOptions } from '@sentry/vercel-edge';
Expand All@@ -24,7 +23,7 @@ import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../common/span-attribu
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { dropMiddlewareTunnelRequests } from '../common/utils/dropMiddlewareTunnelRequests';
import { isBuild } from '../common/utils/isBuild';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import { setUrlProcessingMetadata } from '../common/utils/setUrlProcessingMetadata';
import { distDirRewriteFramesIntegration } from './distDirRewriteFramesIntegration';

Expand DownExpand Up@@ -142,7 +141,7 @@ export function init(options: VercelEdgeOptions = {}): void {

client?.on('spanEnd', span => {
if (span === getRootSpan(span)) {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
}
});

Expand Down
5 changes: 2 additions & 3 deletions packages/nextjs/src/edge/wrapApiHandlerWithSentry.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,12 +9,11 @@ import {
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
setCapturedScopesOnSpan,
startSpan,
vercelWaitUntil,
winterCGRequestToRequestData,
withIsolationScope,
} from '@sentry/core';
import { addHeadersAsAttributes } from '../common/utils/addHeadersAsAttributes';
import { flushSafelyWithTimeout } from '../common/utils/responseEnd';
import { flushSafelyWithTimeout, waitUntil } from '../common/utils/responseEnd';
import type { EdgeRouteHandler } from './types';

/**
Expand DownExpand Up@@ -94,7 +93,7 @@ export function wrapApiHandlerWithSentry<H extends EdgeRouteHandler>(
});
},
() => {
vercelWaitUntil(flushSafelyWithTimeout());
waitUntil(flushSafelyWithTimeout());
},
);
},
Expand Down
99 changes: 99 additions & 0 deletions packages/nextjs/test/common/utils/responseEnd.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
import { GLOBAL_OBJ } from '@sentry/core';
import { beforeEach, describe, expect, it, vi } from 'vitest';
import { waitUntil } from '../../../src/common/utils/responseEnd';

vi.mock('@sentry/core', async () => {
const actual = await vi.importActual('@sentry/core');
return {
...actual,
debug: {
log: vi.fn(),
},
flush: vi.fn(),
vercelWaitUntil: vi.fn(),
};
});

describe('responseEnd utils', () => {
beforeEach(() => {
vi.clearAllMocks();
// Clear Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
(GLOBAL_OBJ as any)[cfContextSymbol] = undefined;
// Clear Vercel context
const vercelContextSymbol = Symbol.for('@vercel/request-context');
(GLOBAL_OBJ as any)[vercelContextSymbol] = undefined;
});

describe('waitUntil', () => {
it('should use cloudflareWaitUntil when Cloudflare context is available', async () => {
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not call vercelWaitUntil when Cloudflare is available
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should use vercelWaitUntil when Cloudflare context is not available', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.resolve('test');

waitUntil(testTask);

expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);
expect(vercelWaitUntil).toHaveBeenCalledTimes(1);
});

it('should prefer Cloudflare over Vercel when both are available', async () => {
// Set up Cloudflare context
const cfContextSymbol = Symbol.for('__cloudflare-context__');
const cfWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[cfContextSymbol] = {
ctx: {
waitUntil: cfWaitUntilMock,
},
};

// Set up Vercel context
const vercelWaitUntilMock = vi.fn();
(GLOBAL_OBJ as any)[Symbol.for('@vercel/request-context')] = {
get: () => ({ waitUntil: vercelWaitUntilMock }),
};

const testTask = Promise.resolve('test');
waitUntil(testTask);

// Should use Cloudflare
expect(cfWaitUntilMock).toHaveBeenCalledWith(testTask);
expect(cfWaitUntilMock).toHaveBeenCalledTimes(1);

// Should not use Vercel
const { vercelWaitUntil } = await import('@sentry/core');
expect(vercelWaitUntil).not.toHaveBeenCalled();
});

it('should handle errors gracefully when waitUntil is called with a rejected promise', async () => {
const { vercelWaitUntil } = await import('@sentry/core');
const testTask = Promise.reject(new Error('test error'));

// Should not throw synchronously
expect(() => waitUntil(testTask)).not.toThrow();
expect(vercelWaitUntil).toHaveBeenCalledWith(testTask);

// Prevent unhandled rejection in test
testTask.catch(() => {});
});
});
});