@pluv/io 0.23.0 → 0.24.0

package/.turbo/turbo-build.log

@@ -1,9 +1,9 @@
 
-> @pluv/io@0.23.0 build /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.24.0 build /home/runner/work/pluv/pluv/packages/io
 > pnpm run version && tsup src/index.ts --format esm,cjs --dts
 
 
-> @pluv/io@0.23.0 version /home/runner/work/pluv/pluv/packages/io
+> @pluv/io@0.24.0 version /home/runner/work/pluv/pluv/packages/io
 > genversion ./src/version.generated.ts --esm
 
 CLI Building entry: src/index.ts
@@ -12,11 +12,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 39.65 KB
-CJS ⚡️ Build success in 159ms
-ESM dist/index.mjs 37.48 KB
-ESM ⚡️ Build success in 160ms
+ESM dist/index.mjs 38.86 KB
+ESM ⚡️ Build success in 112ms
+CJS dist/index.js 41.00 KB
+CJS ⚡️ Build success in 111ms
 DTS Build start
-DTS ⚡️ Build success in 2147ms
-DTS dist/index.d.mts 24.62 KB
-DTS dist/index.d.ts  24.62 KB
+DTS ⚡️ Build success in 2161ms
+DTS dist/index.d.mts 25.28 KB
+DTS dist/index.d.ts  25.28 KB

package/CHANGELOG.md

@@ -1,5 +1,133 @@
 # @pluv/io
 
+## 0.24.0
+
+### Minor Changes
+
+- 6ac8a46: \* Fixed errors thrown when using Cloudflare's websocket hibernation API caused by rooms being re-used between different instances of DurableObjects.
+
+  - Add configurable `onDelete` and `onMessage` event listeners that can be set when rooms are created.
+
+  **BREAKING**
+
+  - Changed `PluvServer.getRoom` to `PluvServer.createRoom`. This means `PluvServer` only handles room creation. Room management must now be handled manually. This mainly affects manually creating rooms with `@pluv/platform-node`, and will likely not affect you if you are either using `createPluvHandler` on any platform, or if you are using `@pluv/platform-cloudflare`.
+
+  ```ts
+  // For @pluv/platform-node
+
+  // Before
+
+  import { createIO } from "@pluv/io";
+
+  const io = createIO(/* ... */);
+  const ioServer = io.server(/* ... */);
+
+  const roomId = "my-room-id";
+  const room = ioServer.getRoom(roomId);
+
+  // After
+
+  import { createIO, type InferIORoom } from "@pluv/io";
+
+  const io = createIO(/* ... */);
+  const ioServer = io.server(/* ... */);
+
+  const rooms = new Map<string, InferIORoom<typeof ioServer>>();
+
+  const roomId = "my-room-id";
+  const room = ioServer.createRoom(roomId, {
+    // Use new onDelete event listener
+    onDelete: (event) => {
+      rooms.delete(event.room);
+    },
+  });
+
+  rooms.set(roomId, room);
+  ```
+
+- c26986d: Fixed websocket messages getting lost after the Cloudflare Worker Durable Object wakes up from hibernation.
+
+  **BREAKING**
+
+  Updated `onMessage`, `onClose` and `onError` to all return `Promise.void` instead of `void`.
+
+  ```ts
+  // Before
+
+  const io = createIO(/* ... */);
+  const ioServer = io.server(/* ... */);
+
+  class RoomDurableObject implements DurableObject {
+    public webSocketClose(ws: WebSocket, code: number, reason: string): void {
+      const handler = this._room.onClose(ws);
+
+      // Previously returned `void`
+      handler({ code, reason });
+    }
+
+    public webSocketError(ws: WebSocket, error: unknown): void {
+      const handler = this._room.onError(ws);
+      const eventError =
+        error instanceof Error ? error : new Error("Internal Error");
+
+      // Previously returned `void`
+      handler({ error: eventError, message: eventError.message });
+    }
+
+    public webSocketMessage(
+      ws: WebSocket,
+      message: string | ArrayBuffer,
+    ): void {
+      const handler = this._room.onMessage(ws);
+
+      // Previously returned `void`
+      handler({ data: message });
+    }
+  }
+
+  // After
+
+  const io = createIO(/* ... */);
+  const ioServer = io.server(/* ... */);
+
+  class RoomDurableObject implements DurableObject {
+    public async webSocketClose(
+      ws: WebSocket,
+      code: number,
+      reason: string,
+    ): Promise<void> {
+      const handler = this._room.onClose(ws);
+
+      // Handler must now be awaited
+      await handler({ code, reason });
+    }
+
+    public async webSocketError(ws: WebSocket, error: unknown): Promise<void> {
+      const handler = this._room.onError(ws);
+      const eventError =
+        error instanceof Error ? error : new Error("Internal Error");
+
+      // Handler must now be awaited
+      await handler({ error: eventError, message: eventError.message });
+    }
+
+    public async webSocketMessage(
+      ws: WebSocket,
+      message: string | ArrayBuffer,
+    ): Promise<void> {
+      const handler = this._room.onMessage(ws);
+
+      // Handler must now be awaited
+      await handler({ data: message });
+    }
+  }
+  ```
+
+### Patch Changes
+
+- @pluv/crdt@0.24.0
+- @pluv/types@0.24.0
+
 ## 0.23.0
 
 ### Minor Changes

