@arrirpc/server 0.79.0 → 0.80.0

package/README.md

@@ -225,7 +225,7 @@ Arri Event streams sent the following event types:
 - `message` - A standard message with the response data serialized as JSON
 - `start` - A starting message to start the stream
 - `done` - A message to tell clients that there will be no more events
-- `ping` - A message periodically sent by the server to keep the connection alive.
+- `heartbeat` - A message periodically sent by the server to keep the connection alive.
 
 ```ts
 /// message event ///
@@ -237,8 +237,8 @@ data: Response; // whatever you have specified as the response serialized to jso
 event: 'done';
 data: 'this stream has ended';
 
-/// ping event ///
-event: 'ping';
+/// heartbeat event ///
+event: 'heartbeat';
 data: '';
 ```
 

package/dist/index.cjs

@@ -472,7 +472,7 @@ function getSchemaName(rpcName, type, schema) {
 function defineEventStreamRpc(config) {
   return {
     ...config,
-    method: config.method ?? "get",
+    method: config.method ?? "post",
     isEventStream: true,
     transport: "http"
   };
@@ -484,16 +484,32 @@ class EventStreamConnection {
   lastEventId;
   validator;
   // for some reason Rollup cannot output DTS when this is set to NodeJS.Timeout
-  pingInterval = void 0;
-  pingIntervalMs;
+  heartbeatInterval = void 0;
+  heartbeatMs;
+  sendHeartbeat;
   eventStream;
+  _isClosed = false;
   constructor(event, opts) {
-    this.eventStream = h3.createEventStream(event);
+    this.heartbeatMs = opts.heartbeatMs ?? 2e4;
+    this.sendHeartbeat = opts.heartbeatEnabled ?? true;
+    h3.setResponseHeader(
+      event,
+      "heartbeat-interval",
+      this.heartbeatMs.toString()
+    );
+    this.eventStream = h3.createEventStream(event, { autoclose: false });
+    event.node.req.once("close", () => {
+      if (this._isClosed) return;
+      this.eventStream.close();
+    });
+    event.node.res.once("close", () => {
+      if (this._isClosed) return;
+      this.eventStream.close();
+    });
     this.lastEventId = h3.getHeader(event, "Last-Event-Id");
-    this.pingIntervalMs = opts.pingInterval ?? 6e4;
     this.validator = opts.validator;
     this.eventStream.onClosed(() => {
-      this.cleanup();
+      this._cleanup();
     });
   }
   /**
@@ -505,12 +521,15 @@ class EventStreamConnection {
       event: "start",
       data: "connection successful"
     });
-    this.pingInterval = setInterval(async () => {
-      await this.eventStream.push({
-        event: "ping",
-        data: ""
-      });
-    }, this.pingIntervalMs);
+    if (this.sendHeartbeat) {
+      this.heartbeatInterval = setInterval(async () => {
+        console.log("SENDING_HEARTBEAT");
+        await this.eventStream.push({
+          event: "heartbeat",
+          data: ""
+        });
+      }, this.heartbeatMs);
+    }
   }
   async push(data, eventId) {
     if (!this.validator) return;
@@ -552,9 +571,10 @@ class EventStreamConnection {
       errors
     };
   }
-  cleanup() {
-    if (this.pingInterval) {
-      clearInterval(this.pingInterval);
+  _cleanup() {
+    this._isClosed = true;
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
     }
   }
   /**
@@ -574,7 +594,7 @@ class EventStreamConnection {
 function registerEventStreamRpc(router, path, procedure, opts) {
   const paramValidator = procedure.params ? getSchemaValidator(procedure.name, "params", procedure.params) : void 0;
   const responseValidator = procedure.response ? getSchemaValidator(procedure.name, "response", procedure.response) : void 0;
-  const httpMethod = procedure.method ?? "get";
+  const httpMethod = procedure.method ?? "post";
   const handler = h3.eventHandler(async (event) => {
     event.context.rpcName = procedure.name;
     if (h3.isPreflightRequest(event)) {
@@ -597,7 +617,8 @@ function registerEventStreamRpc(router, path, procedure, opts) {
         );
       }
       const stream = new EventStreamConnection(event, {
-        pingInterval: procedure.pingInterval,
+        heartbeatMs: procedure.heartbeatMs,
+        heartbeatEnabled: procedure.heartbeatEnabled,
         validator: responseValidator
       });
       event.context.stream = stream;

package/dist/index.d.cts

@@ -102,14 +102,17 @@ interface EventStreamRpcHandlerContext<TParams = any, TResponse = any> extends R
 }
 interface EventStreamConnectionOptions<TData> {
     validator?: RequestValidator<TData>;
-    pingInterval?: number;
+    heartbeatMs?: number;
+    heartbeatEnabled?: boolean;
 }
 declare class EventStreamConnection<TData> {
     readonly lastEventId?: string;
     private readonly validator?;
-    private pingInterval;
-    private readonly pingIntervalMs;
+    private heartbeatInterval;
+    private readonly heartbeatMs;
+    private readonly sendHeartbeat;
     readonly eventStream: EventStream;
+    private _isClosed;
     constructor(event: H3Event, opts: EventStreamConnectionOptions<TData>);
     /**
      * Send the stream to the client. This must be called before sending any events.
@@ -120,7 +123,7 @@ declare class EventStreamConnection<TData> {
      */
     push(data: TData[], eventId?: string): Promise<SsePushResult[]>;
     push(data: TData, eventId?: string): Promise<SsePushResult>;
-    private cleanup;
+    private _cleanup;
     /**
      * Tell clients that the stream has ended and close the connection.
      */
@@ -152,7 +155,8 @@ interface HttpRpc<TIsEventStream extends boolean = false, TParams extends RpcPar
     response: TResponse;
     isDeprecated?: boolean;
     isEventStream?: TIsEventStream;
-    pingInterval?: TIsEventStream extends true ? number : undefined;
+    heartbeatMs?: TIsEventStream extends true ? number : never;
+    heartbeatEnabled?: TIsEventStream extends true ? boolean : never;
     handler: TIsEventStream extends true ? EventStreamRpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined> : RpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : void>;
     postHandler?: TIsEventStream extends true ? undefined : RpcPostHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined>;
 }

package/dist/index.d.mts

@@ -102,14 +102,17 @@ interface EventStreamRpcHandlerContext<TParams = any, TResponse = any> extends R
 }
 interface EventStreamConnectionOptions<TData> {
     validator?: RequestValidator<TData>;
-    pingInterval?: number;
+    heartbeatMs?: number;
+    heartbeatEnabled?: boolean;
 }
 declare class EventStreamConnection<TData> {
     readonly lastEventId?: string;
     private readonly validator?;
-    private pingInterval;
-    private readonly pingIntervalMs;
+    private heartbeatInterval;
+    private readonly heartbeatMs;
+    private readonly sendHeartbeat;
     readonly eventStream: EventStream;
+    private _isClosed;
     constructor(event: H3Event, opts: EventStreamConnectionOptions<TData>);
     /**
      * Send the stream to the client. This must be called before sending any events.
@@ -120,7 +123,7 @@ declare class EventStreamConnection<TData> {
      */
     push(data: TData[], eventId?: string): Promise<SsePushResult[]>;
     push(data: TData, eventId?: string): Promise<SsePushResult>;
-    private cleanup;
+    private _cleanup;
     /**
      * Tell clients that the stream has ended and close the connection.
      */
@@ -152,7 +155,8 @@ interface HttpRpc<TIsEventStream extends boolean = false, TParams extends RpcPar
     response: TResponse;
     isDeprecated?: boolean;
     isEventStream?: TIsEventStream;
-    pingInterval?: TIsEventStream extends true ? number : undefined;
+    heartbeatMs?: TIsEventStream extends true ? number : never;
+    heartbeatEnabled?: TIsEventStream extends true ? boolean : never;
     handler: TIsEventStream extends true ? EventStreamRpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined> : RpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : void>;
     postHandler?: TIsEventStream extends true ? undefined : RpcPostHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined>;
 }

package/dist/index.d.ts

@@ -102,14 +102,17 @@ interface EventStreamRpcHandlerContext<TParams = any, TResponse = any> extends R
 }
 interface EventStreamConnectionOptions<TData> {
     validator?: RequestValidator<TData>;
-    pingInterval?: number;
+    heartbeatMs?: number;
+    heartbeatEnabled?: boolean;
 }
 declare class EventStreamConnection<TData> {
     readonly lastEventId?: string;
     private readonly validator?;
-    private pingInterval;
-    private readonly pingIntervalMs;
+    private heartbeatInterval;
+    private readonly heartbeatMs;
+    private readonly sendHeartbeat;
     readonly eventStream: EventStream;
+    private _isClosed;
     constructor(event: H3Event, opts: EventStreamConnectionOptions<TData>);
     /**
      * Send the stream to the client. This must be called before sending any events.
@@ -120,7 +123,7 @@ declare class EventStreamConnection<TData> {
      */
     push(data: TData[], eventId?: string): Promise<SsePushResult[]>;
     push(data: TData, eventId?: string): Promise<SsePushResult>;
-    private cleanup;
+    private _cleanup;
     /**
      * Tell clients that the stream has ended and close the connection.
      */
@@ -152,7 +155,8 @@ interface HttpRpc<TIsEventStream extends boolean = false, TParams extends RpcPar
     response: TResponse;
     isDeprecated?: boolean;
     isEventStream?: TIsEventStream;
-    pingInterval?: TIsEventStream extends true ? number : undefined;
+    heartbeatMs?: TIsEventStream extends true ? number : never;
+    heartbeatEnabled?: TIsEventStream extends true ? boolean : never;
     handler: TIsEventStream extends true ? EventStreamRpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined> : RpcHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : void>;
     postHandler?: TIsEventStream extends true ? undefined : RpcPostHandler<TParams extends RpcParamSchema<any> ? InferType<TParams> : undefined, TResponse extends RpcParamSchema<any> ? InferType<TResponse> : undefined>;
 }

