Skip to content

Commit dd26643

Browse files
committed
[o11y] Add undefined to tailStream return types
Returning undefined indicates that tail events for the given worker event can be ignored, which is used to shut down the tail stream early as an optimization.
1 parent b93fa71 commit dd26643

5 files changed

Lines changed: 9 additions & 5 deletions

File tree

types/defines/rpc.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ declare namespace CloudflareWorkersModule {
243243
queue?(batch: MessageBatch): void | Promise<void>;
244244
scheduled?(controller: ScheduledController): void | Promise<void>;
245245
tail?(events: TraceItem[]): void | Promise<void>;
246-
tailStream?(event: TailStream.TailEvent<TailStream.Onset>): TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType>;
246+
tailStream?(event: TailStream.TailEvent<TailStream.Onset>): TailStream.TailEventHandlerType | Promise<TailStream.TailEventHandlerType> | undefined;
247247
test?(controller: TestController): void | Promise<void>;
248248
trace?(traces: TraceItem[]): void | Promise<void>;
249249
}

types/generated-snapshot/experimental/index.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16196,7 +16196,8 @@ declare namespace CloudflareWorkersModule {
1619616196
event: TailStream.TailEvent<TailStream.Onset>,
1619716197
):
1619816198
| TailStream.TailEventHandlerType
16199-
| Promise<TailStream.TailEventHandlerType>;
16199+
| Promise<TailStream.TailEventHandlerType>
16200+
| undefined;
1620016201
test?(controller: TestController): void | Promise<void>;
1620116202
trace?(traces: TraceItem[]): void | Promise<void>;
1620216203
}

types/generated-snapshot/experimental/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16137,7 +16137,8 @@ export declare namespace CloudflareWorkersModule {
1613716137
event: TailStream.TailEvent<TailStream.Onset>,
1613816138
):
1613916139
| TailStream.TailEventHandlerType
16140-
| Promise<TailStream.TailEventHandlerType>;
16140+
| Promise<TailStream.TailEventHandlerType>
16141+
| undefined;
1614116142
test?(controller: TestController): void | Promise<void>;
1614216143
trace?(traces: TraceItem[]): void | Promise<void>;
1614316144
}

types/generated-snapshot/index.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15913,7 +15913,8 @@ declare namespace CloudflareWorkersModule {
1591315913
event: TailStream.TailEvent<TailStream.Onset>,
1591415914
):
1591515915
| TailStream.TailEventHandlerType
15916-
| Promise<TailStream.TailEventHandlerType>;
15916+
| Promise<TailStream.TailEventHandlerType>
15917+
| undefined;
1591715918
test?(controller: TestController): void | Promise<void>;
1591815919
trace?(traces: TraceItem[]): void | Promise<void>;
1591915920
}

types/generated-snapshot/index.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15854,7 +15854,8 @@ export declare namespace CloudflareWorkersModule {
1585415854
event: TailStream.TailEvent<TailStream.Onset>,
1585515855
):
1585615856
| TailStream.TailEventHandlerType
15857-
| Promise<TailStream.TailEventHandlerType>;
15857+
| Promise<TailStream.TailEventHandlerType>
15858+
| undefined;
1585815859
test?(controller: TestController): void | Promise<void>;
1585915860
trace?(traces: TraceItem[]): void | Promise<void>;
1586015861
}

0 commit comments

Comments
 (0)