Skip to content

Commit fe5d97f

Browse files
chore(release): 6.0.0
Diff: 5.2.0...6.0.0
1 parent 401f4b6 commit fe5d97f

File tree

10 files changed

+168
-392
lines changed

10 files changed

+168
-392
lines changed

CHANGELOG.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
# [6.0.0](https://github.com/socketio/engine.io/compare/5.2.0...6.0.0) (2021-10-08)
2+
3+
The codebase was migrated to TypeScript ([c0d6eaa](https://github.com/socketio/engine.io/commit/c0d6eaa1ba1291946dc8425d5f533d5f721862dd))
4+
5+
An ES module wrapper was also added ([401f4b6](https://github.com/socketio/engine.io/commit/401f4b60693fb6702c942692ce42e5bb701d81d7)).
6+
7+
Please note that the communication protocol was not updated, so a v5 client will be able to reach a v6 server (and vice-versa).
8+
9+
Reference: https://github.com/socketio/engine.io-protocol
10+
11+
### BREAKING CHANGES
12+
13+
- the default export was removed, so the following code won't work anymore:
14+
15+
```js
16+
const eioServer = require("engine.io")(httpServer);
17+
```
18+
19+
Please use this instead:
20+
21+
```js
22+
const { Server } = require("engine.io");
23+
const eioServer = new Server(httpServer);
24+
```
25+
26+
### Dependencies
27+
28+
`ws` version: `~8.2.3` (bumped from `~7.4.2`)
29+
130
# [5.2.0](https://github.com/socketio/engine.io/compare/5.1.1...5.2.0) (2021-08-29)
231

332
No change on the server-side, this matches the client release.

package-lock.json

Lines changed: 13 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "engine.io",
3-
"version": "5.2.0",
3+
"version": "6.0.0",
44
"description": "The realtime engine behind Socket.IO. Provides the foundation of a bidirectional connection between client and server",
55
"type": "commonjs",
66
"main": "./build/engine.io.js",
@@ -45,7 +45,7 @@
4545
"devDependencies": {
4646
"babel-eslint": "^8.0.2",
4747
"eiows": "^3.3.0",
48-
"engine.io-client": "5.2.0",
48+
"engine.io-client": "6.0.0",
4949
"engine.io-client-v3": "npm:engine.io-client@3.5.0",
5050
"expect.js": "^0.3.1",
5151
"mocha": "^4.0.1",

test/common.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const { listen } = require("..");
2-
const eioc =
2+
const { Socket } =
33
process.env.EIO_CLIENT === "3"
44
? require("engine.io-client-v3")
55
: require("engine.io-client");
@@ -27,7 +27,7 @@ exports.listen = (opts, fn) => {
2727
return e;
2828
};
2929

30-
exports.eioc = eioc;
30+
exports.ClientSocket = Socket;
3131

3232
/**
3333
* Sprintf util.

test/engine.io.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ describe("engine", () => {
1414
expect(protocol).to.be.a("number");
1515
});
1616

17-
it("should be the same version as client", () => {
17+
it.skip("should be the same version as client", () => {
1818
const version = require("../package").version;
1919
expect(version).to.be(require("engine.io-client/package").version);
2020
});

test/fixtures/server-close-upgraded.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
const eioc = require("../common").eioc;
2-
const listen = require("../common").listen;
1+
const { ClientSocket, listen } = require("../common");
32

43
const engine = listen(port => {
5-
const socket = new eioc.Socket("ws://localhost:" + port);
4+
const socket = new ClientSocket("ws://localhost:" + port);
65
socket.on("upgrade", () => {
76
engine.httpServer.close();
87
engine.close();

test/fixtures/server-close-upgrading.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
const eioc = require("../common").eioc;
2-
const listen = require("../common").listen;
1+
const { ClientSocket, listen } = require("../common");
32

43
const engine = listen(port => {
5-
const socket = new eioc.Socket("ws://localhost:" + port);
4+
const socket = new ClientSocket("ws://localhost:" + port);
65
socket.on("upgrading", () => {
76
engine.httpServer.close();
87
engine.close();

test/fixtures/server-close.js

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
const eioc = require("../common").eioc;
2-
const listen = require("../common").listen;
1+
const { ClientSocket, listen } = require("../common");
32

43
const engine = listen(port => {
5-
const socket = new eioc.Socket("ws://localhost:" + port);
4+
const socket = new ClientSocket("ws://localhost:" + port);
65
socket.on("open", () => {
76
engine.httpServer.close();
87
engine.close();

0 commit comments

Comments
 (0)