@genesislcap/foundation-comms 14.306.1 → 14.306.2-alpha-9324131.0

package/dist/esm/connect/socket.js

@@ -1,7 +1,5 @@
-var DefaultSocket_1;
 import { __awaiter, __decorate, __param } from "tslib";
 import { User } from '@genesislcap/foundation-user';
-import { LOGIN_DETAILS_URL, LOGIN_URL } from '@genesislcap/foundation-utils';
 import { GENESIS_SOCKET_URL, JSONSerializer, UUID } from '@genesislcap/foundation-utils';
 import { DOM, observable } from '@microsoft/fast-element';
 import { DI } from '@microsoft/fast-foundation';
@@ -85,7 +83,7 @@ export class SocketMessageHandler {
  * Default Socket implementation.
  * @public
  */
-let DefaultSocket = DefaultSocket_1 = class DefaultSocket {
+let DefaultSocket = class DefaultSocket {
     get isConfigured() {
         return this.status.isConfigured;
     }
@@ -203,6 +201,14 @@ let DefaultSocket = DefaultSocket_1 = class DefaultSocket {
                 switch (receivedMessage.MESSAGE_TYPE) {
                     case EventMessageType.EVENT_LOGIN_AUTH_ACK: {
                         const systemDetails = receivedMessage.DETAILS;
+                        const MINUTES_TO_MILLISECONDS = 60 * 1000;
+                        const timeoutMs = systemDetails.SESSION_TIMEOUT_MINS * MINUTES_TO_MILLISECONDS;
+                        setTimeout(() => {
+                            var _a;
+                            const heartbeatPing = this.messageBuilder.createHeartbeatPingMessage((_a = this.connectOptions) === null || _a === void 0 ? void 0 : _a.verboseHeartbeat);
+                            this.websocket.next(heartbeatPing);
+                            logger.info(`Heartbeat ping sent after session timeout (${systemDetails.SESSION_TIMEOUT_MINS} mins)`);
+                        }, timeoutMs);
                         // Reconfigures the heartbeat with system details from the login response
                         if (systemDetails.HEARTBEAT_INTERVAL_SECS &&
                             ((_a = this.connectOptions) === null || _a === void 0 ? void 0 : _a.heartbeatInterval) === undefined) {
@@ -268,85 +274,14 @@ let DefaultSocket = DefaultSocket_1 = class DefaultSocket {
             this.status.isConfigured = true;
         });
     }
-    /**
-     *
-     * @remarks
-     * This is triggered after `sessionTimeoutMins` elapses and heartbeat would tell us that user is no longer authenticated
-     * more info here https://docs.genesis.global/docs/develop/server-capabilities/access-control/authentication/#sessiontimeoutmins
-     */
-    handleExpiredSession() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // to detect which auth method is used we check if refreshToken is present in session storage
-            // it would not be available in cookies method as it's securely stored within cookie
-            // and not accessible from the client
-            if (this.session.getSessionStorageItem('refreshToken')) {
-                const refreshTokenMessage = this.messageBuilder.createRefreshTokenMessage();
-                const refreshTokenResult = yield this.send(refreshTokenMessage);
-                this.session.setAuthResult(refreshTokenResult);
-                this.updateSessionAndSubscriptions(refreshTokenResult);
-            }
-            else {
-                yield this.handleCookieBasedReauth();
-            }
-        });
-    }
-    handleCookieBasedReauth() {
-        return __awaiter(this, void 0, void 0, function* () {
-            // checking for stale locks, so we don't block reauth forever
-            const lockTimestamp = parseInt(localStorage.getItem(DefaultSocket_1.REAUTH_ACTION_LOCK_KEY) || '0');
-            const LOCK_TIMEOUT_MS = 30000;
-            if (Date.now() - lockTimestamp > LOCK_TIMEOUT_MS) {
-                localStorage.removeItem(DefaultSocket_1.REAUTH_ACTION_LOCK_KEY);
-            }
-            // this is to prevent multiple tabs from trying to reauthenticate at the same time
-            if (!localStorage.getItem(DefaultSocket_1.REAUTH_ACTION_LOCK_KEY)) {
-                localStorage.setItem(DefaultSocket_1.REAUTH_ACTION_LOCK_KEY, Date.now().toString());
-                // session might already be extended on another tab, so we first check if user is
-                // authenticated and if it is we just reconnect as cookies are shared between tabs and
-                // the browser uses latest one when establishing connection with ws
-                const loginDetailsFetch = yield fetch(LOGIN_DETAILS_URL, { credentials: 'include' });
-                const loginDetails = yield loginDetailsFetch.json();
-                if (loginDetails.MESSAGE_TYPE !== 'EVENT_LOGIN_DETAILS_ACK') {
-                    const refreshLoginResponse = yield fetch(LOGIN_URL, {
-                        credentials: 'include',
-                        headers: { 'Content-type': 'application/json; charset=UTF-8' },
-                        method: 'POST',
-                        body: JSON.stringify({
-                            DETAILS: {},
-                            MESSAGE_TYPE: 'EVENT_LOGIN_AUTH',
-                        }),
-                    });
-                    // if the refresh login is not successful we need to reload the page to get back to the login page
-                    if (!refreshLoginResponse.ok) {
-                        window.location.reload();
-                    }
-                }
-                localStorage.removeItem(DefaultSocket_1.REAUTH_ACTION_LOCK_KEY);
-                // connect again to a new stream to use new session token from obtained cookie
-                yield this.connect();
-            }
-            else {
-                // session is already being reauthenticated on another tab so we just wait when it finishes and reconnect
-                window.addEventListener('storage', this.onStorageEvent.bind(this));
+    updateSessionAndSubscriptions(refreshTokenResult) {
+        this.wsMessageHandlers.forEach((mh) => {
+            if (mh.isSubscription) {
+                mh.sentMessage.SESSION_AUTH_TOKEN = refreshTokenResult;
+                this.websocket.next(mh.sentMessage);
             }
         });
     }
-    onStorageEvent(event) {
-        if (event.key === DefaultSocket_1.REAUTH_ACTION_LOCK_KEY && event.newValue === null) {
-            this.connect();
-            window.removeEventListener('storage', this.onStorageEvent);
-        }
-    }
-    updateSessionAndSubscriptions(refreshTokenResult) {
-        if ((refreshTokenResult === null || refreshTokenResult === void 0 ? void 0 : refreshTokenResult.MESSAGE_TYPE) === EventMessageType.EVENT_LOGIN_AUTH_ACK) {
-            this.wsMessageHandlers.forEach((mh) => {
-                if (mh.isSubscription) {
-                    mh.sentMessage.SESSION_AUTH_TOKEN = refreshTokenResult.SESSION_AUTH_TOKEN;
-                    this.websocket.next(mh.sentMessage);
-                }
-            });
-        }
-    }
     prepareHeartbeat() {
         var _a, _b, _c, _d;
         if (this.heartbeatTicker) {
@@ -361,11 +296,6 @@ let DefaultSocket = DefaultSocket_1 = class DefaultSocket {
                 this.connectOptions.heartbeatPingCallback(ping);
             }
             const pong = yield this.send(ping);
-            // when heartbeat runs before user logs in (connected to websocket but
-            // not authenticated) we don't extend session as it doesn't exist yet
-            if (this.user.isAuthenticated && !pong.IS_AUTHENTICATED) {
-                this.handleExpiredSession();
-            }
             if ((_c = this.connectOptions) === null || _c === void 0 ? void 0 : _c.heartbeatPongCallback) {
                 this.connectOptions.heartbeatPongCallback(pong);
             }
@@ -552,7 +482,6 @@ let DefaultSocket = DefaultSocket_1 = class DefaultSocket {
         }
     }
 };
-DefaultSocket.REAUTH_ACTION_LOCK_KEY = 'reauthActionLock';
 __decorate([
     observable
 ], DefaultSocket.prototype, "websocket", void 0);
@@ -568,7 +497,7 @@ __decorate([
 __decorate([
     observable
 ], DefaultSocket.prototype, "heartbeatIsEnabled", void 0);
-DefaultSocket = DefaultSocket_1 = __decorate([
+DefaultSocket = __decorate([
     __param(0, MessageBuilder),
     __param(1, Session),
     __param(2, JSONSerializer),

package/dist/esm/testing/mocks/connect/connect.js

@@ -1,5 +1,5 @@
 import { __awaiter } from "tslib";
-import { from } from 'rxjs';
+import { BehaviorSubject, from } from 'rxjs';
 /**
  * @internal
  */
@@ -7,6 +7,7 @@ export class ConnectMock {
     constructor() {
         this.isConnected = true;
         this.isWorking = false;
+        this.sessionExpired$ = new BehaviorSubject(false);
     }
     get host() {
         return this.socket.host;

package/dist/esm/testing/mocks/connect/socket.js

@@ -8,6 +8,7 @@ export class SocketMock {
         this.isConnectedSubject = new BehaviorSubject(true);
         this.host = 'mock-host';
         this.socketMessagesSubject = new SocketSubject();
+        this.sessionExpiredSubject = new SocketSubject();
     }
     connect(host, options, reconnectOptions) {
         this.host = host;
@@ -26,7 +27,13 @@ export class SocketMock {
     socketMessages() {
         return this.socketMessagesSubject;
     }
+    sessionExpired() {
+        return this.sessionExpiredSubject;
+    }
+    updateSessionAndSubscriptions(refreshToken) {
+        // mock: do nothing
+    }
     reset() {
-        throw new Error('Method not implemented.');
+        // mock: do nothing
     }
 }

package/dist/foundation-comms.api.json

@@ -2108,6 +2108,38 @@
               ],
               "name": "request"
             },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Connect#sessionExpired$:member",
+              "docComment": "/**\n * Emits true when the session is detected as expired (e.g., IS_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly sessionExpired$?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Subject",
+                  "canonicalReference": "rxjs!Subject:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<boolean>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "sessionExpired$",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!Connect#snapshot:member(1)",
@@ -10935,6 +10967,15 @@
                   "text": "User",
                   "canonicalReference": "@genesislcap/foundation-user!User:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", socket: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Socket",
+                  "canonicalReference": "@genesislcap/foundation-comms!Socket:interface"
+                },
                 {
                   "kind": "Content",
                   "text": ");"
@@ -10983,6 +11024,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "socket",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 12
+                  },
+                  "isOptional": false
                 }
               ]
             },
@@ -11251,6 +11300,36 @@
               "isAbstract": false,
               "name": "logout"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultAuth.REAUTH_ACTION_LOCK_KEY:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "static REAUTH_ACTION_LOCK_KEY: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "REAUTH_ACTION_LOCK_KEY",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": true,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultAuth#reAuthFromSession:member(1)",
@@ -11370,6 +11449,15 @@
                   "text": "ConnectConfig",
                   "canonicalReference": "@genesislcap/foundation-comms!ConnectConfig:interface"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", user: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "User",
+                  "canonicalReference": "@genesislcap/foundation-user!User:interface"
+                },
                 {
                   "kind": "Content",
                   "text": ");"
@@ -11418,6 +11506,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "user",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 12
+                  },
+                  "isOptional": false
                 }
               ]
             },
@@ -12362,6 +12458,41 @@
               "isAbstract": false,
               "name": "send"
             },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#sessionExpired$:member",
+              "docComment": "/**\n * Emits true when the session is detected as expired (e.g., IS_AUTHENTICATED is false in heartbeat pong). Consumers can subscribe to this to react to session expiration events.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "readonly sessionExpired$: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "BehaviorSubject",
+                  "canonicalReference": "rxjs!BehaviorSubject:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<boolean>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": true,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "sessionExpired$",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              },
+              "isStatic": false,
+              "isProtected": false,
+              "isAbstract": false
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#setValidSession:member(1)",
@@ -12865,6 +12996,37 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "streamWithoutAutoTeardown"
+            },
+            {
+              "kind": "Property",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnect#user:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "protected user: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "User",
+                  "canonicalReference": "@genesislcap/foundation-user!User:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": false,
+              "releaseTag": "Public",
+              "name": "user",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isStatic": false,
+              "isProtected": true,
+              "isAbstract": false
             }
           ],
           "implementsTokenRanges": [
@@ -23080,6 +23242,54 @@
               "isProtected": false,
               "isAbstract": false
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultSocket#updateSessionAndSubscriptions:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateSessionAndSubscriptions(refreshTokenResult: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "refreshTokenResult",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "updateSessionAndSubscriptions"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultSocket#user:member",
@@ -29259,7 +29469,7 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "{\n        DAYS_TO_PASSWORD_EXPIRY: number;\n        FAILED_LOGIN_ATTEMPTS: number;\n        HEARTBEAT_INTERVAL_SECS: number;\n        LAST_LOGIN_DATETIME: number;\n        NOTIFY_EXPIRY?: boolean;\n        PRODUCT?: any[];\n        SYSTEM?: any;\n    }"
+                  "text": "{\n        DAYS_TO_PASSWORD_EXPIRY: number;\n        FAILED_LOGIN_ATTEMPTS: number;\n        HEARTBEAT_INTERVAL_SECS: number;\n        LAST_LOGIN_DATETIME: number;\n        NOTIFY_EXPIRY?: boolean;\n        PRODUCT?: any[];\n        SYSTEM?: any;\n        SESSION_TIMEOUT_MINS?: number;\n    }"
                 },
                 {
                   "kind": "Content",
@@ -31577,7 +31787,7 @@
             },
             {
               "kind": "Content",
-              "text": "[];\n    SOURCE_REF: string;\n    MORE_ROWS: boolean;\n    ROWS_COUNT: number;\n    SEQUENCE_ID: number;\n}"
+              "text": "[];\n    SOURCE_REF: string;\n    MORE_ROWS: boolean;\n    ROWS_COUNT: number;\n    SEQUENCE_ID: number;\n    LOGGED_OUT: boolean;\n}"
             },
             {
               "kind": "Content",
@@ -34025,6 +34235,51 @@
               "overloadIndex": 1,
               "parameters": [],
               "name": "socketMessages"
+            },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!Socket#updateSessionAndSubscriptions:member(1)",
+              "docComment": "/**\n * Updates the session and subscriptions with the new session token.\n *\n * @param refreshTokenResult - The refresh token result.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateSessionAndSubscriptions(refreshToken: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 3,
+                "endIndex": 4
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "refreshToken",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "updateSessionAndSubscriptions"
             }
           ],
           "extendsTokenRanges": [