mirror of
https://github.com/socketio/socket.io.git
synced 2026-01-13 08:57:59 -05:00
184f3cf7af
This commit adds some syntactic sugar around acknowledgements:
- `emitWithAck()`
```js
try {
const responses = await io.timeout(1000).emitWithAck("some-event");
console.log(responses); // one response per client
} catch (e) {
// some clients did not acknowledge the event in the given delay
}
io.on("connection", async (socket) => {
// without timeout
const response = await socket.emitWithAck("hello", "world");
// with a specific timeout
try {
const response = await socket.timeout(1000).emitWithAck("hello", "world");
} catch (err) {
// the client did not acknowledge the event in the given delay
}
});
```
- `serverSideEmitWithAck()`
```js
try {
const responses = await io.timeout(1000).serverSideEmitWithAck("some-event");
console.log(responses); // one response per server (except itself)
} catch (e) {
// some servers did not acknowledge the event in the given delay
}
```
Related:
- https://github.com/socketio/socket.io/issues/4175
- https://github.com/socketio/socket.io/issues/4577
- https://github.com/socketio/socket.io/issues/4583
88 lines
2.2 KiB
TypeScript
88 lines
2.2 KiB
TypeScript
import { Server } from "..";
|
|
import { createClient, success } from "./support/util";
|
|
import expect from "expect.js";
|
|
|
|
describe("timeout", () => {
|
|
it("should timeout if the client does not acknowledge the event", (done) => {
|
|
const io = new Server(0);
|
|
const client = createClient(io, "/");
|
|
|
|
io.on("connection", (socket) => {
|
|
socket.timeout(50).emit("unknown", (err) => {
|
|
expect(err).to.be.an(Error);
|
|
success(done, io, client);
|
|
});
|
|
});
|
|
});
|
|
|
|
it("should timeout if the client does not acknowledge the event in time", (done) => {
|
|
const io = new Server(0);
|
|
const client = createClient(io, "/");
|
|
|
|
client.on("echo", (arg, cb) => {
|
|
cb(arg);
|
|
});
|
|
|
|
let count = 0;
|
|
|
|
io.on("connection", (socket) => {
|
|
socket.timeout(0).emit("echo", 42, (err) => {
|
|
expect(err).to.be.an(Error);
|
|
count++;
|
|
});
|
|
});
|
|
|
|
setTimeout(() => {
|
|
expect(count).to.eql(1);
|
|
success(done, io, client);
|
|
}, 200);
|
|
});
|
|
|
|
it("should not timeout if the client does acknowledge the event", (done) => {
|
|
const io = new Server(0);
|
|
const client = createClient(io, "/");
|
|
|
|
client.on("echo", (arg, cb) => {
|
|
cb(arg);
|
|
});
|
|
|
|
io.on("connection", (socket) => {
|
|
socket.timeout(50).emit("echo", 42, (err, value) => {
|
|
expect(err).to.be(null);
|
|
expect(value).to.be(42);
|
|
success(done, io, client);
|
|
});
|
|
});
|
|
});
|
|
|
|
it("should timeout if the client does not acknowledge the event (promise)", (done) => {
|
|
const io = new Server(0);
|
|
const client = createClient(io, "/");
|
|
|
|
io.on("connection", async (socket) => {
|
|
try {
|
|
await socket.timeout(50).emitWithAck("unknown");
|
|
expect.fail();
|
|
} catch (err) {
|
|
expect(err).to.be.an(Error);
|
|
success(done, io, client);
|
|
}
|
|
});
|
|
});
|
|
|
|
it("should not timeout if the client does acknowledge the event (promise)", (done) => {
|
|
const io = new Server(0);
|
|
const client = createClient(io, "/");
|
|
|
|
client.on("echo", (arg, cb) => {
|
|
cb(arg);
|
|
});
|
|
|
|
io.on("connection", async (socket) => {
|
|
const value = await socket.timeout(50).emitWithAck("echo", 42);
|
|
expect(value).to.be(42);
|
|
success(done, io, client);
|
|
});
|
|
});
|
|
});
|