-
Notifications
You must be signed in to change notification settings - Fork 14
/
fdc3.broadcast.ts
857 lines (678 loc) · 33.3 KB
/
fdc3.broadcast.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
import { Listener, Channel, Context, ContextTypes } from "@finos/fdc3";
import { assert, expect } from "chai";
import constants from "../constants";
import fdc3AddContextListener from "./fdc3.addContextListener";
import APIDocumentation from "../apiDocuments";
const documentation =
"\r\nDocumentation: " + APIDocumentation.desktopAgent + "\r\nCause:";
export default () =>
describe("fdc3.broadcast", () => {
let listener: Listener;
let listener2: Listener;
let channelsAppContext = {
type: "channelsAppContext",
reverseMethodCallOrder: false,
contextBroadcasts: {
instrument: true,
contact: false,
},
useAppChannel: false,
broadcastMultipleItems: false,
broadcastExecutionComplete: false,
};
it("Broadcast method is callable", async () => {
await window.fdc3.broadcast({
type: "fdc3.instrument",
id: { ticker: "AAPL" },
});
});
describe("User channels", () => {
beforeEach(async () => {
await unsubscribeListeners();
await window.fdc3.leaveCurrentChannel();
resetChannelsAppContext();
});
afterEach(async () => {
await broadcastSystemChannelCloseWindow();
});
it("Should receive context when adding a listener then joining a user channel before app B broadcasts context to the same channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- Add fdc3.instrument context listener to app A\r\n- App A joins channel 1\r\n- App B joins channel 1\r\n- App B broadcasts fdc3.instrument context${documentation}`;
return new Promise(async (resolve, reject) => {
//Add context listener to app A
listener = await window.fdc3.addContextListener(null, (context) => {
expect(context.type).to.be.equal("fdc3.instrument", errorMessage);
resolve();
});
validateListenerObject(listener);
//App A joins channel 1
await joinChannel(1);
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts context
window.fdc3.open("ChannelsApp", channelsAppContext);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive context when joining a user channel then adding a context listener before app B broadcasts context to the same channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A joins channel 1\r\n- Add listener of type fdc3.instrument to App A\r\n- App B joins channel 1\r\n- App B broadcasts fdc3.instrument context${documentation}`;
return new Promise(async (resolve, reject) => {
//App A joins channel 1
await joinChannel(1);
//Add context listener to app A
listener = await window.fdc3.addContextListener(null, (context) => {
expect(context.type).to.be.equal("fdc3.instrument", errorMessage);
resolve();
});
validateListenerObject(listener);
//Open ChannelsApp app. channels app joins channel 1, then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive context when app B joins then broadcasts context to a user channel before A joins and listens on the same channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App B joins channel 1\r\n- App B broadcasts fdc3.instrument context\r\n- App A joins channel 1\r\n- App A adds fdc3.instrument context listener${documentation}`;
return new Promise(async (resolve, reject) => {
//Open ChannelsApp app. channels app joins channel 1, then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//App A joins channel 1
await joinChannel(1);
//Add context listener to app A
listener = await window.fdc3.addContextListener(null, (context) => {
expect(context.type).to.be.equal("fdc3.instrument", errorMessage);
resolve();
});
validateListenerObject(listener);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive context when app B broadcasts the listened type to the same user channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds fdc3.instrument context listener\r\n- App A joins channel 1\r\n- App B joins channel 1\r\n- App B broadcasts context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.contextBroadcasts.contact = true;
//Add context listener to app A
listener = await window.fdc3.addContextListener(
"fdc3.instrument",
(context) => {
expect(context.type).to.be.equals(
"fdc3.instrument",
errorMessage
);
resolve();
}
);
validateListenerObject(listener);
//App A joins channel 1
joinChannel(1);
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts both contexts
window.fdc3.open("ChannelsApp", channelsAppContext);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive multiple contexts when app B broadcasts the listened types to the same user channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds fdc3.instrument and fdc3.contact context listener\r\n- App A joins channel 1\r\n- App B joins channel 1\r\n- App B broadcasts both context types${documentation}`;
return new Promise(async (resolve, reject) => {
let contextTypes: string[] = [];
channelsAppContext.contextBroadcasts.contact = true;
//Add context listener to app A
listener = await window.fdc3.addContextListener(
"fdc3.instrument",
(context) => {
contextTypes.push(context.type);
checkIfBothContextsReceived();
}
);
validateListenerObject(listener);
//Add second context listener to app A
listener2 = await window.fdc3.addContextListener(
"fdc3.contact",
(context) => {
contextTypes.push(context.type);
checkIfBothContextsReceived();
}
);
validateListenerObject(listener2);
//App A joins channel 1
await joinChannel(1);
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts both contexts
await window.fdc3.open("ChannelsApp", channelsAppContext);
function checkIfBothContextsReceived() {
if (contextTypes.length === 2) {
if (
!contextTypes.includes("fdc3.contact") ||
!contextTypes.includes("fdc3.instrument")
) {
assert.fail("Incorrect context received", errorMessage);
} else {
resolve();
}
}
}
//if no context received throw error
await wait();
reject(
new Error(`${errorMessage} At least one context was not received`)
);
});
});
it("Should not receive context when A & B join different user channels and app B broadcasts a listened type", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds fdc3.instrument and fdc3.contact context listener\r\n- App A joins channel 2\r\n- App B joins channel 1\r\n- App B broadcasts both context types${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.contextBroadcasts.contact = true;
//Add two context listeners to app A
listener = window.fdc3.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
listener2 = window.fdc3.addContextListener(
"fdc3.contact",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener2);
//App A joins channel 2
await joinChannel(2);
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts both contexts
await window.fdc3.open("ChannelsApp", channelsAppContext);
//give listener time to receive context
await wait();
resolve();
});
});
it("Should not receive context when unsubscribing a user channel before app B broadcasts the listened type to that channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds context listener of type fdc3.instrument\r\n- App A joins channel 1\r\n- App A unsubscribes the listener\r\n- App B joins channel 1\r\n- App B broadcasts context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.broadcastExecutionComplete = true;
//listens for when app B execution is complete
const executionCompleteContext =
executionCompleteListener("executionComplete");
//Add context listener
listener = window.fdc3.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
//App A joins channel 1
await joinChannel(1);
//unsubscribe from listeners
if (listener !== undefined) {
await listener.unsubscribe();
listener = undefined;
} else {
assert.fail("Listener undefined", errorMessage);
}
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts both contexts
window.fdc3.open("ChannelsApp", channelsAppContext);
await executionCompleteContext;
resolve();
});
});
it("Should not receive context when joining two different user channels before app B broadcasts the listened type to the first channel that was joined", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds context listener of type fdc3.instrument\r\n- App A joins channel 1\r\n- App A joins channel 2\r\n- App B joins channel 1\r\n- App B broadcasts context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.broadcastExecutionComplete = true;
//listens for when app B execution is complete
const executionCompleteContext =
executionCompleteListener("executionComplete");
//Add context listeners to app A
listener = window.fdc3.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
//App A joins a channel and then joins another
await joinChannel(1);
await joinChannel(2);
//Open ChannelsApp app. ChannelsApp joins channel 1, then broadcasts both contexts
window.fdc3.open("ChannelsApp", channelsAppContext);
await executionCompleteContext;
resolve();
});
});
it("Should not receive context when joining and then leaving a user channel before app B broadcasts the listened type to the same channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A adds context listener of type fdc3.instrument\r\n- App A joins channel 1\r\n- App A leaves channel 1\r\n- App B joins channel 1\r\n- App B broadcasts context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
//Add a context listeners to app A
listener = window.fdc3.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
//App A joins channel 1
await joinChannel(1);
//App A leaves channel 1
await window.fdc3.leaveCurrentChannel();
//App B joins channel 1, then broadcasts both contexts
await window.fdc3.open("ChannelsApp", channelsAppContext);
//give listener time to receive context
await wait();
resolve();
});
});
});
describe("App channels", () => {
beforeEach(async () => {
await unsubscribeListeners();
await window.fdc3.leaveCurrentChannel();
resetChannelsAppContext();
});
afterEach(async () => {
await broadcastAppChannelCloseWindow();
});
it("Should receive context when app B broadcasts the listened type to the same app channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds adds a context listener of type null\r\n- App B retrieves the same app channel as A\r\n- App B broadcasts context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//Add context listener to app A
listener = await testChannel.addContextListener(null, (context) => {
expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
resolve();
});
validateListenerObject(listener);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive context when app B broadcasts context to an app channel before A retrieves current context", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App B retrieves an app channel\r\n- App B broadcasts context of type fdc3.instrument\r\n- App A retrieves the same app channel as B\r\n- App A retrieves current context of type null${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
//App B creates/retrieves an app channel then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//give app B time to fully execute
await wait();
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//Retrieve current context from channel
await testChannel.getCurrentContext().then((context) => {
expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
resolve();
});
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive context of correct type when app B broadcasts multiple contexts to an app channel before A retrieves current context of a specified type", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App B retrieves an app channel\r\n- App B broadcasts context of type fdc3.instrument and then of type fdc3.contact\r\n- App A retrieves the same app channel as B\r\n- App A retreives current context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
//App B creates/retrieves an app channel then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//give app B time to fully execute
await wait();
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//Retrieve current context from channel
await testChannel
.getCurrentContext("fdc3.instrument")
.then((context) => {
expect(context.type).to.be.equals(
"fdc3.instrument",
errorMessage
);
resolve();
});
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should only receive the listened context when app B broadcasts multiple contexts to the same app channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds a context listener of type fdc3.instrument\r\n- App B retrieves the same app channel as A\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//Add context listener to app A
listener = await testChannel.addContextListener(
"fdc3.instrument",
(context) => {
expect(context.type).to.be.equals(
"fdc3.instrument",
errorMessage
);
resolve();
}
);
validateListenerObject(listener);
//App B retrieves the same app channel as A then broadcasts two contexts
await window.fdc3.open("ChannelsApp", channelsAppContext);
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should receive multiple contexts when app B broadcasts the listened types to the same app channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds a context listener of type fdc3.instrument and fdc3.contact\r\n- App B retrieves the same app channel as A\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact${documentation}`;
return new Promise(async (resolve, reject) => {
let contextTypes: string[] = [];
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//Add context listener to app A
listener = await testChannel.addContextListener(
"fdc3.instrument",
(context) => {
contextTypes.push(context.type);
checkIfBothContextsReceived();
}
);
validateListenerObject(listener);
//Add a second context listener to app A
listener2 = await testChannel.addContextListener(
"fdc3.contact",
(context) => {
contextTypes.push(context.type);
checkIfBothContextsReceived();
}
);
validateListenerObject(listener2);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
function checkIfBothContextsReceived() {
if (contextTypes.length === 2) {
if (
!contextTypes.includes("fdc3.contact") ||
!contextTypes.includes("fdc3.instrument")
) {
assert.fail("Incorrect context received", errorMessage);
} else {
resolve();
}
}
}
//if no context received throw error
await wait();
reject(new Error(`${errorMessage} No context received`));
});
});
it("Should not receive context when listening for all context types then unsubscribing an app channel before app B broadcasts to that channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds a context listener of type null\r\n- App A unsubscribes the app channel\r\n- App B retrieves the same app channel as A\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
channelsAppContext.broadcastExecutionComplete = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//listens for when app B execution is complete
const executionCompleteContext = executionCompleteListener(
"executionComplete",
testChannel
);
//Add context listener to app A
listener = testChannel.addContextListener(null, (context) => {
reject(
new Error(`${errorMessage} ${context.type} context received`)
);
});
validateListenerObject(listener);
//Unsubscribe from app channel
listener.unsubscribe();
//App B retrieves the same app channel as A then broadcasts context
window.fdc3.open("ChannelsApp", channelsAppContext);
await executionCompleteContext;
resolve();
});
});
it("Should not receive context when unsubscribing an app channel before app B broadcasts the listened type to that channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds a context listener of type fdc3.instrument\r\n- App A unsubscribes the app channel\r\n- App B retrieves the same app channel as A\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
channelsAppContext.broadcastExecutionComplete = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//listens for when app B execution is complete
const executionCompleteContext = executionCompleteListener(
"executionComplete",
testChannel
);
//Add context listener to app A
listener = testChannel.addContextListener(null, (context) => {
reject(
new Error(`${errorMessage} ${context.type} context received`)
);
});
validateListenerObject(listener);
//Unsubscribe from app channel
listener.unsubscribe();
//App B retrieves the same app channel as A then broadcasts context
window.fdc3.open("ChannelsApp", channelsAppContext);
await executionCompleteContext;
resolve();
});
});
it("Should not receive context when app B broadcasts context to a different app channel", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A adds a context listener of type fdc3.instrument\r\n- App B retrieves a different app channel\r\n- App B broadcasts a context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"a-different-test-channel"
);
//Add context listener to app A
listener = testChannel.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//give listener time to receive context
await wait();
resolve();
});
});
it("Should not receive context when retrieving two different app channels before app B broadcasts the listened type to the first channel that was retrieved", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App A switches to a different app channel\r\n- App A adds a context listener of type fdc3.instrument\r\n- App B retrieves the first channel that A retrieved\r\n- App B broadcasts a context of type fdc3.instrument${documentation}`;
return new Promise(async (resolve, reject) => {
channelsAppContext.useAppChannel = true;
//App A retrieves app channel
let testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//App A retrieves different app channel
testChannel = await window.fdc3.getOrCreateChannel(
"a-different-test-channel"
);
//Add context listener to app A
listener = testChannel.addContextListener(
"fdc3.instrument",
(context) =>
reject(
new Error(`${errorMessage} ${context.type} context received`)
)
);
validateListenerObject(listener);
//App B retrieves the first channel that A retrieved then broadcasts context
window.fdc3.open("ChannelsApp", channelsAppContext);
//give listener time to receive context
await wait();
resolve();
});
});
it("Should receive both contexts when app B broadcasts both contexts to the same app channel and A gets current context for each type", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App B retrieves the same app channel\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact\r\n- App A gets current context for types fdc3.instrument and fdc3.contact${documentation}`;
channelsAppContext.useAppChannel = true;
channelsAppContext.contextBroadcasts.contact = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//get contexts from app B
const context = await testChannel.getCurrentContext("fdc3.instrument");
expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
const contactContext = await testChannel.getCurrentContext(
"fdc3.contact"
);
expect(contactContext.type).to.be.equals("fdc3.contact", errorMessage);
});
it("Should retrieve the last broadcast context item when app B broadcasts a context with multiple history items to the same app channel and A gets current context", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A retrieves an app channel\r\n- App B retrieves the same app channel\r\n- App B broadcasts two different contexts of type fdc3.instrument\r\n- App A gets current context for types fdc3.instrument${documentation}`;
channelsAppContext.useAppChannel = true;
channelsAppContext.broadcastMultipleItems = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
//Give app B time to execute
await wait();
//get contexts from app B
const context = await testChannel.getCurrentContext("fdc3.instrument");
expect(context.type).to.be.equals("fdc3.instrument", errorMessage);
expect(context.name).to.be.equals("History-item-2", errorMessage);
});
it("Should retrieve the last broadcast context item when app B broadcasts two different contexts to the same app channel and A gets current context", async () => {
const errorMessage = `\r\nSteps to reproduce:\r\n- App A joins an app channel\r\n- App B joins the same app channel\r\n- App B broadcasts a context of type fdc3.instrument and fdc3.contact\r\n- App B gets current context with no filter applied${documentation}`;
channelsAppContext.useAppChannel = true;
channelsAppContext.broadcastExecutionComplete = true;
channelsAppContext.contextBroadcasts.contact = true;
//App A retrieves app channel
const testChannel = await window.fdc3.getOrCreateChannel(
"test-channel"
);
//listens for when app B execution is complete
const executionCompleteContext = executionCompleteListener(
"executionComplete",
testChannel
);
//App B retrieves the same app channel as A then broadcasts context
await window.fdc3.open("ChannelsApp", channelsAppContext);
await executionCompleteContext;
//get current context
const context = await testChannel.getCurrentContext();
if (context === null) {
assert.fail("No Context retrieved", errorMessage);
} else if (context.type === "closeWindow") {
assert.fail(
"Did not retrieve last broadcast context from app B",
errorMessage
);
} else {
expect(context.type).to.be.equals("executionComplete", errorMessage);
}
});
});
const joinChannel = async (channel: number) => {
const channels = await window.fdc3.getSystemChannels();
if (channels.length > 0) {
await window.fdc3.joinChannel(channels[channel - 1].id);
} else {
assert.fail("No system channels available for app A");
}
};
function validateListenerObject(listenerObject) {
assert.isObject(listenerObject, "No listener object found");
expect(typeof listenerObject.unsubscribe).to.be.equals(
"function",
"Listener does not contain an unsubscribe method"
);
}
async function wait() {
return new Promise((resolve) =>
setTimeout(() => {
resolve(true);
}, constants.WaitTime)
);
}
const broadcastSystemChannelCloseWindow = async () => {
await window.fdc3.broadcast({ type: "closeWindow" });
return new Promise<void>((resolve) => setTimeout(() => resolve(), 3000)); // Wait until close window event is handled
};
const broadcastAppChannelCloseWindow = async () => {
const testChannel = await window.fdc3.getOrCreateChannel("test-channel");
await testChannel.broadcast({ type: "closeWindow" });
return new Promise<void>((resolve) => setTimeout(() => resolve(), 3000)); // Wait until close window event is handled
};
async function unsubscribeListeners() {
if (listener !== undefined) {
await listener.unsubscribe();
listener = undefined;
}
if (listener2 !== undefined) {
await listener2.unsubscribe();
listener2 = undefined;
}
}
function resetChannelsAppContext() {
channelsAppContext.broadcastMultipleItems = false;
channelsAppContext.useAppChannel = false;
channelsAppContext.contextBroadcasts.contact = false;
channelsAppContext.reverseMethodCallOrder = false;
channelsAppContext.broadcastExecutionComplete = false;
}
const executionCompleteListener = (
contextType: string,
channel?: Channel
) => {
return new Promise<Context>(async (resolve) => {
if (channel === undefined) {
const listener = await window.fdc3.addContextListener(
contextType,
(context) => {
resolve(context);
listener.unsubscribe();
}
);
} else {
const listener = await channel.addContextListener(
contextType,
(context) => {
resolve(context);
listener.unsubscribe();
}
);
}
});
};
});