Initial commit

Author: darrachequesne

.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+permissions:
+  contents: read
+
+jobs:
+  test-node:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version:
+          - 14
+          - 18
+
+    services:
+      redis:
+        image: redis
+        options: >-
+          --health-cmd "redis-cli ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 6379:6379
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run tests
+        run: npm test

.gitignore

@@ -0,0 +1,18 @@
+lib-cov
+*.seed
+*.log
+*.csv
+*.dat
+*.out
+*.pid
+*.gz
+
+pids
+logs
+results
+
+npm-debug.log
+node_modules
+.idea
+.nyc_output/
+dist/

CHANGELOG.md

@@ -0,0 +1,3 @@
+# History
+
+# Release notes

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023 The Socket.IO team
+
+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.

README.md

@@ -0,0 +1,80 @@
+# Socket.IO Redis Streams adapter
+
+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**
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Options](#options)
+- [How it works](#how-it-works)
+- [License](#license)
+
+## Installation
+
+```
+npm install @socket.io/redis-streams-adapter redis
+```
+
+## Usage
+
+```js
+import { createClient } from "redis";
+import { Server } from "socket.io";
+import { createAdapter } from "@socket.io/redis-streams-adapter";
+
+const redisClient = createClient({ host: "localhost", port: 6379 });
+
+await redisClient.connect();
+
+const io = new Server({
+  adapter: createAdapter(redisClient)
+});
+
+io.listen(3000);
+```
+
+## Options
+
+| Name                | Description                                                        | Default value |
+|---------------------|--------------------------------------------------------------------|---------------|
+| `streamName`        | The name of the Redis stream.                                      | `socket.io`   |
+| `maxLen`            | The maximum size of the stream. Almost exact trimming (~) is used. | `10_000`      |
+| `readCount`         | The number of elements to fetch per XREAD call.                    | `100`         |
+| `heartbeatInterval` | The number of ms between two heartbeats.                           | `5_000`       |
+| `heartbeatTimeout`  | The number of ms without heartbeat before we consider a node down. | `10_000`      |
+
+## How it works
+
+The adapter will use a [Redis stream](https://redis.io/docs/data-types/streams/) to forward events between the Socket.IO servers.
+
+Notes:
+
+- a single stream is used for all namespaces
+- the `maxLen` option allows to limit the size of the stream
+- unlike the adapter based on Redis PUB/SUB mechanism, this adapter will properly handle any temporary disconnection to the Redis server and resume the stream
+- if [connection state recovery](https://socket.io/docs/v4/connection-state-recovery) is enabled, the sessions will be stored in Redis as a classic key/value pair
+
+## License
+
+[MIT](LICENSE)

docker-compose.yml

@@ -0,0 +1,5 @@
+services:
+  redis:
+    image: redis:5
+    ports:
+      - "6379:6379"