@pluv/platform-cloudflare 0.24.0 → 0.25.0

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @pluv/platform-cloudflare@0.24.0 build /home/runner/work/pluv/pluv/packages/platform-cloudflare
+> @pluv/platform-cloudflare@0.25.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
-ESM dist/index.mjs 14.43 KB
-ESM ⚡️ Build success in 82ms
-CJS dist/index.js 15.47 KB
-CJS ⚡️ Build success in 88ms
+CJS dist/index.js 12.78 KB
+CJS ⚡️ Build success in 38ms
+ESM dist/index.mjs 11.68 KB
+ESM ⚡️ Build success in 53ms
 DTS Build start
-DTS ⚡️ Build success in 3446ms
+DTS ⚡️ Build success in 705ms
 DTS dist/index.d.mts 4.15 KB
 DTS dist/index.d.ts  4.15 KB

package/CHANGELOG.md

@@ -1,5 +1,56 @@
 # @pluv/platform-cloudflare
 
+## 0.25.0
+
+### Minor Changes
+
+- 9db06ba: **BREAKING **
+
+  Fixed typos `persistance` to `persistence`.
+
+  This does mean that all properties referencing `persistance` will need to be fixed. Examples below:
+
+  ```bash
+  # Re-install @pluv/persistence-redis
+  pnpm uninstall @pluv/persistance-redis
+  pnpm install @pluv/persistence-redis
+  ```
+
+  ```ts
+  // Before
+  createIO({
+    platform: platformNode({
+      persistance: new PersistanceRedis(/* ... */),
+    }),
+  });
+
+  // After
+  createIO({
+    platform: platformNode({
+      persistence: new PersistenceRedis(/* ... */),
+    }),
+  });
+  ```
+
+  `@pluv/persistance-redis` has been deprecated for `@pluv/persistence-redis`.
+
+### Patch Changes
+
+- Updated dependencies [9db06ba]
+- Updated dependencies [4e078ca]
+- Updated dependencies [f556d30]
+- Updated dependencies [9db06ba]
+  - @pluv/persistence-cloudflare-transactional-storage@0.25.0
+  - @pluv/io@0.25.0
+  - @pluv/types@0.25.0
+
+## 0.24.1
+
+### Patch Changes
+
+- @pluv/io@0.24.1
+- @pluv/types@0.24.1
+
 ## 0.24.0
 
 ### Patch Changes

package/dist/index.js

@@ -72,14 +72,14 @@ var createPluvHandler = (config) => {
     }
     webSocketClose(ws, code, reason, wasClean) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onClose(ws);
         yield handler2({ code, reason });
       });
     }
     webSocketError(ws, error) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onError(ws);
         const eventError = error instanceof Error ? error : new Error("Internal Error");
         yield handler2({ error: eventError, message: eventError.message });
@@ -87,7 +87,7 @@ var createPluvHandler = (config) => {
     }
     webSocketMessage(ws, message) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onMessage(ws);
         yield handler2({ data: message });
       });
@@ -184,7 +184,8 @@ var createPluvHandler = (config) => {
 };
 
 // src/CloudflarePlatform.ts
-var import_io3 = require("@pluv/io");
+var import_io2 = require("@pluv/io");
+var import_persistence_cloudflare_transactional_storage = require("@pluv/persistence-cloudflare-transactional-storage");
 
 // src/CloudflareWebSocket.ts
 var import_io = require("@pluv/io");
@@ -250,108 +251,14 @@ var CloudflareWebSocket = class extends import_io.AbstractWebSocket {
   }
 };
 
