cojson-transport-ws 0.8.13 → 0.8.17

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.
Files changed (20) hide show
  1. package/CHANGELOG.md +163 -148
  2. package/dist/BatchedOutgoingMessages.js +3 -3
  3. package/dist/BatchedOutgoingMessages.js.map +1 -1
  4. package/dist/index.js +6 -2
  5. package/dist/index.js.map +1 -1
  6. package/dist/serialization.js.map +1 -1
  7. package/dist/tests/BatchedOutgoingMessages.test.js +41 -11
  8. package/dist/tests/BatchedOutgoingMessages.test.js.map +1 -1
  9. package/dist/tests/createWebSocketPeer.test.js +9 -13
  10. package/dist/tests/createWebSocketPeer.test.js.map +1 -1
  11. package/package.json +5 -9
  12. package/src/BatchedOutgoingMessages.ts +36 -35
  13. package/src/index.ts +170 -163
  14. package/src/serialization.ts +25 -23
  15. package/src/tests/BatchedOutgoingMessages.test.ts +138 -106
  16. package/src/tests/createWebSocketPeer.test.ts +404 -411
  17. package/src/types.ts +19 -20
  18. package/tsconfig.json +2 -2
  19. package/.eslintrc.cjs +0 -24
  20. package/.prettierrc.js +0 -9
package/src/tests/BatchedOutgoingMessages.test.ts CHANGED
@@ -1,114 +1,146 @@
1
- import { describe, test, expect, vi, beforeEach, afterEach } from "vitest";
2
- import { BatchedOutgoingMessages, MAX_OUTGOING_MESSAGES_CHUNK_BYTES } from "../BatchedOutgoingMessages.js";
3
1
  import { SyncMessage } from "cojson";
4
2
  import { CoValueKnownState } from "cojson/src/sync.js";
3
+ import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
4
+ import {
5
+ BatchedOutgoingMessages,
6
+ MAX_OUTGOING_MESSAGES_CHUNK_BYTES,
7
+ } from "../BatchedOutgoingMessages.js";
5
8
 
6
9
  beforeEach(() => {
7
- vi.useFakeTimers();
8
- })
10
+ vi.useFakeTimers();
11
+ });
9
12
 
10
13
  afterEach(() => {
11
- vi.useRealTimers();
12
- })
14
+ vi.useRealTimers();
15
+ });
13
16
 