package/dist/index.mjs

@@ -471,7 +471,7 @@ function getSchemaName(rpcName, type, schema) {
 function defineEventStreamRpc(config) {
   return {
     ...config,
-    method: config.method ?? "get",
+    method: config.method ?? "post",
     isEventStream: true,
     transport: "http"
   };
@@ -483,16 +483,32 @@ class EventStreamConnection {
   lastEventId;
   validator;
   // for some reason Rollup cannot output DTS when this is set to NodeJS.Timeout
-  pingInterval = void 0;
-  pingIntervalMs;
+  heartbeatInterval = void 0;
+  heartbeatMs;
+  sendHeartbeat;
   eventStream;
+  _isClosed = false;
   constructor(event, opts) {
-    this.eventStream = createEventStream(event);
+    this.heartbeatMs = opts.heartbeatMs ?? 2e4;
+    this.sendHeartbeat = opts.heartbeatEnabled ?? true;
+    setResponseHeader(
+      event,
+      "heartbeat-interval",
+      this.heartbeatMs.toString()
+    );
+    this.eventStream = createEventStream(event, { autoclose: false });
+    event.node.req.once("close", () => {
+      if (this._isClosed) return;
+      this.eventStream.close();
+    });
+    event.node.res.once("close", () => {
+      if (this._isClosed) return;
+      this.eventStream.close();
+    });
     this.lastEventId = getHeader(event, "Last-Event-Id");
-    this.pingIntervalMs = opts.pingInterval ?? 6e4;
     this.validator = opts.validator;
     this.eventStream.onClosed(() => {
-      this.cleanup();
+      this._cleanup();
     });
   }
   /**
@@ -504,12 +520,15 @@ class EventStreamConnection {
       event: "start",
       data: "connection successful"
     });
-    this.pingInterval = setInterval(async () => {
-      await this.eventStream.push({
-        event: "ping",
-        data: ""
-      });
-    }, this.pingIntervalMs);
+    if (this.sendHeartbeat) {
+      this.heartbeatInterval = setInterval(async () => {
+        console.log("SENDING_HEARTBEAT");
+        await this.eventStream.push({
+          event: "heartbeat",
+          data: ""
+        });
+      }, this.heartbeatMs);
+    }
   }
   async push(data, eventId) {
     if (!this.validator) return;
@@ -551,9 +570,10 @@ class EventStreamConnection {
       errors
     };
   }
-  cleanup() {
-    if (this.pingInterval) {
-      clearInterval(this.pingInterval);
+  _cleanup() {
+    this._isClosed = true;
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
     }
   }
   /**
@@ -573,7 +593,7 @@ class EventStreamConnection {
 function registerEventStreamRpc(router, path, procedure, opts) {
   const paramValidator = procedure.params ? getSchemaValidator(procedure.name, "params", procedure.params) : void 0;
   const responseValidator = procedure.response ? getSchemaValidator(procedure.name, "response", procedure.response) : void 0;
-  const httpMethod = procedure.method ?? "get";
+  const httpMethod = procedure.method ?? "post";
   const handler = eventHandler(async (event) => {
     event.context.rpcName = procedure.name;
     if (isPreflightRequest(event)) {
@@ -596,7 +616,8 @@ function registerEventStreamRpc(router, path, procedure, opts) {
         );
       }
       const stream = new EventStreamConnection(event, {
-        pingInterval: procedure.pingInterval,
+        heartbeatMs: procedure.heartbeatMs,
+        heartbeatEnabled: procedure.heartbeatEnabled,
         validator: responseValidator
       });
       event.context.stream = stream;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arrirpc/server",
-  "version": "0.79.0",
+  "version": "0.80.0",
   "type": "module",
   "license": "MIT",
   "author": {
@@ -23,16 +23,16 @@
   },
   "dependencies": {
     "@types/source-map-support": "^0.5.10",
-    "crossws": "^0.3.4",
-    "h3": "^1.15.1",
+    "crossws": "^0.4.1",
+    "h3": "^1.15.3",
     "scule": "^1.3.0",
     "source-map-support": "^0.5.21",
     "uncrypto": "^0.1.3",
-    "@arrirpc/schema": "0.79.0",
-    "@arrirpc/codegen-utils": "0.79.0",
-    "arri": "0.79.0"
+    "@arrirpc/schema": "0.80.0",
+    "@arrirpc/codegen-utils": "0.80.0",
+    "arri": "0.80.0"
   },
   "devDependencies": {
-    "bun-types": "^1.2.9"
+    "bun-types": "^1.2.15"
   }
 }