-// src/PersistanceCloudflare.ts
-var import_io2 = require("@pluv/io");
-
-// src/utils/partitionByLength.ts
-var partitionByLength = (arr, length) => {
-  if (!arr.length) return [];
-  const head = arr.slice(0, length);
-  const tail = arr.slice(length);
-  return [head, ...partitionByLength(tail, length)];
-};
-
-// src/PersistanceCloudflare.ts
-var CLOUDFLARE_DELETE_BATCH_LIMIT = 128;
-var STORAGE_PREFIX = "$PLUV_STORAGE;";
-var USER_PREFIX = "$PLUV_USER";
-var PersistanceCloudflare = class extends import_io2.AbstractPersistance {
-  constructor(config) {
-    super();
-    const { state } = config;
-    this._state = state;
-  }
-  addUser(room, connectionId, user) {
-    return __async(this, null, function* () {
-      yield this._state.storage.put(this._getUserKey(room, connectionId), user);
-    });
-  }
-  deleteStorageState(room) {
-    return __async(this, null, function* () {
-      yield this._state.storage.delete(this._getStorageKey(room));
-    });
-  }
-  deleteUser(room, connectionId) {
-    return __async(this, null, function* () {
-      yield this._state.storage.delete(this._getUserKey(room, connectionId));
-    });
-  }
-  deleteUsers(room) {
-    return __async(this, null, function* () {
-      const map = yield this._state.storage.list({
-        allowConcurrency: true,
-        noCache: true,
-        prefix: USER_PREFIX
-      });
-      const partitions = partitionByLength(Array.from(map.keys()), CLOUDFLARE_DELETE_BATCH_LIMIT);
-      yield this._state.storage.transaction((tx) => __async(this, null, function* () {
-        yield partitions.reduce((promise, partition) => __async(this, null, function* () {
-          return yield promise.then(() => __async(this, null, function* () {
-            yield tx.delete(partition);
-          }));
-        }), Promise.resolve());
-      }));
-    });
-  }
-  getSize(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.list({ prefix: USER_PREFIX });
-      return storage.size;
-    });
-  }
-  getStorageState(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.get(this._getStorageKey(room));
-      return storage != null ? storage : null;
-    });
-  }
-  getUser(room, connectionId) {
-    return __async(this, null, function* () {
-      const user = yield this._state.storage.get(this._getUserKey(room, connectionId));
-      return user != null ? user : null;
-    });
-  }
-  getUsers(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.list({
-        prefix: USER_PREFIX
-      });
-      return Array.from(storage.values());
-    });
-  }
-  setStorageState(room, state) {
-    return __async(this, null, function* () {
-      yield this._state.storage.put(this._getStorageKey(room), state, {
-        allowConcurrency: true
-      });
-    });
-  }
-  _getStorageKey(room) {
-    return `${STORAGE_PREFIX}::${room}`;
-  }
-  _getUserKey(room, connectionId) {
-    return `${USER_PREFIX}::${room}::${connectionId}`;
-  }
-};
-
 // src/constants.ts
 var DEFAULT_REGISTRATION_MODE = "detached";
 
 // src/CloudflarePlatform.ts
-var CloudflarePlatform = class _CloudflarePlatform extends import_io3.AbstractPlatform {
+var CloudflarePlatform = class _CloudflarePlatform extends import_io2.AbstractPlatform {
   constructor(config = {}) {
     var _a;
-    super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistance: new PersistanceCloudflare(config.context) } : {}));
+    super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistence: new import_persistence_cloudflare_transactional_storage.PersistenceCloudflareTransactionalStorage(config.context) } : {}));
     this._registrationMode = (_a = config.mode) != null ? _a : DEFAULT_REGISTRATION_MODE;
     const detachedState = this._getDetachedState();
     if (!detachedState) return;
@@ -371,7 +278,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends import_io3.AbstractPl
   }
   convertWebSocket(webSocket, config) {
     const { room } = config;
-    return new CloudflareWebSocket(webSocket, { persistance: this.persistance, room });
+    return new CloudflareWebSocket(webSocket, { persistence: this.persistence, room });
   }
   getLastPing(webSocket) {
     var _a;
@@ -406,7 +313,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends import_io3.AbstractPl
     }
     return new _CloudflarePlatform(__spreadProps(__spreadValues({
       mode: this._registrationMode,
-      persistance: this.persistance,
+      persistence: this.persistence,
       pubSub: this.pubSub
     }, config), {
       context: { env: context.env, state: context.state }

package/dist/index.mjs

@@ -48,14 +48,14 @@ var createPluvHandler = (config) => {
     }
     webSocketClose(ws, code, reason, wasClean) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onClose(ws);
         yield handler2({ code, reason });
       });
     }
     webSocketError(ws, error) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onError(ws);
         const eventError = error instanceof Error ? error : new Error("Internal Error");
         yield handler2({ error: eventError, message: eventError.message });
