Skip to content

Commit

Permalink
feat: implement Socket.IO protocol v5
Browse files Browse the repository at this point in the history
In order to be compatible with Socket.IO v3.

- a CONNECT packet may now contain a payload
- the encode() method is synchronous
- a PacketType enum must be exported

Reference: https://github.com/socketio/socket.io-protocol/
  • Loading branch information
darrachequesne committed Oct 23, 2020
1 parent 8c30107 commit 2ab4657
Show file tree
Hide file tree
Showing 4 changed files with 122 additions and 278 deletions.
52 changes: 17 additions & 35 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
var msgpack = require("notepack.io");
var Emitter = require("component-emitter");

exports.protocol = 5;

/**
* Packet types (see https://github.com/socketio/socket.io-protocol)
*/

exports.CONNECT = 0;
exports.DISCONNECT = 1;
exports.EVENT = 2;
exports.ACK = 3;
exports.ERROR = 4;
exports.BINARY_EVENT = 5;
exports.BINARY_ACK = 6;
var PacketType = (exports.PacketType = {
CONNECT: 0,
DISCONNECT: 1,
EVENT: 2,
ACK: 3,
ERROR: 4,
});

var isInteger =
Number.isInteger ||
Expand All @@ -29,47 +31,27 @@ var isString = function (value) {

function Encoder() {}

Encoder.prototype.encode = function (packet, callback) {
switch (packet.type) {
case exports.CONNECT:
case exports.DISCONNECT:
case exports.ERROR:
return callback([JSON.stringify(packet)]);
default:
return callback([msgpack.encode(packet)]);
}
Encoder.prototype.encode = function (packet) {
return [msgpack.encode(packet)];
};

function Decoder() {}

Emitter(Decoder.prototype);

Decoder.prototype.add = function (obj) {
if (typeof obj === "string") {
this.parseJSON(obj);
} else {
this.parseBinary(obj);
}
};

Decoder.prototype.parseJSON = function (obj) {
var decoded = JSON.parse(obj);
this.checkPacket(decoded);
this.emit("decoded", decoded);
};

Decoder.prototype.parseBinary = function (obj) {
var decoded = msgpack.decode(obj);
this.checkPacket(decoded);
this.emit("decoded", decoded);
};

function isDataValid(decoded) {
switch (decoded.type) {
case exports.CONNECT:
case exports.DISCONNECT:
case PacketType.CONNECT:
return decoded.data === undefined || typeof decoded.data === "object";
case PacketType.DISCONNECT:
return decoded.data === undefined;
case exports.ERROR:
case PacketType.ERROR:
return isString(decoded.data);
default:
return Array.isArray(decoded.data);
Expand All @@ -79,8 +61,8 @@ function isDataValid(decoded) {
Decoder.prototype.checkPacket = function (decoded) {
var isTypeValid =
isInteger(decoded.type) &&
decoded.type >= exports.CONNECT &&
decoded.type <= exports.BINARY_ACK;
decoded.type >= PacketType.CONNECT &&
decoded.type <= PacketType.ERROR;
if (!isTypeValid) {
throw new Error("invalid packet type");
}
Expand Down
Loading

0 comments on commit 2ab4657

Please sign in to comment.