Compare commits

...

7 Commits
4.5.1 ... 4.5.2

Author SHA1 Message Date
Damien Arrachequesne
8be95b3bd3 chore(release): 4.5.2
Diff: https://github.com/socketio/socket.io/compare/4.5.1...4.5.2
2022-09-02 23:46:14 +01:00
Damien Arrachequesne
ba497ee3eb fix(uws): prevent the server from crashing after upgrade
This should fix a rare case where the Engine.IO connection was upgraded
to WebSocket while the Socket.IO socket was disconnected, which would
result in the following exception:

> TypeError: Cannot read properties of undefined (reading 'forEach')
>    at subscribe (/node_modules/socket.io/dist/uws.js:87:11)
>    at Socket.<anonymous> (/node_modules/socket.io/dist/uws.js:28:17)
>    at Socket.emit (node:events:402:35)
>    at WebSocket.onPacket (/node_modules/engine.io/build/socket.js:214:22)
>    at WebSocket.emit (node:events:390:28)
>    at WebSocket.onPacket (/node_modules/engine.io/build/transport.js:92:14)
>    at WebSocket.onData (/node_modules/engine.io/build/transport.js:101:14)
>    at message (/node_modules/engine.io/build/userver.js:56:30)

Related: https://github.com/socketio/socket.io/issues/4443
2022-09-02 23:42:26 +01:00
Alex
28038715cb ci: add explicit permissions to workflow (#4466)
Reference: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions
2022-09-02 23:10:19 +01:00
Daniel Rosenwasser
134226e96c refactor: add missing constraints (#4431)
See also: https://github.com/microsoft/TypeScript/issues/49489
2022-09-01 21:13:55 +01:00
Damien Arrachequesne
9890b036cf chore: bump dependencies
Production:

- socket.io-parser: ~4.0.4 => ~4.2.0

Development:

- superagent: ^6.1.0 => ^8.0.0
- tsd: ^0.17.0 => ^0.21.0

Related: https://github.com/socketio/socket.io/issues/3709
2022-06-27 09:16:08 +02:00
Damien Arrachequesne
713a6b451b chore: bump mocha to version 10.0.0
Related: https://github.com/socketio/socket.io/issues/3710
2022-06-27 09:00:31 +02:00
Damien Arrachequesne
18f3fdab12 fix: prevent the socket from joining a room after disconnection
Calling `socket.join()` after disconnection would lead to a memory
leak, because the room was never removed from the memory:

```js
io.on("connection", (socket) => {
  socket.disconnect();
  socket.join("room1"); // leak
});
```

Related:

- https://github.com/socketio/socket.io/issues/4067
- https://github.com/socketio/socket.io/issues/4380
2022-05-25 23:18:42 +02:00
30 changed files with 6225 additions and 5646 deletions

View File

@@ -6,6 +6,9 @@ on:
schedule:
- cron: '0 0 * * 0'
permissions:
contents: read
jobs:
test-node:
runs-on: ubuntu-latest

View File

@@ -1,3 +1,13 @@
## [4.5.2](https://github.com/socketio/socket.io/compare/4.5.1...4.5.2) (2022-09-02)
### Bug Fixes
* prevent the socket from joining a room after disconnection ([18f3fda](https://github.com/socketio/socket.io/commit/18f3fdab12947a9fee3e9c37cfc1da97027d1473))
* **uws:** prevent the server from crashing after upgrade ([ba497ee](https://github.com/socketio/socket.io/commit/ba497ee3eb52c4abf1464380d015d8c788714364))
## [4.5.1](https://github.com/socketio/socket.io/compare/4.5.0...4.5.1) (2022-05-17)

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -1,5 +1,5 @@
/*!
* Socket.IO v4.5.1
* Socket.IO v4.5.2
* (c) 2014-2022 Guillermo Rauch
* Released under the MIT License.
*/
@@ -12,17 +12,11 @@
function _typeof(obj) {
"@babel/helpers - typeof";
if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") {
_typeof = function (obj) {
return typeof obj;
};
} else {
_typeof = function (obj) {
return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
};
}
return _typeof(obj);
return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) {
return typeof obj;
} : function (obj) {
return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj;
}, _typeof(obj);
}
function _classCallCheck(instance, Constructor) {
@@ -44,11 +38,14 @@
function _createClass(Constructor, protoProps, staticProps) {
if (protoProps) _defineProperties(Constructor.prototype, protoProps);
if (staticProps) _defineProperties(Constructor, staticProps);
Object.defineProperty(Constructor, "prototype", {
writable: false
});
return Constructor;
}
function _extends() {
_extends = Object.assign || function (target) {
_extends = Object.assign ? Object.assign.bind() : function (target) {
for (var i = 1; i < arguments.length; i++) {
var source = arguments[i];
@@ -61,7 +58,6 @@
return target;
};
return _extends.apply(this, arguments);
}
@@ -77,22 +73,24 @@
configurable: true
}
});
Object.defineProperty(subClass, "prototype", {
writable: false
});
if (superClass) _setPrototypeOf(subClass, superClass);
}
function _getPrototypeOf(o) {
_getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) {
_getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function _getPrototypeOf(o) {
return o.__proto__ || Object.getPrototypeOf(o);
};
return _getPrototypeOf(o);
}
function _setPrototypeOf(o, p) {
_setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) {
_setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function _setPrototypeOf(o, p) {
o.__proto__ = p;
return o;
};
return _setPrototypeOf(o, p);
}
@@ -111,7 +109,7 @@
function _construct(Parent, args, Class) {
if (_isNativeReflectConstruct()) {
_construct = Reflect.construct;
_construct = Reflect.construct.bind();
} else {
_construct = function _construct(Parent, args, Class) {
var a = [null];
@@ -210,9 +208,9 @@
return object;
}
function _get(target, property, receiver) {
function _get() {
if (typeof Reflect !== "undefined" && Reflect.get) {
_get = Reflect.get;
_get = Reflect.get.bind();
} else {
_get = function _get(target, property, receiver) {
var base = _superPropBase(target, property);
@@ -221,14 +219,14 @@
var desc = Object.getOwnPropertyDescriptor(base, property);
if (desc.get) {
return desc.get.call(receiver);
return desc.get.call(arguments.length < 3 ? target : receiver);
}
return desc.value;
};
}
return _get(target, property, receiver || target);
return _get.apply(this, arguments);
}
function _unsupportedIterableToArray(o, minLen) {
@@ -363,11 +361,6 @@
return fileReader.readAsDataURL(data);
};
/*
* base64-arraybuffer 1.0.1 <https://github.com/niklasvh/base64-arraybuffer>
* Copyright (c) 2022 Niklas von Hertzen <https://hertzen.com>
* Released under MIT License
*/
var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'; // Use a lookup table to find the index.
var lookup$1 = typeof Uint8Array === 'undefined' ? [] : new Uint8Array(256);
@@ -375,7 +368,6 @@
for (var i$1 = 0; i$1 < chars.length; i$1++) {
lookup$1[chars.charCodeAt(i$1)] = i$1;
}
var decode$1 = function decode(base64) {
var bufferLength = base64.length * 0.75,
len = base64.length,
@@ -667,7 +659,7 @@
return !!this.listeners(event).length;
};
var globalThis = (function () {
var globalThisShim = function () {
if (typeof self !== "undefined") {
return self;
} else if (typeof window !== "undefined") {
@@ -675,7 +667,7 @@
} else {
return Function("return this")();
}
})();
}();
function pick(obj) {
for (var _len = arguments.length, attr = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
@@ -695,11 +687,11 @@
var NATIVE_CLEAR_TIMEOUT = clearTimeout;
function installTimerFunctions(obj, opts) {
if (opts.useNativeTimers) {
obj.setTimeoutFn = NATIVE_SET_TIMEOUT.bind(globalThis);
obj.clearTimeoutFn = NATIVE_CLEAR_TIMEOUT.bind(globalThis);
obj.setTimeoutFn = NATIVE_SET_TIMEOUT.bind(globalThisShim);
obj.clearTimeoutFn = NATIVE_CLEAR_TIMEOUT.bind(globalThisShim);
} else {
obj.setTimeoutFn = setTimeout.bind(globalThis);
obj.clearTimeoutFn = clearTimeout.bind(globalThis);
obj.setTimeoutFn = setTimeout.bind(globalThisShim);
obj.clearTimeoutFn = clearTimeout.bind(globalThisShim);
}
} // base64 encoded buffers are about 33% bigger (https://en.wikipedia.org/wiki/Base64)
@@ -753,7 +745,7 @@
return _this;
}
return TransportError;
return _createClass(TransportError);
}( /*#__PURE__*/_wrapNativeSuper(Error));
var Transport = /*#__PURE__*/function (_Emitter) {
@@ -998,7 +990,7 @@
var hasCORS = value;
// browser shim for xmlhttprequest module
function XMLHttpRequest$1 (opts) {
function XHR(opts) {
var xdomain = opts.xdomain; // XMLHttpRequest can be disabled on IE
try {
@@ -1009,7 +1001,7 @@
if (!xdomain) {
try {
return new globalThis[["Active"].concat("Object").join("X")]("Microsoft.XMLHTTP");
return new globalThisShim[["Active"].concat("Object").join("X")]("Microsoft.XMLHTTP");
} catch (e) {}
}
}
@@ -1017,7 +1009,7 @@
function empty() {}
var hasXHR2 = function () {
var xhr = new XMLHttpRequest$1({
var xhr = new XHR({
xdomain: false
});
return null != xhr.responseType;
@@ -1362,7 +1354,7 @@
var opts = pick(this.opts, "agent", "pfx", "key", "passphrase", "cert", "ca", "ciphers", "rejectUnauthorized", "autoUnref");
opts.xdomain = !!this.opts.xd;
opts.xscheme = !!this.opts.xs;
var xhr = this.xhr = new XMLHttpRequest$1(opts);
var xhr = this.xhr = new XHR(opts);
try {
xhr.open(this.method, this.uri, this.async);
@@ -1513,7 +1505,7 @@
// @ts-ignore
attachEvent("onunload", unloadHandler);
} else if (typeof addEventListener === "function") {
var terminationEvent = "onpagehide" in globalThis ? "pagehide" : "unload";
var terminationEvent = "onpagehide" in globalThisShim ? "pagehide" : "unload";
addEventListener(terminationEvent, unloadHandler, false);
}
}
@@ -1539,7 +1531,7 @@
};
}
}();
var WebSocket = globalThis.WebSocket || globalThis.MozWebSocket;
var WebSocket = globalThisShim.WebSocket || globalThisShim.MozWebSocket;
var usingBrowserWebSocket = true;
var defaultBinaryType = "arraybuffer";
@@ -1745,7 +1737,7 @@
}, {
key: "check",
value: function check() {
return !!WebSocket && !("__initialize" in WebSocket && this.name === WS.prototype.name);
return !!WebSocket;
}
}]);
@@ -2501,6 +2493,8 @@
}(Emitter);
Socket$1.protocol = protocol$1;
Socket$1.protocol;
/**
* URL parser.
*
@@ -3207,7 +3201,7 @@
key: "emit",
value: function emit(ev) {
if (RESERVED_EVENTS.hasOwnProperty(ev)) {
throw new Error('"' + ev + '" is a reserved event name');
throw new Error('"' + ev.toString() + '" is a reserved event name');
}
for (var _len2 = arguments.length, args = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
@@ -4179,7 +4173,11 @@
}, {
key: "ondata",
value: function ondata(data) {
this.decoder.add(data);
try {
this.decoder.add(data);
} catch (e) {
this.onclose("parse error");
}
}
/**
* Called when parser fully decodes a packet.

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -163,7 +163,7 @@ export class BroadcastOperator<EmitEvents extends EventsMap, SocketData>
...args: EventParams<EmitEvents, Ev>
): boolean {
if (RESERVED_EVENTS.has(ev)) {
throw new Error(`"${ev}" is a reserved event name`);
throw new Error(`"${String(ev)}" is a reserved event name`);
}
// set up packet object
const data = [ev, ...args];

View File

@@ -33,9 +33,9 @@ export interface NamespaceReservedEventsMap<
}
export interface ServerReservedEventsMap<
ListenEvents,
EmitEvents,
ServerSideEvents,
ListenEvents extends EventsMap,
EmitEvents extends EventsMap,
ServerSideEvents extends EventsMap,
SocketData
> extends NamespaceReservedEventsMap<
ListenEvents,
@@ -218,34 +218,38 @@ export class Namespace<
const socket = new Socket(this, client, query);
this.run(socket, (err) => {
process.nextTick(() => {
if ("open" == client.conn.readyState) {
if (err) {
if (client.conn.protocol === 3) {
return socket._error(err.data || err.message);
} else {
return socket._error({
message: err.message,
data: err.data,
});
}
}
// track socket
this.sockets.set(socket.id, socket);
// it's paramount that the internal `onconnect` logic
// fires before user-set events to prevent state order
// violations (such as a disconnection before the connection
// logic is complete)
socket._onconnect();
if (fn) fn();
// fire user-set events
this.emitReserved("connect", socket);
this.emitReserved("connection", socket);
} else {
if ("open" !== client.conn.readyState) {
debug("next called after client was closed - ignoring socket");
socket._cleanup();
return;
}
if (err) {
debug("middleware error, sending CONNECT_ERROR packet to the client");
socket._cleanup();
if (client.conn.protocol === 3) {
return socket._error(err.data || err.message);
} else {
return socket._error({
message: err.message,
data: err.data,
});
}
}
// track socket
this.sockets.set(socket.id, socket);
// it's paramount that the internal `onconnect` logic
// fires before user-set events to prevent state order
// violations (such as a disconnection before the connection
// logic is complete)
socket._onconnect();
if (fn) fn();
// fire user-set events
this.emitReserved("connect", socket);
this.emitReserved("connection", socket);
});
});
return socket;
@@ -316,7 +320,7 @@ export class Namespace<
...args: EventParams<ServerSideEvents, Ev>
): boolean {
if (RESERVED_EVENTS.has(ev)) {
throw new Error(`"${ev}" is a reserved event name`);
throw new Error(`"${String(ev)}" is a reserved event name`);
}
args.unshift(ev);
this.adapter.serverSideEmit(args);

View File

@@ -112,6 +112,8 @@ export interface Handshake {
*/
export type Event = [string, ...any[]];
function noop() {}
export class Socket<
ListenEvents extends EventsMap = DefaultEventsMap,
EmitEvents extends EventsMap = ListenEvents,
@@ -201,7 +203,7 @@ export class Socket<
...args: EventParams<EmitEvents, Ev>
): boolean {
if (RESERVED_EVENTS.has(ev)) {
throw new Error(`"${ev}" is a reserved event name`);
throw new Error(`"${String(ev)}" is a reserved event name`);
}
const data: any[] = [ev, ...args];
const packet: any = {
@@ -511,7 +513,7 @@ export class Socket<
if (!this.connected) return this;
debug("closing socket - reason %s", reason);
this.emitReserved("disconnecting", reason);
this.leaveAll();
this._cleanup();
this.nsp._remove(this);
this.client._remove(this);
this.connected = false;
@@ -519,6 +521,16 @@ export class Socket<
return;
}
/**
* Makes the socket leave all the rooms it was part of and prevents it from joining any other room
*
* @private
*/
_cleanup() {
this.leaveAll();
this.join = noop;
}
/**
* Produces an `error` packet.
*

View File

@@ -25,7 +25,9 @@ export function patchAdapter(app /* : TemplatedApp */) {
if (isNew) {
socket.conn.on("upgrade", () => {
const rooms = this.sids.get(id);
subscribe(this.nsp.name, socket, isNew, rooms);
if (rooms) {
subscribe(this.nsp.name, socket, isNew, rooms);
}
});
}
};

5321
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@@ -1,6 +1,6 @@
{
"name": "socket.io",
"version": "4.5.1",
"version": "4.5.2",
"description": "node.js realtime framework server",
"keywords": [
"realtime",
@@ -40,7 +40,7 @@
"compile": "rimraf ./dist && tsc",
"test": "npm run format:check && npm run compile && npm run test:types && npm run test:unit",
"test:types": "tsd",
"test:unit": "nyc mocha --require ts-node/register --reporter spec --slow 200 --bail --timeout 10000 test/socket.io.ts",
"test:unit": "nyc mocha --require ts-node/register --reporter spec --slow 200 --bail --timeout 10000 test/index.ts",
"format:check": "prettier --check \"lib/**/*.ts\" \"test/**/*.ts\"",
"format:fix": "prettier --write \"lib/**/*.ts\" \"test/**/*.ts\"",
"prepack": "npm run compile"
@@ -51,21 +51,21 @@
"debug": "~4.3.2",
"engine.io": "~6.2.0",
"socket.io-adapter": "~2.4.0",
"socket.io-parser": "~4.0.4"
"socket.io-parser": "~4.2.0"
},
"devDependencies": {
"@types/mocha": "^9.0.0",
"expect.js": "0.3.1",
"mocha": "^3.5.3",
"mocha": "^10.0.0",
"nyc": "^15.1.0",
"prettier": "^2.3.2",
"rimraf": "^3.0.2",
"socket.io-client": "4.5.1",
"socket.io-client": "4.5.2",
"socket.io-client-v2": "npm:socket.io-client@^2.4.0",
"superagent": "^6.1.0",
"superagent": "^8.0.0",
"supertest": "^6.1.6",
"ts-node": "^10.2.1",
"tsd": "^0.17.0",
"tsd": "^0.21.0",
"typescript": "^4.4.2",
"uWebSockets.js": "github:uNetworking/uWebSockets.js#v20.0.0"
},

181
test/close.ts Normal file
View File

@@ -0,0 +1,181 @@
import { createServer } from "http";
import { io as ioc } from "socket.io-client";
import { join } from "path";
import { exec } from "child_process";
import { Server } from "..";
import expect from "expect.js";
import { createClient, getPort } from "./support/util";
import request from "supertest";
// TODO: update superagent as latest release now supports promises
const eioHandshake = (httpServer): Promise<string> => {
return new Promise((resolve) => {
request(httpServer)
.get("/socket.io/")
.query({ transport: "polling", EIO: 4 })
.end((err, res) => {
const sid = JSON.parse(res.text.substring(1)).sid;
resolve(sid);
});
});
};
const eioPush = (httpServer, sid: string, body: string): Promise<void> => {
return new Promise((resolve) => {
request(httpServer)
.post("/socket.io/")
.send(body)
.query({ transport: "polling", EIO: 4, sid })
.expect(200)
.end(() => {
resolve();
});
});
};
const eioPoll = (httpServer, sid): Promise<string> => {
return new Promise((resolve) => {
request(httpServer)
.get("/socket.io/")
.query({ transport: "polling", EIO: 4, sid })
.expect(200)
.end((err, res) => {
resolve(res.text);
});
});
};
describe("close", () => {
it("should be able to close sio sending a srv", (done) => {
const httpServer = createServer().listen(0);
const io = new Server(httpServer);
const port = getPort(io);
const net = require("net");
const server = net.createServer();
const clientSocket = createClient(io, "/", { reconnection: false });
clientSocket.on("disconnect", () => {
expect(io.sockets.sockets.size).to.equal(0);
server.listen(port);
});
clientSocket.on("connect", () => {
expect(io.sockets.sockets.size).to.equal(1);
io.close();
});
server.once("listening", () => {
// PORT should be free
server.close((error) => {
expect(error).to.be(undefined);
done();
});
});
});
it("should be able to close sio sending a srv", (done) => {
const io = new Server(0);
const port = getPort(io);
const net = require("net");
const server = net.createServer();
const clientSocket = ioc("ws://0.0.0.0:" + port, {
reconnection: false,
});
clientSocket.on("disconnect", () => {
expect(io.sockets.sockets.size).to.equal(0);
server.listen(port);
});
clientSocket.on("connect", () => {
expect(io.sockets.sockets.size).to.equal(1);
io.close();
});
server.once("listening", () => {
// PORT should be free
server.close((error) => {
expect(error).to.be(undefined);
done();
});
});
});
describe("graceful close", () => {
function fixture(filename) {
return (
'"' +
process.execPath +
'" "' +
join(__dirname, "fixtures", filename) +
'"'
);
}
it("should stop socket and timers", (done) => {
exec(fixture("server-close.ts"), done);
});
});
describe("protocol violations", () => {
it("should close the connection when receiving several CONNECT packets", async () => {
const httpServer = createServer();
const io = new Server(httpServer);
httpServer.listen(0);
const sid = await eioHandshake(httpServer);
// send a first CONNECT packet
await eioPush(httpServer, sid, "40");
// send another CONNECT packet
await eioPush(httpServer, sid, "40");
// session is cleanly closed (not discarded, see 'client.close()')
// first, we receive the Socket.IO handshake response
await eioPoll(httpServer, sid);
// then a close packet
const body = await eioPoll(httpServer, sid);
expect(body).to.be("6\u001e1");
io.close();
});
it("should close the connection when receiving an EVENT packet while not connected", async () => {
const httpServer = createServer();
const io = new Server(httpServer);
httpServer.listen(0);
const sid = await eioHandshake(httpServer);
// send an EVENT packet
await eioPush(httpServer, sid, '42["some event"]');
// session is cleanly closed, we receive a close packet
const body = await eioPoll(httpServer, sid);
expect(body).to.be("6\u001e1");
io.close();
});
it("should close the connection when receiving an invalid packet", async () => {
const httpServer = createServer();
const io = new Server(httpServer);
httpServer.listen(0);
const sid = await eioHandshake(httpServer);
// send a CONNECT packet
await eioPush(httpServer, sid, "40");
// send an invalid packet
await eioPush(httpServer, sid, "4abc");
// session is cleanly closed (not discarded, see 'client.close()')
// first, we receive the Socket.IO handshake response
await eioPoll(httpServer, sid);
// then a close packet
const body = await eioPoll(httpServer, sid);
expect(body).to.be("6\u001e1");
io.close();
});
});
});

87
test/handshake.ts Normal file
View File

@@ -0,0 +1,87 @@
import { Server } from "..";
import expect from "expect.js";
import { getPort, success } from "./support/util";
describe("handshake", () => {
const request = require("superagent");
it("should send the Access-Control-Allow-xxx headers on OPTIONS request", (done) => {
const io = new Server(0, {
cors: {
origin: "http://localhost:54023",
methods: ["GET", "POST"],
allowedHeaders: ["content-type"],
credentials: true,
},
});
request
.options(`http://localhost:${getPort(io)}/socket.io/default/`)
.query({ transport: "polling", EIO: 4 })
.set("Origin", "http://localhost:54023")
.end((err, res) => {
expect(res.status).to.be(204);
expect(res.headers["access-control-allow-origin"]).to.be(
"http://localhost:54023"
);
expect(res.headers["access-control-allow-methods"]).to.be("GET,POST");
expect(res.headers["access-control-allow-headers"]).to.be(
"content-type"
);
expect(res.headers["access-control-allow-credentials"]).to.be("true");
success(done, io);
});
});
it("should send the Access-Control-Allow-xxx headers on GET request", (done) => {
const io = new Server(0, {
cors: {
origin: "http://localhost:54024",
methods: ["GET", "POST"],
allowedHeaders: ["content-type"],
credentials: true,
},
});
request
.get(`http://localhost:${getPort(io)}/socket.io/default/`)
.query({ transport: "polling", EIO: 4 })
.set("Origin", "http://localhost:54024")
.end((err, res) => {
expect(res.status).to.be(200);
expect(res.headers["access-control-allow-origin"]).to.be(
"http://localhost:54024"
);
expect(res.headers["access-control-allow-credentials"]).to.be("true");
success(done, io);
});
});
it("should allow request if custom function in opts.allowRequest returns true", (done) => {
const io = new Server(0, {
allowRequest: (req, callback) => callback(null, true),
});
request
.get(`http://localhost:${getPort(io)}/socket.io/default/`)
.query({ transport: "polling", EIO: 4 })
.end((err, res) => {
expect(res.status).to.be(200);
success(done, io);
});
});
it("should disallow request if custom function in opts.allowRequest returns false", (done) => {
const io = new Server(0, {
allowRequest: (req, callback) => callback(null, false),
});
request
.get(`http://localhost:${getPort(io)}/socket.io/default/`)
.set("origin", "http://foo.example")
.query({ transport: "polling", EIO: 4 })
.end((err, res) => {
expect(res.status).to.be(403);
success(done, io);
});
});
});

23
test/index.ts Normal file
View File

@@ -0,0 +1,23 @@
"use strict";
import expect from "expect.js";
describe("socket.io", () => {
it("should be the same version as client", () => {
const version = require("../package").version;
expect(version).to.be(require("socket.io-client/package.json").version);
});
require("./server-attachment");
require("./handshake");
require("./close");
require("./namespaces");
require("./socket");
require("./messaging-many");
require("./middleware");
require("./socket-middleware");
require("./v2-compatibility");
require("./socket-timeout");
require("./uws");
require("./utility-methods");
});

501
test/messaging-many.ts Normal file
View File

@@ -0,0 +1,501 @@
import { Server } from "..";
import expect from "expect.js";
import {
createClient,
createPartialDone,
success,
successFn,
waitFor,
} from "./support/util";
describe("messaging many", () => {
it("emits to a namespace", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/test");
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2, socket3)
);
socket1.on("a", (a) => {
expect(a).to.be("b");
partialDone();
});
socket2.on("a", (a) => {
expect(a).to.be("b");
partialDone();
});
socket3.on("a", () => {
done(new Error("not"));
});
let sockets = 3;
io.on("connection", () => {
--sockets || emit();
});
io.of("/test", () => {
--sockets || emit();
});
function emit() {
io.emit("a", "b");
}
});
it("emits binary data to a namespace", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/test");
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2, socket3)
);
socket1.on("bin", (a) => {
expect(Buffer.isBuffer(a)).to.be(true);
partialDone();
});
socket2.on("bin", (a) => {
expect(Buffer.isBuffer(a)).to.be(true);
partialDone();
});
socket3.on("bin", () => {
done(new Error("not"));
});
let sockets = 3;
io.on("connection", () => {
--sockets || emit();
});
io.of("/test", () => {
--sockets || emit();
});
function emit() {
io.emit("bin", Buffer.alloc(10));
}
});
it("emits to the rest", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/test");
socket1.on("a", (a) => {
expect(a).to.be("b");
socket1.emit("finish");
});
socket2.emit("broadcast");
socket2.on("a", () => {
done(new Error("done"));
});
socket3.on("a", () => {
done(new Error("not"));
});
io.on("connection", (socket) => {
socket.on("broadcast", () => {
socket.broadcast.emit("a", "b");
});
socket.on("finish", () => {
success(done, io, socket1, socket2, socket3);
});
});
});
it("emits to rooms", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
socket2.on("a", () => {
done(new Error("not"));
});
socket1.on("a", () => {
success(done, io, socket1, socket2);
});
socket1.emit("join", "woot");
socket1.emit("emit", "woot");
io.on("connection", (socket) => {
socket.on("join", (room, fn) => {
socket.join(room);
fn && fn();
});
socket.on("emit", (room) => {
io.in(room).emit("a");
});
});
});
it("emits to rooms avoiding dupes", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2)
);
socket2.on("a", () => {
done(new Error("not"));
});
socket1.on("a", partialDone);
socket2.on("b", partialDone);
socket1.emit("join", "woot");
socket1.emit("join", "test");
socket2.emit("join", "third", () => {
socket2.emit("emit");
});
io.on("connection", (socket) => {
socket.on("join", (room, fn) => {
socket.join(room);
fn && fn();
});
socket.on("emit", () => {
io.in("woot").in("test").emit("a");
io.in("third").emit("b");
});
});
});
it("broadcasts to rooms", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2, socket3)
);
socket1.emit("join", "woot");
socket2.emit("join", "test");
socket3.emit("join", "test", () => {
socket3.emit("broadcast");
});
socket1.on("a", () => {
done(new Error("not"));
});
socket2.on("a", () => {
partialDone();
});
socket3.on("a", () => {
done(new Error("not"));
});
socket3.on("b", () => {
partialDone();
});
io.on("connection", (socket) => {
socket.on("join", (room, fn) => {
socket.join(room);
fn && fn();
});
socket.on("broadcast", () => {
socket.broadcast.to("test").emit("a");
socket.emit("b");
});
});
});
it("broadcasts binary data to rooms", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2, socket3)
);
socket1.emit("join", "woot");
socket2.emit("join", "test");
socket3.emit("join", "test", () => {
socket3.emit("broadcast");
});
socket1.on("bin", (data) => {
throw new Error("got bin in socket1");
});
socket2.on("bin", (data) => {
expect(Buffer.isBuffer(data)).to.be(true);
partialDone();
});
socket2.on("bin2", (data) => {
throw new Error("socket2 got bin2");
});
socket3.on("bin", (data) => {
throw new Error("socket3 got bin");
});
socket3.on("bin2", (data) => {
expect(Buffer.isBuffer(data)).to.be(true);
partialDone();
});
io.on("connection", (socket) => {
socket.on("join", (room, fn) => {
socket.join(room);
fn && fn();
});
socket.on("broadcast", () => {
socket.broadcast.to("test").emit("bin", Buffer.alloc(5));
socket.emit("bin2", Buffer.alloc(5));
});
});
});
it("keeps track of rooms", (done) => {
const io = new Server(0);
const socket = createClient(io);
io.on("connection", (s) => {
s.join("a");
expect(s.rooms).to.contain(s.id, "a");
s.join("b");
expect(s.rooms).to.contain(s.id, "a", "b");
s.join("c");
expect(s.rooms).to.contain(s.id, "a", "b", "c");
s.leave("b");
expect(s.rooms).to.contain(s.id, "a", "c");
(s as any).leaveAll();
expect(s.rooms.size).to.eql(0);
success(done, io, socket);
});
});
it("deletes empty rooms", (done) => {
const io = new Server(0);
const socket = createClient(io);
io.on("connection", (s) => {
s.join("a");
expect(s.nsp.adapter.rooms).to.contain("a");
s.leave("a");
expect(s.nsp.adapter.rooms).to.not.contain("a");
success(done, io, socket);
});
});
it("should properly cleanup left rooms", (done) => {
const io = new Server(0);
const socket = createClient(io);
io.on("connection", (s) => {
s.join("a");
expect(s.rooms).to.contain(s.id, "a");
s.join("b");
expect(s.rooms).to.contain(s.id, "a", "b");
s.leave("unknown");
expect(s.rooms).to.contain(s.id, "a", "b");
(s as any).leaveAll();
expect(s.rooms.size).to.eql(0);
success(done, io, socket);
});
});
it("allows to join several rooms at once", (done) => {
const io = new Server(0);
const socket = createClient(io);
io.on("connection", (s) => {
s.join(["a", "b", "c"]);
expect(s.rooms).to.contain(s.id, "a", "b", "c");
success(done, io, socket);
});
});
it("should exclude specific sockets when broadcasting", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
socket2.on("a", () => {
done(new Error("not"));
});
socket3.on("a", () => {
done(new Error("not"));
});
socket1.on("a", successFn(done, io, socket1, socket2, socket3));
io.on("connection", (socket) => {
socket.on("exclude", (id) => {
socket.broadcast.except(id).emit("a");
});
});
socket2.on("connect", () => {
socket3.emit("exclude", socket2.id);
});
});
it("should exclude a specific room when broadcasting", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
socket2.on("a", () => {
done(new Error("not"));
});
socket3.on("a", () => {
done(new Error("not"));
});
socket1.on("a", successFn(done, io, socket1, socket2, socket3));
io.on("connection", (socket) => {
socket.on("join", (room, cb) => {
socket.join(room);
cb();
});
socket.on("broadcast", () => {
socket.broadcast.except("room1").emit("a");
});
});
socket2.emit("join", "room1", () => {
socket3.emit("broadcast");
});
});
it("should return an immutable broadcast operator", (done) => {
const io = new Server(0);
const clientSocket = createClient(io);
io.on("connection", (socket) => {
const operator = socket.local
.compress(false)
.to(["room1", "room2"])
.except("room3");
operator.compress(true).emit("hello");
operator.volatile.emit("hello");
operator.to("room4").emit("hello");
operator.except("room5").emit("hello");
socket.emit("hello");
socket.to("room6").emit("hello");
// @ts-ignore
expect(operator.rooms).to.contain("room1", "room2");
// @ts-ignore
expect(operator.rooms).to.not.contain("room4", "room5", "room6");
// @ts-ignore
expect(operator.exceptRooms).to.contain("room3");
// @ts-ignore
expect(operator.flags).to.eql({ local: true, compress: false });
success(done, io, clientSocket);
});
});
it("should broadcast and expect multiple acknowledgements", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
socket1.on("some event", (cb) => {
cb(1);
});
socket2.on("some event", (cb) => {
cb(2);
});
socket3.on("some event", (cb) => {
cb(3);
});
Promise.all([
waitFor(socket1, "connect"),
waitFor(socket2, "connect"),
waitFor(socket3, "connect"),
]).then(() => {
io.timeout(2000).emit("some event", (err, responses) => {
expect(err).to.be(null);
expect(responses).to.have.length(3);
expect(responses).to.contain(1, 2, 3);
success(done, io, socket1, socket2, socket3);
});
});
});
it("should fail when a client does not acknowledge the event in the given delay", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
socket1.on("some event", (cb) => {
cb(1);
});
socket2.on("some event", (cb) => {
cb(2);
});
socket3.on("some event", () => {
// timeout
});
Promise.all([
waitFor(socket1, "connect"),
waitFor(socket2, "connect"),
waitFor(socket3, "connect"),
]).then(() => {
io.timeout(200).emit("some event", (err, responses) => {
expect(err).to.be.an(Error);
expect(responses).to.have.length(2);
expect(responses).to.contain(1, 2);
success(done, io, socket1, socket2, socket3);
});
});
});
it("should broadcast and return if the packet is sent to 0 client", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/", { multiplex: false });
const socket2 = createClient(io, "/", { multiplex: false });
const socket3 = createClient(io, "/", { multiplex: false });
socket1.on("some event", () => {
done(new Error("should not happen"));
});
socket2.on("some event", () => {
done(new Error("should not happen"));
});
socket3.on("some event", () => {
done(new Error("should not happen"));
});
io.to("room123")
.timeout(200)
.emit("some event", (err, responses) => {
expect(err).to.be(null);
expect(responses).to.have.length(0);
success(done, io, socket1, socket2, socket3);
});
});
});

