Skip to content

feat(cloudflare): Add support for durable objects#16180

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
AbhiPrasad merged 4 commits into from
May 1, 2025
Merged

feat(cloudflare): Add support for durable objects #16180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2631c80
feat(cloudflare): Add support for durable objects
AbhiPrasad May 1, 2025
632dda9
fix return type
AbhiPrasad May 1, 2025
b7f1457
do not capture spans for OPTIONS and HEAD
AbhiPrasad May 1, 2025
36ed392
try catch proxy impl
AbhiPrasad May 1, 2025
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
224 changes: 224 additions & 0 deletions packages/cloudflare/src/durableobject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
captureException,
flush,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
startSpan,
withIsolationScope,
withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
spanName?: string;
spanOp?: string;
options: CloudflareOptions;
context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
wrapperOptions: MethodWrapperOptions,
handler: T,
callback?: (...args: Parameters<T>) => void,
): T {
if (isInstrumented(handler)) {
return handler;
}

markAsInstrumented(handler);

return new Proxy(handler, {
apply(target, thisArg, args: Parameters<T>) {
const currentClient = getClient();
// if a client is already set, use withScope, otherwise use withIsolationScope
const sentryWithScope = currentClient ? withScope : withIsolationScope;
return sentryWithScope(async scope => {
// In certain situations, the passed context can become undefined.
// For example, for Astro while prerendering pages at build time.
// see: https://github.com/getsentry/sentry-javascript/issues/13217
const context = wrapperOptions.context as ExecutionContext | undefined;

const currentClient = scope.getClient();
if (!currentClient) {
const client = init(wrapperOptions.options);
scope.setClient(client);
}

if (!wrapperOptions.spanName) {
try {
if (callback) {
callback(...args);
}
return await Reflect.apply(target, thisArg, args);
} catch (e) {
captureException(e, {
mechanism: {
type: 'cloudflare_durableobject',
handled: false,
},
});
throw e;
} finally {
context?.waitUntil(flush(2000));
}
}

const attributes = wrapperOptions.spanOp
? {
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
}
: {};

// Only create these spans if they have a parent span.
return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
try {
return await Reflect.apply(target, thisArg, args);
} catch (e) {
captureException(e, {
mechanism: {
type: 'cloudflare_durableobject',
handled: false,
},
});
throw e;
} finally {
context?.waitUntil(flush(2000));
}
});
});
},
});
}

/**
* Instruments a Durable Object class to capture errors and performance data.
*
* Instruments the following methods:
* - fetch
* - alarm
* - webSocketMessage
* - webSocketClose
* - webSocketError
*
* as well as any other public RPC methods on the Durable Object instance.
*
* @param optionsCallback Function that returns the options for the SDK initialization.
* @param DurableObjectClass The Durable Object class to instrument.
* @returns The instrumented Durable Object class.
*
* @example
* ```ts
* class MyDurableObjectBase extends DurableObject {
* constructor(ctx: DurableObjectState, env: Env) {
* super(ctx, env);
* }
* }
*
* export const MyDurableObject = instrumentDurableObjectWithSentry(
* env => ({
* dsn: env.SENTRY_DSN,
* tracesSampleRate: 1.0,
* }),
* MyDurableObjectBase,
* );
* ```
*/
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
optionsCallback: (env: E) => CloudflareOptions,
DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
return new Proxy(DurableObjectClass, {
construct(target, [context, env]) {
setAsyncLocalStorageAsyncContextStrategy();

const options = optionsCallback(env);

const obj = new target(context, env);

// These are the methods that are available on a Durable Object
// ref: https://developers.cloudflare.com/durable-objects/api/base/
// obj.alarm
// obj.fetch
// obj.webSocketError
// obj.webSocketClose
// obj.webSocketMessage

// Any other public methods on the Durable Object instance are RPC calls.

if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
obj.fetch = new Proxy(obj.fetch, {
apply(target, thisArg, args) {
return wrapRequestHandler({ options, request: args[0], context }, () =>
Reflect.apply(target, thisArg, args),
);
},
});

markAsInstrumented(obj.fetch);
}

if (obj.alarm && typeof obj.alarm === 'function') {
obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
}

if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
obj.webSocketMessage = wrapMethodWithSentry(
{ options, context, spanName: 'webSocketMessage' },
obj.webSocketMessage,
);
}

if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
}

if (obj.webSocketError && typeof obj.webSocketError === 'function') {
obj.webSocketError = wrapMethodWithSentry(
{ options, context, spanName: 'webSocketError' },
obj.webSocketError,
(_, error) =>
captureException(error, {
mechanism: {
type: 'cloudflare_durableobject_websocket',
handled: false,
},
}),
);
}

