Compare commits

..

27 Commits

Author SHA1 Message Date
Damien Arrachequesne
47ff1cd04c chore(release): @socket.io/cluster-adapter@0.3.0
Diff: https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.2...0.3.0
2025-10-16 19:55:56 +02:00
Damien Arrachequesne
0ae76360f9 Merge remote-tracking branch 'socket.io-cluster-adapter/monorepo' 2025-10-16 19:35:51 +02:00
Damien Arrachequesne
27fd420e75 refactor: prepare migration to monorepo 2025-10-16 19:31:30 +02:00
Damien Arrachequesne
0c431243e2 refactor: use the ClusterAdapter class from socket.io-adapter package
The ClusterAdapter class has been moved to [1], so that this adapter
only needs to implement to pub/sub mechanism.

Also, [2] should reduce the number of "timeout reached: only x
responses received out of y" errors, since the fetchSockets() requests
will now succeed even if a server leaves the cluster.

[1]: https://github.com/socketio/socket.io/tree/main/packages/socket.io-adapter
[2]: 0e23ff0cc6
2025-10-16 19:16:20 +02:00
Damien Arrachequesne
4fc25d80ec ci: add Node.js 24
Reference: https://github.com/nodejs/Release
2025-10-16 12:03:32 +02:00
Damien Arrachequesne
1dd729b1a1 refactor: upgrade to prettier 3 2025-10-16 11:51:11 +02:00
Damien Arrachequesne
6877512f57 refactor: upgrade to TypeScript 5 2025-10-16 11:49:12 +02:00
Damien Arrachequesne
cf6816afcf chore: npm audit fix 2025-10-10 09:29:29 +02:00
Damien Arrachequesne
625fd66d73 chore: dedupe debug dependency 2025-10-10 09:11:54 +02:00
Damien Arrachequesne
f3e1f5ebdf fix(sio): call adapter.init() when creating each namespace
The init() method of the adapter will now be called when creating a namespace with `io.of(<the-namespace>)`.

Note: any promise rejection is silently caught, as I don't see how we could properly expose the promise.

```js
const io = new Server({
  adapter: myAdapter
});
// under the hood, this:
// - implicitly creates the main namespace (/)
// - creates an instance of `myAdapter` for the main namespace
// - calls `myAdapter.init()` (with this change)
```

Related:

