mirror of
https://github.com/socketio/socket.io.git
synced 2026-01-09 15:08:12 -05:00
Merge remote-tracking branch 'socket.io-protocol/main'
Source: https://github.com/socketio/socket.io-protocol
This commit is contained in:
Damien Arrachequesne
733
docs/socket.io-protocol/v5-current.md
Normal file
733
docs/socket.io-protocol/v5-current.md
Normal file
@@ -0,0 +1,733 @@
|
||||
# Socket.IO Protocol
|
||||
|
||||
This document describes the 5th version of the Socket.IO protocol.
|
||||
|
||||
**Table of content**
|
||||
|
||||
- [Introduction](#introduction)
|
||||
- [Exchange protocol](#exchange-protocol)
|
||||
- [Connection to a namespace](#connection-to-a-namespace)
|
||||
- [Sending and receiving data](#sending-and-receiving-data)
|
||||
- [Acknowledgement](#acknowledgement)
|
||||
- [Disconnection from a namespace](#disconnection-from-a-namespace)
|
||||
- [Packet encoding](#packet-encoding)
|
||||
- [Format](#format)
|
||||
- [Examples](#examples)
|
||||
- [Connection to a namespace](#connection-to-a-namespace-1)
|
||||
- [Sending and receiving data](#sending-and-receiving-data-1)
|
||||
- [Acknowledgement](#acknowledgement-1)
|
||||
- [Disconnection from a namespace](#disconnection-from-a-namespace-1)
|
||||
- [Sample session](#sample-session)
|
||||
- [History](#history)
|
||||
- [Difference between v5 and v4](#difference-between-v5-and-v4)
|
||||
- [Difference between v4 and v3](#difference-between-v4-and-v3)
|
||||
- [Difference between v3 and v2](#difference-between-v3-and-v2)
|
||||
- [Difference between v2 and v1](#difference-between-v2-and-v1)
|
||||
- [Initial revision](#initial-revision)
|
||||
- [Test suite](#test-suite)
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
The Socket.IO protocol enables [full-duplex](https://en.wikipedia.org/wiki/Duplex_(telecommunications)#FULL-DUPLEX) and low-overhead communication between a client and a server.
|
||||
|
||||
It is built on top of [the Engine.IO protocol](https://github.com/socketio/engine.io-protocol), which handles the low-level plumbing with WebSocket and HTTP long-polling.
|
||||
|
||||
The Socket.IO protocol adds the following features:
|
||||
|
||||
- multiplexing (referred as ["namespace"](https://socket.io/docs/v4/namespaces) in the Socket.IO jargon)
|
||||
|
||||
Example with the JavaScript API:
|
||||
|
||||
*Server*
|
||||
|
||||
```js
|
||||
// declare the namespace
|
||||
const namespace = io.of("/admin");
|
||||
// handle the connection to the namespace
|
||||
namespace.on("connection", (socket) => {
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
*Client*
|
||||
|
||||
```js
|
||||
// reach the main namespace
|
||||
const socket1 = io();
|
||||
// reach the "/admin" namespace (with the same underlying WebSocket connection)
|
||||
const socket2 = io("/admin");
|
||||
// handle the connection to the namespace
|
||||
socket2.on("connect", () => {
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
||||
- acknowledgement of packets
|
||||
|
||||
Example with the JavaScript API:
|
||||
|
||||
```js
|
||||
// on one side
|
||||
socket.emit("hello", "foo", (arg) => {
|
||||
console.log("received", arg);
|
||||
});
|
||||
|
||||
// on the other side
|
||||
socket.on("hello", (arg, ack) => {
|
||||
ack("bar");
|
||||
});
|
||||
```
|
||||
|
||||
The reference implementation is written in [TypeScript](https://www.typescriptlang.org/):
|
||||
|
||||
- server: https://github.com/socketio/socket.io
|
||||
- client: https://github.com/socketio/socket.io-client
|
||||
|
||||
|
||||
## Exchange protocol
|
||||
|
||||
A Socket.IO packet contains the following fields:
|
||||
|
||||
- a packet type (integer)
|
||||
- a namespace (string)
|
||||
- optionally, a payload (Object | Array)
|
||||
- optionally, an acknowledgment id (integer)
|
||||
|
||||
Here is the list of available packet types:
|
||||
|
||||
| Type | ID | Usage |
|
||||
|---------------|-----|---------------------------------------------------------------------------------------|
|
||||
| CONNECT | 0 | Used during the [connection to a namespace](#connection-to-a-namespace). |
|
||||
| DISCONNECT | 1 | Used when [disconnecting from a namespace](#disconnection-from-a-namespace). |
|
||||
| EVENT | 2 | Used to [send data](#sending-and-receiving-data) to the other side. |
|
||||
| ACK | 3 | Used to [acknowledge](#acknowledgement) an event. |
|
||||
| CONNECT_ERROR | 4 | Used during the [connection to a namespace](#connection-to-a-namespace). |
|
||||
| BINARY_EVENT | 5 | Used to [send binary data](#sending-and-receiving-data) to the other side. |
|
||||
| BINARY_ACK | 6 | Used to [acknowledge](#acknowledgement) an event (the response includes binary data). |
|
||||
|
||||
|
||||
### Connection to a namespace
|
||||
|
||||
At the beginning of a Socket.IO session, the client MUST send a `CONNECT` packet:
|
||||
|
||||
The server MUST respond with either:
|
||||
|
||||
- a `CONNECT` packet if the connection is successful, with the session ID in the payload
|
||||
- or a `CONNECT_ERROR` packet if the connection is not allowed
|
||||
|
||||
```
|
||||
CLIENT SERVER
|
||||
|
||||
│ ───────────────────────────────────────────────────────► │
|
||||
│ { type: CONNECT, namespace: "/" } │
|
||||
│ ◄─────────────────────────────────────────────────────── │
|
||||
│ { type: CONNECT, namespace: "/", data: { sid: "..." } } │
|
||||
```
|
||||
|
||||
If the server does not receive a `CONNECT` packet first, then it MUST close the connection immediately.
|
||||
|
||||
A client MAY be connected to multiple namespaces at the same time, with the same underlying WebSocket connection.
|
||||
|
||||
Examples:
|
||||
|
||||
- with the main namespace (named `"/"`)
|
||||
|
||||
```
|
||||
Client > { type: CONNECT, namespace: "/" }
|
||||
Server > { type: CONNECT, namespace: "/", data: { sid: "wZX3oN0bSVIhsaknAAAI" } }
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
```
|
||||
Client > { type: CONNECT, namespace: "/admin" }
|
||||
Server > { type: CONNECT, namespace: "/admin", data: { sid: "oSO0OpakMV_3jnilAAAA" } }
|
||||
```
|
||||
|
||||
- with an additional payload
|
||||
|
||||
```
|
||||
Client > { type: CONNECT, namespace: "/admin", data: { "token": "123" } }
|
||||
Server > { type: CONNECT, namespace: "/admin", data: { sid: "iLnRaVGHY4B75TeVAAAB" } }
|
||||
```
|
||||
|
||||
- in case the connection is refused
|
||||
|
||||
```
|
||||
Client > { type: CONNECT, namespace: "/" }
|
||||
Server > { type: CONNECT_ERROR, namespace: "/", data: { message: "Not authorized" } }
|
||||
```
|
||||
|
||||
### Sending and receiving data
|
||||
|
||||
Once the [connection to a namespace](#connection-to-a-namespace) is established, the client and the server can begin exchanging data:
|
||||
|
||||
```
|
||||
CLIENT SERVER
|
||||
|
||||
│ ───────────────────────────────────────────────────────► │
|
||||
│ { type: EVENT, namespace: "/", data: ["foo"] } │
|
||||
│ │
|
||||
│ ◄─────────────────────────────────────────────────────── │
|
||||
│ { type: EVENT, namespace: "/", data: ["bar"] } │
|
||||
```
|
||||
|
||||
The payload is mandatory and MUST be a non-empty array. If that's not the case, then the receiver MUST close the connection.
|
||||
|
||||
Examples:
|
||||
|
||||
- with the main namespace
|
||||
|
||||
```
|
||||
Client > { type: EVENT, namespace: "/", data: ["foo"] }
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
```
|
||||
Server > { type: EVENT, namespace: "/admin", data: ["bar"] }
|
||||
```
|
||||
|
||||
- with binary data
|
||||
|
||||
```
|
||||
Client > { type: BINARY_EVENT, namespace: "/", data: ["baz", <Buffer <01 02 03 04>> ] }
|
||||
```
|
||||
|
||||
### Acknowledgement
|
||||
|
||||
The sender MAY include an event ID in order to request an acknowledgement from the receiver:
|
||||
|
||||
```
|
||||
CLIENT SERVER
|
||||
|
||||
│ ───────────────────────────────────────────────────────► │
|
||||
│ { type: EVENT, namespace: "/", data: ["foo"], id: 12 } │
|
||||
│ ◄─────────────────────────────────────────────────────── │
|
||||
│ { type: ACK, namespace: "/", data: ["bar"], id: 12 } │
|
||||
```
|
||||
|
||||
The receiver MUST respond with an `ACK` packet with the same event ID.
|
||||
|
||||
The payload is mandatory and MUST be an array (possibly empty).
|
||||
|
||||
Examples:
|
||||
|
||||
- with the main namespace
|
||||
|
||||
```
|
||||
Client > { type: EVENT, namespace: "/", data: ["foo"], id: 12 }
|
||||
Server > { type: ACK, namespace: "/", data: [], id: 12 }
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
```
|
||||
Server > { type: EVENT, namespace: "/admin", data: ["foo"], id: 13 }
|
||||
Client > { type: ACK, namespace: "/admin", data: ["bar"], id: 13 }
|
||||
```
|
||||
|
||||
- with binary data
|
||||
|
||||
```
|
||||
Client > { type: BINARY_EVENT, namespace: "/", data: ["foo", <buffer <01 02 03 04> ], id: 14 }
|
||||
Server > { type: ACK, namespace: "/", data: ["bar"], id: 14 }
|
||||
|
||||
or
|
||||
|
||||
Server > { type: EVENT, namespace: "/", data: ["foo" ], id: 15 }
|
||||
Client > { type: BINARY_ACK, namespace: "/", data: ["bar", <buffer <01 02 03 04>], id: 15 }
|
||||
```
|
||||
|
||||
### Disconnection from a namespace
|
||||
|
||||
At any time, one side can end the connection to a namespace by sending a `DISCONNECT` packet:
|
||||
|
||||
```
|
||||
CLIENT SERVER
|
||||
|
||||
│ ───────────────────────────────────────────────────────► │
|
||||
│ { type: DISCONNECT, namespace: "/" } │
|
||||
```
|
||||
|
||||
No response is expected from the other side. The low-level connection MAY be kept alive if the client is connected to another namespace.
|
||||
|
||||
|
||||
## Packet encoding
|
||||
|
||||
This section details the encoding used by the default parser which is included in Socket.IO server and client, and
|
||||
whose source can be found [here](https://github.com/socketio/socket.io-parser).
|
||||
|
||||
The JavaScript server and client implementations also supports custom parsers, which have different tradeoffs and may benefit to
|
||||
certain kind of applications. Please see [socket.io-json-parser](https://github.com/socketio/socket.io-json-parser)
|
||||
or [socket.io-msgpack-parser](https://github.com/socketio/socket.io-msgpack-parser) for example.
|
||||
|
||||
Please also note that each Socket.IO packet is sent as a Engine.IO `message` packet (more information [here](https://github.com/socketio/engine.io-protocol)),
|
||||
so the encoded result will be prefixed by the character `"4"` when sent over the wire (in the request/response body with HTTP
|
||||
long-polling, or in the WebSocket frame).
|
||||
|
||||
### Format
|
||||
|
||||
```
|
||||
<packet type>[<# of binary attachments>-][<namespace>,][<acknowledgment id>][JSON-stringified payload without binary]
|
||||
|
||||
+ binary attachments extracted
|
||||
```
|
||||
|
||||
Note: the namespace is only included if it is different from the main namespace (`/`)
|
||||
|
||||
### Examples
|
||||
|
||||
#### Connection to a namespace
|
||||
|
||||
- with the main namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: CONNECT, namespace: "/" }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
0
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: CONNECT, namespace: "/admin", data: { sid: "oSO0OpakMV_3jnilAAAA" } }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
0/admin,{"sid":"oSO0OpakMV_3jnilAAAA"}
|
||||
```
|
||||
|
||||
- in case the connection is refused
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: CONNECT_ERROR, namespace: "/", data: { message: "Not authorized" } }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
4{"message":"Not authorized"}
|
||||
```
|
||||
|
||||
#### Sending and receiving data
|
||||
|
||||
- with the main namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: EVENT, namespace: "/", data: ["foo"] }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
2["foo"]
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: EVENT, namespace: "/admin", data: ["bar"] }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
2/admin,["bar"]
|
||||
```
|
||||
|
||||
- with binary data
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: BINARY_EVENT, namespace: "/", data: ["baz", <Buffer <01 02 03 04>> ] }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
51-["baz",{"_placeholder":true,"num":0}]
|
||||
|
||||
+ <Buffer <01 02 03 04>>
|
||||
```
|
||||
|
||||
- with multiple attachments
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: BINARY_EVENT, namespace: "/admin", data: ["baz", <Buffer <01 02>>, <Buffer <03 04>> ] }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
52-/admin,["baz",{"_placeholder":true,"num":0},{"_placeholder":true,"num":1}]
|
||||
|
||||
+ <Buffer <01 02>>
|
||||
+ <Buffer <03 04>>
|
||||
```
|
||||
|
||||
Please remember that each Socket.IO packet is wrapped in a Engine.IO `message` packet, so they will be prefixed by the character `"4"` when sent over the wire.
|
||||
|
||||
Example: `{ type: EVENT, namespace: "/", data: ["foo"] }` will be sent as `42["foo"]`
|
||||
|
||||
#### Acknowledgement
|
||||
|
||||
- with the main namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: EVENT, namespace: "/", data: ["foo"], id: 12 }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
212["foo"]
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: ACK, namespace: "/admin", data: ["bar"], id: 13 }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
3/admin,13["bar"]`
|
||||
```
|
||||
|
||||
- with binary data
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: BINARY_ACK, namespace: "/", data: ["bar", <Buffer <01 02 03 04>>], id: 15 }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
61-15["bar",{"_placeholder":true,"num":0}]
|
||||
|
||||
+ <Buffer <01 02 03 04>>
|
||||
```
|
||||
|
||||
#### Disconnection from a namespace
|
||||
|
||||
- with the main namespace
|
||||
|
||||
*Packet*
|
||||
|
||||
```
|
||||
{ type: DISCONNECT, namespace: "/" }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
1
|
||||
```
|
||||
|
||||
- with a custom namespace
|
||||
|
||||
```
|
||||
{ type: DISCONNECT, namespace: "/admin" }
|
||||
```
|
||||
|
||||
*Encoded*
|
||||
|
||||
```
|
||||
1/admin,
|
||||
```
|
||||
|
||||
|
||||
## Sample session
|
||||
|
||||
Here is an example of what is sent over the wire when combining both the Engine.IO and the Socket.IO protocols.
|
||||
|
||||
- Request n°1 (open packet)
|
||||
|
||||
```
|
||||
GET /socket.io/?EIO=4&transport=polling&t=N8hyd6w
|
||||
< HTTP/1.1 200 OK
|
||||
< Content-Type: text/plain; charset=UTF-8
|
||||
0{"sid":"lv_VI97HAXpY6yYWAAAC","upgrades":["websocket"],"pingInterval":25000,"pingTimeout":5000,"maxPayload":1000000}
|
||||
```
|
||||
|
||||
Details:
|
||||
|
||||
```
|
||||
0 => Engine.IO "open" packet type
|
||||
{"sid":... => the Engine.IO handshake data
|
||||
```
|
||||
|
||||
Note: the `t` query param is used to ensure that the request is not cached by the browser.
|
||||
|
||||
- Request n°2 (namespace connection request):
|
||||
|
||||
```
|
||||
POST /socket.io/?EIO=4&transport=polling&t=N8hyd7H&sid=lv_VI97HAXpY6yYWAAAC
|
||||
< HTTP/1.1 200 OK
|
||||
< Content-Type: text/plain; charset=UTF-8
|
||||
40
|
||||
```
|
||||
|
||||
Details:
|
||||
|
||||
```
|
||||
4 => Engine.IO "message" packet type
|
||||
0 => Socket.IO "CONNECT" packet type
|
||||
```
|
||||
|
||||
- Request n°3 (namespace connection approval)
|
||||
|
||||
```
|
||||
GET /socket.io/?EIO=4&transport=polling&t=N8hyd7H&sid=lv_VI97HAXpY6yYWAAAC
|
||||
< HTTP/1.1 200 OK
|
||||
< Content-Type: text/plain; charset=UTF-8
|
||||
40{"sid":"wZX3oN0bSVIhsaknAAAI"}
|
||||
```
|
||||
|
||||
- Request n°4
|
||||
|
||||
`socket.emit('hey', 'Jude')` is executed on the server:
|
||||
|
||||
```
|
||||
GET /socket.io/?EIO=4&transport=polling&t=N8hyd7H&sid=lv_VI97HAXpY6yYWAAAC
|
||||
< HTTP/1.1 200 OK
|
||||
< Content-Type: text/plain; charset=UTF-8
|
||||
42["hey","Jude"]
|
||||
```
|
||||
|
||||
Details:
|
||||
|
||||
```
|
||||
4 => Engine.IO "message" packet type
|
||||
2 => Socket.IO "EVENT" packet type
|
||||
[...] => content
|
||||
```
|
||||
|
||||
- Request n°5 (message out)
|
||||
|
||||
`socket.emit('hello'); socket.emit('world');` is executed on the client:
|
||||
|
||||
```
|
||||
POST /socket.io/?EIO=4&transport=polling&t=N8hzxke&sid=lv_VI97HAXpY6yYWAAAC
|
||||
> Content-Type: text/plain; charset=UTF-8
|
||||
42["hello"]\x1e42["world"]
|
||||
< HTTP/1.1 200 OK
|
||||
< Content-Type: text/plain; charset=UTF-8
|
||||
ok
|
||||
```
|
||||
|
||||
Details:
|
||||
|
||||
```
|
||||
4 => Engine.IO "message" packet type
|
||||
2 => Socket.IO "EVENT" packet type
|
||||
["hello"] => the 1st content
|
||||
\x1e => separator
|
||||
4 => Engine.IO "message" packet type
|
||||
2 => Socket.IO "EVENT" packet type
|
||||
["world"] => the 2nd content
|
||||
```
|
||||
|
||||
- Request n°6 (WebSocket upgrade)
|
||||
|
||||
```
|
||||
GET /socket.io/?EIO=4&transport=websocket&sid=lv_VI97HAXpY6yYWAAAC
|
||||
< HTTP/1.1 101 Switching Protocols
|
||||
```
|
||||
|
||||
WebSocket frames:
|
||||
|
||||
```
|
||||
< 2probe => Engine.IO probe request
|
||||
> 3probe => Engine.IO probe response
|
||||
> 5 => Engine.IO "upgrade" packet type
|
||||
> 42["hello"]
|
||||
> 42["world"]
|
||||
> 40/admin, => request access to the admin namespace (Socket.IO "CONNECT" packet)
|
||||
< 40/admin,{"sid":"-G5j-67EZFp-q59rADQM"} => grant access to the admin namespace
|
||||
> 42/admin,1["tellme"] => Socket.IO "EVENT" packet with acknowledgement
|
||||
< 461-/admin,1[{"_placeholder":true,"num":0}] => Socket.IO "BINARY_ACK" packet with a placeholder
|
||||
< <binary> => the binary attachment (sent in the following frame)
|
||||
... after a while without message
|
||||
> 2 => Engine.IO "ping" packet type
|
||||
< 3 => Engine.IO "pong" packet type
|
||||
> 1 => Engine.IO "close" packet type
|
||||
```
|
||||
|
||||
## History
|
||||
|
||||
### Difference between v5 and v4
|
||||
|
||||
The 5th revision (current) of the Socket.IO protocol is used in Socket.IO v3 and above (`v3.0.0` was released in November 2020).
|
||||
|
||||
It is built on top of the 4th revision of [the Engine.IO protocol](https://github.com/socketio/engine.io-protocol) (hence the `EIO=4` query parameter).
|
||||
|
||||
List of changes:
|
||||
|
||||
- remove the implicit connection to the default namespace
|
||||
|
||||
In previous versions, a client was always connected to the default namespace, even if it requested access to another namespace.
|
||||
|
||||
This is not the case anymore, the client must send a `CONNECT` packet in any case.
|
||||
|
||||
Commits: [09b6f23](https://github.com/socketio/socket.io/commit/09b6f2333950b8afc8c1400b504b01ad757876bd) (server) and [249e0be](https://github.com/socketio/socket.io-client/commit/249e0bef9071e7afd785485961c4eef0094254e8) (client)
|
||||
|
||||
|
||||
- rename `ERROR` to `CONNECT_ERROR`
|
||||
|
||||
The meaning and the code number (4) are not modified: this packet type is still used by the server when the connection to a namespace is refused. But we feel the name is more self-descriptive.
|
||||
|
||||
Commits: [d16c035](https://github.com/socketio/socket.io/commit/d16c035d258b8deb138f71801cb5aeedcdb3f002) (server) and [13e1db7c](https://github.com/socketio/socket.io-client/commit/13e1db7c94291c583d843beaa9e06ee041ae4f26) (client).
|
||||
|
||||
|
||||
- the `CONNECT` packet now can contain a payload
|
||||
|
||||
The client can send a payload for authentication/authorization purposes. Example:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": 0,
|
||||
"nsp": "/admin",
|
||||
"data": {
|
||||
"token": "123"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
In case of success, the server responds with a payload contain the ID of the Socket. Example:
|
||||
|
||||
```json
|
||||
{
|
||||
"type": 0,
|
||||
"nsp": "/admin",
|
||||
"data": {
|
||||
"sid": "CjdVH4TQvovi1VvgAC5Z"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
This change means that the ID of the Socket.IO connection will now be different from the ID of the underlying Engine.IO connection (the one that is found in the query parameters of the HTTP requests).
|
||||
|
||||
Commits: [2875d2c](https://github.com/socketio/socket.io/commit/2875d2cfdfa463e64cb520099749f543bbc4eb15) (server) and [bbe94ad](https://github.com/socketio/socket.io-client/commit/bbe94adb822a306c6272e977d394e3e203cae25d) (client)
|
||||
|
||||
|
||||
- the payload `CONNECT_ERROR` packet is now an object instead of a plain string
|
||||
|
||||
Commits: [54bf4a4](https://github.com/socketio/socket.io/commit/54bf4a44e9e896dfb64764ee7bd4e8823eb7dc7b) (server) and [0939395](https://github.com/socketio/socket.io-client/commit/09393952e3397a0c71f239ea983f8ec1623b7c21) (client)
|
||||
|
||||
|
||||
### Difference between v4 and v3
|
||||
|
||||
The 4th revision of the Socket.IO protocol is used in Socket.IO v1 (`v1.0.3` was released in June 2014) and v2 (`v2.0.0` was released in May 2017).
|
||||
|
||||
The details of the revision can be found here: https://github.com/socketio/socket.io-protocol/tree/v4
|
||||
|
||||
It is built on top of the 3rd revision of [the Engine.IO protocol](https://github.com/socketio/engine.io-protocol) (hence the `EIO=3` query parameter).
|
||||
|
||||
List of changes:
|
||||
|
||||
- add a `BINARY_ACK` packet type
|
||||
|
||||
Previously, an `ACK` packet was always treated as if it may contain binary objects, with recursive search for such
|
||||
objects, which could hurt performance.
|
||||
|
||||
Reference: https://github.com/socketio/socket.io-parser/commit/ca4f42a922ba7078e840b1bc09fe3ad618acc065
|
||||
|
||||
### Difference between v3 and v2
|
||||
|
||||
The 3rd revision of the Socket.IO protocol is used in early Socket.IO v1 versions (`socket.io@1.0.0...1.0.2`) (released in May 2014).
|
||||
|
||||
The details of the revision can be found here: https://github.com/socketio/socket.io-protocol/tree/v3
|
||||
|
||||
List of changes:
|
||||
|
||||
- remove the usage of msgpack to encode packets containing binary objects (see also [299849b](https://github.com/socketio/socket.io-parser/commit/299849b00294c3bc95817572441f3aca8ffb1f65))
|
||||
|
||||
### Difference between v2 and v1
|
||||
|
||||
List of changes:
|
||||
|
||||
- add a `BINARY_EVENT` packet type
|
||||
|
||||
This was added during the work towards Socket.IO 1.0, in order to add support for binary objects. The `BINARY_EVENT`
|
||||
packets were encoded with [msgpack](https://msgpack.org/).
|
||||
|
||||
### Initial revision
|
||||
|
||||
This first revision was the result of the split between the Engine.IO protocol (low-level plumbing with WebSocket / HTTP
|
||||
long-polling, heartbeat) and the Socket.IO protocol. It was never included in a Socket.IO release, but paved the way for
|
||||
the next iterations.
|
||||
|
||||
## Test suite
|
||||
|
||||
The test suite in the [`test-suite/`](https://github.com/socketio/socket.io-protocol/tree/main/test-suite) directory lets you check the compliance of a server implementation.
|
||||
|
||||
Usage:
|
||||
|
||||
- in Node.js: `npm ci && npm test`
|
||||
- in a browser: simply open the `index.html` file in your browser
|
||||
|
||||
For reference, here is expected configuration for the JavaScript server to pass all tests:
|
||||
|
||||
```js
|
||||
import { Server } from "socket.io";
|
||||
|
||||
const io = new Server(3000, {
|
||||
pingInterval: 300,
|
||||
pingTimeout: 200,
|
||||
maxPayload: 1000000,
|
||||
connectTimeout: 1000,
|
||||
cors: {
|
||||
origin: "*"
|
||||
}
|
||||
});
|
||||
|
||||
io.on("connection", (socket) => {
|
||||
socket.emit("auth", socket.handshake.auth);
|
||||
|
||||
socket.on("message", (...args) => {
|
||||
socket.emit.apply(socket, ["message-back", ...args]);
|
||||
});
|
||||
|
||||
socket.on("message-with-ack", (...args) => {
|
||||
const ack = args.pop();
|
||||
ack(...args);
|
||||
})
|
||||
});
|
||||
|
||||
io.of("/custom").on("connection", (socket) => {
|
||||
socket.emit("auth", socket.handshake.auth);
|
||||
});
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
1
docs/socket.io-protocol/v5-test-suite/.gitignore
vendored
Executable file
1
docs/socket.io-protocol/v5-test-suite/.gitignore
vendored
Executable file
@@ -0,0 +1 @@
|
||||
node_modules
|
||||
30
docs/socket.io-protocol/v5-test-suite/index.html
Normal file
30
docs/socket.io-protocol/v5-test-suite/index.html
Normal file
@@ -0,0 +1,30 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
|
||||
<title>Test suite for the Socket.IO protocol</title>
|
||||
<link rel="stylesheet" href="https://unpkg.com/mocha@9/mocha.css" />
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<div id="mocha"></div>
|
||||
|
||||
<script src="https://unpkg.com/mocha@9/mocha.js"></script>
|
||||
<script src="https://unpkg.com/chai@4/chai.js" ></script>
|
||||
<script src="https://unpkg.com/chai-string@1/chai-string.js" ></script>
|
||||
|
||||
<script class="mocha-init">
|
||||
mocha.setup("bdd");
|
||||
mocha.checkLeaks();
|
||||
</script>
|
||||
|
||||
<script type="module" src="test-suite.js"></script>
|
||||
|
||||
<script class="mocha-exec">
|
||||
mocha.run();
|
||||
</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
10
docs/socket.io-protocol/v5-test-suite/node-imports.js
Normal file
10
docs/socket.io-protocol/v5-test-suite/node-imports.js
Normal file
@@ -0,0 +1,10 @@
|
||||
import fetch from "node-fetch";
|
||||
import { WebSocket } from "ws";
|
||||
import chai from "chai";
|
||||
import chaiString from "chai-string";
|
||||
|
||||
chai.use(chaiString);
|
||||
|
||||
globalThis.fetch = fetch;
|
||||
globalThis.WebSocket = WebSocket;
|
||||
globalThis.chai = chai;
|
||||
1936
docs/socket.io-protocol/v5-test-suite/package-lock.json
generated
Normal file
1936
docs/socket.io-protocol/v5-test-suite/package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
18
docs/socket.io-protocol/v5-test-suite/package.json
Normal file
18
docs/socket.io-protocol/v5-test-suite/package.json
Normal file
@@ -0,0 +1,18 @@
|
||||
{
|
||||
"name": "socket.io-protocol-test-suite",
|
||||
"version": "0.0.1",
|
||||
"private": true,
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"format": "prettier -w *.js",
|
||||
"test": "mocha test-suite.js"
|
||||
},
|
||||
"devDependencies": {
|
||||
"chai": "^4.3.6",
|
||||
"chai-string": "^1.5.0",
|
||||
"mocha": "^9.2.1",
|
||||
"node-fetch": "^3.2.0",
|
||||
"prettier": "^2.5.1",
|
||||
"ws": "^8.5.0"
|
||||
}
|
||||
}
|
||||
636
docs/socket.io-protocol/v5-test-suite/test-suite.js
Normal file
636
docs/socket.io-protocol/v5-test-suite/test-suite.js
Normal file
@@ -0,0 +1,636 @@
|
||||
const isNodejs = typeof window === "undefined";
|
||||
|
||||
if (isNodejs) {
|
||||
// make the tests runnable in both the browser and Node.js
|
||||
await import("./node-imports.js");
|
||||
}
|
||||
|
||||
const { expect } = chai;
|
||||
|
||||
const URL = "http://localhost:3000";
|
||||
const WS_URL = URL.replace("http", "ws");
|
||||
|
||||
const PING_INTERVAL = 300;
|
||||
const PING_TIMEOUT = 200;
|
||||
|
||||
function sleep(delay) {
|
||||
return new Promise((resolve) => setTimeout(resolve, delay));
|
||||
}
|
||||
|
||||
function waitFor(socket, eventType) {
|
||||
return new Promise((resolve) => {
|
||||
socket.addEventListener(
|
||||
eventType,
|
||||
(event) => {
|
||||
resolve(event);
|
||||
},
|
||||
{ once: true }
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
function waitForPackets(socket, count) {
|
||||
const packets = [];
|
||||
|
||||
return new Promise((resolve) => {
|
||||
const handler = (event) => {
|
||||
if (event.data === "2") {
|
||||
// ignore PING packets
|
||||
return;
|
||||
}
|
||||
packets.push(event.data);
|
||||
if (packets.length === count) {
|
||||
socket.removeEventListener("message", handler);
|
||||
resolve(packets);
|
||||
}
|
||||
};
|
||||
socket.addEventListener("message", handler);
|
||||
});
|
||||
}
|
||||
|
||||
async function initLongPollingSession() {
|
||||
const response = await fetch(`${URL}/socket.io/?EIO=4&transport=polling`);
|
||||
const content = await response.text();
|
||||
return JSON.parse(content.substring(1)).sid;
|
||||
}
|
||||
|
||||
async function initSocketIOConnection() {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
socket.binaryType = "arraybuffer";
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send("40");
|
||||
|
||||
await waitFor(socket, "message"); // Socket.IO handshake
|
||||
await waitFor(socket, "message"); // "auth" packet
|
||||
|
||||
return socket;
|
||||
}
|
||||
|
||||
describe("Engine.IO protocol", () => {
|
||||
describe("handshake", () => {
|
||||
describe("HTTP long-polling", () => {
|
||||
it("should successfully open a session", async () => {
|
||||
const response = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling`
|
||||
);
|
||||
|
||||
expect(response.status).to.eql(200);
|
||||
|
||||
const content = await response.text();
|
||||
|
||||
expect(content).to.startsWith("0");
|
||||
|
||||
const value = JSON.parse(content.substring(1));
|
||||
|
||||
expect(value).to.have.all.keys(
|
||||
"sid",
|
||||
"upgrades",
|
||||
"pingInterval",
|
||||
"pingTimeout",
|
||||
"maxPayload"
|
||||
);
|
||||
expect(value.sid).to.be.a("string");
|
||||
expect(value.upgrades).to.eql(["websocket"]);
|
||||
expect(value.pingInterval).to.eql(PING_INTERVAL);
|
||||
expect(value.pingTimeout).to.eql(PING_TIMEOUT);
|
||||
expect(value.maxPayload).to.eql(1000000);
|
||||
});
|
||||
|
||||
it("should fail with an invalid 'EIO' query parameter", async () => {
|
||||
const response = await fetch(`${URL}/socket.io/?transport=polling`);
|
||||
|
||||
expect(response.status).to.eql(400);
|
||||
|
||||
const response2 = await fetch(
|
||||
`${URL}/socket.io/?EIO=abc&transport=polling`
|
||||
);
|
||||
|
||||
expect(response2.status).to.eql(400);
|
||||
});
|
||||
|
||||
it("should fail with an invalid 'transport' query parameter", async () => {
|
||||
const response = await fetch(`${URL}/socket.io/?EIO=4`);
|
||||
|
||||
expect(response.status).to.eql(400);
|
||||
|
||||
const response2 = await fetch(`${URL}/socket.io/?EIO=4&transport=abc`);
|
||||
|
||||
expect(response2.status).to.eql(400);
|
||||
});
|
||||
|
||||
it("should fail with an invalid request method", async () => {
|
||||
const response = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling`,
|
||||
{
|
||||
method: "post",
|
||||
}
|
||||
);
|
||||
|
||||
expect(response.status).to.eql(400);
|
||||
|
||||
const response2 = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling`,
|
||||
{
|
||||
method: "put",
|
||||
}
|
||||
);
|
||||
|
||||
expect(response2.status).to.eql(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe("WebSocket", () => {
|
||||
it("should successfully open a session", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.startsWith("0");
|
||||
|
||||
const value = JSON.parse(data.substring(1));
|
||||
|
||||
expect(value).to.have.all.keys(
|
||||
"sid",
|
||||
"upgrades",
|
||||
"pingInterval",
|
||||
"pingTimeout",
|
||||
"maxPayload"
|
||||
);
|
||||
expect(value.sid).to.be.a("string");
|
||||
expect(value.upgrades).to.eql([]);
|
||||
expect(value.pingInterval).to.eql(PING_INTERVAL);
|
||||
expect(value.pingTimeout).to.eql(PING_TIMEOUT);
|
||||
expect(value.maxPayload).to.eql(1000000);
|
||||
|
||||
socket.close();
|
||||
});
|
||||
|
||||
it("should fail with an invalid 'EIO' query parameter", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?transport=websocket`
|
||||
);
|
||||
|
||||
if (isNodejs) {
|
||||
socket.on("error", () => {});
|
||||
}
|
||||
|
||||
waitFor(socket, "close");
|
||||
|
||||
const socket2 = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=abc&transport=websocket`
|
||||
);
|
||||
|
||||
if (isNodejs) {
|
||||
socket2.on("error", () => {});
|
||||
}
|
||||
|
||||
waitFor(socket2, "close");
|
||||
});
|
||||
|
||||
it("should fail with an invalid 'transport' query parameter", async () => {
|
||||
const socket = new WebSocket(`${WS_URL}/socket.io/?EIO=4`);
|
||||
|
||||
if (isNodejs) {
|
||||
socket.on("error", () => {});
|
||||
}
|
||||
|
||||
waitFor(socket, "close");
|
||||
|
||||
const socket2 = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=abc`
|
||||
);
|
||||
|
||||
if (isNodejs) {
|
||||
socket2.on("error", () => {});
|
||||
}
|
||||
|
||||
waitFor(socket2, "close");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("heartbeat", function () {
|
||||
this.timeout(5000);
|
||||
|
||||
describe("HTTP long-polling", () => {
|
||||
it("should send ping/pong packets", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
for (let i = 0; i < 3; i++) {
|
||||
const pollResponse = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`
|
||||
);
|
||||
|
||||
expect(pollResponse.status).to.eql(200);
|
||||
|
||||
const pollContent = await pollResponse.text();
|
||||
|
||||
expect(pollContent).to.eql("2");
|
||||
|
||||
const pushResponse = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`,
|
||||
{
|
||||
method: "post",
|
||||
body: "3",
|
||||
}
|
||||
);
|
||||
|
||||
expect(pushResponse.status).to.eql(200);
|
||||
}
|
||||
});
|
||||
|
||||
it("should close the session upon ping timeout", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
await sleep(PING_INTERVAL + PING_TIMEOUT);
|
||||
|
||||
const pollResponse = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`
|
||||
);
|
||||
|
||||
expect(pollResponse.status).to.eql(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe("WebSocket", () => {
|
||||
it("should send ping/pong packets", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // handshake
|
||||
|
||||
for (let i = 0; i < 3; i++) {
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql("2");
|
||||
|
||||
socket.send("3");
|
||||
}
|
||||
|
||||
socket.close();
|
||||
});
|
||||
|
||||
it("should close the session upon ping timeout", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "close"); // handshake
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("close", () => {
|
||||
describe("HTTP long-polling", () => {
|
||||
it("should forcefully close the session", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
const [pollResponse] = await Promise.all([
|
||||
fetch(`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`),
|
||||
fetch(`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`, {
|
||||
method: "post",
|
||||
body: "1",
|
||||
}),
|
||||
]);
|
||||
|
||||
expect(pollResponse.status).to.eql(200);
|
||||
|
||||
const pullContent = await pollResponse.text();
|
||||
|
||||
expect(pullContent).to.eql("6");
|
||||
|
||||
const pollResponse2 = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`
|
||||
);
|
||||
|
||||
expect(pollResponse2.status).to.eql(400);
|
||||
});
|
||||
});
|
||||
|
||||
describe("WebSocket", () => {
|
||||
it("should forcefully close the session", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // handshake
|
||||
|
||||
socket.send("1");
|
||||
|
||||
await waitFor(socket, "close");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("upgrade", () => {
|
||||
it("should successfully upgrade from HTTP long-polling to WebSocket", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
|
||||
);
|
||||
|
||||
await waitFor(socket, "open");
|
||||
|
||||
// send probe
|
||||
socket.send("2probe");
|
||||
|
||||
const probeResponse = await waitFor(socket, "message");
|
||||
|
||||
expect(probeResponse.data).to.eql("3probe");
|
||||
|
||||
// complete upgrade
|
||||
socket.send("5");
|
||||
});
|
||||
|
||||
it("should ignore HTTP requests with same sid after upgrade", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
|
||||
);
|
||||
|
||||
await waitFor(socket, "open");
|
||||
socket.send("2probe");
|
||||
socket.send("5");
|
||||
|
||||
const pollResponse = await fetch(
|
||||
`${URL}/socket.io/?EIO=4&transport=polling&sid=${sid}`
|
||||
);
|
||||
|
||||
expect(pollResponse.status).to.eql(400);
|
||||
});
|
||||
|
||||
it("should ignore WebSocket connection with same sid after upgrade", async () => {
|
||||
const sid = await initLongPollingSession();
|
||||
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
|
||||
);
|
||||
|
||||
await waitFor(socket, "open");
|
||||
socket.send("2probe");
|
||||
socket.send("5");
|
||||
|
||||
const socket2 = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket&sid=${sid}`
|
||||
);
|
||||
|
||||
await waitFor(socket2, "close");
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("Socket.IO protocol", () => {
|
||||
describe("connect", () => {
|
||||
it("should allow connection to the main namespace", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send("40");
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.startsWith("40");
|
||||
|
||||
const handshake = JSON.parse(data.substring(2));
|
||||
|
||||
expect(handshake).to.have.all.keys("sid");
|
||||
expect(handshake.sid).to.be.a("string");
|
||||
|
||||
const authPacket = await waitFor(socket, "message");
|
||||
|
||||
expect(authPacket.data).to.eql('42["auth",{}]');
|
||||
});
|
||||
|
||||
it("should allow connection to the main namespace with a payload", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send('40{"token":"123"}');
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.startsWith("40");
|
||||
|
||||
const handshake = JSON.parse(data.substring(2));
|
||||
|
||||
expect(handshake).to.have.all.keys("sid");
|
||||
expect(handshake.sid).to.be.a("string");
|
||||
|
||||
const authPacket = await waitFor(socket, "message");
|
||||
|
||||
expect(authPacket.data).to.eql('42["auth",{"token":"123"}]');
|
||||
});
|
||||
|
||||
it("should allow connection to a custom namespace", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send("40/custom,");
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.startsWith("40/custom,");
|
||||
|
||||
const handshake = JSON.parse(data.substring(10));
|
||||
|
||||
expect(handshake).to.have.all.keys("sid");
|
||||
expect(handshake.sid).to.be.a("string");
|
||||
|
||||
const authPacket = await waitFor(socket, "message");
|
||||
|
||||
expect(authPacket.data).to.eql('42/custom,["auth",{}]');
|
||||
});
|
||||
|
||||
it("should allow connection to a custom namespace with a payload", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send('40/custom,{"token":"abc"}');
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.startsWith("40/custom,");
|
||||
|
||||
const handshake = JSON.parse(data.substring(10));
|
||||
|
||||
expect(handshake).to.have.all.keys("sid");
|
||||
expect(handshake.sid).to.be.a("string");
|
||||
|
||||
const authPacket = await waitFor(socket, "message");
|
||||
|
||||
expect(authPacket.data).to.eql('42/custom,["auth",{"token":"abc"}]');
|
||||
});
|
||||
|
||||
it("should disallow connection to an unknown namespace", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send("40/random");
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql('44/random,{"message":"Invalid namespace"}');
|
||||
});
|
||||
|
||||
it("should disallow connection with an invalid handshake", async () => {
|
||||
const socket = new WebSocket(
|
||||
`${WS_URL}/socket.io/?EIO=4&transport=websocket`
|
||||
);
|
||||
|
||||
await waitFor(socket, "message"); // Engine.IO handshake
|
||||
|
||||
socket.send("4abc");
|
||||
|
||||
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`
|
||||
);
|
||||
|
||||
await waitFor(socket, "close");
|
||||
});
|
||||
});
|
||||
|
||||
describe("disconnect", () => {
|
||||
it("should disconnect from the main namespace", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send("41");
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql("2");
|
||||
});
|
||||
|
||||
it("should connect then disconnect from a custom namespace", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
await waitFor(socket, "message"); // ping
|
||||
|
||||
socket.send("40/custom");
|
||||
|
||||
await waitFor(socket, "message"); // Socket.IO handshake
|
||||
await waitFor(socket, "message"); // auth packet
|
||||
|
||||
socket.send("41/custom");
|
||||
socket.send('42["message","message to main namespace"]');
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql('42["message-back","message to main namespace"]');
|
||||
});
|
||||
});
|
||||
|
||||
describe("message", () => {
|
||||
it("should send a plain-text packet", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send('42["message",1,"2",{"3":[true]}]');
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql('42["message-back",1,"2",{"3":[true]}]');
|
||||
});
|
||||
|
||||
it("should send a packet with binary attachments", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send(
|
||||
'452-["message",{"_placeholder":true,"num":0},{"_placeholder":true,"num":1}]'
|
||||
);
|
||||
socket.send(Uint8Array.from([1, 2, 3]));
|
||||
socket.send(Uint8Array.from([4, 5, 6]));
|
||||
|
||||
const packets = await waitForPackets(socket, 3);
|
||||
|
||||
expect(packets[0]).to.eql(
|
||||
'452-["message-back",{"_placeholder":true,"num":0},{"_placeholder":true,"num":1}]'
|
||||
);
|
||||
expect(packets[1]).to.eql(Uint8Array.from([1, 2, 3]).buffer);
|
||||
expect(packets[2]).to.eql(Uint8Array.from([4, 5, 6]).buffer);
|
||||
|
||||
socket.close();
|
||||
});
|
||||
|
||||
it("should send a plain-text packet with an ack", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send('42456["message-with-ack",1,"2",{"3":[false]}]');
|
||||
|
||||
const { data } = await waitFor(socket, "message");
|
||||
|
||||
expect(data).to.eql('43456[1,"2",{"3":[false]}]');
|
||||
});
|
||||
|
||||
it("should send a packet with binary attachments and an ack", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send(
|
||||
'452-789["message-with-ack",{"_placeholder":true,"num":0},{"_placeholder":true,"num":1}]'
|
||||
);
|
||||
socket.send(Uint8Array.from([1, 2, 3]));
|
||||
socket.send(Uint8Array.from([4, 5, 6]));
|
||||
|
||||
const packets = await waitForPackets(socket, 3);
|
||||
|
||||
expect(packets[0]).to.eql(
|
||||
'462-789[{"_placeholder":true,"num":0},{"_placeholder":true,"num":1}]'
|
||||
);
|
||||
expect(packets[1]).to.eql(Uint8Array.from([1, 2, 3]).buffer);
|
||||
expect(packets[2]).to.eql(Uint8Array.from([4, 5, 6]).buffer);
|
||||
|
||||
socket.close();
|
||||
});
|
||||
|
||||
it("should close the connection upon invalid format (unknown packet type)", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send("4abc");
|
||||
|
||||
await waitFor(socket, "close");
|
||||
});
|
||||
|
||||
it("should close the connection upon invalid format (invalid payload format)", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send("42{}");
|
||||
|
||||
await waitFor(socket, "close");
|
||||
});
|
||||
|
||||
it("should close the connection upon invalid format (invalid ack id)", async () => {
|
||||
const socket = await initSocketIOConnection();
|
||||
|
||||
socket.send('42abc["message-with-ack",1,"2",{"3":[false]}]');
|
||||
|
||||
await waitFor(socket, "close");
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user