210
test/middleware.ts Normal file
View File

@@ -0,0 +1,210 @@
import { Server, Socket } from "..";
import expect from "expect.js";
import {
success,
createClient,
successFn,
createPartialDone,
} from "./support/util";
describe("middleware", () => {
it("should call functions", (done) => {
const io = new Server(0);
let run = 0;
io.use((socket, next) => {
expect(socket).to.be.a(Socket);
run++;
next();
});
io.use((socket, next) => {
expect(socket).to.be.a(Socket);
run++;
next();
});
const socket = createClient(io);
socket.on("connect", () => {
expect(run).to.be(2);
success(done, io, socket);
});
});
it("should pass errors", (done) => {
const io = new Server(0);
io.use((socket, next) => {
next(new Error("Authentication error"));
});
io.use((socket, next) => {
done(new Error("nope"));
});
const socket = createClient(io);
socket.on("connect", () => {
done(new Error("nope"));
});
socket.on("connect_error", (err) => {
expect(err.message).to.be("Authentication error");
success(done, io, socket);
});
});
it("should pass an object", (done) => {
const io = new Server(0);
io.use((socket, next) => {
const err = new Error("Authentication error");
// @ts-ignore
err.data = { a: "b", c: 3 };
next(err);
});
const socket = createClient(io);
socket.on("connect", () => {
done(new Error("nope"));
});
socket.on("connect_error", (err) => {
expect(err).to.be.an(Error);
expect(err.message).to.eql("Authentication error");
// @ts-ignore
expect(err.data).to.eql({ a: "b", c: 3 });
success(done, io, socket);
});
});
it("should only call connection after fns", (done) => {
const io = new Server(0);
io.use((socket: any, next) => {
socket.name = "guillermo";
next();
});
const clientSocket = createClient(io);
io.on("connection", (socket) => {
expect((socket as any).name).to.be("guillermo");
success(done, io, clientSocket);
});
});
it("should only call connection after (lengthy) fns", (done) => {
const io = new Server(0);
let authenticated = false;
io.use((socket, next) => {
setTimeout(() => {
authenticated = true;
next();
}, 300);
});
const socket = createClient(io);
socket.on("connect", () => {
expect(authenticated).to.be(true);
success(done, io, socket);
});
});
it("should be ignored if socket gets closed", (done) => {
const io = new Server(0);
let socket;
io.use((s, next) => {
socket.io.engine.close();
s.client.conn.on("close", () => {
process.nextTick(next);
setTimeout(() => {
success(done, io, socket);
}, 50);
});
});
socket = createClient(io);
io.on("connection", (socket) => {
done(new Error("should not fire"));
});
});
it("should call functions in expected order", (done) => {
const io = new Server(0);
const result: number[] = [];
io.use(() => {
done(new Error("should not fire"));
});
io.of("/chat").use((socket, next) => {
result.push(1);
setTimeout(next, 50);
});
io.of("/chat").use((socket, next) => {
result.push(2);
setTimeout(next, 50);
});
io.of("/chat").use((socket, next) => {
result.push(3);
setTimeout(next, 50);
});
const chat = createClient(io, "/chat");
chat.on("connect", () => {
expect(result).to.eql([1, 2, 3]);
success(done, io, chat);
});
});
it("should disable the merge of handshake packets", (done) => {
const io = new Server(0);
io.use((socket, next) => {
next();
});
const socket = createClient(io);
socket.on("connect", successFn(done, io, socket));
});
it("should work with a custom namespace", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/");
const socket2 = createClient(io, "/chat");
const partialDone = createPartialDone(
2,
successFn(done, io, socket1, socket2)
);
io.of("/chat").use((socket, next) => {
next();
});
socket1.on("connect", partialDone);
socket2.on("connect", partialDone);
});
it("should only set `connected` to true after the middleware execution", (done) => {
const io = new Server(0);
const clientSocket = createClient(io, "/");
io.use((socket, next) => {
expect(socket.connected).to.be(false);
expect(socket.disconnected).to.be(true);
next();
});
io.on("connection", (socket) => {
expect(socket.connected).to.be(true);
expect(socket.disconnected).to.be(false);
success(done, io, clientSocket);
});
});
});

