-
Notifications
You must be signed in to change notification settings - Fork 15
/
Kuzzle.ts
1211 lines (1036 loc) · 31.6 KB
/
Kuzzle.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
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 {
KuzzleEventEmitter,
PrivateAndPublicSDKEvents,
PublicKuzzleEvents,
} from "./core/KuzzleEventEmitter";
import { KuzzleAbstractProtocol } from "./protocols/abstract/Base";
import { AuthController } from "./controllers/Auth";
import { BulkController } from "./controllers/Bulk";
import { CollectionController } from "./controllers/Collection";
import { DocumentController } from "./controllers/Document";
import { IndexController } from "./controllers/Index";
import { RealtimeController } from "./controllers/Realtime";
import { ServerController } from "./controllers/Server";
import { SecurityController } from "./controllers/Security";
import { MemoryStorageController } from "./controllers/MemoryStorage";
import { Deprecation } from "./utils/Deprecation";
import { uuidv4 } from "./utils/uuidv4";
import { proxify } from "./utils/proxify";
import { debug } from "./utils/debug";
import { BaseRequest, JSONObject, Notification } from "./types";
import { RequestPayload } from "./types/RequestPayload";
import { ResponsePayload } from "./types/ResponsePayload";
import { RequestTimeoutError } from "./RequestTimeoutError";
import { BaseProtocolRealtime } from "./protocols/abstract/Realtime";
import { KuzzleError } from "./KuzzleError";
import { DisconnectionOrigin } from "./protocols/DisconnectionOrigin";
// Defined by webpack plugin
declare const SDKVERSION: any;
export class Kuzzle extends KuzzleEventEmitter {
// We need to define any string key because users can register new controllers
[key: string]: any;
/**
* Protocol used by the SDK to communicate with Kuzzle.
*/
public protocol: any;
/**
* If true, automatically renews all subscriptions on a reconnected event.
*/
public autoResubscribe: boolean;
/**
* Timeout before sending again a similar event.
*/
public eventTimeout: number;
/**
* SDK version.
*/
public sdkVersion: string;
/**
* SDK name (e.g: `[email protected]`).
*/
public sdkName: string;
/**
* Common volatile data that will be sent to all future requests.
*/
public volatile: JSONObject;
/**
* Handle deprecation warning in development mode (hidden in production)
*/
public deprecationHandler: Deprecation;
/**
* Authenticator function called after a reconnection if the SDK is no longer
* authenticated.
*/
public authenticator: () => Promise<void> = null;
/**
* List of every events emitted by the SDK.
*/
public events: PublicKuzzleEvents[] = [
"callbackError",
"connected",
"discarded",
"disconnected",
"loginAttempt",
"beforeLogin",
"afterLogin",
"logoutAttempt",
"beforeLogout",
"afterLogout",
"networkError",
"offlineQueuePush",
"offlineQueuePop",
"queryError",
"reAuthenticated",
"reconnected",
"reconnectionError",
"tokenExpired",
];
public auth: AuthController;
public bulk: any;
public collection: CollectionController;
public document: DocumentController;
public index: IndexController;
public ms: any;
public realtime: RealtimeController;
public security: SecurityController;
public server: ServerController;
private _protectedEvents: any;
private _offlineQueue: any;
private _autoQueue: any;
private _autoReplay: any;
private _offlineQueueLoader: any;
private _queuing: boolean;
private _queueFilter: any;
private _queueMaxSize: any;
private _queueTTL: any;
private _replayInterval: any;
private _requestTimeout: number;
private _tokenExpiredInterval: any;
private _lastTokenExpired: any;
private _cookieAuthentication: boolean;
private _reconnectInProgress: boolean;
private _loggedIn: boolean;
private __proxy__: any;
/**
* Instantiate a new SDK
*
* @example
*
* import { Kuzzle, WebSocket } from 'kuzzle-sdk';
*
* const kuzzle = new Kuzzle(
* new WebSocket('localhost')
* );
*/
constructor(
/**
* Network protocol to connect to Kuzzle. (e.g. `Http` or `WebSocket`)
*/
protocol: KuzzleAbstractProtocol,
options: {
/**
* Automatically renew all subscriptions on a `reconnected` event
* Default: `true`
*/
autoResubscribe?: boolean;
/**
* Time (in ms) during which a similar event is ignored
* Default: `200`
*/
eventTimeout?: number;
/**
* Common volatile data, will be sent to all future requests
* Default: `{}`
*/
volatile?: JSONObject;
/**
* If `true`, automatically queues all requests during offline mode
* Default: `false`
*/
autoQueue?: boolean;
/**
* If `true`, automatically replays queued requests
* on a `reconnected` event
* Default: `false`
*/
autoReplay?: boolean;
/**
* Custom function called during offline mode to filter
* queued requests on-the-fly
*/
queueFilter?: (request: RequestPayload) => boolean;
/**
* Called before dequeuing requests after exiting offline mode,
* to add items at the beginning of the offline queue
*/
offlineQueueLoader?: (...any) => any;
/**
* Number of maximum requests kept during offline mode
* Default: `500`
*/
queueMaxSize?: number;
/**
* Time a queued request is kept during offline mode, in milliseconds
* Default: `120000`
*/
queueTTL?: number;
/**
* Delay between each replayed requests, in milliseconds
* Default: `10`
*/
replayInterval?: number;
/**
* Time (in ms) during which a request will still be waited to be resolved
* Set it to `-1` if you want to wait indefinitely.
* Default: `-1`
*/
requestTimeout?: number;
/**
* Time (in ms) during which a TokenExpired event is ignored
* Default: `1000`
*/
tokenExpiredInterval?: number;
/**
* If set to `auto`, the `autoQueue` and `autoReplay` are also set to `true`
*/
offlineMode?: "auto";
/**
* If `true` uses cookie to store token
* Only supported in a browser
* Default: `false`
*/
cookieAuth?: boolean;
/**
* Show deprecation warning in development mode (hidden either way in production)
* Default: `true`
*/
deprecationWarning?: boolean;
} = {}
) {
super();
if (protocol === undefined || protocol === null) {
throw new Error('"protocol" argument missing');
}
// check the existence of required methods
for (const method of ["addListener", "isReady", "query"]) {
if (typeof protocol[method] !== "function") {
throw new Error(
`Protocol instance must implement a "${method}" method`
);
}
}
this.protocol = protocol;
this._protectedEvents = {
afterLogin: {},
connected: {},
disconnected: {},
error: {},
loginAttempt: {},
reconnected: {},
tokenExpired: {},
};
this.autoResubscribe =
typeof options.autoResubscribe === "boolean"
? options.autoResubscribe
: true;
this.eventTimeout =
typeof options.eventTimeout === "number" ? options.eventTimeout : 200;
this.sdkVersion =
typeof SDKVERSION === "undefined"
? // eslint-disable-next-line @typescript-eslint/no-var-requires
require("../package").version
: SDKVERSION;
this.sdkName = `js@${this.sdkVersion}`;
this.volatile =
typeof options.volatile === "object" ? options.volatile : {};
this._cookieAuthentication =
typeof options.cookieAuth === "boolean" ? options.cookieAuth : false;
if (this._cookieAuthentication) {
this.protocol.enableCookieSupport();
let autoQueueState;
let autoReplayState;
let autoResbuscribeState;
this.protocol.addListener("websocketRenewalStart", () => {
autoQueueState = this.autoQueue;
autoReplayState = this.autoReplay;
autoResbuscribeState = this.autoResubscribe;
this.autoQueue = true;
this.autoReplay = true;
this.autoResubscribe = true;
});
this.protocol.addListener("websocketRenewalDone", () => {
this.autoQueue = autoQueueState;
this.autoReplay = autoReplayState;
this.autoResubscribe = autoResbuscribeState;
});
}
this.deprecationHandler = new Deprecation(
typeof options.deprecationWarning === "boolean"
? options.deprecationWarning
: true
);
if (this._cookieAuthentication && typeof XMLHttpRequest === "undefined") {
throw new Error(
"Support for cookie authentication with cookieAuth option is not supported outside a browser"
);
}
// controllers
this.useController(AuthController, "auth");
this.useController(BulkController, "bulk");
this.useController(CollectionController, "collection");
this.useController(DocumentController, "document");
this.useController(IndexController, "index");
this.useController(MemoryStorageController, "ms");
this.useController(RealtimeController, "realtime");
this.useController(SecurityController, "security");
this.useController(ServerController, "server");
// offline queue
this._offlineQueue = [];
this._autoQueue =
typeof options.autoQueue === "boolean" ? options.autoQueue : false;
this._autoReplay =
typeof options.autoReplay === "boolean" ? options.autoReplay : false;
this._offlineQueueLoader =
typeof options.offlineQueueLoader === "function"
? options.offlineQueueLoader
: null;
this._queueFilter =
typeof options.queueFilter === "function" ? options.queueFilter : null;
this._queueMaxSize =
typeof options.queueMaxSize === "number" ? options.queueMaxSize : 500;
this._queueTTL =
typeof options.queueTTL === "number" ? options.queueTTL : 120000;
this._replayInterval =
typeof options.replayInterval === "number" ? options.replayInterval : 10;
this._requestTimeout =
typeof options.requestTimeout === "number" ? options.requestTimeout : -1;
this._tokenExpiredInterval =
typeof options.tokenExpiredInterval === "number"
? options.tokenExpiredInterval
: 1000;
if (options.offlineMode === "auto") {
this._autoQueue = true;
this._autoReplay = true;
}
this._queuing = false;
this._lastTokenExpired = null;
this._reconnectInProgress = false;
this._loggedIn = false;
/**
* When successfuly logged in
*/
this.on("afterLogin", async (status) => {
if (status.success) {
this._loggedIn = true;
return;
}
/**
* In case of login failure we need to be sure that the stored token is still valid
*/
try {
this._loggedIn = await this.isAuthenticated();
} catch {
this._loggedIn = false;
}
});
/**
* When successfuly logged out
*/
this.on("afterLogout", (status) => {
if (status.success) {
this._loggedIn = false;
}
});
/**
* On connection we need to verify if the token is still valid to know if we are still "logged in"
*/
this.on("connected", async () => {
try {
this._loggedIn = await this.isAuthenticated();
} catch {
this._loggedIn = false;
}
});
return proxify(this, {
exposeApi: true,
name: "kuzzle",
seal: true,
}) as Kuzzle;
}
/**
* Returns `true` if the SDK holds a valid token
*/
get authenticated() {
return Boolean(
this.auth.authenticationToken && !this.auth.authenticationToken.expired
);
}
get autoQueue() {
return this._autoQueue;
}
set autoQueue(value) {
this._checkPropertyType("_autoQueue", "boolean", value);
this._autoQueue = value;
}
get autoReconnect() {
const protocol = this.protocol as BaseProtocolRealtime;
return protocol.autoReconnect;
}
set autoReconnect(value) {
this._checkPropertyType("autoReconnect", "boolean", value);
const protocol = this.protocol as BaseProtocolRealtime;
protocol.autoReconnect = value;
}
get autoReplay() {
return this._autoReplay;
}
set autoReplay(value) {
this._checkPropertyType("_autoReplay", "boolean", value);
this._autoReplay = value;
}
/**
* Returns `true` if the SDK is using the cookie authentication mode.
* (Web only)
*/
get cookieAuthentication() {
return this._cookieAuthentication;
}
/**
* Returns `true` if the SDK is currently connected to a Kuzzle server.
*/
get connected() {
return this.protocol.connected;
}
get host() {
return this.protocol.host;
}
get jwt() {
if (!this.auth.authenticationToken) {
return null;
}
return this.auth.authenticationToken.encodedJwt;
}
set jwt(encodedJwt) {
this.auth.authenticationToken = encodedJwt;
this._loggedIn = encodedJwt ? true : false;
}
get offlineQueue() {
return this._offlineQueue;
}
get offlineQueueLoader() {
return this._offlineQueueLoader;
}
set offlineQueueLoader(value) {
this._checkPropertyType("_offlineQueueLoader", "function", value);
this._offlineQueueLoader = value;
}
get port() {
return this.protocol.port;
}
get queueFilter() {
return this._queueFilter;
}
set queueFilter(value) {
this._checkPropertyType("_queueFilter", "function", value);
this._queueFilter = value;
}
get queueMaxSize() {
return this._queueMaxSize;
}
set queueMaxSize(value) {
this._checkPropertyType("_queueMaxSize", "number", value);
this._queueMaxSize = value;
}
get queueTTL() {
return this._queueTTL;
}
set queueTTL(value) {
this._checkPropertyType("_queueTTL", "number", value);
this._queueTTL = value;
}
get reconnectionDelay() {
const protocol = this.protocol as BaseProtocolRealtime;
return protocol.reconnectionDelay;
}
get replayInterval() {
return this._replayInterval;
}
set replayInterval(value) {
this._checkPropertyType("_replayInterval", "number", value);
this._replayInterval = value;
}
get requestTimeout() {
return this._requestTimeout;
}
set requestTimeout(value) {
this._checkPropertyType("_requestTimeout", "number", value);
this._requestTimeout = value;
}
get sslConnection() {
return this.protocol.sslConnection;
}
get tokenExpiredInterval() {
return this._tokenExpiredInterval;
}
set tokenExpiredInterval(value) {
this._checkPropertyType("_tokenExpiredInterval", "number", value);
this._tokenExpiredInterval = value;
}
/**
* Emit an event to all registered listeners
* An event cannot be emitted multiple times before a timeout has been reached.
*/
public emit(eventName: PrivateAndPublicSDKEvents, ...payload: unknown[]) {
const now = Date.now(),
protectedEvent = this._protectedEvents[eventName];
if (protectedEvent) {
if (
protectedEvent.lastEmitted &&
protectedEvent.lastEmitted > now - this.eventTimeout
) {
return false;
}
protectedEvent.lastEmitted = now;
}
return this._superEmit(eventName, ...payload);
}
private _superEmit(eventName, ...payload) {
return super.emit(eventName, ...payload);
}
on(
eventName: "connected" | "reconnected" | "reAuthenticated" | "tokenExpired",
listener: () => void
): this;
on(eventName: "beforeLogout", listener: () => void): this;
on(
eventName: "logoutAttempt" | "afterLogout",
listener: (status: { success: true }) => void
): this;
on(eventName: "beforeLogin", listener: () => void): this;
on(
eventName: "loginAttempt" | "afterLogin",
listener: (data: { success: boolean; error: string }) => void
): this;
on(eventName: "discarded", listener: (request: RequestPayload) => void): this;
on(
eventName: "disconnected",
listener: (context: { origin: DisconnectionOrigin }) => void
): this;
on(
eventName: "networkError" | "reconnectionError",
listener: (error: Error) => void
): this;
on(
eventName: "offlineQueuePop",
listener: (request: RequestPayload) => void
): this;
on(
eventName: "offlineQueuePush",
listener: (data: { request: RequestPayload }) => void
): this;
on(
eventName: "queryError",
listener: (data: { error: KuzzleError; request: RequestPayload }) => void
): this;
on(
eventName: "callbackError",
listener: (data: { error: KuzzleError; notification: Notification }) => void
): this;
on(eventName: PublicKuzzleEvents, listener: (args: any) => void): this {
return super.on(eventName, listener);
}
/**
* Connects to a Kuzzle instance
*/
connect(): Promise<void> {
if (this.protocol.isReady()) {
return Promise.resolve();
}
if (this.autoQueue) {
this.startQueuing();
}
this.protocol.addListener("queryError", ({ error, request }) => {
this.emit("queryError", { error, request });
});
this.protocol.addListener("tokenExpired", () => this.tokenExpired());
this.protocol.addListener("connect", () => {
if (this.autoQueue) {
this.stopQueuing();
}
if (this.autoReplay) {
this.playQueue();
}
this.emit("connected");
});
this.protocol.addListener("networkError", (error) => {
if (this.autoQueue) {
this.startQueuing();
}
this.emit("networkError", error);
});
this.protocol.addListener("disconnect", (context) => {
this.emit("disconnected", context);
});
this.protocol.addListener("reconnect", this._reconnect.bind(this));
this.protocol.addListener("discarded", (data) =>
this.emit("discarded", data)
);
this.protocol.addListener("websocketRenewalStart", () => {
this._reconnectInProgress = true;
});
this.protocol.addListener("websocketRenewalDone", () => {
this._reconnectInProgress = false;
});
return this.protocol.connect();
}
/**
* Set this client to use a specific API key.
*
* After doing this you don't need to use login as it bypasses the authentication process.
*/
public setAPIKey(apiKey: string) {
if (apiKey.match(/^kapikey-/) === null) {
throw new Error("Invalid API key. Missing the `kapikey-` prefix.");
}
this.jwt = apiKey;
}
async _reconnect() {
if (this._reconnectInProgress) {
return;
}
if (this.autoQueue) {
this.stopQueuing();
}
// If an authenticator was set, check if a user was logged in and if the token is still valid and try
// to re-authenticate if needed. Otherwise the SDK is in disconnected state.
if (this._loggedIn && !(await this.tryReAuthenticate())) {
this._loggedIn = false;
this.disconnect();
return;
}
if (this.autoReplay) {
this.playQueue();
}
this.emit("reconnected");
}
/**
* Try to re-authenticate the SDK if the current token is invalid.
*
* If the token is invalid, this method will return false and emit a
* "reconnectionError" event when:
* - the SDK cannot re-authenticate using the authenticator function
* - the authenticator function is not set
*
* This method never returns a rejected promise.
*/
private async tryReAuthenticate(): Promise<boolean> {
this._reconnectInProgress = true;
try {
const valid = await this.isAuthenticated();
if (valid) {
return true;
}
/**
* Check if there is an authenticator after verifying if the token is still valid,
* like so API Keys can be used even if there is no authenticator since they will be still valid.
*/
if (!this.authenticator) {
this.emit("reconnectionError", {
error: new Error(
'Could not re-authenticate: "authenticator" property is not set.'
),
});
return false;
}
await this.authenticate();
return true;
} catch (err) {
this.emit("reconnectionError", {
error: new Error(
`Failed to authenticate the SDK after reconnection: ${err}`
),
});
return false;
} finally {
this._reconnectInProgress = false;
}
}
/**
* Use the "authenticator" function to authenticate the SDK.
*
* @returns The authentication token
*/
async authenticate(): Promise<void> {
if (typeof this.authenticator !== "function") {
throw new Error('The "authenticator" property must be a function.');
}
await this.authenticator();
const valid = await this.isAuthenticated();
this._loggedIn = valid;
if (!valid) {
throw new Error(
'The "authenticator" function failed to authenticate the SDK.'
);
}
}
/**
* Check wether the user is authenticated or not
* by verifiying if a token is present and still valid
* and if the token doesn't belong to the anonymous user.
*/
async isAuthenticated() {
const { valid, kuid } = await this.auth.checkToken();
return valid && kuid !== "-1";
}
/**
* Adds a listener to a Kuzzle global event. When an event is fired, listeners are called in the order of their
* insertion.
*
* @param {string} event - name of the global event to subscribe to
* @param {function} listener - callback to invoke each time an event is fired
*/
addListener(event, listener) {
if (this.events.indexOf(event) === -1) {
throw new Error(
`[${event}] is not a known event. Known events: ${this.events.join(
", "
)}`
);
}
return this._superAddListener(event, listener);
}
private _superAddListener(event, listener) {
return super.addListener(event, listener);
}
/**
* Empties the offline queue without replaying it.
*
* @returns {Kuzzle}
*/
flushQueue() {
this._offlineQueue = [];
return this;
}
/**
* Disconnects from Kuzzle and invalidate this instance.
*/
disconnect() {
this._loggedIn = false;
this.protocol.close();
}
/**
* This is a low-level method, exposed to allow advanced SDK users to bypass
* high-level methods.
* Base method used to send read queries to Kuzzle
*
* Takes an optional argument object with the following properties:
* - volatile (object, default: null):
* Additional information passed to notifications to other users
*
* @param req
* @param opts - Optional arguments
*/
query<TRequest extends BaseRequest = BaseRequest, TResult = JSONObject>(
req: TRequest,
opts: JSONObject = {}
): Promise<ResponsePayload<TResult>> {
if (typeof req !== "object" || Array.isArray(req)) {
throw new Error(`Kuzzle.query: Invalid request: ${JSON.stringify(req)}`);
}
if (typeof opts !== "object" || Array.isArray(opts)) {
throw new Error(
`Kuzzle.query: Invalid "options" argument: ${JSON.stringify(opts)}`
);
}
const request = JSON.parse(JSON.stringify(req));
const options = JSON.parse(JSON.stringify(opts));
if (!request.requestId) {
request.requestId = uuidv4();
}
let queuable = true;
if (options && options.queuable === false) {
queuable = false;
}
if (this.queueFilter) {
queuable = queuable && this.queueFilter(request);
}
const requestTimeout =
typeof options.timeout === "number"
? options.timeout
: this._requestTimeout;
for (const [key, value] of Object.entries(options)) {
// Ignore common SDK option
if (["queuable", "timeout"].includes(key)) {
continue;
}
request[key] = value;
}
if (request.refresh === undefined && options.refresh !== undefined) {
request.refresh = options.refresh;
}
if (
request.retryOnConflict === undefined &&
options.retryOnConflict !== undefined
) {
request.retryOnConflict = options.retryOnConflict;
}
if (!request.volatile) {
request.volatile = this.volatile;
} else if (
typeof request.volatile !== "object" ||
Array.isArray(request.volatile)
) {
throw new Error(
`Kuzzle.query: Invalid volatile argument received: ${JSON.stringify(
request.volatile
)}`
);
}
for (const item of Object.keys(this.volatile)) {
if (request.volatile[item] === undefined) {
request.volatile[item] = this.volatile[item];
}
}
request.volatile.sdkInstanceId =
request.volatile.sdkInstanceId || this.protocol.id;
request.volatile.sdkName = request.volatile.sdkName || this.sdkName;
this.auth.authenticateRequest(request);
if (this._queuing) {
if (queuable) {
this._cleanQueue();
this.emit("offlineQueuePush", { request });
return new Promise((resolve, reject) => {
this.offlineQueue.push({
reject,
request,
resolve,
timeout: requestTimeout,
ts: Date.now(),
});
});
}
this.emit("discarded", { request });
return Promise.reject(
new Error(`Unable to execute request: not connected to a Kuzzle server.
Discarded request: ${JSON.stringify(request)}`)
);
}
return this._timeoutRequest(requestTimeout, request, options).then(
(response: ResponsePayload<TResult>) => {
debug("RESPONSE", response);
return this.deprecationHandler.logDeprecation(response);
}
);
}
/**
* Starts the requests queuing.
*/
startQueuing() {
this._queuing = true;
return this;
}
/**
* Stops the requests queuing.
*/
stopQueuing() {
this._queuing = false;
return this;
}
/**
* Plays the requests queued during offline mode.
*/
playQueue() {
if (this.protocol.isReady()) {
this._cleanQueue();
this._dequeue();
}
return this;
}
/**
* On token expiration, reset jwt and unsubscribe all rooms.
* Throttles to avoid duplicate event triggers.
*/
async tokenExpired() {
if (this._reconnectInProgress) {
return;
}