Skip to content

Adds props for ExecutionContext for ExportedHandler #5618

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

Open
NejcZdovc wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adds props for ExecutionContext for ExportedHandler #5618

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
30 changes: 15 additions & 15 deletions src/workerd/api/global-scope.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -348,27 +348,27 @@ struct ExportedHandler {
// include it in type definitions.

JSG_STRUCT_TS_DEFINE(
type ExportedHandlerFetchHandler<Env = unknown, CfHostMetadata = unknown> = (request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>, env: Env, ctx: ExecutionContext) => Response | Promise<Response>;
type ExportedHandlerTailHandler<Env = unknown> = (events: TraceItem[], env: Env, ctx: ExecutionContext) => void | Promise<void>;
type ExportedHandlerTraceHandler<Env = unknown> = (traces: TraceItem[], env: Env, ctx: ExecutionContext) => void | Promise<void>;
type ExportedHandlerTailStreamHandler<Env = unknown> = (event : TailStream.TailEvent<TailStream.Onset>, env: Env, ctx: ExecutionContext) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
type ExportedHandlerScheduledHandler<Env = unknown> = (controller: ScheduledController, env: Env, ctx: ExecutionContext) => void | Promise<void>;
type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (batch: MessageBatch<Message>, env: Env, ctx: ExecutionContext) => void | Promise<void>;
type ExportedHandlerTestHandler<Env = unknown> = (controller: TestController, env: Env, ctx: ExecutionContext) => void | Promise<void>;
type ExportedHandlerFetchHandler<Env = unknown, CfHostMetadata = unknown, Props = unknown> = (request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>, env: Env, ctx: ExecutionContext<Props>) => Response | Promise<Response>;
type ExportedHandlerTailHandler<Env = unknown, Props = unknown> = (events: TraceItem[], env: Env, ctx: ExecutionContext<Props>) => void | Promise<void>;
type ExportedHandlerTraceHandler<Env = unknown, Props = unknown> = (traces: TraceItem[], env: Env, ctx: ExecutionContext<Props>) => void | Promise<void>;
type ExportedHandlerTailStreamHandler<Env = unknown, Props = unknown> = (event : TailStream.TailEvent<TailStream.Onset>, env: Env, ctx: ExecutionContext<Props>) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
type ExportedHandlerScheduledHandler<Env = unknown, Props = unknown> = (controller: ScheduledController, env: Env, ctx: ExecutionContext<Props>) => void | Promise<void>;
type ExportedHandlerQueueHandler<Env = unknown, Message = unknown, Props = unknown> = (batch: MessageBatch<Message>, env: Env, ctx: ExecutionContext<Props>) => void | Promise<void>;
type ExportedHandlerTestHandler<Env = unknown, Props = unknown> = (controller: TestController, env: Env, ctx: ExecutionContext<Props>) => void | Promise<void>;
);
JSG_STRUCT_TS_OVERRIDE(<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown> {
JSG_STRUCT_TS_OVERRIDE(<Env = unknown, QueueHandlerMessage = unknown, CfHostMetadata = unknown, Props = unknown> {
email?: EmailExportedHandler<Env>;
Copy link
Contributor

@jamesopstad jamesopstad Dec 8, 2025

Choose a reason for hiding this comment

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

EmailExportedHandler also needs updating here:

workerd/types/defines/email.d.ts

Lines 63 to 67 in 903cdf1

declare type EmailExportedHandler<Env = unknown> = (
message: ForwardableEmailMessage,
env: Env,
ctx: ExecutionContext
) => void | Promise<void>;

fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
tail?: ExportedHandlerTailHandler<Env>;
trace?: ExportedHandlerTraceHandler<Env>;
tailStream?: ExportedHandlerTailStreamHandler<Env>;
scheduled?: ExportedHandlerScheduledHandler<Env>;
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata, Props>;
tail?: ExportedHandlerTailHandler<Env, Props>;
trace?: ExportedHandlerTraceHandler<Env, Props>;
tailStream?: ExportedHandlerTailStreamHandler<Env, Props>;
scheduled?: ExportedHandlerScheduledHandler<Env, Props>;
alarm: never;
webSocketMessage: never;
webSocketClose: never;
webSocketError: never;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
test?: ExportedHandlerTestHandler<Env>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage, Props>;
test?: ExportedHandlerTestHandler<Env, Props>;
});
// Make `env` parameter generic

Expand Down
51 changes: 30 additions & 21 deletions types/generated-snapshot/experimental/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -493,54 +493,63 @@ interface ExecutionContext<Props = unknown> {
readonly props: Props;
abort(reason?: any): void;
}
type ExportedHandlerFetchHandler<Env = unknown, CfHostMetadata = unknown> = (
type ExportedHandlerFetchHandler<
Env = unknown,
CfHostMetadata = unknown,
Props = unknown,
> = (
request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => Response | Promise<Response>;
type ExportedHandlerTailHandler<Env = unknown> = (
type ExportedHandlerTailHandler<Env = unknown, Props = unknown> = (
events: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTraceHandler<Env = unknown> = (
type ExportedHandlerTraceHandler<Env = unknown, Props = unknown> = (
traces: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTailStreamHandler<Env = unknown> = (
type ExportedHandlerTailStreamHandler<Env = unknown, Props = unknown> = (
event: TailStream.TailEvent<TailStream.Onset>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
type ExportedHandlerScheduledHandler<Env = unknown> = (
type ExportedHandlerScheduledHandler<Env = unknown, Props = unknown> = (
controller: ScheduledController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
type ExportedHandlerQueueHandler<
Env = unknown,
Message = unknown,
Props = unknown,
> = (
batch: MessageBatch<Message>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTestHandler<Env = unknown> = (
type ExportedHandlerTestHandler<Env = unknown, Props = unknown> = (
controller: TestController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
interface ExportedHandler<
Env = unknown,
QueueHandlerMessage = unknown,
CfHostMetadata = unknown,
Props = unknown,
> {
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
tail?: ExportedHandlerTailHandler<Env>;
trace?: ExportedHandlerTraceHandler<Env>;
tailStream?: ExportedHandlerTailStreamHandler<Env>;
scheduled?: ExportedHandlerScheduledHandler<Env>;
test?: ExportedHandlerTestHandler<Env>;
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata, Props>;
tail?: ExportedHandlerTailHandler<Env, Props>;
trace?: ExportedHandlerTraceHandler<Env, Props>;
tailStream?: ExportedHandlerTailStreamHandler<Env, Props>;
scheduled?: ExportedHandlerScheduledHandler<Env, Props>;
test?: ExportedHandlerTestHandler<Env, Props>;
email?: EmailExportedHandler<Env>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage, Props>;
}
interface StructuredSerializeOptions {
transfer?: any[];
Expand Down
46 changes: 26 additions & 20 deletions types/generated-snapshot/experimental/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -498,54 +498,60 @@ export interface ExecutionContext<Props = unknown> {
export type ExportedHandlerFetchHandler<
Env = unknown,
CfHostMetadata = unknown,
Props = unknown,
> = (
request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => Response | Promise<Response>;
export type ExportedHandlerTailHandler<Env = unknown> = (
export type ExportedHandlerTailHandler<Env = unknown, Props = unknown> = (
events: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTraceHandler<Env = unknown> = (
export type ExportedHandlerTraceHandler<Env = unknown, Props = unknown> = (
traces: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTailStreamHandler<Env = unknown> = (
export type ExportedHandlerTailStreamHandler<Env = unknown, Props = unknown> = (
event: TailStream.TailEvent<TailStream.Onset>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
export type ExportedHandlerScheduledHandler<Env = unknown> = (
export type ExportedHandlerScheduledHandler<Env = unknown, Props = unknown> = (
controller: ScheduledController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
export type ExportedHandlerQueueHandler<
Env = unknown,
Message = unknown,
Props = unknown,
> = (
batch: MessageBatch<Message>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTestHandler<Env = unknown> = (
export type ExportedHandlerTestHandler<Env = unknown, Props = unknown> = (
controller: TestController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export interface ExportedHandler<
Env = unknown,
QueueHandlerMessage = unknown,
CfHostMetadata = unknown,
Props = unknown,
> {
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
tail?: ExportedHandlerTailHandler<Env>;
trace?: ExportedHandlerTraceHandler<Env>;
tailStream?: ExportedHandlerTailStreamHandler<Env>;
scheduled?: ExportedHandlerScheduledHandler<Env>;
test?: ExportedHandlerTestHandler<Env>;
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata, Props>;
tail?: ExportedHandlerTailHandler<Env, Props>;
trace?: ExportedHandlerTraceHandler<Env, Props>;
tailStream?: ExportedHandlerTailStreamHandler<Env, Props>;
scheduled?: ExportedHandlerScheduledHandler<Env, Props>;
test?: ExportedHandlerTestHandler<Env, Props>;
email?: EmailExportedHandler<Env>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage, Props>;
}
export interface StructuredSerializeOptions {
transfer?: any[];
Expand Down
51 changes: 30 additions & 21 deletions types/generated-snapshot/latest/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,54 +480,63 @@ interface ExecutionContext<Props = unknown> {
readonly exports: Cloudflare.Exports;
readonly props: Props;
}
type ExportedHandlerFetchHandler<Env = unknown, CfHostMetadata = unknown> = (
type ExportedHandlerFetchHandler<
Env = unknown,
CfHostMetadata = unknown,
Props = unknown,
> = (
request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => Response | Promise<Response>;
type ExportedHandlerTailHandler<Env = unknown> = (
type ExportedHandlerTailHandler<Env = unknown, Props = unknown> = (
events: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTraceHandler<Env = unknown> = (
type ExportedHandlerTraceHandler<Env = unknown, Props = unknown> = (
traces: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTailStreamHandler<Env = unknown> = (
type ExportedHandlerTailStreamHandler<Env = unknown, Props = unknown> = (
event: TailStream.TailEvent<TailStream.Onset>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
type ExportedHandlerScheduledHandler<Env = unknown> = (
type ExportedHandlerScheduledHandler<Env = unknown, Props = unknown> = (
controller: ScheduledController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
type ExportedHandlerQueueHandler<
Env = unknown,
Message = unknown,
Props = unknown,
> = (
batch: MessageBatch<Message>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
type ExportedHandlerTestHandler<Env = unknown> = (
type ExportedHandlerTestHandler<Env = unknown, Props = unknown> = (
controller: TestController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
interface ExportedHandler<
Env = unknown,
QueueHandlerMessage = unknown,
CfHostMetadata = unknown,
Props = unknown,
> {
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
tail?: ExportedHandlerTailHandler<Env>;
trace?: ExportedHandlerTraceHandler<Env>;
tailStream?: ExportedHandlerTailStreamHandler<Env>;
scheduled?: ExportedHandlerScheduledHandler<Env>;
test?: ExportedHandlerTestHandler<Env>;
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata, Props>;
tail?: ExportedHandlerTailHandler<Env, Props>;
trace?: ExportedHandlerTraceHandler<Env, Props>;
tailStream?: ExportedHandlerTailStreamHandler<Env, Props>;
scheduled?: ExportedHandlerScheduledHandler<Env, Props>;
test?: ExportedHandlerTestHandler<Env, Props>;
email?: EmailExportedHandler<Env>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage, Props>;
}
interface StructuredSerializeOptions {
transfer?: any[];
Expand Down
46 changes: 26 additions & 20 deletions types/generated-snapshot/latest/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -485,54 +485,60 @@ export interface ExecutionContext<Props = unknown> {
export type ExportedHandlerFetchHandler<
Env = unknown,
CfHostMetadata = unknown,
Props = unknown,
> = (
request: Request<CfHostMetadata, IncomingRequestCfProperties<CfHostMetadata>>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => Response | Promise<Response>;
export type ExportedHandlerTailHandler<Env = unknown> = (
export type ExportedHandlerTailHandler<Env = unknown, Props = unknown> = (
events: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTraceHandler<Env = unknown> = (
export type ExportedHandlerTraceHandler<Env = unknown, Props = unknown> = (
traces: TraceItem[],
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTailStreamHandler<Env = unknown> = (
export type ExportedHandlerTailStreamHandler<Env = unknown, Props = unknown> = (
event: TailStream.TailEvent<TailStream.Onset>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
export type ExportedHandlerScheduledHandler<Env = unknown> = (
export type ExportedHandlerScheduledHandler<Env = unknown, Props = unknown> = (
controller: ScheduledController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerQueueHandler<Env = unknown, Message = unknown> = (
export type ExportedHandlerQueueHandler<
Env = unknown,
Message = unknown,
Props = unknown,
> = (
batch: MessageBatch<Message>,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export type ExportedHandlerTestHandler<Env = unknown> = (
export type ExportedHandlerTestHandler<Env = unknown, Props = unknown> = (
controller: TestController,
env: Env,
ctx: ExecutionContext,
ctx: ExecutionContext<Props>,
) => void | Promise<void>;
export interface ExportedHandler<
Env = unknown,
QueueHandlerMessage = unknown,
CfHostMetadata = unknown,
Props = unknown,
> {
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata>;
tail?: ExportedHandlerTailHandler<Env>;
trace?: ExportedHandlerTraceHandler<Env>;
tailStream?: ExportedHandlerTailStreamHandler<Env>;
scheduled?: ExportedHandlerScheduledHandler<Env>;
test?: ExportedHandlerTestHandler<Env>;
fetch?: ExportedHandlerFetchHandler<Env, CfHostMetadata, Props>;
tail?: ExportedHandlerTailHandler<Env, Props>;
trace?: ExportedHandlerTraceHandler<Env, Props>;
tailStream?: ExportedHandlerTailStreamHandler<Env, Props>;
scheduled?: ExportedHandlerScheduledHandler<Env, Props>;
test?: ExportedHandlerTestHandler<Env, Props>;
email?: EmailExportedHandler<Env>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage>;
queue?: ExportedHandlerQueueHandler<Env, QueueHandlerMessage, Props>;
}
export interface StructuredSerializeOptions {
transfer?: any[];
Expand Down
Loading