575
test/namespaces.ts Normal file
View File

@@ -0,0 +1,575 @@
import type { SocketId } from "socket.io-adapter";
import { Server, Namespace, Socket } from "..";
import expect from "expect.js";
import {
success,
createClient,
successFn,
createPartialDone,
} from "./support/util";
describe("namespaces", () => {
it("should be accessible through .sockets", () => {
const io = new Server();
expect(io.sockets).to.be.a(Namespace);
});
it("should be aliased", () => {
const io = new Server();
expect(io.use).to.be.a("function");
expect(io.to).to.be.a("function");
expect(io["in"]).to.be.a("function");
expect(io.emit).to.be.a("function");
expect(io.send).to.be.a("function");
expect(io.write).to.be.a("function");
expect(io.allSockets).to.be.a("function");
expect(io.compress).to.be.a("function");
});
it("should return an immutable broadcast operator", () => {
const io = new Server();
const operator = io.local.to(["room1", "room2"]).except("room3");
operator.compress(true).emit("hello");
operator.volatile.emit("hello");
operator.to("room4").emit("hello");
operator.except("room5").emit("hello");
io.to("room6").emit("hello");
// @ts-ignore
expect(operator.rooms).to.contain("room1", "room2");
// @ts-ignore
expect(operator.exceptRooms).to.contain("room3");
// @ts-ignore
expect(operator.flags).to.eql({ local: true });
});
it("should automatically connect", (done) => {
const io = new Server(0);
const socket = createClient(io);
socket.on("connect", successFn(done, io, socket));
});
it("should fire a `connection` event", (done) => {
const io = new Server(0);
const clientSocket = createClient(io);
io.on("connection", (socket) => {
expect(socket).to.be.a(Socket);
success(done, io, clientSocket);
});
});
it("should fire a `connect` event", (done) => {
const io = new Server(0);
const clientSocket = createClient(io);
io.on("connect", (socket) => {
expect(socket).to.be.a(Socket);
success(done, io, clientSocket);
});
});
it("should work with many sockets", (done) => {
const io = new Server(0);
io.of("/chat");
io.of("/news");
const chat = createClient(io, "/chat");
const news = createClient(io, "/news");
let total = 2;
chat.on("connect", () => {
--total || success(done, io, chat, news);
});
news.on("connect", () => {
--total || success(done, io, chat, news);
});
});
it('should be able to equivalently start with "" or "/" on server', (done) => {
const io = new Server(0);
const c1 = createClient(io, "/");
const c2 = createClient(io, "/abc");
let total = 2;
io.of("").on("connection", () => {
--total || success(done, io, c1, c2);
});
io.of("abc").on("connection", () => {
--total || success(done, io, c1, c2);
});
});
it('should be equivalent for "" and "/" on client', (done) => {
const io = new Server(0);
const c1 = createClient(io, "");
io.of("/").on("connection", successFn(done, io, c1));
});
it("should work with `of` and many sockets", (done) => {
const io = new Server(0);
const chat = createClient(io, "/chat");
const news = createClient(io, "/news");
let total = 2;
io.of("/news").on("connection", (socket) => {
expect(socket).to.be.a(Socket);
--total || success(done, io, chat, news);
});
io.of("/news").on("connection", (socket) => {
expect(socket).to.be.a(Socket);
--total || success(done, io, chat, news);
});
});
it("should work with `of` second param", (done) => {
const io = new Server(0);
const chat = createClient(io, "/chat");
const news = createClient(io, "/news");
let total = 2;
io.of("/news", (socket) => {
expect(socket).to.be.a(Socket);
--total || success(done, io, chat, news);
});
io.of("/news", (socket) => {
expect(socket).to.be.a(Socket);
--total || success(done, io, chat, news);
});
});
it("should disconnect upon transport disconnection", (done) => {
const io = new Server(0);
const chat = createClient(io, "/chat");
const news = createClient(io, "/news");
let total = 2;
let totald = 2;
let s;
io.of("/news", (socket) => {
socket.on("disconnect", (reason) => {
--totald || success(done, io, chat, news);
});
--total || close();
});
io.of("/chat", (socket) => {
s = socket;
socket.on("disconnect", (reason) => {
--totald || success(done, io, chat, news);
});
--total || close();
});
function close() {
s.disconnect(true);
}
});
it("should fire a `disconnecting` event just before leaving all rooms", (done) => {
const io = new Server(0);
const socket = createClient(io);
io.on("connection", (s) => {
s.join("a");
// FIXME not sure why process.nextTick() is needed here
process.nextTick(() => s.disconnect());
let total = 2;
s.on("disconnecting", (reason) => {
expect(s.rooms).to.contain(s.id, "a");
total--;
});
s.on("disconnect", (reason) => {
expect(s.rooms.size).to.eql(0);
--total || success(done, io, socket);
});
});
});
it("should return error connecting to non-existent namespace", (done) => {
const io = new Server(0);
const socket = createClient(io, "/doesnotexist");
socket.on("connect_error", (err) => {
expect(err.message).to.be("Invalid namespace");
success(done, io);
});
});
it("should not reuse same-namespace connections", (done) => {
const io = new Server(0);
const clientSocket1 = createClient(io);
const clientSocket2 = createClient(io);
let connections = 0;
io.on("connection", () => {
connections++;
if (connections === 2) {
success(done, io, clientSocket1, clientSocket2);
}
});
});
it("should find all clients in a namespace", (done) => {
const io = new Server(0);
const chatSids: string[] = [];
let otherSid: SocketId | null = null;
const c1 = createClient(io, "/chat");
const c2 = createClient(io, "/chat", { forceNew: true });
const c3 = createClient(io, "/other", { forceNew: true });
let total = 3;
io.of("/chat").on("connection", (socket) => {
chatSids.push(socket.id);
--total || getSockets();
});
io.of("/other").on("connection", (socket) => {
otherSid = socket.id;
--total || getSockets();
});
async function getSockets() {
const sids = await io.of("/chat").allSockets();
expect(sids).to.contain(chatSids[0], chatSids[1]);
expect(sids).to.not.contain(otherSid);
success(done, io, c1, c2, c3);
}
});
it("should find all clients in a namespace room", (done) => {
const io = new Server(0);
let chatFooSid: SocketId | null = null;
let chatBarSid: SocketId | null = null;
let otherSid: SocketId | null = null;
const c1 = createClient(io, "/chat");
const c2 = createClient(io, "/chat", { forceNew: true });
const c3 = createClient(io, "/other", { forceNew: true });
let chatIndex = 0;
let total = 3;
io.of("/chat").on("connection", (socket) => {
if (chatIndex++) {
socket.join("foo");
chatFooSid = socket.id;
--total || getSockets();
} else {
socket.join("bar");
chatBarSid = socket.id;
--total || getSockets();
}
});
io.of("/other").on("connection", (socket) => {
socket.join("foo");
otherSid = socket.id;
--total || getSockets();
});
async function getSockets() {
const sids = await io.of("/chat").in("foo").allSockets();
expect(sids).to.contain(chatFooSid);
expect(sids).to.not.contain(chatBarSid);
expect(sids).to.not.contain(otherSid);
success(done, io, c1, c2, c3);
}
});
it("should find all clients across namespace rooms", (done) => {
const io = new Server(0);
let chatFooSid: SocketId | null = null;
let chatBarSid: SocketId | null = null;
let otherSid: SocketId | null = null;
const c1 = createClient(io, "/chat");
const c2 = createClient(io, "/chat", { forceNew: true });
const c3 = createClient(io, "/other", { forceNew: true });
let chatIndex = 0;
let total = 3;
io.of("/chat").on("connection", (socket) => {
if (chatIndex++) {
socket.join("foo");
chatFooSid = socket.id;
--total || getSockets();
} else {
socket.join("bar");
chatBarSid = socket.id;
--total || getSockets();
}
});
io.of("/other").on("connection", (socket) => {
socket.join("foo");
otherSid = socket.id;
--total || getSockets();
});
async function getSockets() {
const sids = await io.of("/chat").allSockets();
expect(sids).to.contain(chatFooSid, chatBarSid);
expect(sids).to.not.contain(otherSid);
success(done, io, c1, c2, c3);
}
});
it("should not emit volatile event after regular event", (done) => {
const io = new Server(0);
let counter = 0;
io.of("/chat").on("connection", (s) => {
// Wait to make sure there are no packets being sent for opening the connection
setTimeout(() => {
io.of("/chat").emit("ev", "data");
io.of("/chat").volatile.emit("ev", "data");
}, 50);
});
const socket = createClient(io, "/chat");
socket.on("ev", () => {
counter++;
});
setTimeout(() => {
expect(counter).to.be(1);
success(done, io, socket);
}, 500);
});
it("should emit volatile event", (done) => {
const io = new Server(0);
let counter = 0;
io.of("/chat").on("connection", (s) => {
// Wait to make sure there are no packets being sent for opening the connection
setTimeout(() => {
io.of("/chat").volatile.emit("ev", "data");
}, 100);
});
const socket = createClient(io, "/chat");
socket.on("ev", () => {
counter++;
});
setTimeout(() => {
expect(counter).to.be(1);
success(done, io, socket);
}, 500);
});
it("should enable compression by default", (done) => {
const io = new Server(0);
const socket = createClient(io, "/chat");
io.of("/chat").on("connection", (s) => {
s.conn.once("packetCreate", (packet) => {
expect(packet.options.compress).to.be(true);
success(done, io, socket);
});
io.of("/chat").emit("woot", "hi");
});
});
it("should disable compression", (done) => {
const io = new Server(0);
const socket = createClient(io, "/chat");
io.of("/chat").on("connection", (s) => {
s.conn.once("packetCreate", (packet) => {
expect(packet.options.compress).to.be(false);
success(done, io, socket);
});
io.of("/chat").compress(false).emit("woot", "hi");
});
});
it("should throw on reserved event", () => {
const io = new Server();
expect(() => io.emit("connect")).to.throwException(
/"connect" is a reserved event name/
);
});
it("should close a client without namespace", (done) => {
const io = new Server(0, {
connectTimeout: 10,
});
const socket = createClient(io);
// @ts-ignore
socket.io.engine.write = () => {}; // prevent the client from sending a CONNECT packet
socket.on("disconnect", successFn(done, io, socket));
});
it("should exclude a specific socket when emitting", (done) => {
const io = new Server(0);
const socket1 = createClient(io, "/");
const socket2 = createClient(io, "/");
socket2.on("a", () => {
done(new Error("should not happen"));
});
socket1.on("a", successFn(done, io, socket1, socket2));
socket2.on("connect", () => {
io.except(socket2.id).emit("a");
});
});
it("should exclude a specific socket when emitting (in a namespace)", (done) => {
const io = new Server(0);
const nsp = io.of("/nsp");
const socket1 = createClient(io, "/nsp");
const socket2 = createClient(io, "/nsp");
socket2.on("a", () => {
done(new Error("not"));
});
socket1.on("a", successFn(done, io, socket1, socket2));
socket2.on("connect", () => {
nsp.except(socket2.id).emit("a");
});
});
it("should exclude a specific room when emitting", (done) => {
const io = new Server(0);
const nsp = io.of("/nsp");
const socket1 = createClient(io, "/nsp");
const socket2 = createClient(io, "/nsp");
socket1.on("a", successFn(done, io, socket1, socket2));
socket2.on("a", () => {
done(new Error("not"));
});
nsp.on("connection", (socket) => {
socket.on("broadcast", () => {
socket.join("room1");
nsp.except("room1").emit("a");
});
});
socket2.emit("broadcast");
});
it("should emit an 'new_namespace' event", (done) => {
const io = new Server();
io.on("new_namespace", (namespace) => {
expect(namespace.name).to.eql("/nsp");
done();
});
io.of("/nsp");
});
describe("dynamic namespaces", () => {
it("should allow connections to dynamic namespaces with a regex", (done) => {
const io = new Server(0);
const socket = createClient(io, "/dynamic-101");
const partialDone = createPartialDone(4, successFn(done, io, socket));
let dynamicNsp = io
.of(/^\/dynamic-\d+$/)
.on("connect", (socket) => {
expect(socket.nsp.name).to.be("/dynamic-101");
dynamicNsp.emit("hello", 1, "2", { 3: "4" });
partialDone();
})
.use((socket, next) => {
next();
partialDone();
});
socket.on("connect_error", (err) => {
expect().fail();
});
socket.on("connect", () => {
partialDone();
});
socket.on("hello", (a, b, c) => {
expect(a).to.eql(1);
expect(b).to.eql("2");
expect(c).to.eql({ 3: "4" });
partialDone();
});
});
it("should allow connections to dynamic namespaces with a function", (done) => {
const io = new Server(0);
const socket = createClient(io, "/dynamic-101");
io.of((name, query, next) => next(null, "/dynamic-101" === name));
socket.on("connect", successFn(done, io, socket));
});
it("should disallow connections when no dynamic namespace matches", (done) => {
const io = new Server(0);
const socket = createClient(io, "/abc");
io.of(/^\/dynamic-\d+$/);
io.of((name, query, next) => next(null, "/dynamic-101" === name));
socket.on("connect_error", (err) => {
expect(err.message).to.be("Invalid namespace");
success(done, io, socket);
});
});
it("should emit an 'new_namespace' event for a dynamic namespace", (done) => {
const io = new Server(0);
io.of(/^\/dynamic-\d+$/);
const socket = createClient(io, "/dynamic-101");
io.on("new_namespace", (namespace) => {
expect(namespace.name).to.be("/dynamic-101");
success(done, io, socket);
});
});
it("should handle race conditions with dynamic namespaces (#4136)", (done) => {
const io = new Server(0);
const counters = {
connected: 0,
created: 0,
events: 0,
};
const buffer: Function[] = [];
io.on("new_namespace", (namespace) => {
counters.created++;
});
const handler = () => {
if (++counters.events === 2) {
expect(counters.created).to.equal(1);
success(done, io, one, two);
}
};
io.of((name, query, next) => {
buffer.push(next);
if (buffer.length === 2) {
buffer.forEach((next) => next(null, true));
}
}).on("connection", (socket) => {
if (++counters.connected === 2) {
io.of("/dynamic-101").emit("message");
}
});
let one = createClient(io, "/dynamic-101");
let two = createClient(io, "/dynamic-101");
one.on("message", handler);
two.on("message", handler);
});
});
});

