@xh/hoist 73.0.0-SNAPSHOT.1744147015222 → 73.0.0-SNAPSHOT.1744228975863

package/security/msal/MsalClient.ts

@@ -14,9 +14,10 @@ import {
     PopupRequest,
     SilentRequest
 } from '@azure/msal-browser';
-import {XH} from '@xh/hoist/core';
+import {AppState, PlainObject, XH} from '@xh/hoist/core';
 import {Token} from '@xh/hoist/security/Token';
 import {logDebug, logError, logInfo, logWarn, mergeDeep, throwIf} from '@xh/hoist/utils/js';
+import {withFormattedTimestamps} from '@xh/hoist/format';
 import {flatMap, union, uniq} from 'lodash';
 import {BaseOAuthClient, BaseOAuthClientConfig} from '../BaseOAuthClient';
 import {AccessTokenSpec, TelemetryResults, TokenMap} from '../Types';
@@ -266,9 +267,13 @@ export class MsalClient extends BaseOAuthClient<MsalClientConfig, MsalTokenSpec>
     //------------------------
     // Telemetry
     //------------------------
+    getFormattedTelemetry(): PlainObject {
+        return withFormattedTimestamps(this.telemetryResults);
+    }
+
     enableTelemetry(): void {
         if (this._telemetryCbHandle) {
-            this.logInfo('Telemetry already enabled', this.telemetryResults);
+            this.logInfo('Telemetry already enabled', this.getFormattedTelemetry());
             return;
         }
 
@@ -279,7 +284,7 @@ export class MsalClient extends BaseOAuthClient<MsalClientConfig, MsalTokenSpec>
                 try {
                     const {events} = this.telemetryResults,
                         {name, startTimeMs, durationMs, success, errorName, errorCode} = e,
-                        eTime = startTimeMs ? new Date(startTimeMs) : new Date();
+                        eTime = startTimeMs ?? Date.now();
 
                     const eResult = (events[name] ??= {
                         firstTime: eTime,
@@ -316,10 +321,9 @@ export class MsalClient extends BaseOAuthClient<MsalClientConfig, MsalTokenSpec>
             });
         });
 
-        // Ask TrackService to include in background health check report, if enabled on that service.
-        // Handle TrackService not yet initialized (common, this client likely initialized before.)
+        // Wait for clientHealthService (this client likely initialized during earlier AUTHENTICATING.)
         this.addReaction({
-            when: () => XH.appIsRunning,
+            when: () => XH.appState === AppState.INITIALIZING_APP,
             run: () => XH.clientHealthService.addSource('msalClient', () => this.telemetryResults)
         });
 
@@ -336,7 +340,7 @@ export class MsalClient extends BaseOAuthClient<MsalClientConfig, MsalTokenSpec>
         this._telemetryCbHandle = null;
 
         XH.clientHealthService.removeSource('msalClient');
-        this.logInfo('Telemetry disabled', this.telemetryResults);
+        this.logInfo('Telemetry disabled', this.getFormattedTelemetry());
     }
 
     //------------------------

package/svc/ClientHealthService.ts

@@ -4,10 +4,11 @@
  *
  * Copyright © 2025 Extremely Heavy Industries Inc.
  */
-import {HoistService, PlainObject, XH} from '@xh/hoist/core';
+import {HoistService, PageState, PlainObject, XH} from '@xh/hoist/core';
 import {Timer} from '@xh/hoist/utils/async';
 import {MINUTES} from '@xh/hoist/utils/datetime';
-import {find, isPlainObject, pick, round} from 'lodash';
+import {withFormattedTimestamps} from '@xh/hoist/format';
+import {pick, round} from 'lodash';
 
 /**
  * Service for gathering data about client health.
@@ -31,19 +32,22 @@ export class ClientHealthService extends HoistService {
     }
 
     /**
-     * Main Entry report.  Return a default report of client health.
+     * Main entry point.  Return a default report of client health.
      */
     getReport(): ClientHealthReport {
         return {
-            session: this.getSession(),
-            ...this.getCustom(),
+            general: this.getGeneral(),
             memory: this.getMemory(),
             connection: this.getConnection(),
-            window: this.getWindow(),
-            screen: this.getScreen()
+            ...this.getCustom()
         };
     }
 
