@pluv/persistence-redis 0.25.0

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+    root: true,
+    extends: ["pluv"],
+};

package/.turbo/turbo-build.log

@@ -0,0 +1,18 @@
+
+> @pluv/persistence-redis@0.25.0 build /home/runner/work/pluv/pluv/packages/persistence-redis
+> tsup src/index.ts --format esm,cjs --dts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.2.4
+CLI Target: es6
+ESM Build start
+CJS Build start
+CJS dist/index.js 4.37 KB
+CJS ⚡️ Build success in 68ms
+ESM dist/index.mjs 3.36 KB
+ESM ⚡️ Build success in 68ms
+DTS Build start
+DTS ⚡️ Build success in 3673ms
+DTS dist/index.d.mts 1.08 KB
+DTS dist/index.d.ts  1.08 KB

package/CHANGELOG.md

@@ -0,0 +1,43 @@
+# @pluv/persistence-redis
+
+## 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 [4e078ca]
+- Updated dependencies [f556d30]
+- Updated dependencies [9db06ba]
+  - @pluv/io@0.25.0
+  - @pluv/types@0.25.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Shoubhit Dash
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,18 @@
+## `@pluv/persistence-redis`
+
+> Crdt storage persistence for [@pluv/io](https://www.npmjs.com/package/@pluv/io) rooms on distributed systems. Available for [Node.js](https://nodejs.org/) only.
+
+**👉 See full documentation on [pluv.io](https://pluv.io/docs/introduction). 👈**
+
+## Installation
+
+```bash
+# npm
+npm install @pluv/persistence-redis ioredis
+
+# yarn
+yarn add @pluv/persistence-redis ioredis
+
+# pnpm
+pnpm add @pluv/persistence-redis ioredis
+```

package/dist/index.d.mts

@@ -0,0 +1,27 @@
+import { AbstractPersistence } from '@pluv/io';
+import { JsonObject } from '@pluv/types';
+import { Cluster, Redis } from 'ioredis';
+
+type RedisClient = Cluster | Redis;
+interface PersistenceRedisOptions {
+    client: RedisClient;
+}
+declare class PersistenceRedis extends AbstractPersistence {
+    private _client;
+    constructor(options: PersistenceRedisOptions);
+    addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void>;
+    deleteStorageState(room: string): Promise<void>;
+    deleteUser(room: string, connectionId: string): Promise<void>;
+    deleteUsers(room: string): Promise<void>;
+    getSize(room: string): Promise<number>;
+    getStorageState(room: string): Promise<string | null>;
+    setStorageState(room: string, state: string): Promise<void>;
+    getUser(room: string, connectionId: string): Promise<JsonObject | null>;
+    getUsers(room: string): Promise<readonly (JsonObject | null)[]>;
+    private _getClusterKey;
+    private _getRoomStorageKey;
+    private _getRoomUsersKey;
+    private _getRoomUsersUserKey;
+}
+
+export { PersistenceRedis, type RedisClient };

package/dist/index.d.ts

@@ -0,0 +1,27 @@
+import { AbstractPersistence } from '@pluv/io';
+import { JsonObject } from '@pluv/types';
+import { Cluster, Redis } from 'ioredis';
+
+type RedisClient = Cluster | Redis;
+interface PersistenceRedisOptions {
+    client: RedisClient;
+}
+declare class PersistenceRedis extends AbstractPersistence {
+    private _client;
+    constructor(options: PersistenceRedisOptions);
+    addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void>;
+    deleteStorageState(room: string): Promise<void>;
+    deleteUser(room: string, connectionId: string): Promise<void>;
+    deleteUsers(room: string): Promise<void>;
+    getSize(room: string): Promise<number>;
+    getStorageState(room: string): Promise<string | null>;
+    setStorageState(room: string, state: string): Promise<void>;
+    getUser(room: string, connectionId: string): Promise<JsonObject | null>;
+    getUsers(room: string): Promise<readonly (JsonObject | null)[]>;
+    private _getClusterKey;
+    private _getRoomStorageKey;
+    private _getRoomUsersKey;
+    private _getRoomUsersUserKey;
+}
+
+export { PersistenceRedis, type RedisClient };

package/dist/index.js

@@ -0,0 +1,131 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  PersistenceRedis: () => PersistenceRedis
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/PersistenceRedis.ts
+var import_io = require("@pluv/io");
+var DELIMITER = ":::";
+var HASH_TAG = "{PluvPersistenceRedis}";
+var PersistenceRedis = class extends import_io.AbstractPersistence {
+  constructor(options) {
+    super();
+    const { client } = options;
+    this._client = client;
+  }
+  addUser(room, connectionId, user) {
+    return __async(this, null, function* () {
+      yield this._client.multi().sadd(this._getRoomUsersKey(room), connectionId).set(this._getRoomUsersUserKey(room, connectionId), JSON.stringify(user)).exec();
+    });
+  }
+  deleteStorageState(room) {
+    return __async(this, null, function* () {
+      yield this._client.del(this._getRoomStorageKey(room));
+    });
+  }
+  deleteUser(room, connectionId) {
+    return __async(this, null, function* () {
+      const size = yield this.getSize(room);
+      let multi = this._client.multi().srem(this._getRoomUsersKey(room), connectionId).del(this._getRoomUsersUserKey(room, connectionId));
+      if (size === 1) {
+        multi = multi.del(this._getRoomStorageKey(room)).del(this._getRoomUsersKey(room));
+      }
+      yield multi.exec();
+    });
+  }
+  deleteUsers(room) {
+    return __async(this, null, function* () {
+      const members = yield this._client.smembers(this._getRoomUsersKey(room));
+      yield members.reduce(
+        (commands, connectionId) => {
+          return commands.del(this._getRoomUsersUserKey(room, connectionId));
+        },
+        this._client.multi().del(this._getRoomUsersKey(room))
+      ).exec();
+    });
+  }
+  getSize(room) {
+    return __async(this, null, function* () {
+      return yield this._client.scard(this._getRoomUsersKey(room));
+    });
+  }
+  getStorageState(room) {
+    return __async(this, null, function* () {
+      return yield this._client.get(this._getRoomStorageKey(room));
+    });
+  }
+  setStorageState(room, state) {
+    return __async(this, null, function* () {
+      yield this._client.set(this._getRoomStorageKey(room), state);
+    });
+  }
+  getUser(room, connectionId) {
+    return __async(this, null, function* () {
+      const data = yield this._client.get(this._getRoomUsersUserKey(room, connectionId));
+      return !data ? null : JSON.parse(data);
+    });
+  }
+  getUsers(room) {
+    return __async(this, null, function* () {
+      const members = yield this._client.smembers(this._getRoomUsersKey(room));
+      return yield Promise.all(members.map((connectionId) => this.getUser(room, connectionId)));
+    });
+  }
+  _getClusterKey(key) {
+    return `${HASH_TAG}${key}`;
+  }
+  _getRoomStorageKey(room) {
+    return this._getClusterKey(`room_storage${DELIMITER}${room}`);
+  }
+  _getRoomUsersKey(room) {
+    return this._getClusterKey(`room_users${DELIMITER}${room}`);
+  }
+  _getRoomUsersUserKey(room, connectionId) {
+    return this._getClusterKey(`${this._getRoomUsersKey(room)}${DELIMITER}${connectionId}`);
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PersistenceRedis
+});

package/dist/index.mjs

@@ -0,0 +1,105 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/PersistenceRedis.ts
+import { AbstractPersistence } from "@pluv/io";
+var DELIMITER = ":::";
+var HASH_TAG = "{PluvPersistenceRedis}";
+var PersistenceRedis = class extends AbstractPersistence {
+  constructor(options) {
+    super();
+    const { client } = options;
+    this._client = client;
+  }
+  addUser(room, connectionId, user) {
+    return __async(this, null, function* () {
+      yield this._client.multi().sadd(this._getRoomUsersKey(room), connectionId).set(this._getRoomUsersUserKey(room, connectionId), JSON.stringify(user)).exec();
+    });
+  }
+  deleteStorageState(room) {
+    return __async(this, null, function* () {
+      yield this._client.del(this._getRoomStorageKey(room));
+    });
+  }
+  deleteUser(room, connectionId) {
+    return __async(this, null, function* () {
+      const size = yield this.getSize(room);
+      let multi = this._client.multi().srem(this._getRoomUsersKey(room), connectionId).del(this._getRoomUsersUserKey(room, connectionId));
+      if (size === 1) {
+        multi = multi.del(this._getRoomStorageKey(room)).del(this._getRoomUsersKey(room));
+      }
+      yield multi.exec();
+    });
+  }
+  deleteUsers(room) {
+    return __async(this, null, function* () {
+      const members = yield this._client.smembers(this._getRoomUsersKey(room));
+      yield members.reduce(
+        (commands, connectionId) => {
+          return commands.del(this._getRoomUsersUserKey(room, connectionId));
+        },
+        this._client.multi().del(this._getRoomUsersKey(room))
+      ).exec();
+    });
+  }
+  getSize(room) {
+    return __async(this, null, function* () {
+      return yield this._client.scard(this._getRoomUsersKey(room));
+    });
+  }
+  getStorageState(room) {
+    return __async(this, null, function* () {
+      return yield this._client.get(this._getRoomStorageKey(room));
+    });
+  }
+  setStorageState(room, state) {
+    return __async(this, null, function* () {
+      yield this._client.set(this._getRoomStorageKey(room), state);
+    });
+  }
+  getUser(room, connectionId) {
+    return __async(this, null, function* () {
+      const data = yield this._client.get(this._getRoomUsersUserKey(room, connectionId));
+      return !data ? null : JSON.parse(data);
+    });
+  }
+  getUsers(room) {
+    return __async(this, null, function* () {
+      const members = yield this._client.smembers(this._getRoomUsersKey(room));
+      return yield Promise.all(members.map((connectionId) => this.getUser(room, connectionId)));
+    });
+  }
+  _getClusterKey(key) {
+    return `${HASH_TAG}${key}`;
+  }
+  _getRoomStorageKey(room) {
+    return this._getClusterKey(`room_storage${DELIMITER}${room}`);
+  }
+  _getRoomUsersKey(room) {
+    return this._getClusterKey(`room_users${DELIMITER}${room}`);
+  }
+  _getRoomUsersUserKey(room, connectionId) {
+    return this._getClusterKey(`${this._getRoomUsersKey(room)}${DELIMITER}${connectionId}`);
+  }
+};
+export {
+  PersistenceRedis
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@pluv/persistence-redis",
+  "version": "0.25.0",
+  "description": "@pluv/io crdt storage persistence for node.js",
+  "author": "leedavidcs",
+  "license": "MIT",
+  "homepage": "https://github.com/pluv-io/pluv",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pluv-io/pluv.git",
+    "directory": "packages/persistence-redis"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@types/node": "^22.5.0",
+    "@pluv/io": "^0.25.0",
+    "@pluv/types": "^0.25.0"
+  },
+  "peerDependencies": {
+    "ioredis": "^5.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.0",
+    "ioredis": "^5.4.1",
+    "tsup": "^8.2.4",
+    "typescript": "^5.5.4",
+    "@pluv/tsconfig": "^0.25.0",
+    "eslint-config-pluv": "^0.25.0"
+  },
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "lint": "eslint src/**/*.ts* --fix",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"
+  }
+}