170
test/server-attachment.ts Normal file
View File

@@ -0,0 +1,170 @@
import { Server } from "..";
import { createServer } from "http";
import request from "supertest";
import expect from "expect.js";
import { getPort, successFn } from "./support/util";
describe("server attachment", () => {
describe("http.Server", () => {
const clientVersion = require("socket.io-client/package.json").version;
const testSource = (filename) => (done) => {
const srv = createServer();
new Server(srv);
request(srv)
.get("/socket.io/" + filename)
.buffer(true)
.end((err, res) => {
if (err) return done(err);
expect(res.headers["content-type"]).to.be("application/javascript");
expect(res.headers.etag).to.be('"' + clientVersion + '"');
expect(res.headers["x-sourcemap"]).to.be(undefined);
expect(res.text).to.match(/engine\.io/);
expect(res.status).to.be(200);
done();
});
};
const testSourceMap = (filename) => (done) => {
const srv = createServer();
new Server(srv);
request(srv)
.get("/socket.io/" + filename)
.buffer(true)
.end((err, res) => {
if (err) return done(err);
expect(res.headers["content-type"]).to.be("application/json");
expect(res.headers.etag).to.be('"' + clientVersion + '"');
expect(res.text).to.match(/engine\.io/);
expect(res.status).to.be(200);
done();
});
};
it("should serve client", testSource("socket.io.js"));
it(
"should serve client with query string",
testSource("socket.io.js?buster=" + Date.now())
);
it("should serve source map", testSourceMap("socket.io.js.map"));
it("should serve client (min)", testSource("socket.io.min.js"));
it("should serve source map (min)", testSourceMap("socket.io.min.js.map"));
it("should serve client (gzip)", (done) => {
const srv = createServer();
new Server(srv);
request(srv)
.get("/socket.io/socket.io.js")
.set("accept-encoding", "gzip,br,deflate")
.buffer(true)
.end((err, res) => {
if (err) return done(err);
expect(res.headers["content-encoding"]).to.be("gzip");
expect(res.status).to.be(200);
done();
});
});
it(
"should serve bundle with msgpack parser",
testSource("socket.io.msgpack.min.js")
);
it(
"should serve source map for bundle with msgpack parser",
testSourceMap("socket.io.msgpack.min.js.map")
);
it("should serve the ESM bundle", testSource("socket.io.esm.min.js"));
it(
"should serve the source map for the ESM bundle",
testSourceMap("socket.io.esm.min.js.map")
);
it("should handle 304", (done) => {
const srv = createServer();
new Server(srv);
request(srv)
.get("/socket.io/socket.io.js")
.set("If-None-Match", '"' + clientVersion + '"')
.end((err, res) => {
if (err) return done(err);
expect(res.statusCode).to.be(304);
done();
});
});
it("should handle 304", (done) => {
const srv = createServer();
new Server(srv);
request(srv)
.get("/socket.io/socket.io.js")
.set("If-None-Match", 'W/"' + clientVersion + '"')
.end((err, res) => {
if (err) return done(err);
expect(res.statusCode).to.be(304);
done();
});
});
it("should not serve static files", (done) => {
const srv = createServer();
new Server(srv, { serveClient: false });
request(srv).get("/socket.io/socket.io.js").expect(400, done);
});
it("should work with #attach", (done) => {
const srv = createServer((req, res) => {
res.writeHead(404);
res.end();
});
const sockets = new Server();
sockets.attach(srv);
request(srv)
.get("/socket.io/socket.io.js")
.end((err, res) => {
if (err) return done(err);
expect(res.status).to.be(200);
done();
});
});
it("should work with #attach (and merge options)", () => {
const srv = createServer((req, res) => {
res.writeHead(404);
res.end();
});
const server = new Server({
pingTimeout: 6000,
});
server.attach(srv, {
pingInterval: 24000,
});
// @ts-ignore
expect(server.eio.opts.pingTimeout).to.eql(6000);
// @ts-ignore
expect(server.eio.opts.pingInterval).to.eql(24000);
server.close();
});
});
describe("port", () => {
it("should be bound", (done) => {
const io = new Server(0);
request(`http://localhost:${getPort(io)}`)
.get("/socket.io/socket.io.js")
.expect(200, successFn(done, io));
});
it("with listen", (done) => {
const io = new Server().listen(0);
request(`http://localhost:${getPort(io)}`)
.get("/socket.io/socket.io.js")
.expect(200, successFn(done, io));
});
});
});

