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

Fix parsing of IPC packets with multiple or partial messages #176

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix parsing of IPC packets with multiple or partial messages #176

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
080cd66
Fix parsing of IPC packets with multiple or partial messages
mpoc Aug 16, 2023
f4fa49f
Add early return for clarity
cuddeford Aug 16, 2023
4b025cd
Emit error event when received payload is not valid JSON
mpoc Aug 21, 2023
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
66 changes: 47 additions & 19 deletions src/transports/ipc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,10 @@ function encode(op, data) {
return packet;
}

const working = {
full: '',
const accumulatedData = {
payload: Buffer.alloc(0),
op: undefined,
expectedLength: 0,
};

function decode(socket, callback) {
Expand All @@ -77,23 +78,46 @@ function decode(socket, callback) {
return;
}

let { op } = working;
let raw;
if (working.full === '') {
op = working.op = packet.readInt32LE(0);
const len = packet.readInt32LE(4);
raw = packet.slice(8, len + 8);
} else {
raw = packet.toString();
}
accumulatedData.payload = Buffer.concat([accumulatedData.payload, packet]);

try {
const data = JSON.parse(working.full + raw);
callback({ op, data }); // eslint-disable-line callback-return
working.full = '';
working.op = undefined;
} catch (err) {
working.full += raw;
while (accumulatedData.payload.length > 0) {
if (accumulatedData.expectedLength === 0) {
// We are at the start of a new payload
accumulatedData.op = accumulatedData.payload.readInt32LE(0);
accumulatedData.expectedLength = accumulatedData.payload.readInt32LE(4);
accumulatedData.payload = accumulatedData.payload.subarray(8); // Remove opcode and length
}

if (accumulatedData.payload.length < accumulatedData.expectedLength) {
// Full payload hasn't been received yet, wait for more data
break;
}

// Accumulated data has the full payload and possibly the beginning of the next payload
const currentPayload = accumulatedData.payload.subarray(0, accumulatedData.expectedLength);
const nextPayload = accumulatedData.payload.subarray(accumulatedData.expectedLength);

accumulatedData.payload = nextPayload; // Keep remainder for next payload

try {
callback({
op: accumulatedData.op,
data: JSON.parse(currentPayload.toString('utf8')),
});

// Reset for next payload
accumulatedData.op = undefined;
accumulatedData.expectedLength = 0;
} catch (err) {
// Full payload has been received, but is not valid JSON
callback({ error: new Error('Received payload with malformed JSON', { cause: err }) });

// Reset for next payload
accumulatedData.op = undefined;
accumulatedData.expectedLength = 0;

break;
}
}

decode(socket, callback);
Expand All @@ -117,7 +141,11 @@ class IPCTransport extends EventEmitter {
}));
socket.pause();
socket.on('readable', () => {
decode(socket, ({ op, data }) => {
decode(socket, ({ error, op, data }) => {
if (error) {
this.client.emit('error', error);
return;
}
switch (op) {
case OPCodes.PING:
this.send(data, OPCodes.PONG);
Expand Down