feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

Closed
JPeer264 wants to merge 1 commit into from
Closed

feat(cloudflare): Infer types correctly in workflows, handlers and DOs #18302

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
E2E_TEST_DSN: '';
E2E_TEST_DSN: string;
}
6 changes: 3 additions & 3 deletions dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
dsn: env?.E2E_TEST_DSN,
env => ({
dsn: env.E2E_TEST_DSN,
tracesSampleRate: 1.0,
}),
app,
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
"typecheck": "tsc --noEmit",
"cf-typegen": "wrangler types",
"test:build": "pnpm install && pnpm build",
"test:assert": "pnpm test:dev && pnpm test:prod",
"test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
"test:prod": "TEST_ENV=production playwright test",
"test:dev": "TEST_ENV=development playwright test"
},
Expand Down
0 ...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts
View file
Open in desktop
File renamed without changes.
25 changes: 22 additions & 3 deletions dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
* Learn more at https://developers.cloudflare.com/workers/
*/
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
env => ({
dsn: env.E2E_TEST_DSN,
environment: 'qa', // dynamic sampling bias to keep transactions
tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
async run(_: WorkflowEvent<any>, step: WorkflowStep) {
await step.do('send marketing follow up', async () => {
throw new Error('To be recorded in Sentry.');
});
}
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
env => ({
dsn: env.E2E_TEST_DSN,
environment: 'qa', // dynamic sampling bias to keep transactions
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1.0,
sendDefaultPii: true,
}),
MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
env => ({
dsn: env.E2E_TEST_DSN,
environment: 'qa', // dynamic sampling bias to keep transactions
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
2 changes: 1 addition & 1 deletion dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

/* Skip type checking all .d.ts files. */
"skipLibCheck": true,
"types": ["./worker-configuration.d.ts"]
"types": ["@cloudflare/workers-types/experimental"]
},
"exclude": ["test"],
"include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down
18 changes: 14 additions & 4 deletions packages/cloudflare/src/durableobject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
});
}

