@socket.io/redis-streams-adapter 0.2.1 → 0.2.3

package/README.md

@@ -2,28 +2,9 @@
 
 The `@socket.io/redis-streams-adapter` package allows broadcasting packets between multiple Socket.IO servers.
 
-Supported features:
-
-- [broadcasting](https://socket.io/docs/v4/broadcasting-events/)
-- [utility methods](https://socket.io/docs/v4/server-instance/#Utility-methods)
-  - [`socketsJoin`](https://socket.io/docs/v4/server-instance/#socketsJoin)
-  - [`socketsLeave`](https://socket.io/docs/v4/server-instance/#socketsLeave)
-  - [`disconnectSockets`](https://socket.io/docs/v4/server-instance/#disconnectSockets)
-  - [`fetchSockets`](https://socket.io/docs/v4/server-instance/#fetchSockets)
-  - [`serverSideEmit`](https://socket.io/docs/v4/server-instance/#serverSideEmit)
-- [connection state recovery](https://socket.io/docs/v4/connection-state-recovery)
-
-Related packages:
-
-- Redis adapter: https://github.com/socketio/socket.io-redis-adapter/
-- Redis emitter: https://github.com/socketio/socket.io-redis-emitter/
-- MongoDB adapter: https://github.com/socketio/socket.io-mongo-adapter/
-- MongoDB emitter: https://github.com/socketio/socket.io-mongo-emitter/
-- Postgres adapter: https://github.com/socketio/socket.io-postgres-adapter/
-- Postgres emitter: https://github.com/socketio/socket.io-postgres-emitter/
-
 **Table of contents**
 
+- [Supported features](#supported-features)
 - [Installation](#installation)
 - [Usage](#usage)
   - [With the `redis` package](#with-the-redis-package)
@@ -34,6 +15,15 @@ Related packages:
 - [How it works](#how-it-works)
 - [License](#license)
 
+## Supported features
+
+| Feature                         | `socket.io` version | Support                                        |
+|---------------------------------|---------------------|------------------------------------------------|
+| Socket management               | `4.0.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Inter-server communication      | `4.1.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Broadcast with acknowledgements | `4.5.0`             | :white_check_mark: YES (since version `0.1.0`) |
+| Connection state recovery       | `4.6.0`             | :white_check_mark: YES (since version `0.1.0`) |
+
 ## Installation
 
 ```

package/dist/adapter.js

@@ -178,10 +178,10 @@ class RedisStreamsAdapter extends socket_io_adapter_1.ClusterAdapterWithHeartbea
             for (const entry of entries) {
                 if (entry.message.nsp === this.nsp.name && entry.message.type === "3") {
                     const message = RedisStreamsAdapter.decode(entry.message);
-                    // @ts-ignore
-                    if (shouldIncludePacket(session.rooms, message.data.opts)) {
-                        // @ts-ignore
-                        session.missedPackets.push(message.data.packet.data);
+                    const { packet, opts } = message.data;
+                    if (shouldIncludePacket(session.rooms, opts)) {
+                        packet.data.push(entry.id);
+                        session.missedPackets.push(packet.data);
                     }
                 }
                 offset = entry.id;

package/dist/util.d.ts

@@ -1,5 +1,4 @@
 export declare function hasBinary(obj: any, toJSON?: boolean): boolean;
-export declare function randomId(): string;
 /**
  * @see https://redis.io/commands/xread/
  */

package/dist/util.js

@@ -1,8 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.GETDEL = exports.SET = exports.XRANGE = exports.XADD = exports.XREAD = exports.randomId = exports.hasBinary = void 0;
-const crypto_1 = require("crypto");
-const redis_1 = require("redis");
+exports.GETDEL = exports.SET = exports.XRANGE = exports.XADD = exports.XREAD = exports.hasBinary = void 0;
 function hasBinary(obj, toJSON) {
     if (!obj || typeof obj !== "object") {
         return false;
@@ -29,10 +27,6 @@ function hasBinary(obj, toJSON) {
     return false;
 }
 exports.hasBinary = hasBinary;
-function randomId() {
-    return (0, crypto_1.randomBytes)(8).toString("hex");
-}
-exports.randomId = randomId;
 /**
  * Whether the client comes from the `redis` package
  *
@@ -64,16 +58,18 @@ function mapResult(result) {
  */
 function XREAD(redisClient, streamName, offset, readCount) {
     if (isRedisV4Client(redisClient)) {
-        return redisClient.xRead((0, redis_1.commandOptions)({
-            isolated: true,
-        }), [
-            {
-                key: streamName,
-                id: offset,
-            },
-        ], {
-            COUNT: readCount,
-            BLOCK: 5000,
+        return Promise.resolve().then(() => require("redis")).then((redisPackage) => {
+            return redisClient.xRead(redisPackage.commandOptions({
+                isolated: true,
+            }), [
+                {
+                    key: streamName,
+                    id: offset,
+                },
+            ], {
+                COUNT: readCount,
+                BLOCK: 5000,
+            });
         });
     }
     else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@socket.io/redis-streams-adapter",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "The Socket.IO adapter based on Redis Streams, allowing to broadcast events between several Socket.IO servers",
   "license": "MIT",
   "repository": {
@@ -17,11 +17,12 @@
     "format:check": "prettier --parser typescript --check \"lib/**/*.ts\" \"test/**/*.ts\"",
     "format:fix": "prettier --parser typescript --write \"lib/**/*.ts\" \"test/**/*.ts\"",
     "prepack": "npm run compile",
-    "test": "npm run format:check && npm run compile && npm run test:redis-standalone && npm run test:redis-cluster && npm run test:ioredis-standalone && npm run test:ioredis-cluster",
+    "test": "npm run format:check && npm run compile && npm run test:redis-standalone && npm run test:redis-cluster && npm run test:ioredis-standalone && npm run test:ioredis-cluster && npm run test:valkey-standalone",
     "test:redis-standalone": "nyc mocha --require ts-node/register test/**/*.ts",
     "test:redis-cluster": "cross-env REDIS_CLUSTER=1 mocha --require ts-node/register test/**/*.ts",
     "test:ioredis-standalone": "cross-env REDIS_LIB=ioredis mocha --require ts-node/register test/**/*.ts",
-    "test:ioredis-cluster": "cross-env REDIS_LIB=ioredis REDIS_CLUSTER=1 mocha --require ts-node/register test/**/*.ts"
+    "test:ioredis-cluster": "cross-env REDIS_LIB=ioredis REDIS_CLUSTER=1 mocha --require ts-node/register test/**/*.ts",
+    "test:valkey-standalone": "cross-env VALKEY=1 mocha --require ts-node/register test/**/*.ts"
   },
   "prettier": {
     "endOfLine": "auto"