package/src/PersistenceRedis.ts

@@ -0,0 +1,104 @@
+import { AbstractPersistence } from "@pluv/io";
+import type { JsonObject } from "@pluv/types";
+import type { Cluster, Redis } from "ioredis";
+
+const DELIMITER = ":::";
+const HASH_TAG = "{PluvPersistenceRedis}";
+
+export type RedisClient = Cluster | Redis;
+
+export interface PersistenceRedisOptions {
+    client: RedisClient;
+}
+
+export class PersistenceRedis extends AbstractPersistence {
+    private _client: RedisClient;
+
+    constructor(options: PersistenceRedisOptions) {
+        super();
+
+        const { client } = options;
+
+        this._client = client;
+    }
+
+    public async addUser(room: string, connectionId: string, user: JsonObject | null): Promise<void> {
+        await this._client
+            .multi()
+            .sadd(this._getRoomUsersKey(room), connectionId)
+            .set(this._getRoomUsersUserKey(room, connectionId), JSON.stringify(user))
+            .exec();
+    }
+
+    public async deleteStorageState(room: string): Promise<void> {
+        await this._client.del(this._getRoomStorageKey(room));
+    }
+
+    public async deleteUser(room: string, connectionId: string): Promise<void> {
+        const size = await this.getSize(room);
+
+        let multi = this._client
+            .multi()
+            .srem(this._getRoomUsersKey(room), connectionId)
+            .del(this._getRoomUsersUserKey(room, connectionId));
+
+        if (size === 1) {
+            multi = multi.del(this._getRoomStorageKey(room)).del(this._getRoomUsersKey(room));
+        }
+
+        await multi.exec();
+    }
+
+    public async deleteUsers(room: string): Promise<void> {
+        const members = await this._client.smembers(this._getRoomUsersKey(room));
+
+        await members
+            .reduce(
+                (commands, connectionId) => {
+                    return commands.del(this._getRoomUsersUserKey(room, connectionId));
+                },
+                this._client.multi().del(this._getRoomUsersKey(room)),
+            )
+            .exec();
+    }
+
+    public async getSize(room: string): Promise<number> {
+        return await this._client.scard(this._getRoomUsersKey(room));
+    }
+
+    public async getStorageState(room: string): Promise<string | null> {
+        return await this._client.get(this._getRoomStorageKey(room));
+    }
+
+    public async setStorageState(room: string, state: string): Promise<void> {
+        await this._client.set(this._getRoomStorageKey(room), state);
+    }
+
+    public async getUser(room: string, connectionId: string): Promise<JsonObject | null> {
+        const data = await this._client.get(this._getRoomUsersUserKey(room, connectionId));
+
+        return !data ? null : JSON.parse(data);
+    }
+
+    public async getUsers(room: string): Promise<readonly (JsonObject | null)[]> {
+        const members = await this._client.smembers(this._getRoomUsersKey(room));
+
+        return await Promise.all(members.map((connectionId) => this.getUser(room, connectionId)));
+    }
+
+    private _getClusterKey(key: string): string {
+        return `${HASH_TAG}${key}`;
+    }
+
+    private _getRoomStorageKey(room: string): string {
+        return this._getClusterKey(`room_storage${DELIMITER}${room}`);
+    }
+
+    private _getRoomUsersKey(room: string): string {
+        return this._getClusterKey(`room_users${DELIMITER}${room}`);
+    }
+
+    private _getRoomUsersUserKey(room: string, connectionId: string): string {
+        return this._getClusterKey(`${this._getRoomUsersKey(room)}${DELIMITER}${connectionId}`);
+    }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export type { RedisClient } from "./PersistenceRedis";
+export { PersistenceRedis } from "./PersistenceRedis";

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+	"extends": "@pluv/tsconfig/library.json",
+	"include": ["**/*.ts"],
+	"exclude": ["node_modules"],
+	"compilerOptions": {
+		"types": ["@types/node"]
+	}
+}