cojson-transport-ws 0.12.1 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.turbo/turbo-build.log +1 -1
- package/CHANGELOG.md +15 -0
- package/dist/createWebSocketPeer.d.ts +2 -1
- package/dist/createWebSocketPeer.d.ts.map +1 -1
- package/dist/createWebSocketPeer.js +6 -6
- package/dist/createWebSocketPeer.js.map +1 -1
- package/dist/tests/integration.test.js +22 -0
- package/dist/tests/integration.test.js.map +1 -1
- package/package.json +2 -2
- package/src/createWebSocketPeer.ts +24 -14
- package/src/tests/integration.test.ts +32 -0
package/.turbo/turbo-build.log
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,20 @@
|
|
|
1
1
|
# cojson-transport-nodejs-ws
|
|
2
2
|
|
|
3
|
+
## 0.13.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [a013538]
|
|
8
|
+
- Updated dependencies [bce3bcc]
|
|
9
|
+
- cojson@0.13.0
|
|
10
|
+
|
|
11
|
+
## 0.12.2
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- Updated dependencies [c2f4827]
|
|
16
|
+
- cojson@0.12.2
|
|
17
|
+
|
|
3
18
|
## 0.12.1
|
|
4
19
|
|
|
5
20
|
### Patch Changes
|
|
@@ -9,8 +9,9 @@ export type CreateWebSocketPeerOpts = {
|
|
|
9
9
|
expectPings?: boolean;
|
|
10
10
|
batchingByDefault?: boolean;
|
|
11
11
|
deletePeerStateOnClose?: boolean;
|
|
12
|
+
pingTimeout?: number;
|
|
12
13
|
onClose?: () => void;
|
|
13
14
|
onSuccess?: () => void;
|
|
14
15
|
};
|
|
15
|
-
export declare function createWebSocketPeer({ id, websocket, role, expectPings, batchingByDefault, deletePeerStateOnClose, onSuccess, onClose, }: CreateWebSocketPeerOpts): Peer;
|
|
16
|
+
export declare function createWebSocketPeer({ id, websocket, role, expectPings, batchingByDefault, deletePeerStateOnClose, pingTimeout, onSuccess, onClose, }: CreateWebSocketPeerOpts): Peer;
|
|
16
17
|
//# sourceMappingURL=createWebSocketPeer.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createWebSocketPeer.d.ts","sourceRoot":"","sources":["../src/createWebSocketPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,IAAI,EAKV,MAAM,QAAQ,CAAC;AAGhB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,eAAO,MAAM,YAAY,SAAU,CAAC;AACpC,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,YAAY,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;
|
|
1
|
+
{"version":3,"file":"createWebSocketPeer.d.ts","sourceRoot":"","sources":["../src/createWebSocketPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,IAAI,EAKV,MAAM,QAAQ,CAAC;AAGhB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,eAAO,MAAM,YAAY,SAAU,CAAC;AACpC,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAEhD,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,YAAY,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACnB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,IAAI,CAAC;CACxB,CAAC;AAuGF,wBAAgB,mBAAmB,CAAC,EAClC,EAAE,EACF,SAAS,EACT,IAAI,EACJ,WAAkB,EAClB,iBAAwB,EACxB,sBAA8B,EAC9B,WAAoB,EACpB,SAAS,EACT,OAAO,GACR,EAAE,uBAAuB,GAAG,IAAI,CAoHhC"}
|
|
@@ -3,7 +3,7 @@ import { BatchedOutgoingMessages } from "./BatchedOutgoingMessages.js";
|
|
|
3
3
|
import { deserializeMessages } from "./serialization.js";
|
|
4
4
|
export const BUFFER_LIMIT = 100000;
|
|
5
5
|
export const BUFFER_LIMIT_POLLING_INTERVAL = 10;
|
|
6
|
-
function createPingTimeoutListener(enabled, callback) {
|
|
6
|
+
function createPingTimeoutListener(enabled, timeout, callback) {
|
|
7
7
|
if (!enabled) {
|
|
8
8
|
return {
|
|
9
9
|
reset() { },
|
|
@@ -16,7 +16,7 @@ function createPingTimeoutListener(enabled, callback) {
|
|
|
16
16
|
pingTimeout && clearTimeout(pingTimeout);
|
|
17
17
|
pingTimeout = setTimeout(() => {
|
|
18
18
|
callback();
|
|
19
|
-
},
|
|
19
|
+
}, timeout);
|
|
20
20
|
},
|
|
21
21
|
clear() {
|
|
22
22
|
pingTimeout && clearTimeout(pingTimeout);
|
|
@@ -82,7 +82,7 @@ function createClosedEventEmitter(callback = () => { }) {
|
|
|
82
82
|
callback();
|
|
83
83
|
};
|
|
84
84
|
}
|
|
85
|
-
export function createWebSocketPeer({ id, websocket, role, expectPings = true, batchingByDefault = true, deletePeerStateOnClose = false, onSuccess, onClose, }) {
|
|
85
|
+
export function createWebSocketPeer({ id, websocket, role, expectPings = true, batchingByDefault = true, deletePeerStateOnClose = false, pingTimeout = 10000, onSuccess, onClose, }) {
|
|
86
86
|
const incoming = new cojsonInternals.Channel();
|
|
87
87
|
const emitClosedEvent = createClosedEventEmitter(onClose);
|
|
88
88
|
function handleClose() {
|
|
@@ -100,7 +100,7 @@ export function createWebSocketPeer({ id, websocket, role, expectPings = true, b
|
|
|
100
100
|
}
|
|
101
101
|
handleClose();
|
|
102
102
|
});
|
|
103
|
-
const
|
|
103
|
+
const pingTimeoutListener = createPingTimeoutListener(expectPings, pingTimeout, () => {
|
|
104
104
|
incoming
|
|
105
105
|
.push("PingTimeout")
|
|
106
106
|
.catch((e) => logger.error("Error while pushing ping timeout", { err: e }));
|
|
@@ -109,6 +109,7 @@ export function createWebSocketPeer({ id, websocket, role, expectPings = true, b
|
|
|
109
109
|
const outgoingMessages = createOutgoingMessagesManager(websocket, batchingByDefault);
|
|
110
110
|
let isFirstMessage = true;
|
|
111
111
|
function handleIncomingMsg(event) {
|
|
112
|
+
pingTimeoutListener.reset();
|
|
112
113
|
if (event.data === "") {
|
|
113
114
|
return;
|
|
114
115
|
}
|
|
@@ -128,7 +129,6 @@ export function createWebSocketPeer({ id, websocket, role, expectPings = true, b
|
|
|
128
129
|
// If more than one message is received, the other peer supports batching
|
|
129
130
|
outgoingMessages.setBatchingEnabled(true);
|
|
130
131
|
}
|
|
131
|
-
pingTimeout.reset();
|
|
132
132
|
for (const msg of messages) {
|
|
133
133
|
if (msg && "action" in msg) {
|
|
134
134
|
incoming
|
|
@@ -147,7 +147,7 @@ export function createWebSocketPeer({ id, websocket, role, expectPings = true, b
|
|
|
147
147
|
outgoingMessages.close();
|
|
148
148
|
websocket.removeEventListener("message", handleIncomingMsg);
|
|
149
149
|
websocket.removeEventListener("close", handleClose);
|
|
150
|
-
|
|
150
|
+
pingTimeoutListener.clear();
|
|
151
151
|
emitClosedEvent();
|
|
152
152
|
if (websocket.readyState === 0) {
|
|
153
153
|
websocket.addEventListener("open", function handleClose() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"createWebSocketPeer.js","sourceRoot":"","sources":["../src/createWebSocketPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,eAAe,EACf,MAAM,GACP,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,mBAAmB,
|
|
1
|
+
{"version":3,"file":"createWebSocketPeer.js","sourceRoot":"","sources":["../src/createWebSocketPeer.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,eAAe,EACf,MAAM,GACP,MAAM,QAAQ,CAAC;AAChB,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGzD,MAAM,CAAC,MAAM,YAAY,GAAG,MAAO,CAAC;AACpC,MAAM,CAAC,MAAM,6BAA6B,GAAG,EAAE,CAAC;AAchD,SAAS,yBAAyB,CAChC,OAAgB,EAChB,OAAe,EACf,QAAoB;IAEpB,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;YACL,KAAK,KAAI,CAAC;YACV,KAAK,KAAI,CAAC;SACX,CAAC;IACJ,CAAC;IAED,IAAI,WAAW,GAAyC,IAAI,CAAC;IAE7D,OAAO;QACL,KAAK;YACH,WAAW,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;YACzC,WAAW,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,QAAQ,EAAE,CAAC;YACb,CAAC,EAAE,OAAO,CAAC,CAAC;QACd,CAAC;QACD,KAAK;YACH,WAAW,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC;QAC3C,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAuB;IACnD,OAAO,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;QACnC,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACtE,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,6BAA6B,CACpC,SAAuB,EACvB,iBAA0B;IAE1B,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,MAAM,gBAAgB,GAAG,IAAI,uBAAuB,CAAC,CAAC,QAAQ,EAAE,EAAE;QAChE,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC/B,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAI,eAAe,GAAG,iBAAiB,CAAC;IAExC,KAAK,UAAU,WAAW,CAAC,GAAgB;QACzC,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,OAAO,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC,CAAC;QACvD,CAAC;QAED,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC/B,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAC;QACxC,CAAC;QAED,OACE,SAAS,CAAC,cAAc,GAAG,YAAY;YACvC,SAAS,CAAC,UAAU,KAAK,CAAC,EAC1B,CAAC;YACD,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE,CAClC,UAAU,CAAC,OAAO,EAAE,6BAA6B,CAAC,CACnD,CAAC;QACJ,CAAC;QAED,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,CAAC;aAAM,CAAC;YACN,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,OAAO;QACL,WAAW;QACX,kBAAkB,CAAC,OAAgB;YACjC,eAAe,GAAG,OAAO,CAAC;QAC5B,CAAC;QACD,KAAK;YACH,MAAM,GAAG,IAAI,CAAC;YACd,gBAAgB,CAAC,KAAK,EAAE,CAAC;QAC3B,CAAC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAQ,GAAG,GAAG,EAAE,GAAE,CAAC;IACnD,IAAI,YAAY,GAAG,KAAK,CAAC;IAEzB,OAAO,GAAG,EAAE;QACV,IAAI,YAAY;YAAE,OAAO;QACzB,YAAY,GAAG,IAAI,CAAC;QACpB,QAAQ,EAAE,CAAC;IACb,CAAC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,EAClC,EAAE,EACF,SAAS,EACT,IAAI,EACJ,WAAW,GAAG,IAAI,EAClB,iBAAiB,GAAG,IAAI,EACxB,sBAAsB,GAAG,KAAK,EAC9B,WAAW,GAAG,KAAM,EACpB,SAAS,EACT,OAAO,GACiB;IACxB,MAAM,QAAQ,GAAG,IAAI,eAAe,CAAC,OAAO,EAEzC,CAAC;IACJ,MAAM,eAAe,GAAG,wBAAwB,CAAC,OAAO,CAAC,CAAC;IAE1D,SAAS,WAAW;QAClB,QAAQ;aACL,IAAI,CAAC,cAAc,CAAC;aACpB,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,MAAM,CAAC,KAAK,CAAC,oCAAoC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAC/D,CAAC;QACJ,eAAe,EAAE,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,gBAAgB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IACjD,6EAA6E;IAC7E,yEAAyE;IACzE,SAAS,CAAC,gBAAgB,CAAC,OAAc,EAAE,CAAC,GAAG,EAAE,EAAE;QACjD,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;QAC1C,CAAC;QAED,WAAW,EAAE,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,yBAAyB,CACnD,WAAW,EACX,WAAW,EACX,GAAG,EAAE;QACH,QAAQ;aACL,IAAI,CAAC,aAAa,CAAC;aACnB,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAC7D,CAAC;QACJ,eAAe,EAAE,CAAC;IACpB,CAAC,CACF,CAAC;IAEF,MAAM,gBAAgB,GAAG,6BAA6B,CACpD,SAAS,EACT,iBAAiB,CAClB,CAAC;IACF,IAAI,cAAc,GAAG,IAAI,CAAC;IAE1B,SAAS,iBAAiB,CAAC,KAAwB;QACjD,mBAAmB,CAAC,KAAK,EAAE,CAAC;QAE5B,IAAI,KAAK,CAAC,IAAI,KAAK,EAAE,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,MAAM,GAAG,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE/C,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;YACf,MAAM,CAAC,IAAI,CAAC,oCAAoC,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC;YACzE,OAAO;QACT,CAAC;QAED,IAAI,cAAc,EAAE,CAAC;YACnB,+FAA+F;YAC/F,qDAAqD;YACrD,SAAS,EAAE,EAAE,CAAC;YACd,cAAc,GAAG,KAAK,CAAC;QACzB,CAAC;QAED,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAE5B,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,yEAAyE;YACzE,gBAAgB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC5C,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG,IAAI,QAAQ,IAAI,GAAG,EAAE,CAAC;gBAC3B,QAAQ;qBACL,IAAI,CAAC,GAAG,CAAC;qBACT,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CACX,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAC7D,CAAC;YACN,CAAC;QACH,CAAC;IACH,CAAC;IAED,SAAS,CAAC,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IAEzD,OAAO;QACL,EAAE;QACF,QAAQ;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,gBAAgB,CAAC,WAAW;YAClC,KAAK;gBACH,gBAAgB,CAAC,KAAK,EAAE,CAAC;gBAEzB,SAAS,CAAC,mBAAmB,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;gBAC5D,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;gBACpD,mBAAmB,CAAC,KAAK,EAAE,CAAC;gBAC5B,eAAe,EAAE,CAAC;gBAElB,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;oBAC/B,SAAS,CAAC,gBAAgB,CACxB,MAAM,EACN,SAAS,WAAW;wBAClB,SAAS,CAAC,KAAK,EAAE,CAAC;oBACpB,CAAC,EACD,EAAE,IAAI,EAAE,IAAI,EAAE,CACf,CAAC;gBACJ,CAAC;qBAAM,IAAI,SAAS,CAAC,UAAU,KAAK,CAAC,EAAE,CAAC;oBACtC,SAAS,CAAC,KAAK,EAAE,CAAC;gBACpB,CAAC;YACH,CAAC;SACF;QACD,IAAI;QACJ,YAAY,EAAE,KAAK;QACnB,sBAAsB;KACvB,CAAC;AACJ,CAAC"}
|
|
@@ -4,6 +4,7 @@ import { afterEach, beforeEach, describe, expect, test } from "vitest";
|
|
|
4
4
|
import { WebSocket } from "ws";
|
|
5
5
|
import { createWebSocketPeer } from "../createWebSocketPeer";
|
|
6
6
|
import { startSyncServer } from "./syncServer";
|
|
7
|
+
import { waitFor } from "./utils";
|
|
7
8
|
describe("WebSocket Peer Integration", () => {
|
|
8
9
|
let server;
|
|
9
10
|
let syncServerUrl;
|
|
@@ -91,5 +92,26 @@ describe("WebSocket Peer Integration", () => {
|
|
|
91
92
|
expect(disconnectCalled).toBe(true);
|
|
92
93
|
expect(ws.readyState).toBe(WebSocket.CLOSED);
|
|
93
94
|
});
|
|
95
|
+
test("should trigger a timeout if the server does not respond", async () => {
|
|
96
|
+
const clientAgent = crypto.newRandomAgentSecret();
|
|
97
|
+
const clientNode = new LocalNode(new ControlledAgent(clientAgent, crypto), crypto.newRandomSessionID(crypto.getAgentID(clientAgent)), crypto);
|
|
98
|
+
const ws = new WebSocket(syncServerUrl);
|
|
99
|
+
let disconnectCalled = false;
|
|
100
|
+
const peer = createWebSocketPeer({
|
|
101
|
+
id: "test-client",
|
|
102
|
+
websocket: ws,
|
|
103
|
+
role: "server",
|
|
104
|
+
pingTimeout: 5,
|
|
105
|
+
onClose: () => {
|
|
106
|
+
disconnectCalled = true;
|
|
107
|
+
},
|
|
108
|
+
});
|
|
109
|
+
clientNode.syncManager.addPeer(peer);
|
|
110
|
+
// Wait for connection to establish and the timeout to kick in
|
|
111
|
+
await waitFor(() => {
|
|
112
|
+
expect(disconnectCalled).toBe(true);
|
|
113
|
+
});
|
|
114
|
+
expect(ws.readyState).toBe(WebSocket.CLOSED);
|
|
115
|
+
});
|
|
94
116
|
});
|
|
95
117
|
//# sourceMappingURL=integration.test.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"integration.test.js","sourceRoot":"","sources":["../../src/tests/integration.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAuB,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;
|
|
1
|
+
{"version":3,"file":"integration.test.js","sourceRoot":"","sources":["../../src/tests/integration.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAuB,SAAS,EAAE,MAAM,QAAQ,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,wBAAwB,CAAC;AAC7D,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAI,MAAW,CAAC;IAChB,IAAI,aAAqB,CAAC;IAC1B,IAAI,MAAsB,CAAC;IAE3B,UAAU,CAAC,KAAK,IAAI,EAAE;QACpB,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,eAAe,EAAE,CAAC;QACvC,MAAM,GAAG,MAAM,CAAC;QAChB,aAAa,GAAG,MAAM,CAAC,UAAU,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,CAAC,KAAK,EAAE,CAAC;IACjB,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC7E,qBAAqB;QACrB,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,IAAI,SAAS,CAC9B,IAAI,eAAe,CAAC,WAAW,EAAE,MAAM,CAAC,EACxC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACzD,MAAM,CACP,CAAC;QAEF,8BAA8B;QAC9B,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QAExC,2BAA2B;QAC3B,IAAI,qBAAqB,GAAG,KAAK,CAAC;QAElC,qCAAqC;QACrC,MAAM,IAAI,GAAG,mBAAmB,CAAC;YAC/B,EAAE,EAAE,aAAa;YACjB,SAAS,EAAE,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,GAAG,EAAE;gBACd,qBAAqB,GAAG,IAAI,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;QAEH,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAErC,mCAAmC;QACnC,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,EAAE;YAClC,MAAM,eAAe,GAAG,WAAW,CAAC,GAAG,EAAE;gBACvC,IAAI,qBAAqB,EAAE,CAAC;oBAC1B,aAAa,CAAC,eAAe,CAAC,CAAC;oBAC/B,OAAO,EAAE,CAAC;gBACZ,CAAC;YACH,CAAC,EAAE,GAAG,CAAC,CAAC;QACV,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,IAAI,SAAS,CAC9B,IAAI,eAAe,CAAC,WAAW,EAAE,MAAM,CAAC,EACxC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACzD,MAAM,CACP,CAAC;QAEF,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QAExC,MAAM,IAAI,GAAG,mBAAmB,CAAC;YAC/B,EAAE,EAAE,aAAa;YACjB,SAAS,EAAE,EAAE;YACb,IAAI,EAAE,QAAQ;SACf,CAAC,CAAC;QAEH,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAErC,sBAAsB;QACtB,MAAM,KAAK,GAAG,UAAU,CAAC,WAAW,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAC9B,GAAG,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;QAE5C,gBAAgB;QAChB,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;QAE7B,iCAAiC;QACjC,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC;QACpC,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAEhD,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,IAAI,SAAS,CAC9B,IAAI,eAAe,CAAC,WAAW,EAAE,MAAM,CAAC,EACxC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACzD,MAAM,CACP,CAAC;QAEF,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,MAAM,IAAI,GAAG,mBAAmB,CAAC;YAC/B,EAAE,EAAE,aAAa;YACjB,SAAS,EAAE,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,GAAG,EAAE;gBACZ,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEH,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAErC,mCAAmC;QACnC,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QAEzD,mBAAmB;QACnB,MAAM,CAAC,KAAK,EAAE,CAAC;QAEf,+BAA+B;QAC/B,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QAEzD,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,WAAW,GAAG,MAAM,CAAC,oBAAoB,EAAE,CAAC;QAClD,MAAM,UAAU,GAAG,IAAI,SAAS,CAC9B,IAAI,eAAe,CAAC,WAAW,EAAE,MAAM,CAAC,EACxC,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,EACzD,MAAM,CACP,CAAC;QAEF,MAAM,EAAE,GAAG,IAAI,SAAS,CAAC,aAAa,CAAC,CAAC;QACxC,IAAI,gBAAgB,GAAG,KAAK,CAAC;QAE7B,MAAM,IAAI,GAAG,mBAAmB,CAAC;YAC/B,EAAE,EAAE,aAAa;YACjB,SAAS,EAAE,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,CAAC;YACd,OAAO,EAAE,GAAG,EAAE;gBACZ,gBAAgB,GAAG,IAAI,CAAC;YAC1B,CAAC;SACF,CAAC,CAAC;QAEH,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAErC,8DAA8D;QAC9D,MAAM,OAAO,CAAC,GAAG,EAAE;YACjB,MAAM,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,CAAC,CAAC,CAAC;QAEH,MAAM,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "cojson-transport-ws",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.13.0",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"license": "MIT",
|
|
8
8
|
"dependencies": {
|
|
9
9
|
"typescript": "~5.6.2",
|
|
10
|
-
"cojson": "0.
|
|
10
|
+
"cojson": "0.13.0"
|
|
11
11
|
},
|
|
12
12
|
"devDependencies": {
|
|
13
13
|
"@types/ws": "8.5.10",
|
|
@@ -7,7 +7,7 @@ import {
|
|
|
7
7
|
logger,
|
|
8
8
|
} from "cojson";
|
|
9
9
|
import { BatchedOutgoingMessages } from "./BatchedOutgoingMessages.js";
|
|
10
|
-
import { deserializeMessages
|
|
10
|
+
import { deserializeMessages } from "./serialization.js";
|
|
11
11
|
import type { AnyWebSocket } from "./types.js";
|
|
12
12
|
|
|
13
13
|
export const BUFFER_LIMIT = 100_000;
|
|
@@ -20,11 +20,16 @@ export type CreateWebSocketPeerOpts = {
|
|
|
20
20
|
expectPings?: boolean;
|
|
21
21
|
batchingByDefault?: boolean;
|
|
22
22
|
deletePeerStateOnClose?: boolean;
|
|
23
|
+
pingTimeout?: number;
|
|
23
24
|
onClose?: () => void;
|
|
24
25
|
onSuccess?: () => void;
|
|
25
26
|
};
|
|
26
27
|
|
|
27
|
-
function createPingTimeoutListener(
|
|
28
|
+
function createPingTimeoutListener(
|
|
29
|
+
enabled: boolean,
|
|
30
|
+
timeout: number,
|
|
31
|
+
callback: () => void,
|
|
32
|
+
) {
|
|
28
33
|
if (!enabled) {
|
|
29
34
|
return {
|
|
30
35
|
reset() {},
|
|
@@ -39,7 +44,7 @@ function createPingTimeoutListener(enabled: boolean, callback: () => void) {
|
|
|
39
44
|
pingTimeout && clearTimeout(pingTimeout);
|
|
40
45
|
pingTimeout = setTimeout(() => {
|
|
41
46
|
callback();
|
|
42
|
-
},
|
|
47
|
+
}, timeout);
|
|
43
48
|
},
|
|
44
49
|
clear() {
|
|
45
50
|
pingTimeout && clearTimeout(pingTimeout);
|
|
@@ -128,6 +133,7 @@ export function createWebSocketPeer({
|
|
|
128
133
|
expectPings = true,
|
|
129
134
|
batchingByDefault = true,
|
|
130
135
|
deletePeerStateOnClose = false,
|
|
136
|
+
pingTimeout = 10_000,
|
|
131
137
|
onSuccess,
|
|
132
138
|
onClose,
|
|
133
139
|
}: CreateWebSocketPeerOpts): Peer {
|
|
@@ -156,14 +162,18 @@ export function createWebSocketPeer({
|
|
|
156
162
|
handleClose();
|
|
157
163
|
});
|
|
158
164
|
|
|
159
|
-
const
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
165
|
+
const pingTimeoutListener = createPingTimeoutListener(
|
|
166
|
+
expectPings,
|
|
167
|
+
pingTimeout,
|
|
168
|
+
() => {
|
|
169
|
+
incoming
|
|
170
|
+
.push("PingTimeout")
|
|
171
|
+
.catch((e) =>
|
|
172
|
+
logger.error("Error while pushing ping timeout", { err: e }),
|
|
173
|
+
);
|
|
174
|
+
emitClosedEvent();
|
|
175
|
+
},
|
|
176
|
+
);
|
|
167
177
|
|
|
168
178
|
const outgoingMessages = createOutgoingMessagesManager(
|
|
169
179
|
websocket,
|
|
@@ -172,6 +182,8 @@ export function createWebSocketPeer({
|
|
|
172
182
|
let isFirstMessage = true;
|
|
173
183
|
|
|
174
184
|
function handleIncomingMsg(event: { data: unknown }) {
|
|
185
|
+
pingTimeoutListener.reset();
|
|
186
|
+
|
|
175
187
|
if (event.data === "") {
|
|
176
188
|
return;
|
|
177
189
|
}
|
|
@@ -197,8 +209,6 @@ export function createWebSocketPeer({
|
|
|
197
209
|
outgoingMessages.setBatchingEnabled(true);
|
|
198
210
|
}
|
|
199
211
|
|
|
200
|
-
pingTimeout.reset();
|
|
201
|
-
|
|
202
212
|
for (const msg of messages) {
|
|
203
213
|
if (msg && "action" in msg) {
|
|
204
214
|
incoming
|
|
@@ -222,7 +232,7 @@ export function createWebSocketPeer({
|
|
|
222
232
|
|
|
223
233
|
websocket.removeEventListener("message", handleIncomingMsg);
|
|
224
234
|
websocket.removeEventListener("close", handleClose);
|
|
225
|
-
|
|
235
|
+
pingTimeoutListener.clear();
|
|
226
236
|
emitClosedEvent();
|
|
227
237
|
|
|
228
238
|
if (websocket.readyState === 0) {
|
|
@@ -4,6 +4,7 @@ import { afterEach, beforeEach, describe, expect, test } from "vitest";
|
|
|
4
4
|
import { WebSocket } from "ws";
|
|
5
5
|
import { createWebSocketPeer } from "../createWebSocketPeer";
|
|
6
6
|
import { startSyncServer } from "./syncServer";
|
|
7
|
+
import { waitFor } from "./utils";
|
|
7
8
|
|
|
8
9
|
describe("WebSocket Peer Integration", () => {
|
|
9
10
|
let server: any;
|
|
@@ -129,4 +130,35 @@ describe("WebSocket Peer Integration", () => {
|
|
|
129
130
|
expect(disconnectCalled).toBe(true);
|
|
130
131
|
expect(ws.readyState).toBe(WebSocket.CLOSED);
|
|
131
132
|
});
|
|
133
|
+
|
|
134
|
+
test("should trigger a timeout if the server does not respond", async () => {
|
|
135
|
+
const clientAgent = crypto.newRandomAgentSecret();
|
|
136
|
+
const clientNode = new LocalNode(
|
|
137
|
+
new ControlledAgent(clientAgent, crypto),
|
|
138
|
+
crypto.newRandomSessionID(crypto.getAgentID(clientAgent)),
|
|
139
|
+
crypto,
|
|
140
|
+
);
|
|
141
|
+
|
|
142
|
+
const ws = new WebSocket(syncServerUrl);
|
|
143
|
+
let disconnectCalled = false;
|
|
144
|
+
|
|
145
|
+
const peer = createWebSocketPeer({
|
|
146
|
+
id: "test-client",
|
|
147
|
+
websocket: ws,
|
|
148
|
+
role: "server",
|
|
149
|
+
pingTimeout: 5,
|
|
150
|
+
onClose: () => {
|
|
151
|
+
disconnectCalled = true;
|
|
152
|
+
},
|
|
153
|
+
});
|
|
154
|
+
|
|
155
|
+
clientNode.syncManager.addPeer(peer);
|
|
156
|
+
|
|
157
|
+
// Wait for connection to establish and the timeout to kick in
|
|
158
|
+
await waitFor(() => {
|
|
159
|
+
expect(disconnectCalled).toBe(true);
|
|
160
|
+
});
|
|
161
|
+
|
|
162
|
+
expect(ws.readyState).toBe(WebSocket.CLOSED);
|
|
163
|
+
});
|
|
132
164
|
});
|