@@ -63,7 +63,7 @@ var createPluvHandler = (config) => {
     }
     webSocketMessage(ws, message) {
       return __async(this, null, function* () {
-        if (io._registrationMode !== "detached") return;
+        if (io._defs.platform._registrationMode !== "detached") return;
         const handler2 = this._room.onMessage(ws);
         yield handler2({ data: message });
       });
@@ -161,6 +161,7 @@ var createPluvHandler = (config) => {
 
 // src/CloudflarePlatform.ts
 import { AbstractPlatform } from "@pluv/io";
+import { PersistenceCloudflareTransactionalStorage } from "@pluv/persistence-cloudflare-transactional-storage";
 
 // src/CloudflareWebSocket.ts
 import { AbstractWebSocket } from "@pluv/io";
@@ -226,100 +227,6 @@ var CloudflareWebSocket = class extends AbstractWebSocket {
   }
 };
 
-// src/PersistanceCloudflare.ts
-import { AbstractPersistance } from "@pluv/io";
-
-// src/utils/partitionByLength.ts
-var partitionByLength = (arr, length) => {
-  if (!arr.length) return [];
-  const head = arr.slice(0, length);
-  const tail = arr.slice(length);
-  return [head, ...partitionByLength(tail, length)];
-};
-
-// src/PersistanceCloudflare.ts
-var CLOUDFLARE_DELETE_BATCH_LIMIT = 128;
-var STORAGE_PREFIX = "$PLUV_STORAGE;";
-var USER_PREFIX = "$PLUV_USER";
-var PersistanceCloudflare = class extends AbstractPersistance {
-  constructor(config) {
-    super();
-    const { state } = config;
-    this._state = state;
-  }
-  addUser(room, connectionId, user) {
-    return __async(this, null, function* () {
-      yield this._state.storage.put(this._getUserKey(room, connectionId), user);
-    });
-  }
-  deleteStorageState(room) {
-    return __async(this, null, function* () {
-      yield this._state.storage.delete(this._getStorageKey(room));
-    });
-  }
-  deleteUser(room, connectionId) {
-    return __async(this, null, function* () {
-      yield this._state.storage.delete(this._getUserKey(room, connectionId));
-    });
-  }
-  deleteUsers(room) {
-    return __async(this, null, function* () {
-      const map = yield this._state.storage.list({
-        allowConcurrency: true,
-        noCache: true,
-        prefix: USER_PREFIX
-      });
-      const partitions = partitionByLength(Array.from(map.keys()), CLOUDFLARE_DELETE_BATCH_LIMIT);
-      yield this._state.storage.transaction((tx) => __async(this, null, function* () {
-        yield partitions.reduce((promise, partition) => __async(this, null, function* () {
-          return yield promise.then(() => __async(this, null, function* () {
-            yield tx.delete(partition);
-          }));
-        }), Promise.resolve());
-      }));
-    });
-  }
-  getSize(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.list({ prefix: USER_PREFIX });
-      return storage.size;
-    });
-  }
-  getStorageState(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.get(this._getStorageKey(room));
-      return storage != null ? storage : null;
-    });
-  }
-  getUser(room, connectionId) {
-    return __async(this, null, function* () {
-      const user = yield this._state.storage.get(this._getUserKey(room, connectionId));
-      return user != null ? user : null;
-    });
-  }
-  getUsers(room) {
-    return __async(this, null, function* () {
-      const storage = yield this._state.storage.list({
-        prefix: USER_PREFIX
-      });
-      return Array.from(storage.values());
-    });
-  }
-  setStorageState(room, state) {
-    return __async(this, null, function* () {
-      yield this._state.storage.put(this._getStorageKey(room), state, {
-        allowConcurrency: true
-      });
-    });
-  }
-  _getStorageKey(room) {
-    return `${STORAGE_PREFIX}::${room}`;
-  }
-  _getUserKey(room, connectionId) {
-    return `${USER_PREFIX}::${room}::${connectionId}`;
-  }
-};
-
 // src/constants.ts
 var DEFAULT_REGISTRATION_MODE = "detached";
 