60
test/socket-middleware.ts Normal file
View File

@@ -0,0 +1,60 @@
import { Server } from "..";
import expect from "expect.js";
import { success, createClient } from "./support/util";
describe("socket middleware", () => {
it("should call functions", (done) => {
const io = new Server(0);
const clientSocket = createClient(io, "/", { multiplex: false });
clientSocket.emit("join", "woot");
let run = 0;
io.on("connection", (socket) => {
socket.use((event, next) => {
expect(event).to.eql(["join", "woot"]);
event.unshift("wrap");
run++;
next();
});
socket.use((event, next) => {
expect(event).to.eql(["wrap", "join", "woot"]);
run++;
next();
});
socket.on("wrap", (data1, data2) => {
expect(data1).to.be("join");
expect(data2).to.be("woot");
expect(run).to.be(2);
success(done, io, clientSocket);
});
});
});
it("should pass errors", (done) => {
const io = new Server(0);
const clientSocket = createClient(io, "/", { multiplex: false });
clientSocket.emit("join", "woot");
io.on("connection", (socket) => {
socket.use((event, next) => {
next(new Error("Authentication error"));
});
socket.use((event, next) => {
done(new Error("should not happen"));
});
socket.on("join", () => {
done(new Error("should not happen"));
});
socket.on("error", (err) => {
expect(err).to.be.an(Error);
expect(err.message).to.eql("Authentication error");
success(done, io, clientSocket);
});
});
});
});