for (const method of Object.getOwnPropertyNames(obj)) {
if (
method === 'fetch' ||
method === 'alarm' ||
method === 'webSocketError' ||
method === 'webSocketClose' ||
method === 'webSocketMessage'
) {
continue;
}

// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
const value = (obj as any)[method] as unknown;
if (typeof value === 'function') {
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
(obj as any)[method] = wrapMethodWithSentry(
{ options, context, spanName: method, spanOp: 'rpc' },
// eslint-disable-next-line @typescript-eslint/no-explicit-any
value as (...args: any[]) => any,
);
}
}

return obj;
},
});
}
136 changes: 56 additions & 80 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
ExportedHandler,
ExportedHandlerFetchHandler,
ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
captureException,
flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
* Extract environment generic from exported handler.
*/
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
* Wrapper for Cloudflare handlers.
*
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
* @param handler {ExportedHandler} The handler to wrap.
* @returns The wrapped handler.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
optionsCallback: (env: Env) => CloudflareOptions,
handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
setAsyncLocalStorageAsyncContextStrategy();

if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
handler.fetch = new Proxy(handler.fetch, {
apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
const [request, env, context] = args;
const options = optionsCallback(env);
return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
},
});
try {
if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
handler.fetch = new Proxy(handler.fetch, {
apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
const [request, env, context] = args;
const options = optionsCallback(env);
return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
},
});

markAsInstrumented(handler.fetch);
}
markAsInstrumented(handler.fetch);
}

if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

return startSpan(
{
op: 'faas.cron',
name: `Scheduled Cron ${event.cron}`,
attributes: {
'faas.cron': event.cron,
'faas.time': new Date(event.scheduledTime).toISOString(),
'faas.trigger': 'timer',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
return startSpan(
{
op: 'faas.cron',
name: `Scheduled Cron ${event.cron}`,
attributes: {
'faas.cron': event.cron,
'faas.time': new Date(event.scheduledTime).toISOString(),
'faas.trigger': 'timer',
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
},
},
},
async () => {
try {
return await (target.apply(thisArg, args) as ReturnType<typeof target>);
} catch (e) {
captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
throw e;
} finally {
context.waitUntil(flush(2000));
}
},
);
});
},
});
async () => {
try {
return await (target.apply(thisArg, args) as ReturnType<typeof target>);
} catch (e) {
captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
throw e;
} finally {
context.waitUntil(flush(2000));
}
},
);
});
},
});

markAsInstrumented(handler.scheduled);
markAsInstrumented(handler.scheduled);
}
// This is here because Miniflare sometimes cannot get instrumented
//
} catch (e) {
// Do not console anything here, we don't want to spam the console with errors
}

return handler;
}