- https://github.com/socketio/socket.io/issues/3662
- https://github.com/socketio/socket.io-postgres-adapter/issues/16
2025-10-09 09:48:07 +02:00
Damien Arrachequesne
e97549259e ci(browser): use Windows 8 for IE tests 2025-09-30 11:44:50 +02:00
MiaoWoo
1da9cddeab fix(eio-client): properly handle port option (#5241)
Passing { port: "443" } would include the port in the URL (":443").
2025-09-30 10:57:43 +02:00
Avi Vahl
6f9b198bc8 chore(deps): ws@8.18.3, debug@4.4.1 (#5335)
Release notes:

- https://github.com/websockets/ws/releases/tag/8.18.3
- https://github.com/debug-js/debug/releases/tag/4.4.1
2025-09-11 07:51:07 +02:00
Damien Arrachequesne
56a53bceb9 ci: add Node.js 20 in the test matrix 2023-07-09 10:03:47 +02:00
Damien Arrachequesne
683720a67d test: fix flaky test 2023-07-09 10:03:46 +02:00
Damien Arrachequesne
a529eb08d6 chore: bump dev dependencies 2023-07-09 10:03:32 +02:00
Damien Arrachequesne
cddb78e5fa chore(release): 0.2.2
Diff: https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.1...0.2.2
2023-03-24 17:32:35 +01:00
Damien Arrachequesne
15fd56e78d chore: add socket.io-parser to peerDependencies
This should (at least in theory) fix sync issues for the
`socket.io-adapter` package, which is imported by both the `socket.io`
and `@socket.io/cluster-adapter` packages:

- `socket.io@4.5.0` should resolve `socket.io-adapter@~2.4.0`
- `socket.io@4.6.0` should resolve `socket.io-adapter@~2.5.0`
2023-03-24 17:28:57 +01:00
Damien Arrachequesne
e86ef45f87 ci: upgrade to actions/checkout@3 and actions/setup-node@3
Reference: https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/
2023-03-24 17:16:25 +01:00
Damien Arrachequesne
fe840e2eb3 chore(release): 0.2.1
Diff: https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.0...0.2.1
2022-10-13 09:23:36 +02:00
Damien Arrachequesne
a5a1c29082 chore: update dev dependencies 2022-10-13 09:17:46 +02:00
Damien Arrachequesne
66b4079953 ci: add Node.js 18 in the test matrix
Reference: https://github.com/nodejs/Release
2022-10-13 09:15:34 +02:00
Rolando Andrade
be0a0e3217 fix: properly handle ERR_IPC_CHANNEL_CLOSED errors (#6)
Related: https://github.com/socketio/socket.io-cluster-adapter/issues/5
2022-10-13 09:11:37 +02:00
Damien Arrachequesne
43f9ee8d23 chore(release): 0.2.0
Diff: https://github.com/socketio/socket.io-cluster-adapter/compare/0.1.0...0.2.0
2022-04-28 16:16:13 +02:00
Damien Arrachequesne
055b7840d8 feat: broadcast and expect multiple acks
This feature was added in `socket.io@4.5.0`:

```js
io.timeout(1000).emit("some-event", (err, responses) => {
  // ...
});
```

Thanks to this change, it will now work with multiple Socket.IO
servers.

Related: https://github.com/socketio/socket.io/issues/4163
2022-04-28 16:11:12 +02:00
Damien Arrachequesne
6397c1bdfd chore(release): 0.1.0 2021-06-22 07:06:15 +02:00
Damien Arrachequesne
ff370cfc46 Initial commit 2021-06-22 07:02:16 +02:00
29 changed files with 7484 additions and 2090 deletions

View File

@@ -10,6 +10,7 @@ Here are the detailed changelogs for each package in this monorepo:
| `socket.io` | [link](packages/socket.io/CHANGELOG.md) |
| `socket.io-adapter` | [link](packages/socket.io-adapter/CHANGELOG.md) |
| `socket.io-client` | [link](packages/socket.io-client/CHANGELOG.md) |
| `@socket.io/cluster-adapter` | [link](packages/socket.io-cluster-adapter/CHANGELOG.md) |
| `@socket.io/cluster-engine` | [link](packages/socket.io-cluster-engine/CHANGELOG.md) |
| `@socket.io/component-emitter` | [link](packages/socket.io-component-emitter/History.md) |
| `socket.io-parser` | [link](packages/socket.io-parser/CHANGELOG.md) |

View File

@@ -7,7 +7,7 @@
"prettier": "^2.8.4",
"rollup": "^3.20.2",
"socket.io": "^4.6.1",
"ws": "^8.13.0"
"ws": "^8.18.3"
},
"scripts": {
"bundle": "rollup -c",

4439
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -8,6 +8,7 @@
"packages/socket.io-cluster-engine",
"packages/engine.io-client",
"packages/socket.io-adapter",
"packages/socket.io-cluster-adapter",
"packages/socket.io-parser",
"packages/socket.io-client",
"packages/socket.io",
@@ -16,7 +17,7 @@
"overrides": {
"@types/estree": "0.0.52",
"@types/lodash": "4.14.189",
"ws": "8.17.1"
"ws": "8.18.3"
},
"devDependencies": {
"@babel/core": "^7.24.7",
@@ -73,6 +74,7 @@
"ts-loader": "^9.5.1",
"ts-node": "^10.9.2",
"tsd": "^0.31.1",
"tsx": "~4.20.6",
"typescript": "^5.5.3",
"uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.48.0",
"wdio-geckodriver-service": "^5.0.2"

View File

@@ -192,7 +192,7 @@ export abstract class Transport extends Emitter<
private _port() {
if (
this.opts.port &&
((this.opts.secure && Number(this.opts.port !== 443)) ||
((this.opts.secure && Number(this.opts.port) !== 443) ||
(!this.opts.secure && Number(this.opts.port) !== 80))
) {
return ":" + this.opts.port;

View File

@@ -53,9 +53,9 @@
],
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.1",
"debug": "~4.4.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.17.1",
"ws": "~8.18.3",
"xmlhttprequest-ssl": "~2.1.1"
},
"scripts": {

View File

@@ -116,6 +116,32 @@ describe("Transport", () => {
expect(polling.uri()).to.contain("https://localhost/engine.io?sid=test");
});
it("should generate an https uri w/o a port (string)", () => {
const polling = new eio.transports.polling({
path: "/engine.io",
hostname: "localhost",
secure: true,
query: { sid: "test" },
port: "443",
timestampRequests: false,
});
expect(polling.uri()).to.contain("https://localhost/engine.io?sid=test");
});
it("should generate an https uri with a port", () => {
const polling = new eio.transports.polling({
path: "/engine.io",
hostname: "localhost",
secure: true,
query: { sid: "test" },
port: 8443,
timestampRequests: false,
});
expect(polling.uri()).to.contain(
"https://localhost:8443/engine.io?sid=test",
);
});
it("should generate a timestamped uri", () => {
const polling = new eio.transports.polling({
path: "/engine.io",

View File

@@ -37,9 +37,9 @@
"base64id": "2.0.0",
"cookie": "~0.7.2",
"cors": "~2.8.5",
"debug": "~4.3.1",
"debug": "~4.4.1",
"engine.io-parser": "~5.2.1",
"ws": "~8.17.1"
"ws": "~8.18.3"
},
"scripts": {
"compile": "rimraf ./build && tsc",

View File

@@ -17,8 +17,8 @@
"types": "./dist/index.d.ts",
"description": "default socket.io in-memory adapter",
"dependencies": {
"debug": "~4.3.4",
"ws": "~8.17.1"
"debug": "~4.4.1",
"ws": "~8.18.3"
},
"scripts": {
"compile": "rimraf ./dist && tsc",

View File

@@ -46,7 +46,7 @@
"types": "./build/esm/index.d.ts",
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.2",
"debug": "~4.4.1",
"engine.io-client": "~6.6.1",
"socket.io-parser": "~4.2.4"
},

View File

@@ -60,7 +60,7 @@ if (process.env.CI === "true") {
{
browserName: "internet explorer",
browserVersion: "10",
platformName: "Windows 7",
platformName: "Windows 8",
"sauce:options": BASE_SAUCE_OPTIONS,
},
{

View File

@@ -0,0 +1,60 @@
# Changelog
| Version | Release date |
|--------------------------|--------------|
| [0.3.0](#030-2025-10-16) | October 2025 |
| [0.2.2](#022-2023-03-24) | March 2023 |
| [0.2.1](#021-2022-10-13) | October 2022 |
| [0.2.0](#020-2022-04-28) | April 2022 |
| [0.1.0](#010-2021-06-22) | June 2021 |
## [0.3.0](https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.2...0.3.0) (2025-10-16)
This release contains an important refactor of the adapter ([this commit](https://github.com/socketio/socket.io-cluster-adapter/commit/0c431243e28913fdd2a4a3de3e67a9f38d67a3aa)), as most of the logic has been moved in the `ClusterAdapter` class of the `socket.io-adapter` package.
Besides, the `@socket.io/cluster-adapter` package is now part of the `socket.io` monorepo.
## [0.2.2](https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.1...0.2.2) (2023-03-24)
The `socket.io-adapter` package was added to the list of `peerDependencies`, in order to fix sync issues with the version imported by the socket.io package (see [15fd56e](https://github.com/socketio/socket.io-cluster-adapter/commit/15fd56e78d52aa65c5fbf412dec57ab4bdaee7cc)).
Support for connection state recovery (see [here](https://github.com/socketio/socket.io/releases/4.6.0)) will be added in the next release.
## [0.2.1](https://github.com/socketio/socket.io-cluster-adapter/compare/0.2.0...0.2.1) (2022-10-13)
### Bug Fixes
* properly handle ERR_IPC_CHANNEL_CLOSED errors ([#6](https://github.com/socketio/socket.io-cluster-adapter/issues/6)) ([be0a0e3](https://github.com/socketio/socket.io-cluster-adapter/commit/be0a0e3217bd7100d569e5624194612bcc8b96ff))
## [0.2.0](https://github.com/socketio/socket.io-cluster-adapter/compare/0.1.0...0.2.0) (2022-04-28)
### Features
* broadcast and expect multiple acks ([055b784](https://github.com/socketio/socket.io-cluster-adapter/commit/055b7840d8cf88173d8299041ef3fafa9791c97a))
This feature was added in `socket.io@4.5.0`:
```js
io.timeout(1000).emit("some-event", (err, responses) => {
// ...
});
```
Thanks to this change, it will now work within a Node.js cluster.
## 0.1.0 (2021-06-22)
Initial commit

View File

@@ -0,0 +1,7 @@
Copyright (c) 2021 Damien Arrachequesne (@darrachequesne)
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.

View File

@@ -0,0 +1,100 @@
# Socket.IO cluster adapter
The `@socket.io/cluster-adapter` package allows broadcasting packets between multiple Socket.IO servers.
![Adapter diagram](./assets/adapter.png)
It can be used in conjunction with [`@socket.io/sticky`](https://github.com/socketio/socket.io-sticky) to broadcast packets between the workers of the same Node.js [cluster](https://nodejs.org/api/cluster.html).
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)
Related packages:
- Postgres adapter: https://github.com/socketio/socket.io-postgres-adapter/
- Redis adapter: https://github.com/socketio/socket.io-redis-adapter/
- MongoDB adapter: https://github.com/socketio/socket.io-mongo-adapter/
**Table of contents**
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)
## Installation
```
npm install @socket.io/cluster-adapter
```
## Usage
```js
const cluster = require("cluster");
const http = require("http");
const { Server } = require("socket.io");
const numCPUs = require("os").cpus().length;
const { setupMaster, setupWorker } = require("@socket.io/sticky");
const { createAdapter, setupPrimary } = require("@socket.io/cluster-adapter");
if (cluster.isMaster) {
console.log(`Master ${process.pid} is running`);
const httpServer = http.createServer();
// setup sticky sessions
setupMaster(httpServer, {
loadBalancingMethod: "least-connection",
});
// setup connections between the workers
setupPrimary();
// needed for packets containing buffers (you can ignore it if you only send plaintext objects)
// Node.js < 16.0.0
cluster.setupMaster({
serialization: "advanced",
});
// Node.js > 16.0.0
// cluster.setupPrimary({
// serialization: "advanced",
// });
httpServer.listen(3000);
for (let i = 0; i < numCPUs; i++) {
cluster.fork();
}
cluster.on("exit", (worker) => {
console.log(`Worker ${worker.process.pid} died`);
cluster.fork();
});
} else {
console.log(`Worker ${process.pid} started`);
const httpServer = http.createServer();
const io = new Server(httpServer);
// use the cluster adapter
io.adapter(createAdapter());
// setup connection with the primary process
setupWorker(io);
io.on("connection", (socket) => {
/* ... */
});
}
```
## License
[MIT](LICENSE)

View File

@@ -0,0 +1,822 @@
{
"type": "excalidraw",
"version": 2,
"source": "https://excalidraw.com",
"elements": [
{
"type": "text",
"version": 345,
"versionNonce": 1782313961,
"isDeleted": false,
"id": "5hUB5ALUlsn26W0PzU4fM",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 777,
"y": -89.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 78,
"height": 26,
"seed": 28708370,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"_wBO22vaQplcoKyBXbWRC"
],
"fontSize": 20,
"fontFamily": 1,
"text": "worker 1",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "rectangle",
"version": 230,
"versionNonce": 1587305255,
"isDeleted": false,
"id": "lmQ4o4New7xuXQLwavuSn",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 725,
"y": -169,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 345.00000000000006,
"height": 311,
"seed": 1594950354,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"_wBO22vaQplcoKyBXbWRC",
"BZVwnsrGk9G-X87ZHkh-6",
"eU1gfEXnHSjxc-pEgv43A",
"XZpY0rnxgeDlxu5b8fgRQ",
"4mjxZzapHnLuRx7KU2JeH",
"mV8ZNfAcYrxGLJ7b9a_kn"
]
},
{
"type": "text",
"version": 152,
"versionNonce": 742887113,
"isDeleted": false,
"id": "ZQsZmj4NaTubBHMkVG2dl",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 745,
"y": -159,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 43,
"height": 26,
"seed": 126533902,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "Host",
"baseline": 18,
"textAlign": "left",
"verticalAlign": "top"
},
{
"type": "rectangle",
"version": 334,
"versionNonce": 1221877319,
"isDeleted": false,
"id": "RRrk3Vsl-pM8Z1r8Fj3Vu",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 749.5,
"y": -105,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 129,
"height": 56,
"seed": 1013161166,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"use4Bp2hbb77Fq5njtwBi",
"U7UCkn3nVHlWGYetjII_Z"
]
},
{
"type": "text",
"version": 386,
"versionNonce": 601673129,
"isDeleted": false,
"id": "qfQdcJHnwYnCMtLCV51X8",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 773,
"y": -18.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 90,
"height": 26,
"seed": 1535426147,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"_wBO22vaQplcoKyBXbWRC",
"2DIFacJXJtC5QIuMuo3pK"
],
"fontSize": 20,
"fontFamily": 1,
"text": "worker 2",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "rectangle",
"version": 330,
"versionNonce": 794754407,
"isDeleted": false,
"id": "IRd1nPQbv0PQdJQn_yLOs",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 749.5,
"y": -36,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 129,
"height": 56,
"seed": 452398413,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"2DIFacJXJtC5QIuMuo3pK",
"NhqDM6wVMhgbRvXrQJQge",
"C1IueNJdiTSkqUxSTEvKe"
]
},
{
"type": "text",
"version": 374,
"versionNonce": 942092425,
"isDeleted": false,
"id": "ENOSqQ4visNbCN7ZMZwxP",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 770.5,
"y": 48.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 89,
"height": 26,
"seed": 1916984429,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"_wBO22vaQplcoKyBXbWRC"
],
"fontSize": 20,
"fontFamily": 1,
"text": "worker 3",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "rectangle",
"version": 314,
"versionNonce": 629717127,
"isDeleted": false,
"id": "IqdB8EO7s50UY1EU9TVVP",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 750.5,
"y": 30,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 129,
"height": 56,
"seed": 1832463587,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"NhqDM6wVMhgbRvXrQJQge"
]
},
{
"type": "rectangle",
"version": 115,
"versionNonce": 997860361,
"isDeleted": false,
"id": "9grXh8d6z3-WENQLWSBP6",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 338,
"y": -95,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 140,
"height": 49,
"seed": 1667334019,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": []
},
{
"type": "text",
"version": 95,
"versionNonce": 1806744839,
"isDeleted": false,
"id": "uw4DcwoucyYZxQuvW-XdC",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 383,
"y": -83.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 50,
"height": 26,
"seed": 1216901411,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "client",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"id": "ZR4mzBF0WDviz0UhZ4jZM",
"type": "diamond",
"x": 891.5,
"y": -87,
"width": 35,
"height": 18,
"angle": 0,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"fillStyle": "hachure",
"strokeWidth": 2,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"groupIds": [],
"strokeSharpness": "sharp",
"seed": 1951590473,
"version": 87,
"versionNonce": 232917705,
"isDeleted": false,
"boundElementIds": [
"LgoBfF5uxSyzlQnWpzp21",
"VzzoutsEZMxQbMloZdWpR",
"OEzsLqAW3F-2LE0bnPrtx"
]
},
{
"id": "tpect-oo26kMVbG_xdqoO",
"type": "text",
"x": 895.5,
"y": -130,
"width": 157,
"height": 26,
"angle": 0,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"fillStyle": "hachure",
"strokeWidth": 2,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"groupIds": [],
"strokeSharpness": "sharp",
"seed": 294816809,
"version": 104,
"versionNonce": 2120602793,
"isDeleted": false,
"boundElementIds": null,
"text": "cluster adapter",
"fontSize": 20,
"fontFamily": 1,
"textAlign": "left",
"verticalAlign": "top",
"baseline": 18
},
{
"type": "diamond",
"version": 113,
"versionNonce": 1690814889,
"isDeleted": false,
"id": "ScoFMjrxukGD1efHfKiFH",
"fillStyle": "hachure",
"strokeWidth": 2,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 894.5,
"y": -20,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 35,
"height": 18,
"seed": 696687431,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"VzzoutsEZMxQbMloZdWpR"
]
},
{
"type": "diamond",
"version": 158,
"versionNonce": 1317846759,
"isDeleted": false,
"id": "wj2HZ2scg4U6UtpfK8x3e",
"fillStyle": "hachure",
"strokeWidth": 2,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 893.5,
"y": 46,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 35,
"height": 18,
"seed": 1469547015,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"OEzsLqAW3F-2LE0bnPrtx"
]
},
{
"id": "U7UCkn3nVHlWGYetjII_Z",
"type": "arrow",
"x": 734.5,
"y": -74,
"width": 238,
"height": 4,
"angle": 0,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"groupIds": [],
"strokeSharpness": "round",
"seed": 1537057031,
"version": 61,
"versionNonce": 1166788937,
"isDeleted": false,
"boundElementIds": null,
"points": [
[
0,
0
],
[
-238,
4
]
],
"lastCommittedPoint": null,
"startBinding": {
"elementId": "RRrk3Vsl-pM8Z1r8Fj3Vu",
"focus": -0.05720889916209189,
"gap": 15
},
"endBinding": null,
"startArrowhead": null,
"endArrowhead": "arrow"
},
{
"type": "rectangle",
"version": 163,
"versionNonce": 15141831,
"isDeleted": false,
"id": "mv6FEWy7Oux1XBpOeYKlJ",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 337.25,
"y": -26.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 140,
"height": 49,
"seed": 1927924585,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": []
},
{
"type": "text",
"version": 143,
"versionNonce": 766883881,
"isDeleted": false,
"id": "sBk2P5AAiZa36HbnmeRLi",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 382.25,
"y": -15,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 50,
"height": 26,
"seed": 1643756455,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "client",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "arrow",
"version": 111,
"versionNonce": 2076179175,
"isDeleted": false,
"id": "C1IueNJdiTSkqUxSTEvKe",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 733.75,
"y": -5.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 238,
"height": 4,
"seed": 542013001,
"groupIds": [],
"strokeSharpness": "round",
"boundElementIds": [],
"startBinding": {
"elementId": "IRd1nPQbv0PQdJQn_yLOs",
"focus": -0.03958393527882115,
"gap": 15.75
},
"endBinding": null,
"lastCommittedPoint": null,
"startArrowhead": null,
"endArrowhead": "arrow",
"points": [
[
0,
0
],
[
-238,
4
]
]
},
{
"type": "rectangle",
"version": 138,
"versionNonce": 478071561,
"isDeleted": false,
"id": "6r_-m_ehoDx3FlKI9YqbJ",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 337.25,
"y": 40.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 140,
"height": 49,
"seed": 704870919,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": []
},
{
"type": "text",
"version": 118,
"versionNonce": 133039623,
"isDeleted": false,
"id": "EEhePeT66oko7kRekPQGo",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 382.25,
"y": 52,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 50,
"height": 26,
"seed": 93212137,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "client",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "arrow",
"version": 86,
"versionNonce": 979534313,
"isDeleted": false,
"id": "etOb8BtJX8fUgxXsPOX2F",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 733.75,
"y": 61.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 238,
"height": 4,
"seed": 464822567,
"groupIds": [],
"strokeSharpness": "round",
"boundElementIds": [],
"startBinding": null,
"endBinding": null,
"lastCommittedPoint": null,
"startArrowhead": null,
"endArrowhead": "arrow",
"points": [
[
0,
0
],
[
-238,
4
]
]
},
{
"type": "rectangle",
"version": 184,
"versionNonce": 1953344807,
"isDeleted": false,
"id": "G6-PJf8TRngnFyuC3A0QC",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 337.25,
"y": 105.5,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 140,
"height": 49,
"seed": 1627945223,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [
"JFhaNprFAz7gl6FY48Aps"
]
},
{
"type": "text",
"version": 163,
"versionNonce": 342645961,
"isDeleted": false,
"id": "UEv3oUzBr56Mj6Mz7hG-B",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 382.25,
"y": 117,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 50,
"height": 26,
"seed": 1822211817,
"groupIds": [],
"strokeSharpness": "sharp",
"boundElementIds": [],
"fontSize": 20,
"fontFamily": 1,
"text": "client",
"baseline": 18,
"textAlign": "center",
"verticalAlign": "middle"
},
{
"type": "arrow",
"version": 135,
"versionNonce": 2091610183,
"isDeleted": false,
"id": "JFhaNprFAz7gl6FY48Aps",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 731.1770639400929,
"y": 74.303452225402,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 240.42706394009292,
"height": 54.196547774598,
"seed": 1203879975,
"groupIds": [],
"strokeSharpness": "round",
"boundElementIds": [],
"startBinding": null,
"endBinding": {
"elementId": "G6-PJf8TRngnFyuC3A0QC",
"focus": 0.4300574064368146,
"gap": 13.5
},
"lastCommittedPoint": null,
"startArrowhead": null,
"endArrowhead": "arrow",
"points": [
[
0,
0
],
[
-240.42706394009292,
54.196547774598
]
]
},
{
"id": "VzzoutsEZMxQbMloZdWpR",
"type": "arrow",
"x": 929.5,
"y": -70,
"width": 17,
"height": 53,
"angle": 0,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"groupIds": [],
"strokeSharpness": "round",
"seed": 1957283401,
"version": 330,
"versionNonce": 1093640775,
"isDeleted": false,
"boundElementIds": null,
"points": [
[
0,
0
],
[
16,
23
],
[
-1,
53
]
],
"lastCommittedPoint": null,
"startBinding": {
"elementId": "ZR4mzBF0WDviz0UhZ4jZM",
"focus": -0.853416149068323,
"gap": 8.48634645640746
},
"endBinding": {
"elementId": "ScoFMjrxukGD1efHfKiFH",
"focus": 0.7485714285714284,
"gap": 4.878378801288122
},
"startArrowhead": null,
"endArrowhead": "arrow"
},
{
"type": "arrow",
"version": 440,
"versionNonce": 2038871081,
"isDeleted": false,
"id": "OEzsLqAW3F-2LE0bnPrtx",
"fillStyle": "hachure",
"strokeWidth": 1,
"strokeStyle": "solid",
"roughness": 1,
"opacity": 100,
"angle": 0,
"x": 930.5,
"y": -71,
"strokeColor": "#000000",
"backgroundColor": "transparent",
"width": 42,
"height": 116,
"seed": 1990607913,
"groupIds": [],
"strokeSharpness": "round",
"boundElementIds": [],
"startBinding": {
"elementId": "ZR4mzBF0WDviz0UhZ4jZM",
"focus": -0.8894409937888198,
"gap": 8.054406666710076
},
"endBinding": {
"elementId": "wj2HZ2scg4U6UtpfK8x3e",
"focus": 0.6,
"gap": 8.435530010560711
},
"lastCommittedPoint": null,
"startArrowhead": null,
"endArrowhead": "arrow",
"points": [
[
0,
0
],
[
39,
46
],
[
-3,
116
]
]
}
],
"appState": {
"gridSize": null,
"viewBackgroundColor": "#ffffff"
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

View File

@@ -0,0 +1,116 @@
import cluster from "node:cluster";
import {
ClusterAdapterWithHeartbeat,
ClusterAdapterOptions,
ClusterMessage,
ServerId,
ClusterResponse,
MessageType,
} from "socket.io-adapter";
import debugModule from "debug";
const debug = debugModule("socket.io-cluster-adapter");
const MESSAGE_SOURCE = "_sio_adapter";
const hasOwnProperty = Object.prototype.hasOwnProperty;
function ignoreError() {}
/**
* Returns a function that will create a NodeClusterAdapter instance.
*
* @param opts - additional options
*
* @public
* @see https://nodejs.org/api/cluster.html
*/
export function createAdapter(opts: Partial<ClusterAdapterOptions> = {}) {
return function (nsp: any) {
return new NodeClusterAdapter(nsp, opts);
};
}
export class NodeClusterAdapter extends ClusterAdapterWithHeartbeat {
constructor(nsp: any, opts: ClusterAdapterOptions = {}) {
super(nsp, opts);
process.on("message", (message: any) => {
const isValidSource = message?.source === MESSAGE_SOURCE;
if (!isValidSource) {
debug("[%s] ignore unknown source", this.uid);
return;
}
// note: this check should be done in the onMessage() handler
if (message.nsp !== this.nsp.name) {
debug("[%s] ignore other namespace", this.uid);
return;
}
this.onMessage(message);
});
// until https://github.com/socketio/socket.io/commit/f3e1f5ebdf59158d0c8d1e20f8230275617fb355 is released
this.init();
}
protected override doPublish(message: ClusterMessage & { source: string }) {
message.source = MESSAGE_SOURCE;
process.send(message, null, {}, ignoreError);
return Promise.resolve(""); // connection state recovery is not supported
}
protected override doPublishResponse(
requesterUid: ServerId,
response: ClusterResponse & { source: string; requesterUid: string },
) {
response.source = MESSAGE_SOURCE;
response.requesterUid = requesterUid;
process.send(response, null, {}, ignoreError);
return Promise.resolve();
}
}
const UIDS = Symbol("uids");
export function setupPrimary() {
cluster.on("message", (worker, message) => {
const isValidSource = message?.source === MESSAGE_SOURCE;
if (!isValidSource) {
return;
}
// store the requester's uids (one per namespace) so that the response can be sent specifically to them
worker[UIDS] = worker[UIDS] || new Set();
worker[UIDS].add(message.uid);
switch (message.type) {
case MessageType.FETCH_SOCKETS_RESPONSE:
case MessageType.SERVER_SIDE_EMIT_RESPONSE:
const requesterUid = message.requesterUid;
for (const workerId in cluster.workers) {
if (
hasOwnProperty.call(cluster.workers, workerId) &&
cluster.workers[workerId][UIDS]?.has(requesterUid)
) {
cluster.workers[workerId].send(message, null, ignoreError);
break;
}
}
break;
default:
const emitterIdAsString = String(worker.id);
// emit to all workers but the requester
for (const workerId in cluster.workers) {
if (
hasOwnProperty.call(cluster.workers, workerId) &&
workerId !== emitterIdAsString
) {
cluster.workers[workerId].send(message, null, ignoreError);
}
}
}
});
}

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,40 @@
{
"name": "@socket.io/cluster-adapter",
"version": "0.3.0",
"description": "The Socket.IO cluster adapter, allowing to broadcast events between several Socket.IO servers",
"license": "MIT",
"homepage": "https://github.com/socketio/socket.io/tree/main/packages/socket.io-cluster-adapter#readme",
"repository": {
"type": "git",
"url": "git+https://github.com/socketio/socket.io.git"
},
"bugs": {
"url": "https://github.com/socketio/socket.io/issues"
},
"files": [
"dist/"
],
"main": "./dist/index.js",
"types": "./dist/index.d.ts",
"scripts": {
"compile": "rimraf ./dist && tsc",
"test": "npm run format:check && npm run compile && nyc mocha --import=tsx test/index.ts",
"format:check": "prettier --check \"lib/**/*.ts' \"test/**/*.ts\"",
"format:fix": "prettier --write \"lib/**/*.ts\" \"test/**/*.ts\"",
"prepack": "npm run compile"
},
"dependencies": {
"debug": "~4.4.1"
},
"peerDependencies": {
"socket.io-adapter": "~2.5.5"
},
"engines": {
"node": ">=10.0.0"
},
"keywords": [
"socket.io",
"cluster",
"adapter"
]
}

View File

@@ -0,0 +1,372 @@
import { io as ioc, Socket as ClientSocket } from "socket.io-client";
import expect = require("expect.js");
import { setupPrimary } from "..";
import { times, sleep } from "./util";
import cluster, { Worker } from "node:cluster";
const NODES_COUNT = 3;
cluster.setupMaster({
exec: "./test/worker.js",
// @ts-ignore
serialization: "advanced", // needed for packets containing buffers
});
setupPrimary();
const getRooms = (worker): Promise<Set<string>> => {
worker.send("get rooms");
return new Promise((resolve) => {
worker.once("message", (content) => {
resolve(content);
});
});
};
describe("@socket.io/cluster-adapter", () => {
let clientSockets: ClientSocket[], workers: Worker[];
beforeEach((done) => {
clientSockets = [];
workers = [];
for (let i = 1; i <= NODES_COUNT; i++) {
const PORT = 40000 + i;
const worker = cluster.fork({
PORT,
});
worker.on("listening", () => {
const clientSocket = ioc(`http://localhost:${PORT}`);
clientSocket.on("connect", async () => {
workers.push(worker);
clientSockets.push(clientSocket);
if (clientSockets.length === NODES_COUNT) {
done();
}
});
});
}
});
afterEach(() => {
for (const id in cluster.workers) {
cluster.workers[id].kill();
}
clientSockets.forEach((socket) => {
socket.disconnect();
});
});
describe("broadcast", function () {
it("broadcasts to all clients", (done) => {
const partialDone = times(3, done);
clientSockets.forEach((clientSocket) => {
clientSocket.on("test", (arg1, arg2, arg3) => {
expect(arg1).to.eql(1);
expect(arg2).to.eql("2");
expect(Buffer.isBuffer(arg3)).to.be(true);
partialDone();
});
});
workers[0].send("broadcasts to all clients");
});
it("broadcasts to all clients in a namespace", (done) => {
const partialDone = times(3, done);
const onConnect = times(3, async () => {
workers[0].send("broadcasts to all clients in a namespace");
});
clientSockets.forEach((clientSocket) => {
const socket = clientSocket.io.socket("/custom");
socket.on("connect", onConnect);
socket.on("test", () => {
socket.disconnect();
partialDone();
});
});
});
it("broadcasts to all clients in a room", (done) => {
workers[1].send("join room1");
clientSockets[0].on("test", () => {
done(new Error("should not happen"));
});
clientSockets[1].on("test", () => {
done();
});
clientSockets[2].on("test", () => {
done(new Error("should not happen"));
});
workers[0].send("broadcasts to all clients in a room");
});
it("broadcasts to all clients except in room", (done) => {
const partialDone = times(2, done);
workers[1].send("join room1");
clientSockets[0].on("test", () => {
partialDone();
});
clientSockets[1].on("test", () => {
done(new Error("should not happen"));
});
clientSockets[2].on("test", () => {
partialDone();
});
workers[0].send("broadcasts to all clients except in room");
});
it("broadcasts to local clients only", (done) => {
clientSockets[0].on("test", () => {
done();
});
clientSockets[1].on("test", () => {
done(new Error("should not happen"));
});
clientSockets[2].on("test", () => {
done(new Error("should not happen"));
});
workers[0].send("broadcasts to local clients only");
});
it("broadcasts with multiple acknowledgements", (done) => {
clientSockets[0].on("test", (cb) => {
cb(1);
});
clientSockets[1].on("test", (cb) => {
cb(2);
});
clientSockets[2].on("test", (cb) => {
cb(3);
});
workers[0].send("broadcasts with multiple acknowledgements");
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
it("broadcasts with multiple acknowledgements (binary content)", (done) => {
clientSockets[0].on("test", (cb) => {
cb(Buffer.from([1]));
});
clientSockets[1].on("test", (cb) => {
cb(Buffer.from([2]));
});
clientSockets[2].on("test", (cb) => {
cb(Buffer.from([3]));
});
workers[0].send(
"broadcasts with multiple acknowledgements (binary content)",
);
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
it("broadcasts with multiple acknowledgements (no client)", (done) => {
workers[0].send("broadcasts with multiple acknowledgements (no client)");
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
it("broadcasts with multiple acknowledgements (timeout)", (done) => {
clientSockets[0].on("test", (cb) => {
cb(1);
});
clientSockets[1].on("test", (cb) => {
cb(2);
});
clientSockets[2].on("test", (cb) => {
// do nothing
});
workers[0].send("broadcasts with multiple acknowledgements (timeout)");
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
});
describe("socketsJoin", () => {
it("makes all socket instances join the specified room", async () => {
workers[0].send("makes all socket instances join the specified room");
await sleep(100);
expect((await getRooms(workers[0])).has("room1")).to.be(true);
expect((await getRooms(workers[1])).has("room1")).to.be(true);
expect((await getRooms(workers[2])).has("room1")).to.be(true);
});
it("makes the matching socket instances join the specified room", async () => {
workers[0].send("join room1");
workers[2].send("join room1");
workers[0].send(
"makes the matching socket instances join the specified room",
);
await sleep(100);
expect((await getRooms(workers[0])).has("room2")).to.be(true);
expect((await getRooms(workers[1])).has("room2")).to.be(false);
expect((await getRooms(workers[2])).has("room2")).to.be(true);
});
});
describe("socketsLeave", () => {
it("makes all socket instances leave the specified room", async () => {
workers[0].send("join room1");
workers[2].send("join room1");
workers[0].send("makes all socket instances leave the specified room");
await sleep(100);
expect((await getRooms(workers[0])).has("room1")).to.be(false);
expect((await getRooms(workers[1])).has("room1")).to.be(false);
expect((await getRooms(workers[2])).has("room1")).to.be(false);
});
it("makes the matching socket instances leave the specified room", async () => {
workers[0].send("join room1 & room2");
workers[2].send("join room2");
workers[0].send(
"makes the matching socket instances leave the specified room",
);
await sleep(100);
expect((await getRooms(workers[0])).has("room2")).to.be(false);
expect((await getRooms(workers[1])).has("room2")).to.be(false);
expect((await getRooms(workers[2])).has("room2")).to.be(true);
});
});
describe("disconnectSockets", () => {
it("makes all socket instances disconnect", (done) => {
const partialDone = times(3, done);
clientSockets.forEach((clientSocket) => {
clientSocket.on("disconnect", (reason) => {
expect(reason).to.eql("io server disconnect");
partialDone();
});
});
workers[0].send("makes all socket instances disconnect");
});
});
describe("fetchSockets", () => {
it("returns all socket instances", (done) => {
workers[0].send("returns all socket instances");
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
});
describe("serverSideEmit", () => {
it("sends an event to other server instances", (done) => {
const partialDone = times(2, done);
workers[0].send("sends an event to other server instances");
workers[0].on("message", (result) => {
if (result === "ok") {
done(new Error("should not happen"));
}
});
workers[1].on("message", (result) => {
expect(result).to.eql("ok");
partialDone();
});
workers[2].on("message", (result) => {
expect(result).to.eql("ok");
partialDone();
});
});
it("sends an event and receives a response from the other server instances", (done) => {
workers[0].send(
"sends an event and receives a response from the other server instances (1)",
);
workers[1].send(
"sends an event and receives a response from the other server instances (2)",
);
workers[2].send(
"sends an event and receives a response from the other server instances (3)",
);
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
it("sends an event but timeout if one server does not respond", function (done) {
this.timeout(6000); // currently not possible to configure the timeout delay
workers[0].send(
"sends an event but timeout if one server does not respond (1)",
);
workers[1].send(
"sends an event but timeout if one server does not respond (2)",
);
workers[2].send(
"sends an event but timeout if one server does not respond (3)",
);
workers[0].on("message", (result) => {
if (result === "ok") {
done();
}
});
});
});
});

View File

@@ -0,0 +1,13 @@
export function times(count: number, fn: () => void) {
let i = 0;
return () => {
i++;
if (i === count) {
fn();
}
};
}
export function sleep(duration: number) {
return new Promise((resolve) => setTimeout(resolve, duration));
}

View File

@@ -0,0 +1,182 @@
const { createServer } = require("http");
const { Server } = require("socket.io");
const { createAdapter } = require("..");
const httpServer = createServer();
const io = new Server(httpServer);
const expect = require("expect.js");
io.adapter(createAdapter());
let serverSocket;
io.on("connection", (socket) => {
serverSocket = socket;
});
const customNamespace = io.of("/custom");
process.on("message", async (msg) => {
switch (msg) {
case "broadcasts to all clients":
io.emit("test", 1, "2", Buffer.from([3, 4]));
break;
case "broadcasts to all clients in a namespace":
customNamespace.emit("test");
break;
case "join room1":
serverSocket.join("room1");
break;
case "join room1 & room2":
serverSocket.join(["room1", "room2"]);
break;
case "join room2":
serverSocket.join("room2");
break;
case "broadcasts to all clients in a room":
io.to("room1").emit("test");
break;
case "broadcasts to all clients except in room":
io.of("/").except("room1").emit("test");
break;
case "broadcasts to local clients only":
io.local.emit("test");
break;
case "broadcasts with multiple acknowledgements": {
io.timeout(500).emit("test", (err, responses) => {
expect(err).to.be(null);
expect(responses).to.contain(1);
expect(responses).to.contain(2);
expect(responses).to.contain(3);
setTimeout(() => {
expect(io.of("/").adapter.ackRequests.size).to.eql(0);
process.send("ok");
}, 500);
});
break;
}
case "broadcasts with multiple acknowledgements (binary content)": {
io.timeout(500).emit("test", (err, responses) => {
expect(err).to.be(null);
responses.forEach((response) => {
expect(Buffer.isBuffer(response)).to.be(true);
});
process.send("ok");
});
break;
}
case "broadcasts with multiple acknowledgements (no client)": {
io
.to("abc")
.timeout(500)
.emit("test", (err, responses) => {
expect(err).to.be(null);
expect(responses).to.eql([]);
process.send("ok");
});
break;
}
case "broadcasts with multiple acknowledgements (timeout)": {
io.timeout(500).emit("test", (err, responses) => {
expect(err).to.be.an(Error);
expect(responses).to.contain(1);
expect(responses).to.contain(2);
process.send("ok");
});
break;
}
case "get rooms":
process.send(serverSocket.rooms);
break;
case "makes all socket instances join the specified room":
io.socketsJoin("room1");
break;
case "makes the matching socket instances join the specified room":
io.in("room1").socketsJoin("room2");
break;
case "makes all socket instances leave the specified room":
io.socketsLeave("room1");
break;
case "makes the matching socket instances leave the specified room":
io.in("room1").socketsLeave("room2");
break;
case "makes all socket instances disconnect":
io.disconnectSockets();
break;
case "returns all socket instances":
const sockets = await io.fetchSockets();
expect(sockets).to.be.an(Array);
expect(sockets).to.have.length(3);
expect(io.of("/").adapter.requests.size).to.eql(0); // clean up
process.send("ok");
break;
case "sends an event to other server instances":
io.serverSideEmit("hello", "world", 1, "2");
break;
case "sends an event and receives a response from the other server instances (1)":
io.serverSideEmit("hello with ack", (err, response) => {
expect(err).to.be(null);
expect(response).to.be.an(Array);
expect(response).to.contain(2);
expect(response).to.contain("3");
process.send("ok");
});
break;
case "sends an event and receives a response from the other server instances (2)":
io.on("hello with ack", (cb) => {
cb(2);
});
break;
case "sends an event and receives a response from the other server instances (3)":
io.on("hello with ack", (cb) => {
cb("3");
});
break;
case "sends an event but timeout if one server does not respond (1)":
io.serverSideEmit("hello with ack", (err, response) => {
expect(err.message).to.be(
"timeout reached: missing 1 responses"
);
expect(response).to.be.an(Array);
expect(response).to.contain(2);
process.send("ok");
});
break;
case "sends an event but timeout if one server does not respond (2)":
io.on("hello with ack", (cb) => {
cb(2);
});
break;
case "sends an event but timeout if one server does not respond (3)":
io.on("hello with ack", (cb) => {
// do nothing
});
break;
}
});
io.on("hello", (arg1, arg2, arg3) => {
expect(arg1).to.eql("world");
expect(arg2).to.eql(1);
expect(arg3).to.eql("2");
process.send("ok");
});
httpServer.listen(parseInt(process.env.PORT, 10));

View File

@@ -0,0 +1,13 @@
{
"compilerOptions": {
"outDir": "./dist",
"allowJs": false,
"target": "es2017",
"module": "commonjs",
"declaration": true,
"esModuleInterop": true
},
"include": [
"./lib/**/*"
]
}

View File

@@ -19,7 +19,7 @@
],
"dependencies": {
"@msgpack/msgpack": "~2.8.0",
"debug": "~4.3.3",
"debug": "~4.4.1",
"engine.io": "~6.6.0",
"engine.io-parser": "~5.2.3"
},

View File

@@ -26,7 +26,7 @@
},
"dependencies": {
"@socket.io/component-emitter": "~3.1.0",
"debug": "~4.3.1"
"debug": "~4.4.1"
},
"scripts": {
"compile": "rimraf ./build && tsc && tsc -p tsconfig.esm.json && ./postcompile.sh",

View File

@@ -53,7 +53,7 @@ if (process.env.CI === "true") {
{
browserName: "internet explorer",
browserVersion: "10",
platformName: "Windows 7",
platformName: "Windows 8",
"sauce:options": BASE_SAUCE_OPTIONS,
},
{

View File

@@ -22,7 +22,7 @@
},
"dependencies": {
"@msgpack/msgpack": "^2.7.0",
"debug": "~4.3.1"
"debug": "~4.4.1"
},
"keywords": [
"socket.io",

View File

@@ -197,6 +197,10 @@ export class Namespace<
_initAdapter(): void {
// @ts-ignore
this.adapter = new (this.server.adapter()!)(this);
Promise.resolve(this.adapter.init()).catch((err) => {
debug("error while initializing adapter: %s", err);
});
}
/**

View File

@@ -53,7 +53,7 @@
"accepts": "~1.3.4",
"base64id": "~2.0.0",
"cors": "~2.8.5",
"debug": "~4.3.2",
"debug": "~4.4.1",
"engine.io": "~6.6.0",
"socket.io-adapter": "~2.5.2",
"socket.io-parser": "~4.2.4"