@genesislcap/foundation-comms 15.83.0 → 15.84.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist/dts/connect/connect.d.ts +22 -10
  2. package/dist/dts/connect/connect.d.ts.map +1 -1
  3. package/dist/dts/connect/connect.errors.d.ts +120 -0
  4. package/dist/dts/connect/connect.errors.d.ts.map +1 -0
  5. package/dist/dts/connect/connect.types.d.ts +27 -0
  6. package/dist/dts/connect/connect.types.d.ts.map +1 -1
  7. package/dist/dts/connect/errorCodes.d.ts +6 -0
  8. package/dist/dts/connect/errorCodes.d.ts.map +1 -0
  9. package/dist/dts/connect/http.connect.d.ts +14 -5
  10. package/dist/dts/connect/http.connect.d.ts.map +1 -1
  11. package/dist/dts/connect/http.d.ts +1 -0
  12. package/dist/dts/connect/http.d.ts.map +1 -1
  13. package/dist/dts/connect/httpTransport.d.ts +12 -6
  14. package/dist/dts/connect/httpTransport.d.ts.map +1 -1
  15. package/dist/dts/connect/index.d.ts +1 -0
  16. package/dist/dts/connect/index.d.ts.map +1 -1
  17. package/dist/dts/connect/message.d.ts +18 -1
  18. package/dist/dts/connect/message.d.ts.map +1 -1
  19. package/dist/dts/connect/networkFailure.d.ts +7 -0
  20. package/dist/dts/connect/networkFailure.d.ts.map +1 -0
  21. package/dist/dts/connect/reconnectStrategy.d.ts +2 -1
  22. package/dist/dts/connect/reconnectStrategy.d.ts.map +1 -1
  23. package/dist/dts/connect/requestLifecycle.d.ts +23 -0
  24. package/dist/dts/connect/requestLifecycle.d.ts.map +1 -0
  25. package/dist/dts/connect/socket.d.ts +14 -3
  26. package/dist/dts/connect/socket.d.ts.map +1 -1
  27. package/dist/dts/connect/socket.types.d.ts +5 -0
  28. package/dist/dts/connect/socket.types.d.ts.map +1 -1
  29. package/dist/dts/utils/error-code.d.ts +2 -1
  30. package/dist/dts/utils/error-code.d.ts.map +1 -1
  31. package/dist/esm/connect/connect.errors.js +192 -0
  32. package/dist/esm/connect/connect.js +56 -28
  33. package/dist/esm/connect/errorCodes.js +20 -0
  34. package/dist/esm/connect/http.connect.js +166 -74
  35. package/dist/esm/connect/http.js +22 -9
  36. package/dist/esm/connect/httpTransport.js +35 -12
  37. package/dist/esm/connect/index.js +1 -0
  38. package/dist/esm/connect/message.js +6 -1
  39. package/dist/esm/connect/networkFailure.js +12 -0
  40. package/dist/esm/connect/reconnectStrategy.js +4 -3
  41. package/dist/esm/connect/requestLifecycle.js +96 -0
  42. package/dist/esm/connect/socket.js +57 -34
  43. package/dist/esm/utils/error-code.js +6 -2
  44. package/dist/foundation-comms.api.json +1572 -34
  45. package/dist/foundation-comms.d.ts +238 -24
  46. package/package.json +12 -12
@@ -11,10 +11,13 @@ import { MetaCache } from '../metadata';
11
11
  import { Session } from '../session';
12
12
  import { logger } from '../utils';
13
13
  import { withErrorCode } from '../utils/error-code';
14
+ import { ConnectNackError, ConnectTransportError } from './connect.errors';
14
15
  import { ConnectConfig } from './connect.types';
16
+ import { normaliseErrorCodes } from './errorCodes';
15
17
  import { Http } from './http';
16
18
  import { EventMessageType, MessageBuilder, MessageType, } from './message';
17
19
  import { exponentialScheduler, linearScheduler, MAX_RECONNECT_ATTEMPTS, retryInterval, SocketReconnectStrategy, } from './reconnectStrategy';
20
+ import { abortedBeforeSend, isRejectedNack, settleWithin } from './requestLifecycle';
18
21
  import { resourceNameOf, ScdbStreamDecoder } from './scdbStreamDecoder';
19
22
  import { onOtherTabReauthComplete, SessionRefreshResult, tryRefreshSession, waitForOtherTabReauth, } from './sessionRefresh';
20
23
  import { SocketStatus } from './socket.status';
