github/socket.io
1
1
Fork 0
mirror of https://github.com/socketio/socket.io.git synced 2026-01-09 06:58:02 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix message handler latency in test suites

Browse Source 
Related: https://github.com/socketio/socket.io-protocol/issues/32
This commit is contained in:
Damien Arrachequesne
2025-03-28 21:29:20 +01:00
parent 72d61dab82
commit e95f6abf93
2 changed files with 104 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
docs/engine.io-protocol/v4-test-suite/test-suite.js
View File

@@ -17,16 +17,35 @@ function sleep(delay) {
return new Promise((resolve) => setTimeout(resolve, delay));
}
function createWebSocket(url) {
const socket = new WebSocket(url);
socket._eventBuffer = {};
socket._pendingPromises = {};
for (const eventType of ["open", "close", "message"]) {
socket._eventBuffer[eventType] = [];
socket._pendingPromises[eventType] = [];
socket.addEventListener(eventType, (event) => {
if (socket._pendingPromises[eventType].length) {
socket._pendingPromises[eventType].shift()(event);
} else {
socket._eventBuffer[eventType].push(event);
}
});
}
return socket;
}
function waitFor(socket, eventType) {
return new Promise((resolve) => {
socket.addEventListener(
eventType,
(event) => {
resolve(event);
},
{ once: true }
);
});
if (socket._eventBuffer[eventType].length) {
return Promise.resolve(socket._eventBuffer[eventType].shift());
} else {
return new Promise((resolve) => {
socket._pendingPromises[eventType].push(resolve);
});
}
}
async function initLongPollingSession() {
@@ -110,7 +129,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("successfully opens a session", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -137,7 +156,7 @@ describe("Engine.IO protocol", () => {
});
it("fails with an invalid 'EIO' query parameter", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?transport=websocket`
);
@@ -145,9 +164,9 @@ describe("Engine.IO protocol", () => {
socket.on("error", () => {});
}
waitFor(socket, "close");
await waitFor(socket, "close");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/engine.io/?EIO=abc&transport=websocket`
);
@@ -155,19 +174,19 @@ describe("Engine.IO protocol", () => {
socket2.on("error", () => {});
}
waitFor(socket2, "close");
await waitFor(socket2, "close");
});
it("fails with an invalid 'transport' query parameter", async () => {
const socket = new WebSocket(`${WS_URL}/engine.io/?EIO=4`);
const socket = createWebSocket(`${WS_URL}/engine.io/?EIO=4`);
if (isNodejs) {
socket.on("error", () => {});
}
waitFor(socket, "close");
await waitFor(socket, "close");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=abc`
);
@@ -175,7 +194,7 @@ describe("Engine.IO protocol", () => {
socket2.on("error", () => {});
}
waitFor(socket2, "close");
await waitFor(socket2, "close");
});
});
});
@@ -317,7 +336,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("sends and receives a plain text packet", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -335,7 +354,7 @@ describe("Engine.IO protocol", () => {
});
it("sends and receives a binary packet", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
socket.binaryType = "arraybuffer";
@@ -352,7 +371,7 @@ describe("Engine.IO protocol", () => {
});
it("closes the session upon invalid packet format", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -412,7 +431,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("sends ping/pong packets", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -430,7 +449,7 @@ describe("Engine.IO protocol", () => {
});
it("closes the session upon ping timeout", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -468,7 +487,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("forcefully closes the session", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket`
);
@@ -485,7 +504,7 @@ describe("Engine.IO protocol", () => {
it("successfully upgrades from HTTP long-polling to WebSocket", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket&sid=${sid}`
);
@@ -521,12 +540,13 @@ describe("Engine.IO protocol", () => {
it("ignores HTTP requests with same sid after upgrade", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket&sid=${sid}`
);
await waitFor(socket, "open");
socket.send("2probe");
await waitFor(socket, "message"); // "3probe"
socket.send("5");
const pollResponse = await fetch(
@@ -545,15 +565,16 @@ describe("Engine.IO protocol", () => {
it("ignores WebSocket connection with same sid after upgrade", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket&sid=${sid}`
);
await waitFor(socket, "open");
socket.send("2probe");
await waitFor(socket, "message"); // "3probe"
socket.send("5");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/engine.io/?EIO=4&transport=websocket&sid=${sid}`
);

90
docs/socket.io-protocol/v5-test-suite/test-suite.js
View File

@@ -17,16 +17,35 @@ function sleep(delay) {
return new Promise((resolve) => setTimeout(resolve, delay));
}
function createWebSocket(url) {
const socket = new WebSocket(url);
socket._eventBuffer = {};
socket._pendingPromises = {};
for (const eventType of ["open", "close", "message"]) {
socket._eventBuffer[eventType] = [];
socket._pendingPromises[eventType] = [];
socket.addEventListener(eventType, (event) => {
if (socket._pendingPromises[eventType].length) {
socket._pendingPromises[eventType].shift()(event);
} else {
socket._eventBuffer[eventType].push(event);
}
});
}
return socket;
}
function waitFor(socket, eventType) {
return new Promise((resolve) => {
socket.addEventListener(
eventType,
(event) => {
resolve(event);
},
{ once: true }
);
});
if (socket._eventBuffer[eventType].length) {
return Promise.resolve(socket._eventBuffer[eventType].shift());
} else {
return new Promise((resolve) => {
socket._pendingPromises[eventType].push(resolve);
});
}
}
function waitForPackets(socket, count) {
@@ -55,7 +74,7 @@ async function initLongPollingSession() {
}
async function initSocketIOConnection() {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
socket.binaryType = "arraybuffer";
@@ -145,7 +164,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("should successfully open a session", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -172,7 +191,7 @@ describe("Engine.IO protocol", () => {
});
it("should fail with an invalid 'EIO' query parameter", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?transport=websocket`
);
@@ -180,9 +199,9 @@ describe("Engine.IO protocol", () => {
socket.on("error", () => {});
}
waitFor(socket, "close");
await waitFor(socket, "close");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/socket.io/?EIO=abc&transport=websocket`
);
@@ -190,19 +209,19 @@ describe("Engine.IO protocol", () => {
socket2.on("error", () => {});
}
waitFor(socket2, "close");
await waitFor(socket2, "close");
});
it("should fail with an invalid 'transport' query parameter", async () => {
const socket = new WebSocket(`${WS_URL}/socket.io/?EIO=4`);
const socket = createWebSocket(`${WS_URL}/socket.io/?EIO=4`);
if (isNodejs) {
socket.on("error", () => {});
}
waitFor(socket, "close");
await waitFor(socket, "close");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=abc`
);
@@ -210,7 +229,7 @@ describe("Engine.IO protocol", () => {
socket2.on("error", () => {});
}
waitFor(socket2, "close");
await waitFor(socket2, "close");
});
});
});
@@ -260,7 +279,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("should send ping/pong packets", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -278,7 +297,7 @@ describe("Engine.IO protocol", () => {
});
it("should close the session upon ping timeout", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -316,7 +335,7 @@ describe("Engine.IO protocol", () => {
describe("WebSocket", () => {
it("should forcefully close the session", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -333,7 +352,7 @@ describe("Engine.IO protocol", () => {
it("should successfully upgrade from HTTP long-polling to WebSocket", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
);
@@ -353,12 +372,13 @@ describe("Engine.IO protocol", () => {
it("should ignore HTTP requests with same sid after upgrade", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
);
await waitFor(socket, "open");
socket.send("2probe");
await waitFor(socket, "message"); // "3probe"
socket.send("5");
const pollResponse = await fetch(
@@ -371,15 +391,16 @@ describe("Engine.IO protocol", () => {
it("should ignore WebSocket connection with same sid after upgrade", async () => {
const sid = await initLongPollingSession();
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
);
await waitFor(socket, "open");
socket.send("2probe");
await waitFor(socket, "message"); // "3probe"
socket.send("5");
const socket2 = new WebSocket(
const socket2 = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
);
@@ -391,7 +412,7 @@ describe("Engine.IO protocol", () => {
describe("Socket.IO protocol", () => {
describe("connect", () => {
it("should allow connection to the main namespace", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -414,7 +435,7 @@ describe("Socket.IO protocol", () => {
});
it("should allow connection to the main namespace with a payload", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -437,7 +458,7 @@ describe("Socket.IO protocol", () => {
});
it("should allow connection to a custom namespace", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -460,7 +481,7 @@ describe("Socket.IO protocol", () => {
});
it("should allow connection to a custom namespace with a payload", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -483,7 +504,7 @@ describe("Socket.IO protocol", () => {
});
it("should disallow connection to an unknown namespace", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -497,7 +518,7 @@ describe("Socket.IO protocol", () => {
});
it("should disallow connection with an invalid handshake", async () => {
const socket = new WebSocket(
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
@@ -508,10 +529,9 @@ describe("Socket.IO protocol", () => {
await waitFor(socket, "close");
});
it("should close the connection if no handshake is received", async () => {
const socket = new WebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
const socket = createWebSocket(
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
);
await waitFor(socket, "close");