feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, '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

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \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

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(core,cloudflare): Add dispose to the client for proper cleanup#19506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JPeer264 merged 1 commit into from
Mar 2, 2026
Merged

feat(core,cloudflare): Add dispose to the client for proper cleanup #19506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 32 additions & 2 deletions packages/cloudflare/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ export class CloudflareClient extends ServerRuntimeClient {
private _spanCompletionPromise: Promise<void> | null = null;
private _resolveSpanCompletion: (() => void) | null = null;

private _unsubscribeSpanStart: (() => void) | null = null;
private _unsubscribeSpanEnd: (() => void) | null = null;

/**
* Creates a new Cloudflare SDK instance.
* @param options Configuration options for this SDK.
Expand All@@ -37,7 +40,7 @@ export class CloudflareClient extends ServerRuntimeClient {
this._flushLock = flushLock;

// Track span lifecycle to know when to flush
this.on('spanStart', span => {
this._unsubscribeSpanStart = this.on('spanStart', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span started:', spanId);
this._pendingSpans.add(spanId);
Expand All@@ -49,7 +52,7 @@ export class CloudflareClient extends ServerRuntimeClient {
}
});

this.on('spanEnd', span => {
this._unsubscribeSpanEnd = this.on('spanEnd', span => {
const spanId = span.spanContext().spanId;
DEBUG_BUILD && debug.log('[CloudflareClient] Span ended:', spanId);
this._pendingSpans.delete(spanId);
Expand DownExpand Up@@ -99,6 +102,33 @@ export class CloudflareClient extends ServerRuntimeClient {
return super.flush(timeout);
}

/**
* Disposes of the client and releases all resources.
*
* This method clears all Cloudflare-specific state in addition to the base client cleanup.
* It unsubscribes from span lifecycle events and clears pending span tracking.
*
* Call this method after flushing to allow the client to be garbage collected.
* After calling dispose(), the client should not be used anymore.
*/
public override dispose(): void {
DEBUG_BUILD && debug.log('[CloudflareClient] Disposing client...');

super.dispose();

if (this._unsubscribeSpanStart) {
this._unsubscribeSpanStart();
this._unsubscribeSpanStart = null;
}
if (this._unsubscribeSpanEnd) {
this._unsubscribeSpanEnd();
this._unsubscribeSpanEnd = null;
}

this._resetSpanCompletionPromise();
(this as unknown as { _flushLock: ReturnType<typeof makeFlushLock> | void })._flushLock = undefined;
}

/**
* Resets the span completion promise and resolve function.
*/
Expand Down
15 changes: 15 additions & 0 deletions packages/cloudflare/src/flush.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
import type { ExecutionContext } from '@cloudflare/workers-types';
import type { Client } from '@sentry/core';
import { flush } from '@sentry/core';

type FlushLock = {
readonly ready: Promise<void>;
Expand DownExpand Up@@ -36,3 +38,16 @@ export function makeFlushLock(context: ExecutionContext): FlushLock {
},
});
}

/**
* Flushes the client and then disposes of it to allow garbage collection.
* This should be called at the end of each request to prevent memory leaks.
*
* @param client - The CloudflareClient instance to flush and dispose
* @param timeout - Timeout in milliseconds for the flush operation
* @returns A promise that resolves when flush and dispose are complete
*/
export async function flushAndDispose(client: Client | undefined, timeout = 2000): Promise<void> {
await flush(timeout);
client?.dispose();
}
10 changes: 5 additions & 5 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
import {
captureException,
flush,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
Expand All@@ -9,6 +8,7 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { getHonoIntegration } from './integrations/hono';
import { getFinalOptions } from './options';
Expand DownExpand Up@@ -113,7 +113,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.scheduled' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -157,7 +157,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.email' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -209,7 +209,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.queue' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
},
);
Expand DownExpand Up@@ -243,7 +243,7 @@ export function withSentry<
captureException(e, { mechanism: { handled: false, type: 'auto.faas.cloudflare.tail' } });
throw e;
} finally {
waitUntil(flush(2000));
waitUntil(flushAndDispose(client));
}
});
},
Expand Down
20 changes: 14 additions & 6 deletions packages/cloudflare/src/request.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@ import type { ExecutionContext, IncomingRequestCfProperties } from '@cloudflare/
import {
captureException,
continueTrace,
flush,
getClient,
getHttpSpanDetailsFromUrlObject,
httpHeadersToSpanAttributes,
Expand All@@ -14,6 +13,7 @@ import {
withIsolationScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext, addCultureContext, addRequest } from './scope-utils';
import { init } from './sdk';
import { classifyResponseStreaming } from './utils/streaming';
Expand DownExpand Up@@ -95,7 +95,7 @@ export function wrapRequestHandler(
}
throw e;
} finally {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
}