@@ -175,12 +178,13 @@ let DefaultSocket = class DefaultSocket {
175
178
  var _a, _b, _c, _d;
176
179
  logger.info(`${this.isReconnecting ? 'Reconnecting' : 'Connecting'} to ${this.url}`);
177
180
  this.status.isConnecting = !this.isReconnecting;
181
+ this.rejectPendingRequests();
178
182
  const cleanMessages = !this.isReconnecting || !((_a = this.reconnectOptions) === null || _a === void 0 ? void 0 : _a.reconnectStreams);
179
183
  if (cleanMessages) {
180
184
  this.cleanMessages();
181
185
  }
182
186
  (_b = this.socketSubscription) === null || _b === void 0 ? void 0 : _b.unsubscribe();
183
- this.websocket = new WebSocketSubject({
187
+ const websocket = new WebSocketSubject({
184
188
  url: this.url,
185
189
  openObserver: {
186
190
  next: () => {
@@ -193,9 +197,16 @@ let DefaultSocket = class DefaultSocket {
193
197
  },
194
198
  closeObserver: {
195
199
  next: (closeEvent) => {
196
- this.status.onClose(closeEvent);
197
- if (this.isDisconnectedByServer) {
198
- logger.info(`WebSocket connection was closed due an error - Code: ${closeEvent.code} ${closeEvent.reason ? ' | Reason: ' + closeEvent.reason : ''}`);
200
+ // A replaced socket closes late; its close must not touch its successor's state.
201
+ if (this.websocket === websocket) {
202
+ this.status.onClose(closeEvent);
203
+ this.rejectPendingRequests(new ConnectTransportError('WebSocket connection closed before a reply arrived', {
204
+ closeCode: closeEvent === null || closeEvent === void 0 ? void 0 : closeEvent.code,
205
+ closeReason: closeEvent === null || closeEvent === void 0 ? void 0 : closeEvent.reason,
206
+ }));
207
+ if (this.isDisconnectedByServer) {
208
+ logger.info(`WebSocket connection was closed due an error - Code: ${closeEvent.code} ${closeEvent.reason ? ' | Reason: ' + closeEvent.reason : ''}`);
209
+ }
199
210
  }
200
211
  resolve(this.isConnected);
201
212
  },
@@ -203,8 +214,10 @@ let DefaultSocket = class DefaultSocket {
203
214
  serializer: (object) => this.serializer.serialize(object),
204
215
  deserializer: (event) => this.serializer.deserialize(event),
205
216
  });
217
+ this.websocket = websocket;
206
218
  const onNextMessage = (receivedMessage) => __awaiter(this, void 0, void 0, function* () {
207
219
  var _a;
220
+ normaliseErrorCodes(receivedMessage);
208
221
  const responseMessageReceivedLog = `Response Message received for SourceRef: ${receivedMessage.SOURCE_REF} | MessageType: ${receivedMessage.MESSAGE_TYPE}`;
209
222
  this.logMessageTypeFlow(receivedMessage.MESSAGE_TYPE, logger.info, responseMessageReceivedLog);
210
223
  const { SOURCE_REF, MESSAGE_TYPE } = receivedMessage;
@@ -217,7 +230,7 @@ let DefaultSocket = class DefaultSocket {
217
230
  }
218
231
  return;
219
232
  }
220
- let nacked = false;
233
+ const nacked = isRejectedNack(receivedMessage);
221
234
  switch (receivedMessage.MESSAGE_TYPE) {
222
235
  case EventMessageType.EVENT_LOGIN_AUTH_ACK: {
223
236
  this.applyServerHeartbeatInterval(receivedMessage.DETAILS);
@@ -241,11 +254,6 @@ let DefaultSocket = class DefaultSocket {
241
254
  }
242
255
  break;
243
256
  }
244
- case MessageType.MSG_NACK:
245
- case MessageType.LOGON_NACK: {
246
- nacked = true;
247
- break;
248
- }
249
257
  }
250
258
  // A binary payload lazily warms the WASM fast-path (covers per-datasource opt-ins too).
251
259
  if ((receivedMessage === null || receivedMessage === void 0 ? void 0 : receivedMessage.ENCODING) === 'SCDB_V1')
@@ -263,19 +271,13 @@ let DefaultSocket = class DefaultSocket {
263
271
  { CODE: 'SCDB_DECODE_FAILED', TEXT: String((_a = error === null || error === void 0 ? void 0 : error.message) !== null && _a !== void 0 ? _a : error) },
264
272
  ],
265
273
  };
266
- messageHandler.onReceivedError.call(this, {
267
- receivedMessage: nack,
268
- sentMessage: messageHandler.sentMessage,
269
- });
274
+ messageHandler.onReceivedError.call(this, new ConnectNackError(nack, messageHandler.sentMessage));
270
275
  this.removeMessageHandler(SOURCE_REF);
271
276
  this.wsMessages.next(nack);
272
277
  return;
273
278
  }
274
279
  if (nacked) {
275
- messageHandler.onReceivedError.call(this, {
276
- receivedMessage,
277
- sentMessage: messageHandler.sentMessage,
278
- });
280
+ messageHandler.onReceivedError.call(this, new ConnectNackError(receivedMessage, messageHandler.sentMessage));
279
281
  }
280
282
  else {
281
283
  messageHandler.onReceivedMessage.call(this, receivedMessage);
@@ -372,6 +374,7 @@ let DefaultSocket = class DefaultSocket {
372
374
  if (this.heartbeatTicker) {
373
375
  this.heartbeatTicker.stop();
374
376
  }
377
+ const intervalInMillisecocnds = (_b = (_a = this.connectOptions) === null || _a === void 0 ? void 0 : _a.heartbeatInterval) !== null && _b !== void 0 ? _b : this.heartbeatInterval;
375
378
  const sendHeartbeat = () => __awaiter(this, void 0, void 0, function* () {
376
379
  var _a, _b, _c;
377
380
  if (!this.isConnected)
@@ -380,11 +383,18 @@ let DefaultSocket = class DefaultSocket {
380
383
  if ((_b = this.connectOptions) === null || _b === void 0 ? void 0 : _b.heartbeatPingCallback) {
381
384
  this.connectOptions.heartbeatPingCallback(ping);
382
385
  }
383
- const pong = yield this.send(ping);
386
+ let pong;
387
+ try {
388
+ pong = yield this.send(ping, true, { timeout: intervalInMillisecocnds });
389
+ }
390
+ catch (error) {
391
+ logger.debug('Heartbeat ping got no pong: ', error);
392
+ return;
393
+ }
384
394
  // when heartbeat runs before user logs in (connected to websocket but
385
395
  // not authenticated) we don't extend session as it doesn't exist yet
386
396
  if (this.user.isAuthenticated && !pong.IS_AUTHENTICATED) {
387
- this.handleExpiredSession();
397
+ this.handleExpiredSession().catch((error) => logger.debug('Could not refresh the expired session: ', error));
388
398
  }
389
399
  if ((_c = this.connectOptions) === null || _c === void 0 ? void 0 : _c.heartbeatPongCallback) {
390
400
  this.connectOptions.heartbeatPongCallback(pong);
@@ -392,8 +402,7 @@ let DefaultSocket = class DefaultSocket {
392
402
  this.heartbeatIsEnabled =
393
403
  pong.MESSAGE_TYPE === MessageType.HEARTBEAT_PONG && pong.SOURCE_REF === ping.SOURCE_REF;
394
404
  });
395
- if ((_b = (_a = this.connectOptions) === null || _a === void 0 ? void 0 : _a.enableHeartbeat) !== null && _b !== void 0 ? _b : this.heartbeatIsEnabled) {
396
- const intervalInMillisecocnds = (_d = (_c = this.connectOptions) === null || _c === void 0 ? void 0 : _c.heartbeatInterval) !== null && _d !== void 0 ? _d : this.heartbeatInterval;
405
+ if ((_d = (_c = this.connectOptions) === null || _c === void 0 ? void 0 : _c.enableHeartbeat) !== null && _d !== void 0 ? _d : this.heartbeatIsEnabled) {
397
406
  this.heartbeatTicker = new Ticker(intervalInMillisecocnds);
398
407
  this.heartbeatTicker.start(() => {
399
408
  if (this.websocket && this.isConnected) {
@@ -486,34 +495,48 @@ let DefaultSocket = class DefaultSocket {
486
495
  this.cleanMessages();
487
496
  }
488
497
  cleanMessages() {
498
+ this.rejectPendingRequests();
489
499
  this.wsMessages && this.wsMessages.complete();
490
500
  this.wsMessages = new SocketSubject();
491
501
  this.wsMessageHandlers = new Map();
492
502
  this.scdbDecoder.clear();
493
503
  }
494
- send(message, needsHandling = true) {
504
+ // Stream handlers are kept: they are re-sent on reconnect.
505
+ rejectPendingRequests(error = new ConnectTransportError('WebSocket connection closed before a reply arrived')) {
506
+ var _a;
507
+ (_a = this.wsMessageHandlers) === null || _a === void 0 ? void 0 : _a.forEach((handler, sourceRef) => {
508
+ if (handler.isSubscription)
509
+ return;
510
+ this.wsMessageHandlers.delete(sourceRef);
511
+ handler.onReceivedError.call(this, error);
512
+ });
513
+ }
514
+ send(message, needsHandling = true, options) {
515
+ var _a, _b;
516
+ const aborted = abortedBeforeSend(options === null || options === void 0 ? void 0 : options.signal);
517
+ if (aborted) {
518
+ return aborted;
519
+ }
495
520
  if (!this.isConnected) {
496
- return Promise.reject(new Error('WebSocket connection is closed'));
521
+ return Promise.reject(new ConnectTransportError('WebSocket connection is closed'));
497
522
  }
498
523
  const sendingMessasgeLog = `Sending Message for SourceRef: ${message.SOURCE_REF} | MessageType: ${message.MESSAGE_TYPE}`;
499
524
  this.logMessageTypeFlow(message.MESSAGE_TYPE, logger.info, sendingMessasgeLog);
500
525
  this.scdbDecoder.prepareRequest(message);
501
- return new Promise((resolve, reject) => {
502
- const onMessage = (msg) => {
503
- resolve(msg);
504
- };
505
- const onError = (err) => {
506
- reject(err);
507
- };
526
+ const reply = new Promise((resolve, reject) => {
508
527
  if (needsHandling) {
509
- this.setMessageHandler(message, onMessage, onError);
528
+ this.setMessageHandler(message, resolve, reject);
510
529
  }
511
530
  this.websocket.next(message);
512
531
  });
532
+ if (!needsHandling) {
533
+ return reply;
534
+ }
535
+ return settleWithin(reply, { timeout: (_a = options === null || options === void 0 ? void 0 : options.timeout) !== null && _a !== void 0 ? _a : (_b = this.connectOptions) === null || _b === void 0 ? void 0 : _b.requestTimeout, signal: options === null || options === void 0 ? void 0 : options.signal }, () => this.removeMessageHandler(message.SOURCE_REF));
513
536
  }
514
537
  sendForStream(message, onMessage, onError, onComplete) {
515
538
  if (!this.isConnected) {
516
- return throwError(() => new Error('WebSocket connection is closed'));
539
+ return throwError(() => new ConnectTransportError('WebSocket connection is closed'));
517
540
  }
518
541
  const sendingMessageLog = `Sending Message (stream) for SourceRef: ${message.SOURCE_REF} | MessageType: ${message.MESSAGE_TYPE}`;
519
542
  this.logMessageTypeFlow(message.MESSAGE_TYPE, logger.info, sendingMessageLog);
@@ -553,7 +576,7 @@ let DefaultSocket = class DefaultSocket {
553
576
  }
554
577
  sendForStreamWithoutTeardown(message, onMessage, onError) {
555
578
  if (!this.isConnected) {
556
- return throwError(() => new Error('WebSocket connection is closed'));
579
+ return throwError(() => new ConnectTransportError('WebSocket connection is closed'));
557
580
  }
558
581
  const sendingMessageLog = `Sending Message (stream) for SourceRef: ${message.SOURCE_REF} | MessageType: ${message.MESSAGE_TYPE}`;
559
582
  this.logMessageTypeFlow(message.MESSAGE_TYPE, logger.info, sendingMessageLog);
@@ -1,5 +1,8 @@
1
1
  const errorCodeOf = (source) => {
2
- const errors = source === null || source === void 0 ? void 0 : source.ERROR;
2
+ var _a, _b;
3
+ const carrier = source;
4
+ const nack = (_b = (_a = carrier === null || carrier === void 0 ? void 0 : carrier.receivedMessage) !== null && _a !== void 0 ? _a : carrier === null || carrier === void 0 ? void 0 : carrier.body) !== null && _b !== void 0 ? _b : source;
5
+ const errors = nack === null || nack === void 0 ? void 0 : nack.ERROR;
3
6
  const entry = Array.isArray(errors) ? errors[0] : source;
4
7
  const code = entry === null || entry === void 0 ? void 0 : entry.CODE;
5
8
  return typeof code === 'string' || typeof code === 'number' ? String(code) : undefined;
@@ -10,7 +13,8 @@ const errorCodeOf = (source) => {
10
13
  * different failures apart without sending the NACK.
11
14
  *
12
15
  * @param message - The log message.
13
- * @param source - A NACK message, or one of its `ERROR` entries.
16
+ * @param source - A NACK message, one of its `ERROR` entries, or an error carrying the NACK as
17
+ * `receivedMessage` or `body`.
14
18
  * @internal
15
19
  */
16
20
  export const withErrorCode = (message, source) => {