14
17
  describe("BatchedOutgoingMessages", () => {
15
- function setup() {
16
- const sendMock = vi.fn();
17
- const batchedMessages = new BatchedOutgoingMessages(sendMock);
18
- return { sendMock, batchedMessages };
19
- }
20
-
21
- test("should batch messages and send them after a timeout", () => {
22
- const { sendMock, batchedMessages } = setup();
23
- const message1: SyncMessage = { action: "known", id: "co_z1", header: false, sessions: {} };
24
- const message2: SyncMessage = { action: "known", id: "co_z2", header: false, sessions: {} };
25
-
26
- batchedMessages.push(message1);
27
- batchedMessages.push(message2);
28
-
29
- expect(sendMock).not.toHaveBeenCalled();
30
-
31
- vi.runAllTimers();
32
-
33
- expect(sendMock).toHaveBeenCalledTimes(1);
34
- expect(sendMock).toHaveBeenCalledWith(
35
- `${JSON.stringify(message1)}\n${JSON.stringify(message2)}`
36
- );
37
- });
38
-
39
- test("should send messages immediately when reaching MAX_OUTGOING_MESSAGES_CHUNK_BYTES", () => {
40
- const { sendMock, batchedMessages } = setup();
41
- const largeMessage: SyncMessage = {
42
- action: "known",
43
- id: "co_z_large",
44
- header: false,
45
- sessions: {
46
- // Add a large payload to exceed MAX_OUTGOING_MESSAGES_CHUNK_BYTES
47
- payload: "x".repeat(MAX_OUTGOING_MESSAGES_CHUNK_BYTES)
48
- } as CoValueKnownState['sessions'],
49
-
50
- };
51
-
52
- batchedMessages.push(largeMessage);
53
-
54
- expect(sendMock).toHaveBeenCalledTimes(1);
55
- expect(sendMock).toHaveBeenCalledWith(JSON.stringify(largeMessage));
56
- });
57
-
58
- test("should send accumulated messages before a large message", () => {
59
- const { sendMock, batchedMessages } = setup();
60
- const smallMessage: SyncMessage = { action: "known", id: "co_z_small", header: false, sessions: {} };
61
- const largeMessage: SyncMessage = {
62
- action: "known",
63
- id: "co_z_large",
64
- header: false,
65
- sessions: {
66
- // Add a large payload to exceed MAX_OUTGOING_MESSAGES_CHUNK_BYTES
67
- payload: "x".repeat(MAX_OUTGOING_MESSAGES_CHUNK_BYTES)
68
- } as CoValueKnownState['sessions'],
69
- };
70
-
71
- batchedMessages.push(smallMessage);
72
- batchedMessages.push(largeMessage);
73
-
74
- vi.runAllTimers();
75
-
76
- expect(sendMock).toHaveBeenCalledTimes(2);
77
- expect(sendMock).toHaveBeenNthCalledWith(1, JSON.stringify(smallMessage));
78
- expect(sendMock).toHaveBeenNthCalledWith(2, JSON.stringify(largeMessage));
79
- });
80
-
81
- test("should send remaining messages on close", () => {
82
- const { sendMock, batchedMessages } = setup();
83
- const message: SyncMessage = { action: "known", id: "co_z_test", header: false, sessions: {} };
84
-
85
- batchedMessages.push(message);
86
- expect(sendMock).not.toHaveBeenCalled();
87
-
88
- batchedMessages.close();
89
-
90
- expect(sendMock).toHaveBeenCalledTimes(1);
91
- expect(sendMock).toHaveBeenCalledWith(JSON.stringify(message));
92
- });
93
-
94
- test("should clear timeout when pushing new messages", () => {
95
- const { sendMock, batchedMessages } = setup();
96
- const message1: SyncMessage = { action: "known", id: "co_z1", header: false, sessions: {} };
97
- const message2: SyncMessage = { action: "known", id: "co_z2", header: false, sessions: {} };
98
-
99
- batchedMessages.push(message1);
100
-
101
- const clearTimeoutSpy = vi.spyOn(global, 'clearTimeout');
102
-
103
- batchedMessages.push(message2);
104
-
105
- expect(clearTimeoutSpy).toHaveBeenCalled();
106
-
107
- vi.runAllTimers();
108
-
109
- expect(sendMock).toHaveBeenCalledTimes(1);
110
- expect(sendMock).toHaveBeenCalledWith(
111
- `${JSON.stringify(message1)}\n${JSON.stringify(message2)}`
112
- );
113
- });
114
- });
18
+ function setup() {
19
+ const sendMock = vi.fn();
20
+ const batchedMessages = new BatchedOutgoingMessages(sendMock);
21
+ return { sendMock, batchedMessages };
22
+ }
23
+
24
+ test("should batch messages and send them after a timeout", () => {
25
+ const { sendMock, batchedMessages } = setup();
26
+ const message1: SyncMessage = {
27
+ action: "known",
28
+ id: "co_z1",
29
+ header: false,
30
+ sessions: {},
31
+ };
32
+ const message2: SyncMessage = {
33
+ action: "known",
34
+ id: "co_z2",
35
+ header: false,
36
+ sessions: {},
37
+ };
38
+
39
+ batchedMessages.push(message1);
40
+ batchedMessages.push(message2);
41
+
42
+ expect(sendMock).not.toHaveBeenCalled();
43
+
44
+ vi.runAllTimers();
45
+
46
+ expect(sendMock).toHaveBeenCalledTimes(1);
47
+ expect(sendMock).toHaveBeenCalledWith(
48
+ `${JSON.stringify(message1)}\n${JSON.stringify(message2)}`,
49
+ );
50
+ });
51
+
52
+ test("should send messages immediately when reaching MAX_OUTGOING_MESSAGES_CHUNK_BYTES", () => {
53
+ const { sendMock, batchedMessages } = setup();
54
+ const largeMessage: SyncMessage = {
55
+ action: "known",
56
+ id: "co_z_large",
57
+ header: false,
58
+ sessions: {
59
+ // Add a large payload to exceed MAX_OUTGOING_MESSAGES_CHUNK_BYTES
60
+ payload: "x".repeat(MAX_OUTGOING_MESSAGES_CHUNK_BYTES),
61
+ } as CoValueKnownState["sessions"],
62
+ };
63
+
64
+ batchedMessages.push(largeMessage);
65
+
66
+ expect(sendMock).toHaveBeenCalledTimes(1);
67
+ expect(sendMock).toHaveBeenCalledWith(JSON.stringify(largeMessage));
68
+ });
69
+
70
+ test("should send accumulated messages before a large message", () => {
71
+ const { sendMock, batchedMessages } = setup();
72
+ const smallMessage: SyncMessage = {
73
+ action: "known",
74
+ id: "co_z_small",
75
+ header: false,
76
+ sessions: {},
77
+ };
78
+ const largeMessage: SyncMessage = {
79
+ action: "known",
80
+ id: "co_z_large",
81
+ header: false,
82
+ sessions: {
83
+ // Add a large payload to exceed MAX_OUTGOING_MESSAGES_CHUNK_BYTES
84
+ payload: "x".repeat(MAX_OUTGOING_MESSAGES_CHUNK_BYTES),
85
+ } as CoValueKnownState["sessions"],
86
+ };
87
+
88
+ batchedMessages.push(smallMessage);
89
+ batchedMessages.push(largeMessage);
90
+
91
+ vi.runAllTimers();
92
+
93
+ expect(sendMock).toHaveBeenCalledTimes(2);
94
+ expect(sendMock).toHaveBeenNthCalledWith(1, JSON.stringify(smallMessage));
95
+ expect(sendMock).toHaveBeenNthCalledWith(2, JSON.stringify(largeMessage));
96
+ });
97
+
98
+ test("should send remaining messages on close", () => {
99
+ const { sendMock, batchedMessages } = setup();
100
+ const message: SyncMessage = {
101
+ action: "known",
102
+ id: "co_z_test",
103
+ header: false,
104
+ sessions: {},
105
+ };
106
+
107
+ batchedMessages.push(message);
108
+ expect(sendMock).not.toHaveBeenCalled();
109
+
110
+ batchedMessages.close();
111
+
112
+ expect(sendMock).toHaveBeenCalledTimes(1);
113
+ expect(sendMock).toHaveBeenCalledWith(JSON.stringify(message));
114
+ });
115
+
116
+ test("should clear timeout when pushing new messages", () => {
117
+ const { sendMock, batchedMessages } = setup();
118
+ const message1: SyncMessage = {
119
+ action: "known",
120
+ id: "co_z1",
121
+ header: false,
122
+ sessions: {},
123
+ };
124
+ const message2: SyncMessage = {
125
+ action: "known",
126
+ id: "co_z2",
127
+ header: false,
128
+ sessions: {},
129
+ };
130
+
131
+ batchedMessages.push(message1);
132
+
133
+ const clearTimeoutSpy = vi.spyOn(global, "clearTimeout");
134
+
135
+ batchedMessages.push(message2);
136
+
137
+ expect(clearTimeoutSpy).toHaveBeenCalled();
138
+
139
+ vi.runAllTimers();
140
+
141
+ expect(sendMock).toHaveBeenCalledTimes(1);
142
+ expect(sendMock).toHaveBeenCalledWith(
143
+ `${JSON.stringify(message1)}\n${JSON.stringify(message2)}`,
144
+ );
145
+ });
146
+ });