@player-devtools/messenger 0.0.7--canary.8.483

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.
@@ -0,0 +1,371 @@
1
+ import { describe, beforeEach, expect, test, vi } from "vitest";
2
+ import { Messenger } from "../index";
3
+ import { createMockContext } from "./helpers";
4
+ import { BaseEvent } from "@player-devtools/types";
5
+
6
+ vi.useFakeTimers();
7
+
8
+ describe("Messenger", () => {
9
+ beforeEach(() => {
10
+ vi.clearAllMocks();
11
+ Messenger.reset();
12
+ });
13
+
14
+ test("beacons", () => {
15
+ const { spies, mockMessagingAPI } = createMockContext();
16
+
17
+ // not assigning to a variable would lead to "new for side effects" error
18
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
19
+ const messenger = new Messenger({
20
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
21
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
22
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
23
+ messageCallback: spies.web1.messageCallback,
24
+ context: "devtools",
25
+ id: "test1",
26
+ logger: console,
27
+ });
28
+
29
+ vi.advanceTimersByTime(1000);
30
+
31
+ expect(spies.web1.sendMessage).toHaveBeenCalledWith(
32
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
33
+ );
34
+ });
35
+
36
+ test("queue messages while handshake is in progress, and send them as the connection is established", () => {
37
+ const { spies, mockMessagingAPI } = createMockContext();
38
+
39
+ const messenger = new Messenger({
40
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
41
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
42
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
43
+ messageCallback: spies.web1.messageCallback,
44
+ context: "devtools",
45
+ id: "test2",
46
+ logger: console,
47
+ });
48
+
49
+ const events: Array<BaseEvent<string, unknown>> = [
50
+ { type: "TEST", payload: { count: 1 } },
51
+ { type: "TEST", payload: { count: 2 } },
52
+ { type: "TEST", payload: { count: 3 } },
53
+ ];
54
+
55
+ messenger.sendMessage(events[0]);
56
+
57
+ vi.advanceTimersByTime(1000);
58
+
59
+ messenger.sendMessage(events[1]);
60
+
61
+ vi.advanceTimersByTime(1000);
62
+
63
+ messenger.sendMessage(events[2]);
64
+
65
+ vi.advanceTimersByTime(1000);
66
+
67
+ mockMessagingAPI.sendMessage({
68
+ type: "MESSENGER_BEACON",
69
+ context: "content-script",
70
+ _messenger_: true,
71
+ sender: "test-2",
72
+ });
73
+
74
+ expect(spies.web1.sendMessage).toHaveBeenCalledTimes(8);
75
+
76
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
77
+ 1,
78
+ expect.objectContaining({ ...events[0], sender: "test2" }),
79
+ );
80
+
81
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
82
+ 2,
83
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
84
+ );
85
+
86
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
87
+ 3,
88
+ expect.objectContaining({ ...events[1], sender: "test2" }),
89
+ );
90
+
91
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
92
+ 4,
93
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
94
+ );
95
+
96
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
97
+ 5,
98
+ expect.objectContaining({ ...events[2], sender: "test2" }),
99
+ );
100
+
101
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
102
+ 6,
103
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
104
+ );
105
+
106
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
107
+ 7,
108
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
109
+ );
110
+
111
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
112
+ 8,
113
+ expect.objectContaining({
114
+ type: "MESSENGER_EVENT_BATCH",
115
+ target: "test-2",
116
+ payload: {
117
+ events: [
118
+ expect.objectContaining({ ...events[0] }),
119
+ expect.objectContaining({ ...events[1] }),
120
+ expect.objectContaining({ ...events[2] }),
121
+ ],
122
+ },
123
+ }),
124
+ );
125
+ });
126
+
127
+ test("messeges sent between two Messenger instances", () => {
128
+ const { spies, mockMessagingAPI } = createMockContext();
129
+
130
+ const eventsweb1: Array<BaseEvent<string, unknown>> = [
131
+ { type: "TEST", payload: { count: 1 } },
132
+ { type: "TEST", payload: { count: 2 } },
133
+ ];
134
+
135
+ const eventsDevtools: Array<BaseEvent<string, unknown>> = [
136
+ { type: "TEST", payload: { count: 3 } },
137
+ { type: "TEST", payload: { count: 4 } },
138
+ ];
139
+
140
+ const messenger1 = new Messenger({
141
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
142
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
143
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
144
+ messageCallback: spies.web1.messageCallback,
145
+ context: "player",
146
+ id: "web1",
147
+ logger: console,
148
+ });
149
+
150
+ vi.advanceTimersByTime(1000);
151
+
152
+ messenger1.sendMessage(eventsweb1[0]);
153
+
154
+ const messenger2 = new Messenger({
155
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
156
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
157
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
158
+ messageCallback: spies.devtools.messageCallback,
159
+ context: "devtools",
160
+ id: "devtools1",
161
+ logger: console,
162
+ });
163
+
164
+ vi.advanceTimersByTime(1000);
165
+
166
+ messenger2.sendMessage(eventsDevtools[0]);
167
+
168
+ vi.advanceTimersByTime(1000);
169
+
170
+ messenger1.sendMessage(eventsweb1[1]);
171
+
172
+ messenger2.sendMessage(eventsDevtools[1]);
173
+
174
+ vi.advanceTimersByTime(1000);
175
+
176
+ expect(spies.web1.sendMessage).toHaveBeenCalledTimes(12);
177
+
178
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
179
+ 1,
180
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
181
+ );
182
+
183
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
184
+ 2,
185
+ expect.objectContaining({ ...eventsweb1[0], sender: "web1" }),
186
+ );
187
+
188
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
189
+ 3,
190
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
191
+ );
192
+
193
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
194
+ 4,
195
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
196
+ );
197
+
198
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
199
+ 5,
200
+ expect.objectContaining({
201
+ type: "MESSENGER_EVENT_BATCH",
202
+ target: "devtools1",
203
+ payload: {
204
+ events: [expect.objectContaining({ ...eventsweb1[0] })],
205
+ },
206
+ }),
207
+ );
208
+
209
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
210
+ 6,
211
+ expect.objectContaining({ ...eventsDevtools[0], sender: "devtools1" }),
212
+ );
213
+
214
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
215
+ 7,
216
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
217
+ );
218
+
219
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
220
+ 8,
221
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
222
+ );
223
+
224
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
225
+ 9,
226
+ expect.objectContaining({ ...eventsweb1[1], sender: "web1" }),
227
+ );
228
+
229
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
230
+ 10,
231
+ expect.objectContaining({ ...eventsDevtools[1], sender: "devtools1" }),
232
+ );
233
+
234
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
235
+ 11,
236
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
237
+ );
238
+
239
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
240
+ 12,
241
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
242
+ );
243
+ });
244
+
245
+ test("messages sent between two web Messenger instances and one devtools instance", () => {
246
+ const { spies, mockMessagingAPI } = createMockContext();
247
+
248
+ const eventsWeb1: Array<BaseEvent<string, unknown>> = [
249
+ { type: "TEST", target: "web2", payload: { count: 1 } },
250
+ { type: "TEST", target: "devtools", payload: { count: 2 } },
251
+ ];
252
+
253
+ const eventsWeb2: Array<BaseEvent<string, unknown>> = [
254
+ { type: "TEST", target: "web1", payload: { count: 3 } },
255
+ { type: "TEST", target: "devtools", payload: { count: 4 } },
256
+ ];
257
+
258
+ const eventsDevtools: Array<BaseEvent<string, unknown>> = [
259
+ { type: "TEST", target: "web1", payload: { count: 5 } },
260
+ { type: "TEST", target: "web2", payload: { count: 6 } },
261
+ ];
262
+
263
+ const messengerWeb1 = new Messenger({
264
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
265
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
266
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
267
+ messageCallback: spies.web1.messageCallback,
268
+ id: "web2",
269
+ context: "player",
270
+ logger: console,
271
+ });
272
+
273
+ const messengerWeb2 = new Messenger({
274
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
275
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
276
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
277
+ messageCallback: spies.web2.messageCallback,
278
+ id: "web3",
279
+ context: "player",
280
+ logger: console,
281
+ });
282
+
283
+ const messengerDevtools = new Messenger({
284
+ sendMessage: mockMessagingAPI.sendMessage.bind(mockMessagingAPI),
285
+ addListener: mockMessagingAPI.addListener.bind(mockMessagingAPI),
286
+ removeListener: mockMessagingAPI.removeListener.bind(mockMessagingAPI),
287
+ messageCallback: spies.devtools.messageCallback,
288
+ id: "devtools2",
289
+ context: "devtools",
290
+ logger: console,
291
+ });
292
+
293
+ vi.advanceTimersByTime(1000);
294
+
295
+ messengerWeb1.sendMessage(eventsWeb1[0]);
296
+ messengerWeb2.sendMessage(eventsWeb2[0]);
297
+ messengerDevtools.sendMessage(eventsDevtools[0]);
298
+
299
+ vi.advanceTimersByTime(1000);
300
+
301
+ messengerWeb1.sendMessage(eventsWeb1[1]);
302
+ messengerWeb2.sendMessage(eventsWeb2[1]);
303
+ messengerDevtools.sendMessage(eventsDevtools[1]);
304
+
305
+ vi.advanceTimersByTime(1000);
306
+
307
+ expect(spies.web1.sendMessage).toHaveBeenCalledTimes(15);
308
+ expect(spies.web2.sendMessage).toHaveBeenCalledTimes(15);
309
+ expect(spies.devtools.sendMessage).toHaveBeenCalledTimes(15);
310
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
311
+ 1,
312
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
313
+ );
314
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
315
+ 2,
316
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
317
+ );
318
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
319
+ 3,
320
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
321
+ );
322
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
323
+ 4,
324
+ expect.objectContaining({ ...eventsWeb1[0], target: "web2" }),
325
+ );
326
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
327
+ 5,
328
+ expect.objectContaining({ ...eventsWeb2[0], target: "web1" }),
329
+ );
330
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
331
+ 6,
332
+ expect.objectContaining({ ...eventsDevtools[0], target: "web1" }),
333
+ );
334
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
335
+ 7,
336
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
337
+ );
338
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
339
+ 8,
340
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
341
+ );
342
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
343
+ 9,
344
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
345
+ );
346
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
347
+ 10,
348
+ expect.objectContaining({ ...eventsWeb1[1], target: "devtools" }),
349
+ );
350
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
351
+ 11,
352
+ expect.objectContaining({ ...eventsWeb2[1], target: "devtools" }),
353
+ );
354
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
355
+ 12,
356
+ expect.objectContaining({ ...eventsDevtools[1], target: "web2" }),
357
+ );
358
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
359
+ 13,
360
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
361
+ );
362
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
363
+ 14,
364
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
365
+ );
366
+ expect(spies.web1.sendMessage).toHaveBeenNthCalledWith(
367
+ 15,
368
+ expect.objectContaining({ type: "MESSENGER_BEACON" }),
369
+ );
370
+ });
371
+ });