feat!: update event-iterator options (#199)

* update event-source ping options

* wip

* make LinkFetchClientOptions extends ToFetchRequestOptions

* sync

Author: dinwwwh

apps/content/docs/client/event-iterator.md

@@ -49,7 +49,7 @@ for await (const event of iterator) {
 If an error occurs during streaming, oRPC will attempt retries based on your configuration. It can retry multiple times until the specified limit is reached, after which the error will be thrown.
 
 ::: info
-If you're using [RPCLink](/docs/client/rpc-link), you can customize the retry behavior [here](/docs/client/rpc-link#event-source-configuration).
+If you're using [RPCLink](/docs/client/rpc-link), you can customize the retry behavior [here](/docs/client/rpc-link#event-iterator-configuration).
 :::
 
 ```ts

apps/content/docs/client/rpc-link.md

@@ -118,22 +118,22 @@ const link = new RPCLink<ClientContext>({
 You should disable event iterator retries when streaming results from a chatbot AI.
 :::
 
-## Event-Source Ping Interval
+## Event Iterator Keep Alive
 
-To keep EventSource connections alive (the mechanism behind [Event Iterator](/docs/event-iterator)), `RPCLink` periodically sends a ping comment to the server. You can configure this behavior using the following options:
+To keep [Event Iterator](/docs/event-iterator) connections alive, `RPCLink` periodically sends a ping comment to the server. You can configure this behavior using the following options:
 
-- `eventSourcePingEnabled` (default: `true`) – Enables or disables pings.
-- `eventSourcePingInterval` (default: `5000`) – Time between pings (in milliseconds).
-- `eventSourcePingContent` (default: `''`) – Custom content for ping messages.
+- `eventIteratorKeepAliveEnabled` (default: `true`) – Enables or disables pings.
+- `eventIteratorKeepAliveInterval` (default: `5000`) – Time between pings (in milliseconds).
+- `eventIteratorKeepAliveComment` (default: `''`) – Custom content for ping messages.
 
 ```ts
 const link = new RPCLink({
-  eventSourcePingEnabled: true,
-  eventSourcePingInterval: 5000, // 5 seconds
-  eventSourcePingContent: '',
+  eventIteratorKeepAliveEnabled: true,
+  eventIteratorKeepAliveInterval: 5000, // 5 seconds
+  eventIteratorKeepAliveComment: '',
 })
 ```
 
 :::warning
-These options for sending [Event Iterator](/docs/event-iterator) from client to the server, not from the server to client as used in [RPCHandler](/docs/rpc-handler#event-source-ping-interval) or [OpenAPIHandler](/docs/openapi/openapi-handler#event-source-ping-interval).
+These options for sending [Event Iterator](/docs/event-iterator) from client to the server, not from the server to client as used in [RPCHandler](/docs/rpc-handler#event-iterator-keep-alive) or [OpenAPIHandler](/docs/openapi/openapi-handler#event-iterator-keep-alive).
 :::

apps/content/docs/openapi/openapi-handler.md

@@ -87,18 +87,18 @@ export default async function fetch(request: Request) {
 }
 ```
 
-## Event-Source Ping Interval
+## Event Iterator Keep Alive
 
-To keep EventSource connections alive (the mechanism behind [Event Iterator](/docs/event-iterator)), `OpenAPIHandler` periodically sends a ping comment to the client. You can configure this behavior using the following options:
+To keep [Event Iterator](/docs/event-iterator) connections alive, `OpenAPIHandler` periodically sends a ping comment to the client. You can configure this behavior using the following options:
 
-- `eventSourcePingEnabled` (default: `true`) – Enables or disables pings.
-- `eventSourcePingInterval` (default: `5000`) – Time between pings (in milliseconds).
-- `eventSourcePingContent` (default: `''`) – Custom content for ping messages.
+- `eventIteratorKeepAliveEnabled` (default: `true`) – Enables or disables pings.
+- `eventIteratorKeepAliveInterval` (default: `5000`) – Time between pings (in milliseconds).
+- `eventIteratorKeepAliveComment` (default: `''`) – Custom content for ping messages.
 
 ```ts
 const result = await handler.handle(request, {
-  eventSourcePingEnabled: true,
-  eventSourcePingInterval: 5000, // 5 seconds
-  eventSourcePingContent: '',
+  eventIteratorKeepAliveEnabled: true,
+  eventIteratorKeepAliveInterval: 5000, // 5 seconds
+  eventIteratorKeepAliveComment: '',
 })
 ```

apps/content/docs/rpc-handler.md

@@ -66,18 +66,18 @@ export default async function fetch(request: Request) {
 }
 ```
 
-## Event-Source Ping Interval
+## Event-Iterator Keep Alive
 
-To keep EventSource connections alive (the mechanism behind [Event Iterator](/docs/event-iterator)), `RPCHandler` periodically sends a ping comment to the client. You can configure this behavior using the following options:
+To keep [Event Iterator](/docs/event-iterator) connections alive, `RPCHandler` periodically sends a ping comment to the client. You can configure this behavior using the following options:
 
-- `eventSourcePingEnabled` (default: `true`) – Enables or disables pings.
-- `eventSourcePingInterval` (default: `5000`) – Time between pings (in milliseconds).
-- `eventSourcePingContent` (default: `''`) – Custom content for ping messages.
+- `eventIteratorKeepAliveEnabled` (default: `true`) – Enables or disables pings.
+- `eventIteratorKeepAliveInterval` (default: `5000`) – Time between pings (in milliseconds).
+- `eventIteratorKeepAliveComment` (default: `''`) – Custom content for ping comments.
 
 ```ts
 const result = await handler.handle(request, {
-  eventSourcePingEnabled: true,
-  eventSourcePingInterval: 5000, // 5 seconds
-  eventSourcePingContent: '',
+  eventIteratorKeepAliveEnabled: true,
+  eventIteratorKeepAliveInterval: 5000, // 5 seconds
+  eventIteratorKeepAliveComment: '',
 })
 ```

packages/client/src/adapters/fetch/link-fetch-client.test.ts

@@ -35,7 +35,7 @@ describe('linkFetchClient', () => {
     expect(toStandardLazyResponseSpy).toBeCalledWith(await fetch.mock.results[0]!.value)
 
     expect(toFetchRequestSpy).toBeCalledTimes(1)
-    expect(toFetchRequestSpy).toBeCalledWith(standardRequest)
+    expect(toFetchRequestSpy).toBeCalledWith(standardRequest, { fetch })
 
     expect(fetch).toBeCalledTimes(1)
     expect(fetch).toBeCalledWith(

packages/client/src/adapters/fetch/link-fetch-client.ts

@@ -1,9 +1,10 @@
 import type { StandardLazyResponse, StandardRequest } from '@orpc/standard-server'
+import type { ToFetchRequestOptions } from '@orpc/standard-server-fetch'
 import type { ClientContext, ClientOptionsOut } from '../../types'
 import type { StandardLinkClient } from '../standard'
 import { toFetchRequest, toStandardLazyResponse } from '@orpc/standard-server-fetch'
 
-export interface LinkFetchClientOptions<T extends ClientContext> {
+export interface LinkFetchClientOptions<T extends ClientContext> extends ToFetchRequestOptions {
   fetch?: (
     request: Request,
     init: Record<never, never>,
@@ -15,13 +16,15 @@ export interface LinkFetchClientOptions<T extends ClientContext> {
 
 export class LinkFetchClient<T extends ClientContext> implements StandardLinkClient<T> {
   private readonly fetch: Exclude<LinkFetchClientOptions<T>['fetch'], undefined>
+  private readonly toFetchRequestOptions: ToFetchRequestOptions
 
   constructor(options: LinkFetchClientOptions<T>) {
     this.fetch = options?.fetch ?? globalThis.fetch.bind(globalThis)
+    this.toFetchRequestOptions = options
   }
 
   async call(request: StandardRequest, options: ClientOptionsOut<T>, path: readonly string[], input: unknown): Promise<StandardLazyResponse> {
-    const fetchRequest = toFetchRequest(request)
+    const fetchRequest = toFetchRequest(request, this.toFetchRequestOptions)
 
     const fetchResponse = await this.fetch(fetchRequest, {}, options, path, input)
 

packages/client/src/adapters/standard/link.ts

@@ -98,7 +98,7 @@ export class StandardLink<T extends ClientContext> implements ClientLink<T> {
         const maybeIterator = await this.#call(path, input, updatedOptions)
 
         if (!isAsyncIteratorObject(maybeIterator)) {
-          throw new InvalidEventIteratorRetryResponse('Invalid EventSource retry response')
+          throw new InvalidEventIteratorRetryResponse('Invalid Event Iterator retry response')
         }
 
         return maybeIterator

packages/client/src/adapters/standard/rpc-serializer.test.ts

@@ -60,7 +60,7 @@ describe.each(supportedDataTypes)('rpcSerializer: $name', ({ value, expected })
   })
 })
 
-describe('rpcSerializer: event-source iterator', async () => {
+describe('rpcSerializer: event iterator', async () => {
   const serializer = new RPCSerializer()
 
   function serializeAndDeserialize(value: unknown): unknown {

packages/openapi-client/src/adapters/standard/openapi-serializer.test.ts

@@ -66,7 +66,7 @@ describe('openAPISerializer', () => {
       expect(serialize).toHaveBeenCalledWith(data)
     })
 
-    describe('with event-source iterator', async () => {
+    describe('with event iterator', async () => {
       it('on success', async () => {
         const date = new Date()
 
@@ -235,7 +235,7 @@ describe('openAPISerializer', () => {
       expect(deserialized).toEqual(data)
     })
 
-    describe('with event-source iterator', async () => {
+    describe('with event iterator', async () => {
       it('on success', async () => {
         const date = new Date()
 

packages/openapi/src/adapters/fetch/openapi-handler.ts

@@ -20,11 +20,13 @@ export class OpenAPIHandler<T extends Context> implements FetchHandler<T> {
 
   async handle(
     request: Request,
-    ...[options]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>
+    ...[
+      options = {} as StandardHandleOptions<T> & ToFetchResponseOptions,
+    ]: MaybeOptionalOptions<StandardHandleOptions<T> & ToFetchResponseOptions>
   ): Promise<FetchHandleResult> {
     const standardRequest = toStandardLazyRequest(request)
 
-    const result = await this.standardHandler.handle(standardRequest, options as any)
+    const result = await this.standardHandler.handle(standardRequest, options)
 
     if (!result.matched) {
       return result