package/dist/index.d.mts

@@ -290,22 +290,24 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private readonly _sessions;
     get _events(): TEvents;
     get broadcast(): BroadcastProxy<this>;
+    private get _initialized();
     constructor(id: string, config: IORoomConfig<TPlatform, TAuthorize, TContext, TEvents>);
     getSize(): number;
-    onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => void;
-    onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => void;
-    onMessage(webSocket: WebSocketType<TPlatform>): (event: AbstractMessageEvent) => void;
+    onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => Promise<void>;
+    onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => Promise<void>;
+    onMessage(webSocket: WebSocketType<TPlatform>): (event: AbstractMessageEvent) => Promise<void>;
     register(webSocket: InferPlatformWebSocketSource<TPlatform>, options?: WebsocketRegisterOptions): Promise<void>;
     private _broadcast;
     private _emitQuitters;
     private _emitRegistered;
     private _ensureDetached;
     private _getAbstractWs;
-    private _getSession;
     private _getAuthorizedUser;
+    private _getInitialDoc;
     private _getIOAuthorize;
     private _getProcedure;
     private _getProcedureInputs;
+    private _getSession;
     private _getSessions;
     private _initialize;
     private _logDebug;
@@ -330,11 +332,10 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-type GetRoomOptions<TPlatform extends AbstractPlatform> = keyof InferRoomContextType<TPlatform> extends never ? [{
+type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     debug?: boolean;
-}] | [] : [Id<{
-    debug?: boolean;
-} & InferRoomContextType<TPlatform>>];
+};
+type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
 declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>> = BaseIOAuthorize, TContext extends JsonObject = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IORouterLike<TEvents> {
     _listeners: PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>;
     readonly version: string;
@@ -345,16 +346,14 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     private readonly _debug;
     private readonly _getInitialStorage;
     private readonly _platform;
-    private readonly _rooms;
     private readonly _router;
     get _events(): TEvents;
     get _registrationMode(): WebSocketRegistrationMode;
     private get _procedure();
     constructor(options: PluvServerConfig<TPlatform, TAuthorize, TContext, TEvents>);
+    createRoom(room: string, ...options: CreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>): IORoom<TPlatform, TAuthorize, TContext, TEvents>;
     createToken(params: JWTEncodeParams<InferIOAuthorizeUser<InferIOAuthorize<this>>, TPlatform>): Promise<string>;
-    getRoom(room: string, ...options: GetRoomOptions<TPlatform>): IORoom<TPlatform, TAuthorize, TContext, TEvents>;
     private _logDebug;
-    private _purgeEmptyRooms;
 }
 
 type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject> = {
@@ -396,4 +395,4 @@ type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<a
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>, TContext>;
 
-export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistance, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type GetRoomOptions, type IOPubSubEventMessage, IORoom, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };
+export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistance, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type CreateRoomOptions, type IOPubSubEventMessage, IORoom, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };

package/dist/index.d.ts

@@ -290,22 +290,24 @@ declare class IORoom<TPlatform extends AbstractPlatform<any> = AbstractPlatform<
     private readonly _sessions;
     get _events(): TEvents;
     get broadcast(): BroadcastProxy<this>;
+    private get _initialized();
     constructor(id: string, config: IORoomConfig<TPlatform, TAuthorize, TContext, TEvents>);
     getSize(): number;
-    onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => void;
-    onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => void;
-    onMessage(webSocket: WebSocketType<TPlatform>): (event: AbstractMessageEvent) => void;
+    onClose(webSocket: WebSocketType<TPlatform>): (event: AbstractCloseEvent) => Promise<void>;
+    onError(webSocket: WebSocketType<TPlatform>): (event: AbstractErrorEvent) => Promise<void>;
+    onMessage(webSocket: WebSocketType<TPlatform>): (event: AbstractMessageEvent) => Promise<void>;
     register(webSocket: InferPlatformWebSocketSource<TPlatform>, options?: WebsocketRegisterOptions): Promise<void>;
     private _broadcast;
     private _emitQuitters;
     private _emitRegistered;
     private _ensureDetached;
     private _getAbstractWs;