@@ -327,7 +234,7 @@ var DEFAULT_REGISTRATION_MODE = "detached";
 var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
   constructor(config = {}) {
     var _a;
-    super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistance: new PersistanceCloudflare(config.context) } : {}));
+    super(__spreadValues(__spreadValues({}, config), config.context && config.mode === "detached" ? { persistence: new PersistenceCloudflareTransactionalStorage(config.context) } : {}));
     this._registrationMode = (_a = config.mode) != null ? _a : DEFAULT_REGISTRATION_MODE;
     const detachedState = this._getDetachedState();
     if (!detachedState) return;
@@ -347,7 +254,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
   }
   convertWebSocket(webSocket, config) {
     const { room } = config;
-    return new CloudflareWebSocket(webSocket, { persistance: this.persistance, room });
+    return new CloudflareWebSocket(webSocket, { persistence: this.persistence, room });
   }
   getLastPing(webSocket) {
     var _a;
@@ -382,7 +289,7 @@ var CloudflarePlatform = class _CloudflarePlatform extends AbstractPlatform {
     }
     return new _CloudflarePlatform(__spreadProps(__spreadValues({
       mode: this._registrationMode,
-      persistance: this.persistance,
+      persistence: this.persistence,
       pubSub: this.pubSub
     }, config), {
       context: { env: context.env, state: context.state }

package/package.json

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

package/src/CloudflarePlatform.ts

@@ -5,8 +5,8 @@ import type {
     WebSocketSerializedState,
 } from "@pluv/io";
 import { AbstractPlatform } from "@pluv/io";
+import { PersistenceCloudflareTransactionalStorage } from "@pluv/persistence-cloudflare-transactional-storage";
 import { CloudflareWebSocket } from "./CloudflareWebSocket";
-import { PersistanceCloudflare } from "./PersistanceCloudflare";
 import { DEFAULT_REGISTRATION_MODE } from "./constants";
 
 export type CloudflarePlatformConfig<TEnv extends Record<string, any> = {}> = AbstractPlatformConfig<
@@ -25,7 +25,7 @@ export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends A
         super({
             ...config,
             ...(config.context && config.mode === "detached"
-                ? { persistance: new PersistanceCloudflare(config.context) }
+                ? { persistence: new PersistenceCloudflareTransactionalStorage(config.context) }
                 : {}),
         });
 
@@ -55,7 +55,7 @@ export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends A
     public convertWebSocket(webSocket: WebSocket, config: ConvertWebSocketConfig): CloudflareWebSocket {
         const { room } = config;
 
-        return new CloudflareWebSocket(webSocket, { persistance: this.persistance, room });
+        return new CloudflareWebSocket(webSocket, { persistence: this.persistence, room });
     }
 
     public getLastPing(webSocket: CloudflareWebSocket): number | null {
@@ -100,7 +100,7 @@ export class CloudflarePlatform<TEnv extends Record<string, any> = {}> extends A
 
         return new CloudflarePlatform<TEnv>({
             mode: this._registrationMode,
-            persistance: this.persistance,
+            persistence: this.persistence,
             pubSub: this.pubSub,
             ...config,
             context: { env: context.env, state: context.state },

package/src/createPluvHandler.ts

@@ -59,7 +59,7 @@ export const createPluvHandler = <TPluvServer extends PluvServer<CloudflarePlatf
         }
 
         public async webSocketClose(ws: WebSocket, code: number, reason: string, wasClean: boolean): Promise<void> {
-            if (io._registrationMode !== "detached") return;
+            if (io._defs.platform._registrationMode !== "detached") return;
 
             const handler = this._room.onClose(ws);
 
@@ -67,7 +67,7 @@ export const createPluvHandler = <TPluvServer extends PluvServer<CloudflarePlatf
         }
 
         public async webSocketError(ws: WebSocket, error: unknown): Promise<void> {
-            if (io._registrationMode !== "detached") return;
+            if (io._defs.platform._registrationMode !== "detached") return;
 
             const handler = this._room.onError(ws);
             const eventError = error instanceof Error ? error : new Error("Internal Error");
@@ -76,7 +76,7 @@ export const createPluvHandler = <TPluvServer extends PluvServer<CloudflarePlatf
         }
 
         public async webSocketMessage(ws: WebSocket, message: string | ArrayBuffer): Promise<void> {
-            if (io._registrationMode !== "detached") return;
+            if (io._defs.platform._registrationMode !== "detached") return;
 
             const handler = this._room.onMessage(ws);
 

package/src/PersistanceCloudflare.ts

@@ -1,100 +0,0 @@
-import { AbstractPersistance } from "@pluv/io";
-import type { JsonObject } from "@pluv/types";
-import { partitionByLength } from "./utils";
-
-/**
- * !HACK
- * @description The max amount of keys a Cloudflare transactional storage may delete at once
- * @see https://developers.cloudflare.com/durable-objects/api/transactional-storage-api/#delete
- * @date July 8, 2024
- */
-const CLOUDFLARE_DELETE_BATCH_LIMIT = 128;
-const STORAGE_PREFIX = "$PLUV_STORAGE;";
-const USER_PREFIX = "$PLUV_USER";
-
-export interface PersistanceCloudflareConfig<TEnv extends Record<string, any> = {}> {
-    env: TEnv;
-    state: DurableObjectState;
-}
-
-export class PersistanceCloudflare<TEnv extends Record<string, any> = {}> extends AbstractPersistance {
-    private _state: DurableObjectState;
-
-    constructor(config: PersistanceCloudflareConfig<TEnv>) {
-        super();
-
-        const { state } = config;
-
-        this._state = state;
-    }
-
-    public async addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void> {
-        await this._state.storage.put(this._getUserKey(room, connectionId), user);
-    }
-
-    public async deleteStorageState(room: string): Promise<void> {
-        await this._state.storage.delete(this._getStorageKey(room));
-    }
-
-    public async deleteUser(room: string, connectionId: string): Promise<void> {
-        await this._state.storage.delete(this._getUserKey(room, connectionId));
-    }
-
-    public async deleteUsers(room: string): Promise<void> {
-        const map = await this._state.storage.list({
-            allowConcurrency: true,
-            noCache: true,
-            prefix: USER_PREFIX,
-        });
-
-        const partitions = partitionByLength(Array.from(map.keys()), CLOUDFLARE_DELETE_BATCH_LIMIT);
-
-        await this._state.storage.transaction(async (tx) => {
-            await partitions.reduce(async (promise, partition) => {
-                return await promise.then(async () => {
-                    await tx.delete(partition as string[]);
-                });
-            }, Promise.resolve());
-        });
-    }
-
-    public async getSize(room: string): Promise<number> {
-        const storage = await this._state.storage.list({ prefix: USER_PREFIX });
-
-        return storage.size;
-    }
-
-    public async getStorageState(room: string): Promise<string | null> {
-        const storage = await this._state.storage.get<string>(this._getStorageKey(room));
-
-        return storage ?? null;
-    }
-
-    public async getUser(room: string, connectionId: string): Promise<JsonObject | null> {
-        const user = await this._state.storage.get<JsonObject | null>(this._getUserKey(room, connectionId));
-
-        return user ?? null;
-    }
-
-    public async getUsers(room: string): Promise<readonly (JsonObject | null)[]> {
-        const storage = await this._state.storage.list({
-            prefix: USER_PREFIX,
-        });
-
-        return Array.from(storage.values()) as (JsonObject | null)[];
-    }
-
-    public async setStorageState(room: string, state: string): Promise<void> {
-        await this._state.storage.put(this._getStorageKey(room), state, {
-            allowConcurrency: true,
-        });
-    }
-
-    private _getStorageKey(room: string): string {
-        return `${STORAGE_PREFIX}::${room}`;
-    }
-
-    private _getUserKey(room: string, connectionId: string): string {
-        return `${USER_PREFIX}::${room}::${connectionId}`;
-    }
-}

package/src/utils/index.ts

@@ -1 +0,0 @@
-export { partitionByLength } from "./partitionByLength";

package/src/utils/partitionByLength.ts

@@ -1,8 +0,0 @@
-export const partitionByLength = <T>(arr: readonly T[] | T[], length: number): readonly (readonly T[])[] => {
-    if (!arr.length) return [];
-
-    const head = arr.slice(0, length);
-    const tail = arr.slice(length);
-
-    return [head, ...partitionByLength(tail, length)];
-};