@pluv/platform-cloudflare 0.21.1 → 0.23.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-cloudflare@0.21.1 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.23.0 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
 > tsup src/index.ts --format esm,cjs --dts
 
 CLI Building entry: src/index.ts
@@ -8,11 +8,11 @@
 CLI Target: es6
 ESM Build start
 CJS Build start
-CJS dist/index.js 15.00 KB
-CJS ⚡️ Build success in 118ms
-ESM dist/index.mjs 13.96 KB
-ESM ⚡️ Build success in 122ms
+ESM dist/index.mjs 14.13 KB
+ESM ⚡️ Build success in 95ms
+CJS dist/index.js 15.18 KB
+CJS ⚡️ Build success in 96ms
 DTS Build start
-DTS ⚡️ Build success in 2904ms
-DTS dist/index.d.mts 4.11 KB
-DTS dist/index.d.ts  4.11 KB
+DTS ⚡️ Build success in 3590ms
+DTS dist/index.d.mts 4.15 KB
+DTS dist/index.d.ts  4.15 KB

package/CHANGELOG.md

@@ -1,5 +1,26 @@
 # @pluv/platform-cloudflare
 
+## 0.23.0
+
+### Patch Changes
+
+- Updated dependencies [c01b16f]
+  - @pluv/io@0.23.0
+  - @pluv/types@0.23.0
+
+## 0.22.0
+
+### Minor Changes
+
+- 650e577: \* Fix `@pluv/platform-cloudflare` causing frequent disconnects due to incorrect heartbeat handling.
+  - Updated default `mode` of `@pluv/platform-cloudflare` back to `"detached"` (i.e. use Cloudflare Worker Hibernation API by default).
+
+### Patch Changes
+
+- Updated dependencies [650e577]
+  - @pluv/io@0.22.0
+  - @pluv/types@0.22.0
+
 ## 0.21.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -7,6 +7,7 @@ declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
     get readyState(): 0 | 1 | 2 | 3;
     get sessionId(): string;
     get state(): WebSocketSerializedState;
+    set state(state: WebSocketSerializedState);
     constructor(webSocket: WebSocket, config: CloudflareWebSocketConfig);
     addEventListener<TType extends keyof AbstractEventMap>(type: TType, handler: AbstractListener<TType>): void;
     close(code?: number | undefined, reason?: string | undefined): void;
@@ -31,7 +32,7 @@ declare class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends
     acceptWebSocket(webSocket: CloudflareWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): CloudflareWebSocket;
     getLastPing(webSocket: CloudflareWebSocket): number | null;