-    private _getSession;
     private _getAuthorizedUser;
+    private _getInitialDoc;
     private _getIOAuthorize;
     private _getProcedure;
     private _getProcedureInputs;
+    private _getSession;
     private _getSessions;
     private _initialize;
     private _logDebug;
@@ -330,11 +332,10 @@ type PluvServerConfig<TPlatform extends AbstractPlatform<any> = AbstractPlatform
     platform: TPlatform;
     router?: PluvRouter<TPlatform, TAuthorize, TContext, TEvents>;
 };
-type GetRoomOptions<TPlatform extends AbstractPlatform> = keyof InferRoomContextType<TPlatform> extends never ? [{
+type BaseCreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = Partial<IORoomListeners<TPlatform, TAuthorize, TContext, TEvents>> & {
     debug?: boolean;
-}] | [] : [Id<{
-    debug?: boolean;
-} & InferRoomContextType<TPlatform>>];
+};
+type CreateRoomOptions<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext>> = keyof InferRoomContextType<TPlatform> extends never ? [BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>] | [] : [Id<BaseCreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents> & InferRoomContextType<TPlatform>>];
 declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>> = BaseIOAuthorize, TContext extends JsonObject = {}, TEvents extends PluvRouterEventConfig<TPlatform, TAuthorize, TContext> = {}> implements IORouterLike<TEvents> {
     _listeners: PluvIOListeners<TPlatform, TAuthorize, TContext, TEvents>;
     readonly version: string;
@@ -345,16 +346,14 @@ declare class PluvServer<TPlatform extends AbstractPlatform<any> = AbstractPlatf
     private readonly _debug;
     private readonly _getInitialStorage;
     private readonly _platform;
-    private readonly _rooms;
     private readonly _router;
     get _events(): TEvents;
     get _registrationMode(): WebSocketRegistrationMode;
     private get _procedure();
     constructor(options: PluvServerConfig<TPlatform, TAuthorize, TContext, TEvents>);
+    createRoom(room: string, ...options: CreateRoomOptions<TPlatform, TAuthorize, TContext, TEvents>): IORoom<TPlatform, TAuthorize, TContext, TEvents>;
     createToken(params: JWTEncodeParams<InferIOAuthorizeUser<InferIOAuthorize<this>>, TPlatform>): Promise<string>;
-    getRoom(room: string, ...options: GetRoomOptions<TPlatform>): IORoom<TPlatform, TAuthorize, TContext, TEvents>;
     private _logDebug;
-    private _purgeEmptyRooms;
 }
 
 type PluvIOConfig<TPlatform extends AbstractPlatform<any>, TAuthorize extends IOAuthorize<any, any, InferPlatformContextType<TPlatform>>, TContext extends JsonObject> = {
@@ -396,4 +395,4 @@ type CreateIOParams<TPlatform extends AbstractPlatform<any> = AbstractPlatform<a
 };
 declare const createIO: <TPlatform extends AbstractPlatform<any> = AbstractPlatform<any, {}, {}>, TContext extends JsonObject = {}, TAuthorizeUser extends BaseUser = BaseUser, TAuthorizeRequired extends boolean = false>(params: CreateIOParams<TPlatform, TContext, TAuthorizeUser, TAuthorizeRequired>) => PluvIO<TPlatform, IOAuthorize<TAuthorizeUser, TAuthorizeRequired, InferPlatformContextType<TPlatform>>, TContext>;
 
-export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistance, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type GetRoomOptions, type IOPubSubEventMessage, IORoom, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };
+export { type AbstractCloseEvent, type AbstractErrorEvent, type AbstractEvent, type AbstractEventMap, type AbstractListener, type AbstractMessageEvent, AbstractPersistance, AbstractPlatform, type AbstractPlatformConfig, AbstractPubSub, AbstractWebSocket, type AbstractWebSocketConfig, type AbstractWebSocketHandleErrorParams, type AuthorizeModule, type AuthorizeParams, type ConvertWebSocketConfig, type CreateIOParams, type CreateRoomOptions, type IOPubSubEventMessage, IORoom, type InferIORoom, type InferPlatformContextType, type InferPlatformWebSocketType, type InferRoomContextType, type JWT, type JWTEncodeParams, type MergedRouter, PluvIO, type PluvIOConfig, PluvProcedure, type PluvProcedureConfig, PluvRouter, type PluvRouterEventConfig, PluvServer, type PluvServerConfig, type ServerConfig, type WebSocketRegistrationMode, type WebSocketSerializedState, type WebSocketSession, createIO };