Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Emit at most one event per microtask #2160

Merged
merged 1 commit into from
Aug 28, 2023
Merged

Emit at most one event per microtask #2160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions lib/receiver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ const { concat, toArrayBuffer, unmask } = require('./buffer-util');
const { isValidStatusCode, isValidUTF8 } = require('./validation');

const FastBuffer = Buffer[Symbol.species];
const promise = Promise.resolve();

const GET_INFO = 0;
const GET_PAYLOAD_LENGTH_16 = 1;
const GET_PAYLOAD_LENGTH_64 = 2;
const GET_MASK = 3;
const GET_DATA = 4;
const INFLATING = 5;
const WAIT_MICROTASK = 6;

/**
* HyBi Receiver implementation.
Expand Down Expand Up @@ -157,9 +160,23 @@ class Receiver extends Writable {
case GET_DATA:
err = this.getData(cb);
break;
case INFLATING:
this._loop = false;
return;
default:
// `INFLATING`
//
// `WAIT_MICROTASK`.
//
this._loop = false;

//
// `queueMicrotask()` is not available in Node.js < 11 and is no
// better anyway.
//
promise.then(() => {
this._state = GET_INFO;
this.startLoop(cb);
});
return;
}
} while (this._loop);
Expand Down Expand Up @@ -542,7 +559,7 @@ class Receiver extends Writable {
}
}

this._state = GET_INFO;
this._state = WAIT_MICROTASK;
}

/**
Expand All @@ -559,6 +576,8 @@ class Receiver extends Writable {
if (data.length === 0) {
this.emit('conclude', 1005, EMPTY_BUFFER);
this.end();

this._state = GET_INFO;
} else {
const code = data.readUInt16BE(0);

Expand Down Expand Up @@ -590,14 +609,16 @@ class Receiver extends Writable {

this.emit('conclude', code, buf);
this.end();

this._state = GET_INFO;
}
} else if (this._opcode === 0x09) {
this.emit('ping', data);
this._state = WAIT_MICROTASK;
} else {
this.emit('pong', data);
this._state = WAIT_MICROTASK;
}

this._state = GET_INFO;
}
}

Expand Down
92 changes: 92 additions & 0 deletions test/receiver.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1083,4 +1083,96 @@ describe('Receiver', () => {

receiver.write(Buffer.from([0x88, 0x03, 0x03, 0xe8, 0xf8]));
});

it("waits a microtask after each 'message' event", (done) => {
const messages = [];
const receiver = new Receiver();

receiver.on('message', (data, isBinary) => {
assert.ok(!isBinary);

const message = data.toString();
messages.push(message);

// `queueMicrotask()` is not available in Node.js < 11.
Promise.resolve().then(() => {
messages.push(`microtask ${message}`);

if (messages.length === 6) {
assert.deepStrictEqual(messages, [
'1',
'microtask 1',
'2',
'microtask 2',
'3',
'microtask 3'
]);

done();
}
});
});

receiver.write(Buffer.from('810131810132810133', 'hex'));
});

it("waits a microtask after each 'ping' event", (done) => {
const actual = [];
const receiver = new Receiver();

receiver.on('ping', (data) => {
const message = data.toString();
actual.push(message);

// `queueMicrotask()` is not available in Node.js < 11.
Promise.resolve().then(() => {
actual.push(`microtask ${message}`);

if (actual.length === 6) {
assert.deepStrictEqual(actual, [
'1',
'microtask 1',
'2',
'microtask 2',
'3',
'microtask 3'
]);

done();
}
});
});

receiver.write(Buffer.from('890131890132890133', 'hex'));
});

it("waits a microtask after each 'pong' event", (done) => {
const actual = [];
const receiver = new Receiver();

receiver.on('pong', (data) => {
const message = data.toString();
actual.push(message);

// `queueMicrotask()` is not available in Node.js < 11.
Promise.resolve().then(() => {
actual.push(`microtask ${message}`);

if (actual.length === 6) {
assert.deepStrictEqual(actual, [
'1',
'microtask 1',
'2',
'microtask 2',
'3',
'microtask 3'
]);

done();
}
});
});

receiver.write(Buffer.from('8A01318A01328A0133', 'hex'));
});
});
23 changes: 13 additions & 10 deletions test/websocket.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4109,18 +4109,18 @@ describe('WebSocket', () => {
const messages = [];
const ws = new WebSocket(`ws://localhost:${wss.address().port}`);

ws.on('open', () => {
ws._socket.on('end', () => {
assert.strictEqual(ws._receiver._state, 5);
});
});

ws.on('message', (message, isBinary) => {
assert.ok(!isBinary);

if (messages.push(message.toString()) > 1) return;

ws.close(1000);
// `queueMicrotask()` is not available in Node.js < 11.
Promise.resolve().then(() => {
process.nextTick(() => {
assert.strictEqual(ws._receiver._state, 5);
ws.close(1000);
});
});
});

ws.on('close', (code, reason) => {
Expand Down Expand Up @@ -4365,9 +4365,12 @@ describe('WebSocket', () => {

if (messages.push(message.toString()) > 1) return;

process.nextTick(() => {
assert.strictEqual(ws._receiver._state, 5);
ws.terminate();
// `queueMicrotask()` is not available in Node.js < 11.
Promise.resolve().then(() => {
process.nextTick(() => {
assert.strictEqual(ws._receiver._state, 5);
ws.terminate();
});
});
});

Expand Down