@genesislcap/foundation-comms 14.176.1-alpha-ed9e3d4.0 → 14.177.1

package/dist/esm/networkMonitor/service.js

@@ -1,15 +1,16 @@
 var _a;
 import { __awaiter, __decorate } from "tslib";
 import { createLogger, LogLevel } from '@genesislcap/foundation-logger';
+import { User } from '@genesislcap/foundation-user';
 import { formatDateTimeTimestamp, resolveAfter } from '@genesislcap/foundation-utils';
 import { observable } from '@microsoft/fast-element';
 import { DI } from '@microsoft/fast-foundation';
 import Bowser from 'bowser';
+import safeStringify from 'fast-safe-stringify';
 import { StatusCodes } from 'http-status-codes';
 import { ConnectEvents } from '../connect/connect.events';
 import { messageHasErrorCode, MessageType } from '../connect/message';
 import { SocketStatus } from '../connect/socket.status';
-import { User } from '../user/user';
 import { NetworkMonitorConfig } from './config';
 import { SystemHealthChanged, } from './types';
 /**
@@ -26,6 +27,21 @@ const firstUpdated = Date.now();
 const browserInformation = ((_a = window.navigator) === null || _a === void 0 ? void 0 : _a.userAgent)
     ? Bowser.parse(window.navigator.userAgent)
     : undefined;
+/**
+ * @internal
+ */
+const safeStringifyValue = (value, options = {
+    depthLimit: 10,
+    edgesLimit: 10,
+}) => {
+    if (value instanceof Event) {
+        return `'${value.type}' Event`;
+    }
+    if (typeof value === 'string') {
+        return value;
+    }
+    return safeStringify(value, undefined, 2, options);
+};
 /**
  * Default NetworkMonitor implementation.
  * @public
@@ -41,12 +57,12 @@ export class DefaultNetworkMonitor {
          */
         this.runAllChecks = (source, force) => __awaiter(this, void 0, void 0, function* () {
             /**
-             * Abort if checks are already running and the call is not forced
+             * Abort when not ready, or when checks are already running and the call was not forced
              */
-            if (this.isRunningChecks && !force) {
+            if (!this.isReady || (this.isRunningChecks && !force)) {
                 return;
             }
-            networkLogger.info(`Run health checks, triggered by`, source, `| Active resources`, this.resources.size);
+            networkLogger.info(`Run health checks, triggered by`, safeStringifyValue(source), `| Active resources`, this.resources.size);
             this.isRunningChecks = true;
             /**
              * Synchronise check interval given this has multiple non-automated triggers
@@ -54,9 +70,19 @@ export class DefaultNetworkMonitor {
             this.synchroniseCheckInterval();
             let formattedTimestamp = this.getFormattedTimestamp(this.getNowTimestamp());
             const isOnline = yield this.isOnlineCheck();
-            if (!isOnline) {
+            if (isOnline) {
+                networkLogger.debug(`Network connected at ${formattedTimestamp}`);
+            }
+            else {
                 networkLogger.warn(`Network disconnected at ${formattedTimestamp}`);
-                const socket = this.normaliseSerializedSocketStatus(this.socketStatus.serialize(), false);
+            }
+            const socket = this.normaliseSerializedSocketStatus(this.socketStatus.serialize(), isOnline);
+            const passedPreFlightSocketChecks = this.preFlightSocketChecks(socket);
+            if (!passedPreFlightSocketChecks) {
+                networkLogger.debug(`Socket pre-flight checks failed`);
+            }
+            if (!isOnline || !passedPreFlightSocketChecks) {
+                networkLogger.debug(`Aborting remaining health checks`);
                 const resources = [...this.resources].reduce((output, [_, metadata]) => {
                     const existingEntry = output[metadata.resourceName];
                     if (existingEntry) {
@@ -66,13 +92,13 @@ export class DefaultNetworkMonitor {
                     return Object.assign(Object.assign({}, output), { [metadata.resourceName]: this.normaliseResourceHealth({
                             name: metadata.resourceName,
                             sourceRef: [metadata.message.SOURCE_REF],
-                            isConnected: false,
-                            lastUpdated: undefined,
-                        }, false) });
+                            isConnected: metadata.isConnected,
+                            lastUpdated: metadata.lastUpdated,
+                        }, isOnline) });
                 }, {});
                 this.reportSystemHealth({
-                    isAuthenticated: socket.hasValidSession,
-                    isOnline: false,
+                    isAuthenticated: this.user.isAuthenticated,
+                    isOnline,
                     resources,
                     resourcesAllConnected: false,
                     socket,
@@ -80,13 +106,6 @@ export class DefaultNetworkMonitor {
                 this.isRunningChecks = false;
                 return;
             }
-            networkLogger.debug(`Network connected at ${formattedTimestamp}`);
-            const socket = this.normaliseSerializedSocketStatus(this.socketStatus.serialize());
-            if (socket.isConnecting) {
-                networkLogger.debug(`Aborting remaining health checks as socket is still connecting`);
-                this.isRunningChecks = false;
-                return;
-            }
             let resourcesAllConnected = true;
             const allChecks = [];
             this.resources.forEach((meta, resource) => {
@@ -136,11 +155,17 @@ export class DefaultNetworkMonitor {
                     else {
                         networkLogger.warn(`${name} is not healthy at ${formattedTimestamp}`);
                     }
+                    if (lastMessage) {
+                        networkLogger.debug(`${name} messaged at ${formattedTimestamp}`, safeStringifyValue(lastMessage));
+                    }
                     if (lastError) {
-                        networkLogger.error(`${name} errored at ${formattedTimestamp}`, lastError);
+                        networkLogger.error(`${name} errored at ${formattedTimestamp}`, safeStringifyValue(lastError));
+                    }
+                    if (timeout) {
+                        networkLogger.warn(`${name} timed out at ${formattedTimestamp}`);
                     }
                     if (attemptDataLogon) {
-                        networkLogger.error(`${name} timed out at ${formattedTimestamp}. Re-attempting data logon.`);
+                        networkLogger.error(`${name} issue, re-attempting data logon at ${formattedTimestamp}`);
                         resourceDataLogon(meta);
                     }
                     /**
@@ -175,8 +200,9 @@ export class DefaultNetworkMonitor {
                 networkLogger.warn(`Unexpected promise rejection occurred. Please check any custom resourceChecks return MonitoredResourceChecksResult.`);
                 return prev;
             }, {});
+            networkLogger.debug('Health checks complete');
             this.reportSystemHealth({
-                isAuthenticated: socket.hasValidSession,
+                isAuthenticated: this.user.isAuthenticated,
                 isOnline,
                 resources,
                 resourcesAllConnected,
@@ -184,6 +210,12 @@ export class DefaultNetworkMonitor {
             });
             this.isRunningChecks = false;
         });
+        /**
+         * Apply log level from config if set
+         */
+        if (this.config.logLevel !== undefined) {
+            networkLogger.level = this.config.logLevel;
+        }
     }
     /**
      * {@inheritDoc NetworkMonitor.create}
@@ -195,11 +227,11 @@ export class DefaultNetworkMonitor {
         }
         this.addListeners();
         this.resources = new Map();
-        this.synchroniseCheckInterval();
-        /**
-         * Report system health on creation to populate initial status data.
-         */
-        this.runAllChecks('network monitor create');
+        setTimeout(() => {
+            this.isReady = true;
+            this.synchroniseCheckInterval();
+            this.runAllChecks(`NetworkMonitor.create()`);
+        }, this.config.startDelay);
     }
     /**
      * {@inheritDoc NetworkMonitor.destroy}
@@ -210,6 +242,7 @@ export class DefaultNetworkMonitor {
         this.resources.clear();
         this.resources = undefined;
         this.status = undefined;
+        this.isReady = undefined;
     }
     /**
      * @internal
@@ -242,17 +275,29 @@ export class DefaultNetworkMonitor {
         if (this.config.genesisConnectEvents.includes('stream')) {
             this.unsubscribableObservers.push(this.connectEvents.addStreamListener(({ detail }) => {
                 const { functions, message, resourceName, stream } = detail;
+                if (this.config.ignoredGenesisResources.includes(resourceName)) {
+                    return;
+                }
                 this.addResource(stream, {
                     functions,
                     message,
                     resourceName,
                 });
             }, ({ detail }) => {
-                this.removeResource(detail);
+                const { resourceName, stream } = detail;
+                if (this.config.ignoredGenesisResources.includes(resourceName)) {
+                    return;
+                }
+                this.removeResource(stream);
             }));
         }
         if (this.config.genesisConnectEvents.includes('commit')) {
-            this.unsubscribableObservers.push(this.connectEvents.addCommitListener(this.runAllChecks));
+            this.unsubscribableObservers.push(this.connectEvents.addCommitListener((event) => {
+                if (this.config.ignoredGenesisResources.includes(event.detail.eventName)) {
+                    return;
+                }
+                this.runAllChecks(event);
+            }));
         }
         this.unsubscribableObservers.push(this.connectEvents.addMetadataListener(({ detail }) => {
             const { resourceName, error } = detail;
@@ -285,7 +330,7 @@ export class DefaultNetworkMonitor {
         const eventEmitter = (_a = this.config.eventEmitter) !== null && _a !== void 0 ? _a : document;
         this.status = this.normaliseEventDetail(detail);
         const loggerFn = this.status.isHealthy ? networkLogger.debug : networkLogger.warn;
-        loggerFn(`Emitting 'system-health-changed' event`, this.status);
+        loggerFn(`Emitting 'system-health-changed' event`, safeStringifyValue(this.status));
         eventEmitter === null || eventEmitter === void 0 ? void 0 : eventEmitter.dispatchEvent(new CustomEvent(SystemHealthChanged, {
             detail: this.status,
             bubbles: eventEmitter !== document,
@@ -374,6 +419,41 @@ export class DefaultNetworkMonitor {
             } });
         return normalisedDetail;
     }
+    /**
+     * @returns A flag to indicate if the socket is in a state that allows resource checking.
+     * @internal
+     */
+    preFlightSocketChecks(status) {
+        if (!status.isConfigured) {
+            networkLogger.debug(`Socket not configured`);
+            return false;
+        }
+        if (status.isReconnecting) {
+            networkLogger.debug(`Socket reconnecting`);
+            return false;
+        }
+        if (status.isConnecting) {
+            networkLogger.debug(`Socket connecting`);
+            return false;
+        }
+        if (status.isDisconnected) {
+            const closedDetails = status.isDisconnectedByServer
+                ? `by the server, code: ${status.closedCode}, reason: ${status.closedReason}`
+                : '';
+            networkLogger.debug(`Socket disconnected ${closedDetails}`);
+            if (status.reconnectionLimitReached) {
+                networkLogger.debug(`Socket reconnection limit reached`);
+            }
+            return false;
+        }
+        /**
+         * Socket is okay to run resource checks.
+         * Data servers can be set to serve anonymous users, so don't block due to session validity.
+         */
+        const withOrWithout = this.user.isAuthenticated ? `with` : 'without';
+        networkLogger.debug(`Socket connected ${withOrWithout} valid session`);
+        return true;
+    }
     /**
      * @internal
      */

package/dist/esm/storage/kv/kv.service.js

@@ -1,6 +1,6 @@
 import { __awaiter, __decorate, __param } from "tslib";
+import { User } from '@genesislcap/foundation-user';
 import { DI, optional } from '@microsoft/fast-foundation';
-import { Auth } from '../../auth';
 import { Connect } from '../../connect';
 import { logger } from '../../utils';
 import { defaultKVStorageConfig, KVStorageConfig } from './kv-config.service';
@@ -10,9 +10,9 @@ import { KVEventMessageType, KVMessageType, } from './kv.types';
  * @alpha
  */
 let DefaultKVStorage = class DefaultKVStorage {
-    constructor(connect, auth, kvStorageConfig = defaultKVStorageConfig) {
+    constructor(connect, user, kvStorageConfig = defaultKVStorageConfig) {
         this.connect = connect;
-        this.auth = auth;
+        this.user = user;
         this.kvStorageConfig = kvStorageConfig;
         this.checkAvailability();
     }
@@ -78,11 +78,11 @@ let DefaultKVStorage = class DefaultKVStorage {
      * ```
      */
     get(key) {
-        var _a, _b, _c;
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const params = {
                 REQUEST: {
-                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : (_c = (_b = this.auth) === null || _b === void 0 ? void 0 : _b.currentUser) === null || _c === void 0 ? void 0 : _c.username,
+                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : this.user.userName,
                     KEY: key,
                 },
             };
@@ -109,11 +109,11 @@ let DefaultKVStorage = class DefaultKVStorage {
      * ```
      */
     list() {
-        var _a, _b, _c;
+        var _a;
         return __awaiter(this, void 0, void 0, function* () {
             const params = {
                 REQUEST: {
-                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : (_c = (_b = this.auth) === null || _b === void 0 ? void 0 : _b.currentUser) === null || _c === void 0 ? void 0 : _c.username,
+                    USER_NAME: (_a = this.kvStorageConfig.authEmail) !== null && _a !== void 0 ? _a : this.user.userName,
                 },
             };
             const result = yield this.connect.request(KVMessageType.REQ_KEY_VALUE_LIST, params);
@@ -161,7 +161,7 @@ let DefaultKVStorage = class DefaultKVStorage {
 };
 DefaultKVStorage = __decorate([
     __param(0, Connect),
-    __param(1, Auth),
+    __param(1, User),
     __param(2, optional(KVStorageConfig))
 ], DefaultKVStorage);
 export { DefaultKVStorage };
@@ -170,3 +170,21 @@ export { DefaultKVStorage };
  * @internal
  */
 export const KVStorage = DI.createInterface((x) => x.singleton(DefaultKVStorage));
+/**
+ * Gets KVStorage from the DI container.
+ *
+ * @remarks
+ * A utility method for host applications that are not using decorators or the DI container.
+ *
+ * @example
+ * ```ts
+ * import { getKVStorage } from '@genesislcap/foundation-comms';
+ * ...
+ * private kvStorage = getKVStorage();
+ * ```
+ *
+ * @public
+ */
+export function getKVStorage() {
+    return DI.getOrCreateDOMContainer().get(KVStorage);
+}

package/dist/esm/user/user.js

@@ -1,66 +1,23 @@
-import { __decorate } from "tslib";
-import { observable } from '@microsoft/fast-element';
+import { User as NextUser, DefaultUser as DefaultNextUser } from '@genesislcap/foundation-user';
 import { DI } from '@microsoft/fast-foundation';
 /**
  * Represents the current user (i.e. the user that is currently logged in).
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#DefaultUser} instead.
+ *
  * @public
  */
-export class CurrentUser {
-    constructor(options) {
-        this.set(options);
-    }
-    set(options) {
-        if (!options) {
-            return;
-        }
-        this.permissions = options.permissions;
-        this.profiles = options.profiles;
-        this.username = options.username;
-    }
-    unset() {
-        this.permissions = undefined;
-        this.profiles = undefined;
-        this.username = undefined;
-    }
-    hasAdminProfile() {
-        return this.hasProfile('ADMIN');
-    }
-    hasPermission(permission) {
-        return this.hasKey(this.permissions, permission);
-    }
-    hasProfile(profile) {
-        return this.hasKey(this.profiles, profile);
-    }
-    /**
-     * Checks if the given key or keys are present in the given array of keys.
-     * @internal
-     * @param keys - The array of keys to check.
-     * @param key - The key or keys to check for.
-     * @returns True if the key or keys are present in the array of keys.
-     */
-    hasKey(keys, key) {
-        if (!keys || !keys.length || !key) {
-            return false;
-        }
-        if (!Array.isArray(key)) {
-            key = [key];
-        }
-        return key.some((k) => keys.includes(k));
-    }
+export class CurrentUser extends DefaultNextUser {
 }
-__decorate([
-    observable
-], CurrentUser.prototype, "permissions", void 0);
-__decorate([
-    observable
-], CurrentUser.prototype, "profiles", void 0);
-__decorate([
-    observable
-], CurrentUser.prototype, "username", void 0);
 /**
  * User DI key.
+ *
  * @privateRemarks
  * Marked as internal to stop api-extractor becoming confused cross-linking tokens with the same name.
+ * Using aliasTo to point to {@link @genesislcap/foundation-user#User}.
+ *
+ * @deprecated - Use {@link @genesislcap/foundation-user#User} instead.
+ *
  * @internal
  */
-export const User = DI.createInterface((x) => x.singleton(CurrentUser));
+export const User = DI.createInterface((x) => x.aliasTo(NextUser));