/**
* Helper type to extract the environment type from a DurableObject constructor.
* This extracts the second parameter type (env) from the constructor signature.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
* Instruments a Durable Object class to capture errors and performance data.
*
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
* ```
*/
export function instrumentDurableObjectWithSentry<
E,
T extends DurableObject<E>,
C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
return new Proxy(DurableObjectClass, {
construct(target, [ctx, env]) {
setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
}

// Create a wrapper that gets context/options from the instance at runtime
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const wrappedMethod = function (this: any, ...args: any[]): unknown {
const thisWithSentry = this as {
__SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

if (!instanceOptions) {
// Fallback to original method if no Sentry data found
// eslint-disable-next-line @typescript-eslint/no-explicit-any
return (originalMethod as (...args: any[]) => any).apply(this, args);
}

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
spanName: methodName,
spanOp: 'rpc',
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
originalMethod as (...args: any[]) => any,
undefined,
true, // noMark = true since we'll mark the prototype method
);

// eslint-disable-next-line @typescript-eslint/no-explicit-any
return (wrapper as (...args: any[]) => any).apply(this, args);
};

Expand Down
52 changes: 41 additions & 11 deletions packages/cloudflare/src/handler.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
* Helper type to filter out empty object types from a union
* This is a distributive conditional type that operates on each member of a union
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
* Helper type to extract Env from ExportedHandler
* Filters out empty object types from unions and returns unknown instead
*/
type InferEnv<T> =
// eslint-disable-next-line @typescript-eslint/no-explicit-any
T extends ExportedHandler<infer E, any, any>
? unknown extends E
? unknown
: FilterEmptyObjects<E> extends never
? unknown
: FilterEmptyObjects<E>
: unknown;

/**
* Helper type to extract QueueHandlerMessage from ExportedHandler
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
* Helper type to extract CfHostMetadata from ExportedHandler
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
* Wrapper for Cloudflare handlers.
*
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
* @param handler {ExportedHandler} The handler to wrap.
* @returns The wrapped handler.
*/
// eslint-disable-next-line complexity
export function withSentry<
Env = unknown,
QueueHandlerMessage = unknown,
CfHostMetadata = unknown,
T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
Env,
QueueHandlerMessage,
CfHostMetadata
>,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
handler: T,
): T {
type Env = InferEnv<T>;
type QueueHandlerMessage = InferQueueMessage<T>;
type CfHostMetadata = InferCfHostMetadata<T>;
setAsyncLocalStorageAsyncContextStrategy();

try {
Expand Down
30 changes: 23 additions & 7 deletions packages/cloudflare/src/workflows.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
}
}

/**
* Helper type to extract the environment type from a WorkflowEntrypoint constructor.
* This extracts the second parameter type (env) from the constructor signature.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
* Helper type to extract the payload type from a WorkflowEntrypoint constructor.
* This extracts the second parameter type (P) from the constructor signature.
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
* Instruments a Cloudflare Workflow class with Sentry.
*
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
* @returns Instrumented workflow class with the same interface
*/
export function instrumentWorkflowWithSentry<
E, // Environment type
P, // Payload type
T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
type Env = ExtractEnv<C>;
type Payload = ExtractPayload<C>;
type T = WorkflowEntrypoint<Env, Payload>;

return new Proxy(WorkFlowClass, {
construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
const [ctx, env] = args;
const context = copyExecutionContext(ctx);
args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
return new Proxy(instance, {
get(obj, prop, receiver) {
if (prop === 'run') {
return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
setAsyncLocalStorageAsyncContextStrategy();

return withIsolationScope(async isolationScope => {
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

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

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

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

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

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

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down

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

Skip to content
feat(cloudflare): Infer types correctly in workflows, handlers and DOs#18302

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

 Closed

JPeer264
wants to merge
1
commit into

from

 Closed


feat(cloudflare): Infer types correctly in workflows, handlers and DOs
#18302
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,5 +2,5 @@
// by running `wrangler types`

interface Env {
 E2E_TEST_DSN: '';
 E2E_TEST_DSN: string;
}

6 changes: 3 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-hono/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
import { Hono } from 'hono';
import * as Sentry from '@sentry/cloudflare';

const app = new Hono();
const app = new Hono<{ Bindings: Env }>();

app.get('/', ctx => {
 return ctx.json({ message: 'Welcome to Hono API' });
Expand All@@ -26,8 +26,8 @@ app.notFound(ctx => {
});

export default Sentry.withSentry(
(env: Env) => ({
 dsn: env?.E2E_TEST_DSN,
 env => ({
 dsn: env.E2E_TEST_DSN,
 tracesSampleRate: 1.0,
 }),
 app,
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,7 +10,7 @@
 "typecheck": "tsc --noEmit",
 "cf-typegen": "wrangler types",
 "test:build": "pnpm install && pnpm build",
 "test:assert": "pnpm test:dev && pnpm test:prod",
 "test:assert": "pnpm typecheck && pnpm test:dev && pnpm test:prod",
 "test:prod": "TEST_ENV=production playwright test",
 "test:dev": "TEST_ENV=development playwright test"
 },
Expand Down

0
...udflare-workers/worker-configuration.d.ts → ...lications/cloudflare-workers/src/env.d.ts

View file


Open in desktop


File renamed without changes.


25 changes: 22 additions & 3 deletions
dev-packages/e2e-tests/test-applications/cloudflare-workers/src/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@
 * Learn more at https://developers.cloudflare.com/workers/
 */
import * as Sentry from '@sentry/cloudflare';
import { DurableObject } from 'cloudflare:workers';
import { DurableObject, WorkflowEntrypoint, WorkflowEvent, WorkflowStep } from 'cloudflare:workers';

class MyDurableObjectBase extends DurableObject<Env> {
 private throwOnExit = new WeakMap<WebSocket, Error>();
Expand DownExpand Up@@ -53,7 +53,7 @@ class MyDurableObjectBase extends DurableObject<Env> {
}

export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand All@@ -68,8 +68,27 @@ export const MyDurableObject = Sentry.instrumentDurableObjectWithSentry(
 MyDurableObjectBase,
);

class MyWorkflowBase extends WorkflowEntrypoint<Env> {
 async run(_: WorkflowEvent<any>, step: WorkflowStep) {
 await step.do('send marketing follow up', async () => {
 throw new Error('To be recorded in Sentry.');
 });
 }
}

export const MyWorkflow = Sentry.instrumentWorkflowWithSentry(
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
 tracesSampleRate: 1.0,
 sendDefaultPii: true,
 }),
 MyWorkflowBase,
);

export default Sentry.withSentry(
(env: Env) => ({
 env => ({
 dsn: env.E2E_TEST_DSN,
 environment: 'qa', // dynamic sampling bias to keep transactions
 tunnel: `http://localhost:3031/`, // proxy server
Expand Down

2 changes: 1 addition & 1 deletion
dev-packages/e2e-tests/test-applications/cloudflare-workers/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -36,7 +36,7 @@

 /* Skip type checking all .d.ts files. */
 "skipLibCheck": true,
 "types": ["./worker-configuration.d.ts"]
 "types": ["@cloudflare/workers-types/experimental"]
 },
 "exclude": ["test"],
 "include": ["worker-configuration.d.ts", "src/**/*.ts"]
Expand Down

18 changes: 14 additions & 4 deletions
packages/cloudflare/src/durableobject.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -154,6 +154,13 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 });
}

/**
 * Helper type to extract the environment type from a DurableObject constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (state: any, env: infer E) => any ? E : never;

/**
 * Instruments a Durable Object class to capture errors and performance data.
 *
Expand DownExpand Up@@ -188,10 +195,9 @@ function wrapMethodWithSentry<T extends OriginalMethod>(
 * ```
 */
export function instrumentDurableObjectWithSentry<
 E,
 T extends DurableObject<E>,
 C extends new (state: DurableObjectState, env: E) => T,
>(optionsCallback: (env: E) => CloudflareOptions, DurableObjectClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (state: DurableObjectState, env: any) => DurableObject<any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, DurableObjectClass: C): C {
 return new Proxy(DurableObjectClass, {
 construct(target, [ctx, env]) {
 setAsyncLocalStorageAsyncContextStrategy();
Expand DownExpand Up@@ -332,6 +338,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 }

 // Create a wrapper that gets context/options from the instance at runtime
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const wrappedMethod = function (this: any, ...args: any[]): unknown {
 const thisWithSentry = this as {
 __SENTRY_CONTEXT__: DurableObjectState;
Expand All@@ -342,6 +349,7 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst

 if (!instanceOptions) {
 // Fallback to original method if no Sentry data found
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (originalMethod as (...args: any[]) => any).apply(this, args);
 }

Expand All@@ -353,11 +361,13 @@ function instrumentPrototype<T extends NewableFunction>(target: T, methodsToInst
 spanName: methodName,
 spanOp: 'rpc',
 },
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 originalMethod as (...args: any[]) => any,
 undefined,
 true, // noMark = true since we'll mark the prototype method
 );

 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 return (wrapper as (...args: any[]) => any).apply(this, args);
 };

Expand Down

52 changes: 41 additions & 11 deletions
packages/cloudflare/src/handler.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,39 @@ import { addCloudResourceContext } from './scope-utils';
import { init } from './sdk';
import { copyExecutionContext } from './utils/copyExecutionContext';

/**
 * Helper type to filter out empty object types from a union
 * This is a distributive conditional type that operates on each member of a union
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type FilterEmptyObjects<T> = T extends any ? ([keyof T] extends [never] ? never : T) : never;

/**
 * Helper type to extract Env from ExportedHandler
 * Filters out empty object types from unions and returns unknown instead
 */
type InferEnv<T> =
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 T extends ExportedHandler<infer E, any, any>
 ? unknown extends E
 ? unknown
 : FilterEmptyObjects<E> extends never
 ? unknown
 : FilterEmptyObjects<E>
 : unknown;

/**
 * Helper type to extract QueueHandlerMessage from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferQueueMessage<T> = T extends ExportedHandler<any, infer Q, any> ? Q : unknown;

/**
 * Helper type to extract CfHostMetadata from ExportedHandler
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type InferCfHostMetadata<T> = T extends ExportedHandler<any, any, infer C> ? C : unknown;

/**
 * Wrapper for Cloudflare handlers.
 *
Expand All@@ -28,17 +61,14 @@ import { copyExecutionContext } from './utils/copyExecutionContext';
 * @param handler {ExportedHandler} The handler to wrap.
 * @returns The wrapped handler.
 */
// eslint-disable-next-line complexity
export function withSentry<
 Env = unknown,
 QueueHandlerMessage = unknown,
 CfHostMetadata = unknown,
 T extends ExportedHandler<Env, QueueHandlerMessage, CfHostMetadata> = ExportedHandler<
 Env,
 QueueHandlerMessage,
 CfHostMetadata
 >,
>(optionsCallback: (env: Env) => CloudflareOptions, handler: T): T {
// eslint-disable-next-line complexity, @typescript-eslint/no-explicit-any
export function withSentry<T extends ExportedHandler<any, any, any>>(
 optionsCallback: (env: InferEnv<T>) => CloudflareOptions,
 handler: T,
): T {
 type Env = InferEnv<T>;
 type QueueHandlerMessage = InferQueueMessage<T>;
 type CfHostMetadata = InferCfHostMetadata<T>;
 setAsyncLocalStorageAsyncContextStrategy();

 try {
Expand Down

30 changes: 23 additions & 7 deletions
packages/cloudflare/src/workflows.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -132,6 +132,20 @@ class WrappedWorkflowStep implements WorkflowStep {
 }
}

/**
 * Helper type to extract the environment type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (env) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractEnv<C> = C extends new (ctx: any, env: infer E) => any ? E : never;

/**
 * Helper type to extract the payload type from a WorkflowEntrypoint constructor.
 * This extracts the second parameter type (P) from the constructor signature.
 */
// eslint-disable-next-line @typescript-eslint/no-explicit-any
type ExtractPayload<C> = C extends new (ctx: any, env: any, payload: infer P) => any ? P : never;

/**
 * Instruments a Cloudflare Workflow class with Sentry.
 *
Expand All@@ -150,13 +164,15 @@ class WrappedWorkflowStep implements WorkflowStep {
 * @returns Instrumented workflow class with the same interface
 */
export function instrumentWorkflowWithSentry<
 E, // Environment type
 P, // Payload type
 T extends WorkflowEntrypoint<E, P>, // WorkflowEntrypoint type
 C extends new (ctx: ExecutionContext, env: E) => T, // Constructor type of the WorkflowEntrypoint class
>(optionsCallback: (env: E) => CloudflareOptions, WorkFlowClass: C): C {
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 C extends new (ctx: ExecutionContext, env: any) => WorkflowEntrypoint<any, any>,
>(optionsCallback: (env: ExtractEnv<C>) => CloudflareOptions, WorkFlowClass: C): C {
 type Env = ExtractEnv<C>;
 type Payload = ExtractPayload<C>;
 type T = WorkflowEntrypoint<Env, Payload>;

 return new Proxy(WorkFlowClass, {
 construct(target: C, args: [ctx: ExecutionContext, env: E], newTarget) {
 construct(target: C, args: [ctx: ExecutionContext, env: Env], newTarget) {
 const [ctx, env] = args;
 const context = copyExecutionContext(ctx);
 args[0] = context;
Expand All@@ -166,7 +182,7 @@ export function instrumentWorkflowWithSentry<
 return new Proxy(instance, {
 get(obj, prop, receiver) {
 if (prop === 'run') {
 return async function (event: WorkflowEvent<P>, step: WorkflowStep): Promise<unknown> {
 return async function (event: WorkflowEvent<Payload>, step: WorkflowStep): Promise<unknown> {
 setAsyncLocalStorageAsyncContextStrategy();

 return withIsolationScope(async isolationScope => {
Expand Down