-    getSerializedState(webSocket: CloudflareWebSocket): WebSocketSerializedState | null;
+    getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
     initialize(config: AbstractPlatformConfig<{

package/dist/index.d.ts

@@ -7,6 +7,7 @@ declare class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
     get readyState(): 0 | 1 | 2 | 3;
     get sessionId(): string;
     get state(): WebSocketSerializedState;
+    set state(state: WebSocketSerializedState);
     constructor(webSocket: WebSocket, config: CloudflareWebSocketConfig);
     addEventListener<TType extends keyof AbstractEventMap>(type: TType, handler: AbstractListener<TType>): void;
     close(code?: number | undefined, reason?: string | undefined): void;
@@ -31,7 +32,7 @@ declare class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends
     acceptWebSocket(webSocket: CloudflareWebSocket): Promise<void>;
     convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): CloudflareWebSocket;
     getLastPing(webSocket: CloudflareWebSocket): number | null;
-    getSerializedState(webSocket: CloudflareWebSocket): WebSocketSerializedState | null;
+    getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null;
     getSessionId(webSocket: WebSocket): string | null;
     getWebSockets(): readonly WebSocket[];
     initialize(config: AbstractPlatformConfig<{

package/dist/index.js

@@ -207,6 +207,10 @@ var CloudflareWebSocket = class extends import_io.AbstractWebSocket {
     if (!state) throw new Error("Could not get websocket state");
     return state;
   }
+  set state(state) {
+    const deserialized = this.webSocket.deserializeAttachment();
+    this.webSocket.serializeAttachment(__spreadProps(__spreadValues({}, deserialized), { state }));
+  }
   constructor(webSocket, config) {
     const { room } = config;
     super(webSocket, config);
@@ -333,7 +337,7 @@ var PersistanceCloudflare = class extends import_io2.AbstractPersistance {
 };
 
 // src/constants.ts
-var DEFAULT_REGISTRATION_MODE = "attached";
+var DEFAULT_REGISTRATION_MODE = "detached";
 
 // src/CloudflarePlatform.ts
 var CloudflarePlatform = class _CloudflarePlatform extends import_io3.AbstractPlatform {
@@ -370,7 +374,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends import_io3.AbstractPl
   }
   getSerializedState(webSocket) {
     var _a;
-    const deserialized = webSocket.webSocket.deserializeAttachment();
+    const deserialized = webSocket.deserializeAttachment();
     return (_a = deserialized == null ? void 0 : deserialized.state) != null ? _a : null;
   }
   getSessionId(webSocket) {

package/dist/index.mjs

@@ -183,6 +183,10 @@ var CloudflareWebSocket = class extends AbstractWebSocket {
     if (!state) throw new Error("Could not get websocket state");
     return state;
   }
+  set state(state) {
+    const deserialized = this.webSocket.deserializeAttachment();
+    this.webSocket.serializeAttachment(__spreadProps(__spreadValues({}, deserialized), { state }));
+  }
   constructor(webSocket, config) {
     const { room } = config;
     super(webSocket, config);
@@ -309,7 +313,7 @@ var PersistanceCloudflare = class extends AbstractPersistance {
 };
 
 // src/constants.ts
-var DEFAULT_REGISTRATION_MODE = "attached";
+var DEFAULT_REGISTRATION_MODE = "detached";
 
 // src/CloudflarePlatform.ts
 var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
@@ -346,7 +350,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
   }
   getSerializedState(webSocket) {
     var _a;
-    const deserialized = webSocket.webSocket.deserializeAttachment();
+    const deserialized = webSocket.deserializeAttachment();
     return (_a = deserialized == null ? void 0 : deserialized.state) != null ? _a : null;
   }
   getSessionId(webSocket) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pluv/platform-cloudflare",
-  "version": "0.21.1",
+  "version": "0.23.0",
   "description": "@pluv/io adapter for cloudflare workers",
   "author": "leedavidcs",
   "license": "MIT",
@@ -18,16 +18,16 @@
   },
   "dependencies": {
     "path-to-regexp": "^7.1.0",
-    "@pluv/io": "^0.21.1",
-    "@pluv/types": "^0.21.1"
+    "@pluv/io": "^0.23.0",
+    "@pluv/types": "^0.23.0"
   },
   "devDependencies": {
-    "@cloudflare/workers-types": "^4.20240806.0",
+    "@cloudflare/workers-types": "^4.20240815.0",
     "eslint": "^8.57.0",
     "tsup": "^8.2.4",
     "typescript": "^5.5.4",
-    "@pluv/tsconfig": "^0.21.1",
-    "eslint-config-pluv": "^0.21.1"
+    "@pluv/tsconfig": "^0.23.0",
+    "eslint-config-pluv": "^0.23.0"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",

package/src/CloudflarePlatform.ts

@@ -68,8 +68,8 @@ export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends A
         return timestamp?.getTime() ?? null;
     }
 
-    public getSerializedState(webSocket: CloudflareWebSocket): WebSocketSerializedState | null {
-        const deserialized = webSocket.webSocket.deserializeAttachment();
+    public getSerializedState(webSocket: WebSocket): WebSocketSerializedState | null {
+        const deserialized = webSocket.deserializeAttachment();
 
         return deserialized?.state ?? null;
     }

package/src/CloudflareWebSocket.ts

@@ -46,6 +46,12 @@ export class CloudflareWebSocket extends AbstractWebSocket<WebSocket> {
         return state;
     }
 
+    public set state(state: WebSocketSerializedState) {
+        const deserialized = this.webSocket.deserializeAttachment();
+
+        this.webSocket.serializeAttachment({ ...deserialized, state });
+    }
+
     constructor(webSocket: WebSocket, config: CloudflareWebSocketConfig) {
         const { room } = config;
 

package/src/constants.ts

@@ -1,3 +1,3 @@
 import type { WebSocketRegistrationMode } from "@pluv/io";
 
-export const DEFAULT_REGISTRATION_MODE: WebSocketRegistrationMode = "attached";
+export const DEFAULT_REGISTRATION_MODE: WebSocketRegistrationMode = "detached";

package/src/createPluvHandler.ts

@@ -70,7 +70,6 @@ export const createPluvHandler = <TPluvServer extends PluvServer<CloudflarePlatf
             if (io._registrationMode !== "detached") return;
 
             const handler = this._room.onError(ws);
-
             const eventError = error instanceof Error ? error : new Error("Internal Error");
 
             handler({ error: eventError, message: eventError.message });
@@ -92,7 +91,6 @@ export const createPluvHandler = <TPluvServer extends PluvServer<CloudflarePlatf
             }
 
             const { 0: client, 1: server } = new WebSocketPair();
-
             const token = new URL(request.url).searchParams.get("token");
 
             await this._room.register(server, { token });

package/src/platformCloudflare.ts

@@ -1,6 +1,8 @@
 import type { CloudflarePlatformConfig } from "./CloudflarePlatform";
 import { CloudflarePlatform } from "./CloudflarePlatform";
 
-export const platformCloudflare = <TEnv extends Record<string, any> = {}>(config: CloudflarePlatformConfig<TEnv> = {}): CloudflarePlatform<TEnv> => {
+export const platformCloudflare = <TEnv extends Record<string, any> = {}>(
+    config: CloudflarePlatformConfig<TEnv> = {},
+): CloudflarePlatform<TEnv> => {
     return new CloudflarePlatform<TEnv>(config);
 };