-
Notifications
You must be signed in to change notification settings - Fork 55
/
modular.test.js
1043 lines (910 loc) · 37.7 KB
/
modular.test.js
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
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import {
BaseRest,
BaseRealtime,
Rest,
generateRandomKey,
getDefaultCryptoParams,
decodeMessage,
decodeEncryptedMessage,
decodeMessages,
decodeEncryptedMessages,
Crypto,
MsgPack,
RealtimePresence,
decodePresenceMessage,
decodePresenceMessages,
constructPresenceMessage,
XHRPolling,
WebSocketTransport,
FetchRequest,
XHRRequest,
MessageInteractions,
} from '../../build/modular/index.mjs';
function registerAblyModularTests(Helper) {
describe('browser/modular', function () {
this.timeout(10 * 1000);
const expect = chai.expect;
const BufferUtils = BaseRest.Platform.BufferUtils;
const loadTestData = async (helper, dataPath) => {
return new Promise((resolve, reject) => {
helper.loadTestData(dataPath, (err, testData) => (err ? reject(err) : resolve(testData)));
});
};
async function monitorConnectionThenCloseAndFinish(helper, action, realtime, states) {
try {
await helper.monitorConnectionAsync(action, realtime, states);
} finally {
await helper.closeAndFinishAsync(realtime);
}
}
before(function (done) {
const helper = Helper.forHook(this);
helper.setupApp(done);
});
describe('attempting to initialize with no client options', () => {
for (const clientClass of [BaseRest, BaseRealtime]) {
describe(clientClass.name, () => {
/** @nospec */
it('throws an error', () => {
expect(() => new clientClass()).to.throw('must be initialized with a client options object');
});
});
}
});
describe('attempting to initialize with just an API key', () => {
for (const clientClass of [BaseRest, BaseRealtime]) {
describe(clientClass.name, () => {
/** @nospec */
it('throws an error', () => {
expect(() => new clientClass('foo:bar')).to.throw(
'cannot be initialized with just an Ably API key; you must provide a client options object with a `plugins` property',
);
});
});
}
});
describe('attempting to initialize with just a token', () => {
for (const clientClass of [BaseRest, BaseRealtime]) {
describe(clientClass.name, () => {
/** @nospec */
it('throws an error', () => {
expect(() => new clientClass('foo')).to.throw(
'cannot be initialized with just an Ably Token; you must provide a client options object with a `plugins` property',
);
});
});
}
});
describe('without any plugins', () => {
for (const clientClass of [BaseRest, BaseRealtime]) {
describe(clientClass.name, function () {
/** @nospec */
it('throws an error due to the absence of an HTTP plugin', function () {
expect(() => new clientClass(this.test.helper.ablyClientOptions())).to.throw(
'No HTTP request plugin provided. Provide at least one of the FetchRequest or XHRRequest plugins.',
);
});
});
}
});
describe('Rest', () => {
const restScenarios = [
{
description: 'use push admin functionality',
action: (client) => client.push.admin.publish({ clientId: 'foo' }, { data: { bar: 'baz' } }),
},
{ description: 'call `time()`', action: (client) => client.time() },
{
description: 'call `auth.createTokenRequest()` with `queryTime` option enabled',
action: (client, helper) =>
client.auth.createTokenRequest(undefined, {
key: helper.getTestApp().keys[0].keyStr /* if passing authOptions you have to explicitly pass the key */,
queryTime: true,
}),
},
{ description: 'call `stats()`', action: (client) => client.stats() },
{ description: 'call `request(...)`', action: (client) => client.request('get', '/channels/channel', 2) },
{
description: 'call `batchPublish(...)`',
action: (client) => client.batchPublish({ channels: ['channel'], messages: { data: { foo: 'bar' } } }),
},
{
description: 'call `batchPresence(...)`',
action: (client) => client.batchPresence(['channel']),
},
{
description: 'call `auth.revokeTokens(...)`',
getAdditionalClientOptions: (helper) => {
const testApp = helper.getTestApp();
return { key: testApp.keys[4].keyStr /* this key has revocableTokens enabled */ };
},
action: (client) => client.auth.revokeTokens([{ type: 'clientId', value: 'foo' }]),
},
{
description: 'call channel’s `history()`',
action: (client) => client.channels.get('channel').history(),
},
{
description: 'call channel’s `presence.history()`',
additionalRealtimePlugins: { RealtimePresence },
action: (client) => client.channels.get('channel').presence.history(),
},
{
description: 'call channel’s `status()`',
action: (client) => client.channels.get('channel').status(),
},
];
describe('BaseRest without explicit Rest', () => {
for (const scenario of restScenarios) {
/** @nospec */
it(`allows you to ${scenario.description}`, async function () {
const helper = this.test.helper;
const client = new BaseRest(
helper.ablyClientOptions({ ...scenario.getAdditionalClientOptions?.(helper), plugins: { FetchRequest } }),
);
let thrownError = null;
try {
await scenario.action(client, helper);
} catch (error) {
thrownError = error;
}
expect(thrownError).to.be.null;
});
}
});
describe('BaseRealtime with Rest', () => {
for (const scenario of restScenarios) {
/** @nospec */
it(`allows you to ${scenario.description}`, async function () {
const helper = this.test.helper;
const client = new BaseRealtime(
helper.ablyClientOptions({
autoConnect: false,
...scenario.getAdditionalClientOptions?.(helper),
plugins: {
WebSocketTransport,
FetchRequest,
Rest,
...scenario.additionalRealtimePlugins,
},
}),
);
let thrownError = null;
try {
await scenario.action(client, helper);
} catch (error) {
thrownError = error;
}
expect(thrownError).to.be.null;
});
}
});
describe('BaseRealtime without Rest', () => {
/** @nospec */
it('still allows publishing and subscribing', async function () {
const helper = this.test.helper;
const client = new BaseRealtime(
this.test.helper.ablyClientOptions({ plugins: { WebSocketTransport, FetchRequest } }),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const channel = client.channels.get('channel');
await channel.attach();
const recievedMessagePromise = new Promise((resolve) => {
channel.subscribe((message) => {
resolve(message);
});
});
await channel.publish({ data: { foo: 'bar' } });
const receivedMessage = await recievedMessagePromise;
expect(receivedMessage.data).to.eql({ foo: 'bar' });
},
client,
);
});
/** @nospec */
it('allows `auth.createTokenRequest()` without `queryTime` option enabled', async function () {
const client = new BaseRealtime(
this.test.helper.ablyClientOptions({ autoConnect: false, plugins: { WebSocketTransport, FetchRequest } }),
);
const tokenRequest = await client.auth.createTokenRequest();
expect(tokenRequest).to.be.an('object');
});
for (const scenario of restScenarios) {
/** @nospec */
it(`throws an error when attempting to ${scenario.description}`, async function () {
const helper = this.test.helper;
const client = new BaseRealtime(
this.test.helper.ablyClientOptions({
autoConnect: false,
...scenario.getAdditionalClientOptions?.(helper),
plugins: {
WebSocketTransport,
FetchRequest,
...scenario.additionalRealtimePlugins,
},
}),
);
let thrownError = null;
try {
await scenario.action(client, helper);
} catch (error) {
thrownError = error;
}
expect(thrownError).not.to.be.null;
expect(thrownError.message).to.equal('Rest plugin not provided');
});
}
});
});
describe('Crypto standalone functions', () => {
/**
* This test does a basic sanity check for RSE2b but for a function exposed in the modular bundle,
* so it's not really relevant to the spec item here.
*
* @nospec
*/
it('generateRandomKey', async () => {
const key = await generateRandomKey();
expect(key).to.be.an('ArrayBuffer');
});
/** @nospec */
it('getDefaultCryptoParams', async () => {
const key = await generateRandomKey();
const params = getDefaultCryptoParams({ key });
expect(params).to.be.an('object');
});
});
describe('Message standalone functions', () => {
async function testDecodesMessageData(helper, functionUnderTest) {
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const item = testData.items[1];
const decoded = await functionUnderTest(item.encoded);
expect(decoded.data).to.be.an('ArrayBuffer');
}
describe('decodeMessage', () => {
/**
* This tests TM3 (fromEncoded part) but for a function exposed in the modular bundle,
* so it's not really relevant to the spec item.
*
* @nospec
*/
it('decodes a message’s data', async function () {
testDecodesMessageData(this.test.helper, decodeMessage);
});
/** @nospec */
it('throws an error when given channel options with a cipher', async function () {
const helper = this.test.helper;
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const key = BufferUtils.base64Decode(testData.key);
const iv = BufferUtils.base64Decode(testData.iv);
let thrownError = null;
try {
await decodeMessage(testData.items[0].encrypted, { cipher: { key, iv } });
} catch (error) {
thrownError = error;
}
expect(thrownError).not.to.be.null;
expect(thrownError.message).to.equal('Crypto plugin not provided');
});
});
describe('decodeEncryptedMessage', async () => {
/** @nospec */
it('decodes a message’s data', async function () {
testDecodesMessageData(this.test.helper, decodeEncryptedMessage);
});
/** @nospec */
it('decrypts a message', async function () {
const helper = this.test.helper;
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const key = BufferUtils.base64Decode(testData.key);
const iv = BufferUtils.base64Decode(testData.iv);
for (const item of testData.items) {
const [decodedFromEncoded, decodedFromEncrypted] = await Promise.all([
decodeMessage(item.encoded),
decodeEncryptedMessage(item.encrypted, { cipher: { key, iv } }),
]);
this.test.helper.testMessageEquality(decodedFromEncoded, decodedFromEncrypted);
}
});
});
async function testDecodesMessagesData(helper, functionUnderTest) {
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const items = [testData.items[1], testData.items[3]];
const decoded = await functionUnderTest(items.map((item) => item.encoded));
expect(decoded[0].data).to.be.an('ArrayBuffer');
expect(decoded[1].data).to.be.an('array');
}
describe('decodeMessages', () => {
/**
* This tests TM3 (fromEncodedArray part) but for a function exposed in the modular bundle,
* so it's not really relevant to the spec item.
*
* @nospec
*/
it('decodes messages’ data', async function () {
testDecodesMessagesData(this.test.helper, decodeMessages);
});
/** @nospec */
it('throws an error when given channel options with a cipher', async function () {
const helper = this.test.helper;
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const key = BufferUtils.base64Decode(testData.key);
const iv = BufferUtils.base64Decode(testData.iv);
let thrownError = null;
try {
await decodeMessages(
testData.items.map((item) => item.encrypted),
{ cipher: { key, iv } },
);
} catch (error) {
thrownError = error;
}
expect(thrownError).not.to.be.null;
expect(thrownError.message).to.equal('Crypto plugin not provided');
});
});
describe('decodeEncryptedMessages', () => {
/** @nospec */
it('decodes messages’ data', async function () {
testDecodesMessagesData(this.test.helper, decodeEncryptedMessages);
});
/** @nospec */
it('decrypts messages', async function () {
const helper = this.test.helper;
const testData = await loadTestData(helper, helper.testResourcesPath + 'crypto-data-128.json');
const key = BufferUtils.base64Decode(testData.key);
const iv = BufferUtils.base64Decode(testData.iv);
const [decodedFromEncoded, decodedFromEncrypted] = await Promise.all([
decodeMessages(testData.items.map((item) => item.encoded)),
decodeEncryptedMessages(
testData.items.map((item) => item.encrypted),
{ cipher: { key, iv } },
),
]);
for (let i = 0; i < decodedFromEncoded.length; i++) {
this.test.helper.testMessageEquality(decodedFromEncoded[i], decodedFromEncrypted[i]);
}
});
});
});
describe('Crypto', () => {
describe('without Crypto', () => {
async function testThrowsAnErrorWhenGivenChannelOptionsWithACipher(helper, clientClassConfig) {
const client = new clientClassConfig.clientClass(
helper.ablyClientOptions({
...clientClassConfig.additionalClientOptions,
plugins: {
...clientClassConfig.additionalPlugins,
FetchRequest,
},
}),
);
const key = await generateRandomKey();
expect(() => client.channels.get('channel', { cipher: { key } })).to.throw('Crypto plugin not provided');
}
for (const clientClassConfig of [
{ clientClass: BaseRest },
{
clientClass: BaseRealtime,
additionalClientOptions: { autoConnect: false },
additionalPlugins: { WebSocketTransport },
},
]) {
describe(clientClassConfig.clientClass.name, () => {
/** @nospec */
it('throws an error when given channel options with a cipher', async function () {
await testThrowsAnErrorWhenGivenChannelOptionsWithACipher(this.test.helper, clientClassConfig);
});
});
}
});
describe('with Crypto', () => {
async function testIsAbleToPublishEncryptedMessages(helper, clientClassConfig) {
const clientOptions = helper.ablyClientOptions();
const key = await generateRandomKey();
// Publish the message on a channel configured to use encryption, and receive it on one not configured to use encryption
const rxClient = new BaseRealtime({ ...clientOptions, plugins: { WebSocketTransport, FetchRequest } });
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const rxChannel = rxClient.channels.get('channel');
await rxChannel.attach();
const rxMessagePromise = new Promise((resolve, _) => rxChannel.subscribe((message) => resolve(message)));
const encryptionChannelOptions = { cipher: { key } };
const txMessage = { name: 'message', data: 'data' };
const txClient = new clientClassConfig.clientClass({
...clientOptions,
plugins: {
...clientClassConfig.additionalPlugins,
FetchRequest,
Crypto,
},
});
await (
clientClassConfig.isRealtime ? monitorConnectionThenCloseAndFinish : async (helper, op) => await op()
)(
helper,
async () => {
const txChannel = txClient.channels.get('channel', encryptionChannelOptions);
await txChannel.publish(txMessage);
const rxMessage = await rxMessagePromise;
// Verify that the message was published with encryption
expect(rxMessage.encoding).to.equal('utf-8/cipher+aes-256-cbc');
// Verify that the message was correctly encrypted
const rxMessageDecrypted = await decodeEncryptedMessage(rxMessage, encryptionChannelOptions);
helper.testMessageEquality(rxMessageDecrypted, txMessage);
},
txClient,
);
},
rxClient,
);
}
for (const clientClassConfig of [
{ clientClass: BaseRest, isRealtime: false },
{
clientClass: BaseRealtime,
additionalPlugins: { WebSocketTransport },
isRealtime: true,
},
]) {
describe(clientClassConfig.clientClass.name, () => {
/** @nospec */
it('is able to publish encrypted messages', async function () {
await testIsAbleToPublishEncryptedMessages(this.test.helper, clientClassConfig);
});
});
}
});
});
describe('MsgPack', () => {
async function testRestUsesContentType(rest, expectedContentType) {
const channelName = 'channel';
const channel = rest.channels.get(channelName);
const contentTypeUsedForPublishPromise = new Promise((resolve, reject) => {
rest.http.do = async (method, path, headers, body, params) => {
if (!(method == 'post' && path == `/channels/${channelName}/messages`)) {
return new Promise(() => {});
}
resolve(headers['content-type']);
return { error: null };
};
});
await channel.publish('message', 'body');
const contentTypeUsedForPublish = await contentTypeUsedForPublishPromise;
expect(contentTypeUsedForPublish).to.equal(expectedContentType);
}
async function testRealtimeUsesFormat(realtime, expectedFormat) {
const formatUsedForConnectionPromise = new Promise((resolve, reject) => {
realtime.connection.connectionManager.connectImpl = (transportParams) => {
resolve(transportParams.format);
};
});
realtime.connect();
const formatUsedForConnection = await formatUsedForConnectionPromise;
expect(formatUsedForConnection).to.equal(expectedFormat);
}
// TODO once https://github.com/ably/ably-js/issues/1424 is fixed, this should also test the case where the useBinaryProtocol option is not specified
describe('with useBinaryProtocol client option', () => {
describe('without MsgPack', () => {
describe('BaseRest', () => {
/** @nospec */
it('uses JSON', async function () {
const client = new BaseRest(
this.test.helper.ablyClientOptions({ useBinaryProtocol: true, plugins: { FetchRequest } }),
);
await testRestUsesContentType(client, 'application/json');
});
});
describe('BaseRealtime', () => {
/** @nospec */
it('uses JSON', async function () {
const helper = this.test.helper;
const client = new BaseRealtime(
helper.ablyClientOptions({
useBinaryProtocol: true,
autoConnect: false,
plugins: {
WebSocketTransport,
FetchRequest,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
await testRealtimeUsesFormat(client, 'json');
},
client,
);
});
});
});
describe('with MsgPack', () => {
describe('BaseRest', () => {
/** @nospec */
it('uses MessagePack', async function () {
const client = new BaseRest(
this.test.helper.ablyClientOptions({
useBinaryProtocol: true,
plugins: {
FetchRequest,
MsgPack,
},
}),
);
await testRestUsesContentType(client, 'application/x-msgpack');
});
});
describe('BaseRealtime', () => {
/** @nospec */
it('uses MessagePack', async function () {
const helper = this.test.helper;
const client = new BaseRealtime(
helper.ablyClientOptions({
useBinaryProtocol: true,
autoConnect: false,
plugins: {
WebSocketTransport,
FetchRequest,
MsgPack,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
await testRealtimeUsesFormat(client, 'msgpack');
},
client,
);
});
});
});
});
});
describe('RealtimePresence', () => {
describe('BaseRealtime without RealtimePresence', () => {
/** @nospec */
it('throws an error when attempting to access the `presence` property', async function () {
const helper = this.test.helper;
const client = new BaseRealtime(helper.ablyClientOptions({ plugins: { WebSocketTransport, FetchRequest } }));
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const channel = client.channels.get('channel');
expect(() => channel.presence).to.throw('RealtimePresence plugin not provided');
},
client,
);
});
/** @nospec */
it('doesn’t break when it receives a PRESENCE ProtocolMessage', async function () {
const helper = this.test.helper;
const rxClient = new BaseRealtime(
helper.ablyClientOptions({ plugins: { WebSocketTransport, FetchRequest } }),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const rxChannel = rxClient.channels.get('channel');
await rxChannel.attach();
const receivedMessagePromise = new Promise((resolve) => rxChannel.subscribe(resolve));
const txClient = new BaseRealtime(
this.test.helper.ablyClientOptions({
clientId: Helper.randomString(),
plugins: {
WebSocketTransport,
FetchRequest,
RealtimePresence,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const txChannel = txClient.channels.get('channel');
await txChannel.publish('message', 'body');
await txChannel.presence.enter();
// The idea being here that in order for receivedMessagePromise to resolve, rxClient must have first processed the PRESENCE ProtocolMessage that resulted from txChannel.presence.enter()
await receivedMessagePromise;
},
txClient,
);
},
rxClient,
);
});
});
describe('BaseRealtime with RealtimePresence', () => {
/**
* Tests RTP6b and RTP8a but for a RealtimePresence plugin with modular BaseRealtime,
* so it's not explictly related to any spec item.
*
* @nospec
*/
it('offers realtime presence functionality', async function () {
const helper = this.test.helper;
const rxClient = new BaseRealtime(
helper.ablyClientOptions({
plugins: {
WebSocketTransport,
FetchRequest,
RealtimePresence,
},
}),
);
const rxChannel = rxClient.channels.get('channel');
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const txClientId = Helper.randomString();
const txClient = new BaseRealtime(
this.test.helper.ablyClientOptions({
clientId: txClientId,
plugins: {
WebSocketTransport,
FetchRequest,
RealtimePresence,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const txChannel = txClient.channels.get('channel');
let resolveRxPresenceMessagePromise;
const rxPresenceMessagePromise = new Promise((resolve, reject) => {
resolveRxPresenceMessagePromise = resolve;
});
await rxChannel.presence.subscribe('enter', resolveRxPresenceMessagePromise);
await txChannel.presence.enter();
const rxPresenceMessage = await rxPresenceMessagePromise;
expect(rxPresenceMessage.clientId).to.equal(txClientId);
},
txClient,
);
},
rxClient,
);
});
});
});
describe('PresenceMessage standalone functions', () => {
describe('decodePresenceMessage', () => {
/**
* Tests TP4 (fromEncoded part) but for a function exposed in the modular bundle,
* so it's not really relevant to the spec item.
*
* @nospec
*/
it('decodes a presence message’s data', async () => {
const buffer = BufferUtils.utf8Encode('foo');
const encodedMessage = { data: BufferUtils.base64Encode(buffer), encoding: 'base64' };
const decodedMessage = await decodePresenceMessage(encodedMessage);
expect(BufferUtils.areBuffersEqual(decodedMessage.data, buffer)).to.be.true;
expect(decodedMessage.encoding).to.be.null;
});
});
describe('decodeMessages', () => {
/**
* Tests TP4 (fromEncodedArray part) but for a function exposed in the modular bundle,
* so it's not really relevant to the spec item.
*
* @nospec
*/
it('decodes presence messages’ data', async () => {
const buffers = ['foo', 'bar'].map((data) => BufferUtils.utf8Encode(data));
const encodedMessages = buffers.map((buffer) => ({
data: BufferUtils.base64Encode(buffer),
encoding: 'base64',
}));
const decodedMessages = await decodePresenceMessages(encodedMessages);
for (let i = 0; i < decodedMessages.length; i++) {
const decodedMessage = decodedMessages[i];
expect(BufferUtils.areBuffersEqual(decodedMessage.data, buffers[i])).to.be.true;
expect(decodedMessage.encoding).to.be.null;
}
});
});
describe('constructPresenceMessage', () => {
/** @nospec */
it('creates a PresenceMessage instance', async () => {
const extras = { foo: 'bar' };
const presenceMessage = constructPresenceMessage({ extras });
expect(presenceMessage.constructor.name).to.contain('PresenceMessage');
expect(presenceMessage.extras).to.equal(extras);
});
});
});
describe('Transports', () => {
describe('BaseRealtime', () => {
describe('without a transport plugin', () => {
/** @nospec */
it('throws an error due to absence of a transport plugin', function () {
expect(() => new BaseRealtime(this.test.helper.ablyClientOptions({ plugins: { FetchRequest } }))).to.throw(
'no requested transports available',
);
});
});
for (const scenario of [
{ pluginsKey: 'WebSocketTransport', transportPlugin: WebSocketTransport, transportName: 'web_socket' },
{ pluginsKey: 'XHRPolling', transportPlugin: XHRPolling, transportName: 'xhr_polling' },
]) {
describe(`with the ${scenario.pluginsKey} plugin`, () => {
/**
* Tests RTN1 support for modular bundle.
* @nospec
*/
it(`is able to use the ${scenario.transportName} transport`, async function () {
const helper = this.test.helper;
const realtime = new BaseRealtime(
helper.ablyClientOptions({
autoConnect: false,
transports: [scenario.transportName],
plugins: {
FetchRequest,
[scenario.pluginsKey]: scenario.transportPlugin,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
let firstTransportCandidate;
const connectionManager = realtime.connection.connectionManager;
const originalTryATransport = connectionManager.tryATransport;
realtime.connection.connectionManager.tryATransport = (transportParams, candidate, callback) => {
if (!firstTransportCandidate) {
firstTransportCandidate = candidate;
}
originalTryATransport.bind(connectionManager)(transportParams, candidate, callback);
};
realtime.connect();
await realtime.connection.once('connected');
expect(firstTransportCandidate).to.equal(scenario.transportName);
},
realtime,
);
});
});
}
});
});
describe('HTTP request implementations', () => {
describe('with multiple HTTP request implementations', () => {
/** @nospec */
it('prefers XHR', async function () {
let usedXHR = false;
const XHRRequestSpy = class XHRRequestSpy extends XHRRequest {
static createRequest(...args) {
usedXHR = true;
return super.createRequest(...args);
}
};
const rest = new BaseRest(
this.test.helper.ablyClientOptions({ plugins: { FetchRequest, XHRRequest: XHRRequestSpy } }),
);
await rest.time();
expect(usedXHR).to.be.true;
});
});
});
describe('MessageInteractions', () => {
describe('BaseRealtime', () => {
describe('without MessageInteractions', () => {
/** @nospec */
it('is able to subscribe to and unsubscribe from channel events, as long as a MessageFilter isn’t passed', async function () {
const helper = this.test.helper;
const realtime = new BaseRealtime(
helper.ablyClientOptions({ plugins: { WebSocketTransport, FetchRequest } }),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const channel = realtime.channels.get('channel');
await channel.attach();
const subscribeReceivedMessagePromise = new Promise((resolve) => channel.subscribe(resolve));
await channel.publish('message', 'body');
const subscribeReceivedMessage = await subscribeReceivedMessagePromise;
expect(subscribeReceivedMessage.data).to.equal('body');
},
realtime,
);
});
/** @nospec */
it('throws an error when attempting to subscribe to channel events using a MessageFilter', async function () {
const helper = this.test.helper;
const realtime = new BaseRealtime(
helper.ablyClientOptions({ plugins: { WebSocketTransport, FetchRequest } }),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const channel = realtime.channels.get('channel');
let thrownError = null;
try {
await channel.subscribe({ clientId: 'someClientId' }, () => {});
} catch (error) {
thrownError = error;
}
expect(thrownError).not.to.be.null;
expect(thrownError.message).to.equal('MessageInteractions plugin not provided');
},
realtime,
);
});
});
describe('with MessageInteractions', () => {
/**
* Tests RTL22d, MFI2e but for a MessageInteractions plugin with modular BaseRealtime.
* @nospec
*/
it('can take a MessageFilter argument when subscribing to and unsubscribing from channel events', async function () {
const helper = this.test.helper;
const realtime = new BaseRealtime(
helper.ablyClientOptions({
plugins: {
WebSocketTransport,
FetchRequest,
MessageInteractions,
},
}),
);
await monitorConnectionThenCloseAndFinish(
helper,
async () => {
const channel = realtime.channels.get('channel');
await channel.attach();
// Test `subscribe` with a filter: send two messages with different clientIds, and check that unfiltered subscription receives both messages but clientId-filtered subscription only receives the matching one.
const messageFilter = { clientId: 'someClientId' }; // note that `unsubscribe` compares filter by reference, I found that a bit surprising
const filteredSubscriptionReceivedMessages = [];
channel.subscribe(messageFilter, (message) => {
filteredSubscriptionReceivedMessages.push(message);
});
const unfilteredSubscriptionReceivedFirstTwoMessagesPromise = new Promise((resolve) => {
const receivedMessages = [];
channel.subscribe(function listener(message) {
receivedMessages.push(message);
if (receivedMessages.length === 2) {
channel.unsubscribe(listener);
resolve();
}