+    /** Get report, suitable for viewing in console. **/
+    getFormattedReport(): PlainObject {
+        return withFormattedTimestamps(this.getReport());
+    }
+
     /**
      * Register a new source for client health report data. No-op if background health report is
      * not generally enabled via `xhActivityTrackingConfig.clientHealthReport.intervalMins`.
@@ -63,11 +67,16 @@ export class ClientHealthService extends HoistService {
     // -----------------------------------
     // Generate individual report sections
     //------------------------------------
-    getSession(): SessionData {
-        const {loadStarted} = XH.appContainerModel.appStateModel;
+    getGeneral(): GeneralData {
+        const startTime = XH.appContainerModel.appStateModel.loadStarted,
+            elapsedMins = (ts: number) => round((Date.now() - ts) / 60_000, 1);
+
         return {
-            startTime: loadStarted,
-            durationMins: round((Date.now() - loadStarted) / 60_000, 1)
+            startTime,
+            durationMins: elapsedMins(startTime),
+            idleMins: elapsedMins(XH.lastActivityMs),
+            pageState: XH.pageState,
+            webSocket: XH.webSocketService.channelKey
         };
     }
 
@@ -89,44 +98,12 @@ export class ClientHealthService extends HoistService {
 
         const {jsHeapSizeLimit: limit, usedJSHeapSize: used} = ret;
         if (limit && used) {
-            ret.usedPctLimit = round((used / limit) * 100, 1);
+            ret.usedPctLimit = round((used / limit) * 100);
         }
 
         return ret;
     }
 
-    getScreen(): ScreenData {
-        const screen = window.screen as any;
-        if (!screen) return null;
-
-        const ret: ScreenData = pick(screen, [
-            'availWidth',
-            'availHeight',
-            'width',
-            'height',
-            'colorDepth',
-            'pixelDepth',
-            'availLeft',
-            'availTop'
-        ]);
-        if (screen.orientation) {
-            ret.orientation = pick(screen.orientation, ['angle', 'type']);
-        }
-        return ret;
-    }
-
-    getWindow(): WindowData {
-        return pick(window, [
-            'devicePixelRatio',
-            'screenX',
-            'screenY',
-            'innerWidth',
-            'innerHeight',
-            'outerWidth',
-            'outerHeight'
-        ]);
-    }
-
     getCustom(): PlainObject {
         const ret = {};
         this.sources.forEach((cb, k) => {
@@ -144,31 +121,27 @@ export class ClientHealthService extends HoistService {
     // Implementation
     //------------------
     private sendReport() {
-        const {
-            intervalMins,
-            severity: defaultSeverity,
-            ...rest
-        } = XH.trackService.conf.clientHealthReport ?? {};
-
-        const rpt = this.getReport();
-        let severity = defaultSeverity ?? 'INFO';
-        if (find(rpt, (v: any) => isPlainObject(v) && v.severity === 'WARN')) {
-            severity = 'WARN';
-        }
+        const {intervalMins, ...rest} = XH.trackService.conf.clientHealthReport ?? {};
 
         XH.track({
             category: 'App',
             message: 'Submitted health report',
-            severity,
             ...rest,
-            data: rpt
+            data: {
+                clientId: XH.clientId,
+                sessionId: XH.sessionId,
+                ...this.getReport()
+            }
         });
     }
 }
 
-export interface SessionData {
+export interface GeneralData {
     startTime: number;
     durationMins: number;
+    idleMins: number;
+    pageState: PageState;
+    webSocket: string;
 }
 
 export interface ConnectionData {
@@ -185,35 +158,8 @@ export interface MemoryData {
     usedJSHeapSize?: number;
 }
 
-export interface WindowData {
-    devicePixelRatio: number;
-    screenX: number;
-    screenY: number;
-    innerWidth: number;
-    innerHeight: number;
-    outerWidth: number;
-    outerHeight: number;
-}
-
-export interface ScreenData {
-    availWidth: number;
-    availHeight: number;
-    width: number;
-    height: number;
-    colorDepth: number;
-    pixelDepth: number;
-    availLeft: number;
-    availTop: number;
-    orientation?: {
-        angle: number;
-        type: string;
-    };
-}
-
 export interface ClientHealthReport {
-    session: SessionData;
+    general: GeneralData;
     connection: ConnectionData;
     memory: MemoryData;
-    window: WindowData;
-    screen: ScreenData;
 }