type SentryInstrumented<T> = T & {
__SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
try {
(handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
} catch {
// ignore errors here
}
}

function isInstrumented<T>(handler: T): boolean | undefined {
try {
return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
} catch {
return false;
}
}
1 change: 1 addition & 0 deletions packages/cloudflare/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(cloudflare): Add support for durable objects by AbhiPrasad · Pull Request #16180 · getsentry/sentry-javascript · GitHub
Skip to content
feat(cloudflare): Add support for durable objects#16180

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

AbhiPrasad
merged 4 commits into

from

May 1, 2025
 Merged


feat(cloudflare): Add support for durable objects
#16180
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
2631c80

feat(cloudflare): Add support for durable objects


AbhiPrasad May 1, 2025
632dda9

fix return type


AbhiPrasad May 1, 2025
b7f1457

do not capture spans for OPTIONS and HEAD


AbhiPrasad May 1, 2025
36ed392

try catch proxy impl


AbhiPrasad May 1, 2025

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


224 changes: 224 additions & 0 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
/* eslint-disable @typescript-eslint/unbound-method */
import {
 captureException,
 flush,
 getClient,
 SEMANTIC_ATTRIBUTE_SENTRY_OP,
 SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
 startSpan,
 withIsolationScope,
 withScope,
} from '@sentry/core';
import type { DurableObject } from 'cloudflare:workers';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { init } from './sdk';

type MethodWrapperOptions = {
 spanName?: string;
 spanOp?: string;
 options: CloudflareOptions;
 context: ExecutionContext | DurableObjectState;
};

// eslint-disable-next-line @typescript-eslint/no-explicit-any
function wrapMethodWithSentry<T extends (...args: any[]) => any>(
 wrapperOptions: MethodWrapperOptions,
 handler: T,
 callback?: (...args: Parameters<T>) => void,
): T {
 if (isInstrumented(handler)) {
 return handler;
 }

 markAsInstrumented(handler);

 return new Proxy(handler, {
 apply(target, thisArg, args: Parameters<T>) {
 const currentClient = getClient();
 // if a client is already set, use withScope, otherwise use withIsolationScope
 const sentryWithScope = currentClient ? withScope : withIsolationScope;
 return sentryWithScope(async scope => {
 // In certain situations, the passed context can become undefined.
 // For example, for Astro while prerendering pages at build time.
 // see: https://github.com/getsentry/sentry-javascript/issues/13217
 const context = wrapperOptions.context as ExecutionContext | undefined;

 const currentClient = scope.getClient();
 if (!currentClient) {
 const client = init(wrapperOptions.options);
 scope.setClient(client);
 }

 if (!wrapperOptions.spanName) {
 try {
 if (callback) {
 callback(...args);
 }
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 }

 const attributes = wrapperOptions.spanOp
 ? {
 [SEMANTIC_ATTRIBUTE_SENTRY_OP]: wrapperOptions.spanOp,
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare_durableobjects',
 }
 : {};

 // Only create these spans if they have a parent span.
 return startSpan({ name: wrapperOptions.spanName, attributes, onlyIfParent: true }, async () => {
 try {
 return await Reflect.apply(target, thisArg, args);
 } catch (e) {
 captureException(e, {
 mechanism: {
 type: 'cloudflare_durableobject',
 handled: false,
 },
 });
 throw e;
 } finally {
 context?.waitUntil(flush(2000));
 }
 });
 });
 },
 });
}

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
 * Instruments the following methods:
 * - fetch
 * - alarm
 * - webSocketMessage
 * - webSocketClose
 * - webSocketError
 *
 * as well as any other public RPC methods on the Durable Object instance.
 *
 * @param optionsCallback Function that returns the options for the SDK initialization.
 * @param DurableObjectClass The Durable Object class to instrument.
 * @returns The instrumented Durable Object class.
 *
 * @example
 * ```ts
 * class MyDurableObjectBase extends DurableObject {
 * constructor(ctx: DurableObjectState, env: Env) {
 * super(ctx, env);
 * }
 * }
 *
 * export const MyDurableObject = instrumentDurableObjectWithSentry(
 * env => ({
 * dsn: env.SENTRY_DSN,
 * tracesSampleRate: 1.0,
 * }),
 * MyDurableObjectBase,
 * );
 * ```
 */
export function instrumentDurableObjectWithSentry<E, T extends DurableObject<E>>(
 optionsCallback: (env: E) => CloudflareOptions,
 DurableObjectClass: new (state: DurableObjectState, env: E) => T,
): new (state: DurableObjectState, env: E) => T {
 return new Proxy(DurableObjectClass, {
 construct(target, [context, env]) {
 setAsyncLocalStorageAsyncContextStrategy();

 const options = optionsCallback(env);

 const obj = new target(context, env);

 // These are the methods that are available on a Durable Object
 // ref: https://developers.cloudflare.com/durable-objects/api/base/
 // obj.alarm
 // obj.fetch
 // obj.webSocketError
 // obj.webSocketClose
 // obj.webSocketMessage

 // Any other public methods on the Durable Object instance are RPC calls.

 if (obj.fetch && typeof obj.fetch === 'function' && !isInstrumented(obj.fetch)) {
 obj.fetch = new Proxy(obj.fetch, {
 apply(target, thisArg, args) {
 return wrapRequestHandler({ options, request: args[0], context }, () =>
 Reflect.apply(target, thisArg, args),
 );
 },
 });

 markAsInstrumented(obj.fetch);
 }

 if (obj.alarm && typeof obj.alarm === 'function') {
 obj.alarm = wrapMethodWithSentry({ options, context, spanName: 'alarm' }, obj.alarm);
 }

 if (obj.webSocketMessage && typeof obj.webSocketMessage === 'function') {
 obj.webSocketMessage = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketMessage' },
 obj.webSocketMessage,
 );
 }

 if (obj.webSocketClose && typeof obj.webSocketClose === 'function') {
 obj.webSocketClose = wrapMethodWithSentry({ options, context, spanName: 'webSocketClose' }, obj.webSocketClose);
 }

 if (obj.webSocketError && typeof obj.webSocketError === 'function') {
 obj.webSocketError = wrapMethodWithSentry(
 { options, context, spanName: 'webSocketError' },
 obj.webSocketError,
 (_, error) =>
 captureException(error, {
 mechanism: {
 type: 'cloudflare_durableobject_websocket',
 handled: false,
 },
 }),
 );
 }

 for (const method of Object.getOwnPropertyNames(obj)) {
 if (
 method === 'fetch' ||
 method === 'alarm' ||
 method === 'webSocketError' ||
 method === 'webSocketClose' ||
 method === 'webSocketMessage'
 ) {
 continue;
 }

 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 const value = (obj as any)[method] as unknown;
 if (typeof value === 'function') {
 // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-explicit-any
 (obj as any)[method] = wrapMethodWithSentry(
 { options, context, spanName: method, spanOp: 'rpc' },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 value as (...args: any[]) => any,
 );
 }
 }

 return obj;
 },
 });
}

136 changes: 56 additions & 80 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,3 @@
import type {
 ExportedHandler,
 ExportedHandlerFetchHandler,
 ExportedHandlerScheduledHandler,
} from '@cloudflare/workers-types';
import {
 captureException,
 flush,
Expand All@@ -13,15 +8,11 @@ import {
} from '@sentry/core';
import { setAsyncLocalStorageAsyncContextStrategy } from './async';
import type { CloudflareOptions } from './client';
import { isInstrumented, markAsInstrumented } from './instrument';
import { wrapRequestHandler } from './request';
import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';

/**
 * Extract environment generic from exported handler.
 */
type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -33,85 +24,70 @@ type ExtractEnv<P> = P extends ExportedHandler<infer Env> ? Env : never;
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export function withSentry<E extends ExportedHandler<any>>(
 optionsCallback: (env: ExtractEnv<E>) => CloudflareOptions,
 handler: E,
): E {
export function withSentry<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown>(
 optionsCallback: (env: Env) => CloudflareOptions,
 handler: ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata>,
): ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> {
 setAsyncLocalStorageAsyncContextStrategy();

 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<ExtractEnv<E>>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });
 try {
 if ('fetch' in handler && typeof handler.fetch === 'function' && !isInstrumented(handler.fetch)) {
 handler.fetch = new Proxy(handler.fetch, {
 apply(target, thisArg, args: Parameters<ExportedHandlerFetchHandler<Env, CfHostMetadata>>) {
 const [request, env, context] = args;
 const options = optionsCallback(env);
 return wrapRequestHandler({ options, request, context }, () => target.apply(thisArg, args));
 },
 });

 markAsInstrumented(handler.fetch);
 }
markAsInstrumented(handler.fetch);
}

 if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
 handler.scheduled = new Proxy(handler.scheduled, {
 apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<ExtractEnv<E>>>) {
 const [event, env, context] = args;
 return withIsolationScope(isolationScope => {
 const options = optionsCallback(env);
 const client = init(options);
 isolationScope.setClient(client);
if ('scheduled' in handler && typeof handler.scheduled === 'function' && !isInstrumented(handler.scheduled)) {
handler.scheduled = new Proxy(handler.scheduled, {
apply(target, thisArg, args: Parameters<ExportedHandlerScheduledHandler<Env>>) {
const [event, env, context] = args;
return withIsolationScope(isolationScope => {
const options = optionsCallback(env);
const client = init(options);
isolationScope.setClient(client);

 addCloudResourceContext(isolationScope);
addCloudResourceContext(isolationScope);

 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 return startSpan(
 {
 op: 'faas.cron',
 name: `Scheduled Cron ${event.cron}`,
 attributes: {
 'faas.cron': event.cron,
 'faas.time': new Date(event.scheduledTime).toISOString(),
 'faas.trigger': 'timer',
 [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.faas.cloudflare',
 [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
 },
 },
 },
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });
 async () => {
 try {
 return await (target.apply(thisArg, args) as ReturnType<typeof target>);
 } catch (e) {
 captureException(e, { mechanism: { handled: false, type: 'cloudflare' } });
 throw e;
 } finally {
 context.waitUntil(flush(2000));
 }
 },
 );
 });
 },
 });

 markAsInstrumented(handler.scheduled);
 markAsInstrumented(handler.scheduled);
 }
 // This is here because Miniflare sometimes cannot get instrumented
 //
 } catch (e) {
 // Do not console anything here, we don't want to spam the console with errors
 }

 return handler;
}

type SentryInstrumented<T> = T & {
 __SENTRY_INSTRUMENTED__?: boolean;
};

function markAsInstrumented<T>(handler: T): void {
 try {
 (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__ = true;
 } catch {
 // ignore errors here
 }
}

function isInstrumented<T>(handler: T): boolean | undefined {
 try {
 return (handler as SentryInstrumented<T>).__SENTRY_INSTRUMENTED__;
 } catch {
 return false;
 }
}

1 change: 1 addition & 0 deletions
packages/cloudflare/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -92,6 +92,7 @@ export {
} from '@sentry/core';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';

export { wrapRequestHandler } from './request';
Expand Down
Loading