File diff suppressed because it is too large Load Diff

1043
test/socket.ts Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -31,16 +31,50 @@ expect.Assertion.prototype.contain = function (...args) {
export function createClient(
io: Server,
nsp: string,
opts?: ManagerOptions & SocketOptions
nsp: string = "/",
opts?: Partial<ManagerOptions & SocketOptions>
): ClientSocket {
// @ts-ignore
const port = io.httpServer.address().port;
return ioc(`http://localhost:${port}${nsp}`, opts);
}
export function success(done: Function, io: Server, client: ClientSocket) {
export function success(
done: Function,
io: Server,
...clients: ClientSocket[]
) {
io.close();
client.disconnect();
clients.forEach((client) => client.disconnect());
done();
}
export function successFn(
done: () => void,
sio: Server,
...clientSockets: ClientSocket[]
) {
return () => success(done, sio, ...clientSockets);
}
export function getPort(io: Server): number {
// @ts-ignore
return io.httpServer.address().port;
}
export function createPartialDone(count: number, done: (err?: Error) => void) {
let i = 0;
return () => {
if (++i === count) {
done();
} else if (i > count) {
done(new Error(`partialDone() called too many times: ${i} > ${count}`));
}
};
}
export function waitFor(emitter, event) {
return new Promise((resolve) => {
emitter.once(event, resolve);
});
}

View File

@@ -6,26 +6,10 @@ import expect from "expect.js";
import type { AddressInfo } from "net";
import "./support/util";
import { createPartialDone } from "./support/util";
const SOCKETS_COUNT = 3;
const createPartialDone = (
count: number,
done: () => void,
callback?: () => void
) => {
let i = 0;
return () => {
i++;
if (i === count) {
done();
if (callback) {
callback();
}
}
};
};
class DummyAdapter extends Adapter {
fetchSockets(opts: BroadcastOptions): Promise<any[]> {
return Promise.resolve([
@@ -49,7 +33,7 @@ class DummyAdapter extends Adapter {
}
}
describe("socket.io", () => {
describe("utility methods", () => {
let io: Server, clientSockets: ClientSocket[], serverSockets: Socket[];
beforeEach((done) => {
const srv = createServer();
@@ -59,7 +43,12 @@ describe("socket.io", () => {
clientSockets = [];
for (let i = 0; i < SOCKETS_COUNT; i++) {
clientSockets.push(ioc(`http://localhost:${port}`));
clientSockets.push(
ioc(`http://localhost:${port}`, {
// FIXME needed so that clients are properly closed
transports: ["websocket"],
})
);
}
serverSockets = [];
@@ -77,100 +66,99 @@ describe("socket.io", () => {
clientSockets.forEach((socket) => socket.disconnect());
});
describe("utility methods", () => {
describe("fetchSockets", () => {
it("returns all socket instances", async () => {
const sockets = await io.fetchSockets();
expect(sockets.length).to.eql(3);
});
describe("fetchSockets", () => {
it("returns all socket instances", async () => {
const sockets = await io.fetchSockets();
expect(sockets.length).to.eql(3);
});
it("returns all socket instances in the given room", async () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
const sockets = await io.in("room1").fetchSockets();
expect(sockets.length).to.eql(2);
});
it("returns all socket instances in the given room", async () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
const sockets = await io.in("room1").fetchSockets();
expect(sockets.length).to.eql(2);
});
it("works with a custom adapter", async () => {
io.adapter(DummyAdapter);
const sockets = await io.fetchSockets();
expect(sockets.length).to.eql(1);
const remoteSocket = sockets[0];
expect(remoteSocket.id).to.eql("42");
expect(remoteSocket.rooms).to.contain("42", "room1");
expect(remoteSocket.data).to.eql({ username: "john" });
it("works with a custom adapter", async () => {
io.adapter(DummyAdapter);
const sockets = await io.fetchSockets();
expect(sockets.length).to.eql(1);
const remoteSocket = sockets[0];
expect(remoteSocket.id).to.eql("42");
expect(remoteSocket.rooms).to.contain("42", "room1");
expect(remoteSocket.data).to.eql({ username: "john" });
});
});
describe("socketsJoin", () => {
it("makes all socket instances join the given room", () => {
io.socketsJoin("room1");
serverSockets.forEach((socket) => {
expect(socket.rooms).to.contain("room1");
});
});
describe("socketsJoin", () => {
it("makes all socket instances join the given room", () => {
io.socketsJoin("room1");
serverSockets.forEach((socket) => {
expect(socket.rooms).to.contain("room1");
});
});
it("makes all socket instances in a room join the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room1").socketsJoin("room3");
expect(serverSockets[0].rooms).to.contain("room3");
expect(serverSockets[1].rooms).to.contain("room3");
expect(serverSockets[2].rooms).to.not.contain("room3");
});
});
it("makes all socket instances in a room join the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room1").socketsJoin("room3");
expect(serverSockets[0].rooms).to.contain("room3");
expect(serverSockets[1].rooms).to.contain("room3");
expect(serverSockets[2].rooms).to.not.contain("room3");
});
describe("socketsLeave", () => {
it("makes all socket instances leave the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.socketsLeave("room1");
expect(serverSockets[0].rooms).to.contain("room2");
expect(serverSockets[0].rooms).to.not.contain("room1");
expect(serverSockets[1].rooms).to.not.contain("room1");
});
describe("socketsLeave", () => {
it("makes all socket instances leave the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.socketsLeave("room1");
expect(serverSockets[0].rooms).to.contain("room2");
expect(serverSockets[0].rooms).to.not.contain("room1");
expect(serverSockets[1].rooms).to.not.contain("room1");
});
it("makes all socket instances in a room leave the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room2").socketsLeave("room1");
expect(serverSockets[0].rooms).to.contain("room2");
expect(serverSockets[0].rooms).to.not.contain("room1");
expect(serverSockets[1].rooms).to.contain("room1");
});
});
it("makes all socket instances in a room leave the given room", () => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room2").socketsLeave("room1");
expect(serverSockets[0].rooms).to.contain("room2");
expect(serverSockets[0].rooms).to.not.contain("room1");
expect(serverSockets[1].rooms).to.contain("room1");
});
describe("disconnectSockets", () => {
it("makes all socket instances disconnect", (done) => {
io.disconnectSockets(true);
const partialDone = createPartialDone(3, done);
clientSockets[0].on("disconnect", partialDone);
clientSockets[1].on("disconnect", partialDone);
clientSockets[2].on("disconnect", partialDone);
});
describe("disconnectSockets", () => {
it("makes all socket instances disconnect", (done) => {
io.disconnectSockets(true);
it("makes all socket instances in a room disconnect", (done) => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room2").disconnectSockets(true);
const partialDone = createPartialDone(3, done);
clientSockets[0].on("disconnect", partialDone);
clientSockets[1].on("disconnect", partialDone);
clientSockets[2].on("disconnect", partialDone);
const partialDone = createPartialDone(2, () => {
clientSockets[1].off("disconnect");
done();
});
it("makes all socket instances in a room disconnect", (done) => {
serverSockets[0].join(["room1", "room2"]);
serverSockets[1].join("room1");
serverSockets[2].join("room2");
io.in("room2").disconnectSockets(true);
const partialDone = createPartialDone(2, done, () => {
clientSockets[1].off("disconnect");
});
clientSockets[0].on("disconnect", partialDone);
clientSockets[1].on("disconnect", () => {
done(new Error("should not happen"));
});
clientSockets[2].on("disconnect", partialDone);
clientSockets[0].on("disconnect", partialDone);
clientSockets[1].on("disconnect", () => {
done(new Error("should not happen"));
});
clientSockets[2].on("disconnect", partialDone);
});
});
});

View File

@@ -1,4 +1,8 @@
import { App, us_socket_local_port } from "uWebSockets.js";
import {
App,
us_socket_local_port,
us_listen_socket_close,
} from "uWebSockets.js";
import { Server } from "..";
import { io as ioc, Socket as ClientSocket } from "socket.io-client";
import request from "supertest";
@@ -19,6 +23,7 @@ const shouldNotHappen = (done) => () => done(new Error("should not happen"));
describe("socket.io with uWebSocket.js-based engine", () => {
let io: Server,
uwsSocket: any,
port: number,
client: ClientSocket,
clientWSOnly: ClientSocket,
@@ -33,6 +38,7 @@ describe("socket.io with uWebSocket.js-based engine", () => {
io.of("/custom");
app.listen(0, (listenSocket) => {
uwsSocket = listenSocket;
port = us_socket_local_port(listenSocket);
client = ioc(`http://localhost:${port}`);
@@ -54,6 +60,8 @@ describe("socket.io with uWebSocket.js-based engine", () => {
afterEach(() => {
io.close();
us_listen_socket_close(uwsSocket);
client.disconnect();
clientWSOnly.disconnect();
clientPollingOnly.disconnect();
@@ -178,6 +186,12 @@ describe("socket.io with uWebSocket.js-based engine", () => {
io.to("room1").emit("hello");
});
it("should not crash when socket is disconnected before the upgrade", (done) => {
client.on("disconnect", () => done());
io.of("/").sockets.get(client.id)!.disconnect();
});
it("should serve static files", (done) => {
const clientVersion = require("socket.io-client/package.json").version;

64
test/v2-compatibility.ts Normal file
View File

@@ -0,0 +1,64 @@
import { Server, Socket } from "..";
import expect from "expect.js";
import { success, getPort, waitFor } from "./support/util";
import * as io_v2 from "socket.io-client-v2";
describe("v2 compatibility", () => {
it("should connect if `allowEIO3` is true", (done) => {
const io = new Server(0, {
allowEIO3: true,
});
const clientSocket = io_v2.connect(`http://localhost:${getPort(io)}`, {
multiplex: false,
});
Promise.all([
waitFor(io, "connection"),
waitFor(clientSocket, "connect"),
]).then(([socket]) => {
expect((socket as Socket).id).to.eql(clientSocket.id);
success(done, io, clientSocket);
});
});
it("should be able to connect to a namespace with a query", (done) => {
const io = new Server(0, {
allowEIO3: true,
});
const clientSocket = io_v2.connect(
`http://localhost:${getPort(io)}/the-namespace`,
{
multiplex: false,
}
);
clientSocket.query = { test: "123" };
Promise.all([
waitFor(io.of("/the-namespace"), "connection"),
waitFor(clientSocket, "connect"),
]).then(([socket]) => {
expect((socket as Socket).handshake.auth).to.eql({ test: "123" });
success(done, io, clientSocket);
});
});
it("should not connect if `allowEIO3` is false (default)", (done) => {
const io = new Server(0);
const clientSocket = io_v2.connect(`http://localhost:${getPort(io)}`, {
multiplex: false,
});
clientSocket.on("connect", () => {
done(new Error("should not happen"));
});
clientSocket.on("connect_error", () => {
success(done, io, clientSocket);
});
});
});