Expand All@@ -122,7 +122,7 @@ export function wrapRequestHandler(
if (captureErrors) {
captureException(e, { mechanism: { handled: false, type: 'auto.http.cloudflare' } });
}
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
throw e;
}

Expand All@@ -149,7 +149,7 @@ export function wrapRequestHandler(
} finally {
reader.releaseLock();
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
}
})();

Expand All@@ -165,14 +165,22 @@ export function wrapRequestHandler(
} catch (e) {
// tee() failed (e.g stream already locked) - fall back to non-streaming handling
span.end();
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(client));
return res;
}
}

// Non-streaming response - end span immediately and return original
span.end();
waitUntil?.(flush(2000));

// Don't dispose for protocol upgrades (101 Switching Protocols) - the connection stays alive.
// This includes WebSocket upgrades where webSocketMessage/webSocketClose handlers
// will still be called and may need the client to capture errors.
if (res.status === 101) {
waitUntil?.(client?.flush(2000));

@cursorcursorBotFeb 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Passing undefined to waitUntil for 101 responses

Low Severity

When res.status === 101, waitUntil?.(client?.flush(2000)) can pass undefined to waitUntil if client is undefined (which the init() return type permits as CloudflareClient | undefined). The Cloudflare waitUntil expects a Promise, so this could cause a runtime error. All other code paths use flushAndDispose(client), which is an async function that always returns a Promise regardless of whether client is defined. The previous code uniformly used the global flush(2000), which also always returns a Promise.

Fix in CursorFix in Web

} else {
waitUntil?.(flushAndDispose(client));
}
return res;
});
},
Expand Down
3 changes: 2 additions & 1 deletion packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,6 +20,7 @@ import type {
} from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { instrumentContext } from './utils/instrumentContext';
Expand DownExpand Up@@ -186,7 +187,7 @@ export function instrumentWorkflowWithSentry<
new WrappedWorkflowStep(event.instanceId, context, options, step),
);
} finally {
context.waitUntil(flush(2000));
context.waitUntil(flushAndDispose(client));
}
});
});
Expand Down
20 changes: 11 additions & 9 deletions packages/cloudflare/src/wrapMethodWithSentry.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
import type { DurableObjectStorage } from '@cloudflare/workers-types';
import {
captureException,
flush,
getClient,
isThenable,
type Scope,
Expand All@@ -12,6 +11,7 @@ import {
withScope,
} from '@sentry/core';
import type { CloudflareOptions } from './client';
import { flushAndDispose } from './flush';
import { isInstrumented, markAsInstrumented } from './instrument';
import { init } from './sdk';

Expand DownExpand Up@@ -74,6 +74,8 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
scope.setClient(client);
}

const clientToDispose = currentClient || scope.getClient();

if (!wrapperOptions.spanName) {
try {
if (callback) {
Expand All@@ -84,7 +86,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -94,12 +96,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -109,7 +111,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
}
Expand All@@ -128,7 +130,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
if (isThenable(result)) {
return result.then(
(res: unknown) => {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return res;
},
(e: unknown) => {
Expand All@@ -138,12 +140,12 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
},
);
} else {
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
return result;
}
} catch (e) {
Expand All@@ -153,7 +155,7 @@ export function wrapMethodWithSentry<T extends OriginalMethod>(
handled: false,
},
});
waitUntil?.(flush(2000));
waitUntil?.(flushAndDispose(clientToDispose));
throw e;
}
});
Expand Down
Loading
Loading