Added health metrics for application load and database load (#2257)

* Added health metrics for application load

* Added health metrics for application load

* Fix unit tests

* Added more metrics

* Added few comments

* Added DatabaseLoad Scenario and address comments

* Fix unit tests

* fix unit tests

* Fix unit tests

* fix unit tests

* fix the mock

* Fix unit tests

src/Metrics/Constants.ts

@@ -0,0 +1,16 @@
+import { ApiType } from "Common/Constants";
+import { Platform } from "ConfigContext";
+
+// Metric scenarios represent lifecycle checkpoints we measure.
+export enum MetricScenario {
+  ApplicationLoad = "ApplicationLoad",
+  DatabaseLoad = "DatabaseLoad",
+}
+
+// Generic metric emission event describing scenario outcome.
+export interface MetricEvent {
+  readonly platform: Platform;
+  readonly api: ApiType;
+  readonly scenario: MetricScenario;
+  readonly healthy: boolean;
+}

src/Metrics/MetricEvents.test.ts

@@ -0,0 +1,104 @@
+import { configContext, Platform } from "../ConfigContext";
+import { getAuthorizationHeader } from "../Utils/AuthorizationUtils";
+import { fetchWithTimeout } from "../Utils/FetchWithTimeout";
+import MetricScenario, { reportHealthy, reportUnhealthy } from "./MetricEvents";
+
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+const { Response } = require("node-fetch");
+
+jest.mock("../Utils/AuthorizationUtils", () => ({
+  getAuthorizationHeader: jest.fn().mockReturnValue({ header: "authorization", token: "Bearer test-token" }),
+}));
+
+jest.mock("../Utils/FetchWithTimeout", () => ({
+  fetchWithTimeout: jest.fn(),
+}));
+
+describe("MetricEvents", () => {
+  const mockFetchWithTimeout = fetchWithTimeout as jest.MockedFunction<typeof fetchWithTimeout>;
+
+  afterEach(() => {
+    jest.clearAllMocks();
+  });
+
+  test("reportHealthy success includes auth header", async () => {
+    const mockResponse = new Response(null, { status: 200 });
+    mockFetchWithTimeout.mockResolvedValue(mockResponse);
+
+    const result = await reportHealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL");
+
+    expect(result).toBeInstanceOf(Response);
+    expect(result.ok).toBe(true);
+    expect(result.status).toBe(200);
+    expect(mockFetchWithTimeout).toHaveBeenCalledTimes(1);
+
+    const callArgs = mockFetchWithTimeout.mock.calls[0];
+    expect(callArgs[0]).toContain("/api/dataexplorer/metrics/health");
+    expect(callArgs[1]?.headers).toEqual({
+      "Content-Type": "application/json",
+      authorization: "Bearer test-token",
+    });
+
+    const body = JSON.parse(callArgs[1]?.body as string);
+    expect(body.scenario).toBe(MetricScenario.ApplicationLoad);
+    expect(body.platform).toBe(Platform.Portal);
+    expect(body.api).toBe("SQL");
+    expect(body.healthy).toBe(true);
+    expect(getAuthorizationHeader).toHaveBeenCalled();
+  });
+
+  test("reportUnhealthy failure status", async () => {
+    const mockResponse = new Response("Failure", { status: 500 });
+    mockFetchWithTimeout.mockResolvedValue(mockResponse);
+
+    const result = await reportUnhealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL");
+
+    expect(result).toBeInstanceOf(Response);
+    expect(result.ok).toBe(false);
+    expect(result.status).toBe(500);
+
+    const callArgs = mockFetchWithTimeout.mock.calls[0];
+    const body = JSON.parse(callArgs[1]?.body as string);
+    expect(body.healthy).toBe(false);
+  });
+
+  test("helpers healthy/unhealthy", async () => {
+    mockFetchWithTimeout.mockResolvedValue(new Response(null, { status: 201 }));
+
+    const healthyResult = await reportHealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL");
+    const unhealthyResult = await reportUnhealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL");
+
+    expect(healthyResult.status).toBe(201);
+    expect(unhealthyResult.status).toBe(201);
+    expect(mockFetchWithTimeout).toHaveBeenCalledTimes(2);
+  });
+
+  test("throws when backend endpoint missing", async () => {
+    const original = configContext.PORTAL_BACKEND_ENDPOINT;
+    (configContext as { PORTAL_BACKEND_ENDPOINT: string }).PORTAL_BACKEND_ENDPOINT = "";
+
+    await expect(reportHealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL")).rejects.toThrow(
+      "baseUri is null or empty",
+    );
+
+    expect(mockFetchWithTimeout).not.toHaveBeenCalled();
+    (configContext as { PORTAL_BACKEND_ENDPOINT: string }).PORTAL_BACKEND_ENDPOINT = original;
+  });
+
+  test("propagates fetch errors", async () => {
+    mockFetchWithTimeout.mockRejectedValue(new Error("Network error"));
+
+    await expect(reportHealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL")).rejects.toThrow(
+      "Network error",
+    );
+  });
+
+  test("propagates timeout errors", async () => {
+    const abortError = new DOMException("The operation was aborted", "AbortError");
+    mockFetchWithTimeout.mockRejectedValue(abortError);
+
+    await expect(reportUnhealthy(MetricScenario.ApplicationLoad, Platform.Portal, "SQL")).rejects.toThrow(
+      "The operation was aborted",
+    );
+  });
+});

src/Metrics/MetricEvents.ts

@@ -0,0 +1,28 @@
+// Metrics module: scenario metric emission logic.
+import { MetricEvent, MetricScenario } from "Metrics/Constants";
+import { createUri } from "../Common/UrlUtility";
+import { configContext, Platform } from "../ConfigContext";
+import { ApiType } from "../UserContext";
+import { getAuthorizationHeader } from "../Utils/AuthorizationUtils";
+import { fetchWithTimeout } from "../Utils/FetchWithTimeout";
+
+const RELATIVE_PATH = "/api/dataexplorer/metrics/health"; // Endpoint retains 'health' for backend compatibility.
+
+export const reportHealthy = (scenario: MetricScenario, platform: Platform, api: ApiType): Promise<Response> =>
+  send({ platform, api, scenario, healthy: true });
+
+export const reportUnhealthy = (scenario: MetricScenario, platform: Platform, api: ApiType): Promise<Response> =>
+  send({ platform, api, scenario, healthy: false });
+
+const send = async (event: MetricEvent): Promise<Response> => {
+  const url = createUri(configContext?.PORTAL_BACKEND_ENDPOINT, RELATIVE_PATH);
+  const authHeader = getAuthorizationHeader();
+
+  return await fetchWithTimeout(url, {
+    method: "POST",
+    headers: { "Content-Type": "application/json", [authHeader.header]: authHeader.token },
+    body: JSON.stringify(event),
+  });
+};
+
+export default MetricScenario;

src/Metrics/MetricScenarioConfigs.ts

@@ -0,0 +1,17 @@
+import MetricScenario from "./MetricEvents";
+import { ApplicationMetricPhase, CommonMetricPhase, ScenarioConfig } from "./ScenarioConfig";
+
+export const scenarioConfigs: Record<MetricScenario, ScenarioConfig> = {
+  [MetricScenario.ApplicationLoad]: {
+    requiredPhases: [ApplicationMetricPhase.ExplorerInitialized, CommonMetricPhase.Interactive],
+    timeoutMs: 10000,
+  },
+  [MetricScenario.DatabaseLoad]: {
+    requiredPhases: [
+      ApplicationMetricPhase.DatabasesFetched,
+      ApplicationMetricPhase.DatabaseTreeRendered,
+      CommonMetricPhase.Interactive,
+    ],
+    timeoutMs: 10000,
+  },
+};

src/Metrics/MetricScenarioProvider.tsx

@@ -0,0 +1,29 @@
+import React, { useContext } from "react";
+import MetricScenario from "./MetricEvents";
+import { MetricPhase } from "./ScenarioConfig";
+import { scenarioMonitor } from "./ScenarioMonitor";
+
+interface MetricScenarioContextValue {
+  startScenario: (scenario: MetricScenario) => void;
+  startPhase: (scenario: MetricScenario, phase: MetricPhase) => void;
+  completePhase: (scenario: MetricScenario, phase: MetricPhase) => void;
+}
+
+const MetricScenarioContext = React.createContext<MetricScenarioContextValue | undefined>(undefined);
+
+export const MetricScenarioProvider: React.FC<{ children: React.ReactNode }> = ({ children }) => {
+  const value: MetricScenarioContextValue = {
+    startScenario: (s: MetricScenario) => scenarioMonitor.start(s),
+    startPhase: (s: MetricScenario, p: MetricPhase) => scenarioMonitor.startPhase(s, p),
+    completePhase: (s: MetricScenario, p: MetricPhase) => scenarioMonitor.completePhase(s, p),
+  };
+  return <MetricScenarioContext.Provider value={value}>{children}</MetricScenarioContext.Provider>;
+};
+
+export function useMetricScenario(): MetricScenarioContextValue {
+  const ctx = useContext(MetricScenarioContext);
+  if (!ctx) {
+    throw new Error("useMetricScenario must be used within MetricScenarioProvider");
+  }
+  return ctx;
+}

src/Metrics/ScenarioConfig.ts

@@ -0,0 +1,47 @@
+import MetricScenario from "./MetricEvents";
+
+// Common phases shared across all scenarios
+export enum CommonMetricPhase {
+  Interactive = "Interactive",
+}
+
+// Application-specific phases
+export enum ApplicationMetricPhase {
+  ExplorerInitialized = "ExplorerInitialized",
+  DatabasesFetched = "DatabasesFetched",
+  DatabaseTreeRendered = "DatabaseTreeRendered",
+}
+
+// Combined type for all metric phases
+export type MetricPhase = CommonMetricPhase | ApplicationMetricPhase;
+
+export interface WebVitals {
+  lcp?: number; // Largest Contentful Paint
+  inp?: number; // Interaction to Next Paint
+  cls?: number; // Cumulative Layout Shift
+  fcp?: number; // First Contentful Paint
+  ttfb?: number; // Time to First Byte
+}
+
+export interface ScenarioConfig<TPhase extends string = MetricPhase> {
+  requiredPhases: TPhase[];
+  timeoutMs: number;
+  validate?: (ctx: ScenarioContextSnapshot<TPhase>) => boolean; // Optional custom validation
+}
+
+export interface PhaseTimings {
+  endTimeISO: string; // When the phase completed
+  durationMs: number; // Duration from scenario start to phase completion
+}
+
+export interface ScenarioContextSnapshot<TPhase extends string = MetricPhase> {
+  scenario: MetricScenario;
+  startTimeISO: string; // Human-readable ISO timestamp
+  endTimeISO: string; // Human-readable end timestamp
+  durationMs: number; // Total scenario duration from start to end
+  completed: TPhase[]; // Array for JSON serialization
+  failedPhases?: TPhase[]; // Phases that failed
+  timedOut: boolean;
+  vitals?: WebVitals;
+  phaseTimings?: Record<string, PhaseTimings>; // Start/end times for each phase
+}

src/Metrics/ScenarioMonitor.ts

@@ -0,0 +1,267 @@
+import { Metric, onCLS, onFCP, onINP, onLCP, onTTFB } from "web-vitals";
+import { configContext } from "../ConfigContext";
+import { trackEvent } from "../Shared/appInsights";
+import { userContext } from "../UserContext";
+import MetricScenario, { reportHealthy, reportUnhealthy } from "./MetricEvents";
+import { scenarioConfigs } from "./MetricScenarioConfigs";
+import { MetricPhase, PhaseTimings, ScenarioConfig, ScenarioContextSnapshot, WebVitals } from "./ScenarioConfig";
+
+interface PhaseContext {
+  startMarkName: string; // Performance mark name for phase start
+  endMarkName?: string; // Performance mark name for phase end
+}
+
+interface InternalScenarioContext {
+  scenario: MetricScenario;
+  config: ScenarioConfig;
+  startMarkName: string;
+  completed: Set<MetricPhase>;
+  failed: Set<MetricPhase>;
+  phases: Map<MetricPhase, PhaseContext>; // Track start/end for each phase
+  timeoutId?: number;
+  emitted: boolean;
+}
+
+class ScenarioMonitor {
+  private contexts = new Map<MetricScenario, InternalScenarioContext>();
+  private vitals: WebVitals = {};
+  private vitalsInitialized = false;
+
+  constructor() {
+    this.initializeVitals();
+  }
+
+  private initializeVitals() {
+    if (this.vitalsInitialized) {
+      return;
+    }
+    this.vitalsInitialized = true;
+
+    onLCP((metric: Metric) => {
+      this.vitals.lcp = metric.value;
+    });
+    onINP((metric: Metric) => {
+      this.vitals.inp = metric.value;
+    });
+    onCLS((metric: Metric) => {
+      this.vitals.cls = metric.value;
+    });
+    onFCP((metric: Metric) => {
+      this.vitals.fcp = metric.value;
+    });
+    onTTFB((metric: Metric) => {
+      this.vitals.ttfb = metric.value;
+    });
+  }
+
+  start(scenario: MetricScenario) {
+    if (this.contexts.has(scenario)) {
+      return;
+    }
+    const config = scenarioConfigs[scenario];
+    if (!config) {
+      throw new Error(`Missing scenario config for ${scenario}`);
+    }
+
+    const startMarkName = `scenario_${scenario}_start`;
+    performance.mark(startMarkName);
+
+    const ctx: InternalScenarioContext = {
+      scenario,
+      config,
+      startMarkName,
+      completed: new Set<MetricPhase>(),
+      failed: new Set<MetricPhase>(),
+      phases: new Map<MetricPhase, PhaseContext>(),
+      emitted: false,
+    };
+
+    // Start all required phases at scenario start time
+    config.requiredPhases.forEach((phase) => {
+      const phaseStartMarkName = `scenario_${scenario}_${phase}_start`;
+      performance.mark(phaseStartMarkName);
+      ctx.phases.set(phase, { startMarkName: phaseStartMarkName });
+    });
+
+    ctx.timeoutId = window.setTimeout(() => this.emit(ctx, false, true), config.timeoutMs);
+    this.contexts.set(scenario, ctx);
+  }
+
+  startPhase(scenario: MetricScenario, phase: MetricPhase) {
+    const ctx = this.contexts.get(scenario);
+    if (!ctx || ctx.emitted || !ctx.config.requiredPhases.includes(phase) || ctx.phases.has(phase)) {
+      return;
+    }
+
+    const startMarkName = `scenario_${scenario}_${phase}_start`;
+    performance.mark(startMarkName);
+    ctx.phases.set(phase, { startMarkName });
+  }
+
+  completePhase(scenario: MetricScenario, phase: MetricPhase) {
+    const ctx = this.contexts.get(scenario);
+    const phaseCtx = ctx?.phases.get(phase);
+    if (!ctx || ctx.emitted || !ctx.config.requiredPhases.includes(phase) || !phaseCtx) {
+      return;
+    }
+
+    const endMarkName = `scenario_${scenario}_${phase}_end`;
+    performance.mark(endMarkName);
+    phaseCtx.endMarkName = endMarkName;
+    ctx.completed.add(phase);
+
+    this.tryEmitIfReady(ctx);
+  }
+
+  failPhase(scenario: MetricScenario, phase: MetricPhase) {
+    const ctx = this.contexts.get(scenario);
+    if (!ctx || ctx.emitted) {
+      return;
+    }
+
+    // Mark the explicitly failed phase
+    performance.mark(`scenario_${scenario}_${phase}_failed`);
+    ctx.failed.add(phase);
+
+    // Mark all remaining incomplete required phases as failed
+    ctx.config.requiredPhases.forEach((requiredPhase) => {
+      if (!ctx.completed.has(requiredPhase) && !ctx.failed.has(requiredPhase)) {
+        ctx.failed.add(requiredPhase);
+      }
+    });
+
+    // Build a snapshot with failure info
+    const failureSnapshot = this.buildSnapshot(ctx, { final: false, timedOut: false });
+
+    // Emit unhealthy immediately
+    this.emit(ctx, false, false, failureSnapshot);
+  }
+
+  private tryEmitIfReady(ctx: InternalScenarioContext) {
+    const allDone = ctx.config.requiredPhases.every((p) => ctx.completed.has(p));
+    if (!allDone) {
+      return;
+    }
+    const finalSnapshot = this.buildSnapshot(ctx, { final: true, timedOut: false });
+    const healthy = ctx.config.validate ? ctx.config.validate(finalSnapshot) : true;
+    this.emit(ctx, healthy, false, finalSnapshot);
+  }
+
+  private getPhaseTimings(ctx: InternalScenarioContext): Record<string, PhaseTimings> {
+    const result: Record<string, PhaseTimings> = {};
+    const navigationStart = performance.timeOrigin;
+
+    ctx.phases.forEach((phaseCtx, phase) => {
+      // Only include completed phases (those with endMarkName)
+      if (phaseCtx.endMarkName) {
+        const endEntry = performance.getEntriesByName(phaseCtx.endMarkName)[0];
+        if (endEntry) {
+          const endTimeISO = new Date(navigationStart + endEntry.startTime).toISOString();
+
+          // Use Performance API measure to calculate duration
+          const measureName = `scenario_${ctx.scenario}_${phase}_duration`;
+          performance.measure(measureName, phaseCtx.startMarkName, phaseCtx.endMarkName);
+          const measure = performance.getEntriesByName(measureName)[0];
+          if (measure) {
+            result[phase] = {
+              endTimeISO,
+              durationMs: measure.duration,
+            };
+          }
+        }
+      }
+    });
+
+    return result;
+  }
+
+  private emit(ctx: InternalScenarioContext, healthy: boolean, timedOut: boolean, snapshot?: ScenarioContextSnapshot) {
+    if (ctx.emitted) {
+      return;
+    }
+    ctx.emitted = true;
+    if (ctx.timeoutId) {
+      clearTimeout(ctx.timeoutId);
+      ctx.timeoutId = undefined;
+    }
+
+    const platform = configContext.platform;
+    const api = userContext.apiType;
+
+    // Build snapshot if not provided
+    const finalSnapshot = snapshot || this.buildSnapshot(ctx, { final: false, timedOut });
+
+    // Emit enriched telemetry with performance data
+    // TODO: Call portal backend metrics endpoint
+    trackEvent(
+      { name: "MetricScenarioComplete" },
+      {
+        scenario: ctx.scenario,
+        healthy: healthy.toString(),
+        timedOut: timedOut.toString(),
+        platform,
+        api,
+        durationMs: finalSnapshot.durationMs.toString(),
+        completedPhases: finalSnapshot.completed.join(","),
+        failedPhases: finalSnapshot.failedPhases?.join(","),
+        lcp: finalSnapshot.vitals?.lcp?.toString(),
+        inp: finalSnapshot.vitals?.inp?.toString(),
+        cls: finalSnapshot.vitals?.cls?.toString(),
+        fcp: finalSnapshot.vitals?.fcp?.toString(),
+        ttfb: finalSnapshot.vitals?.ttfb?.toString(),
+        phaseTimings: JSON.stringify(finalSnapshot.phaseTimings),
+      },
+    );
+
+    // Call portal backend health metrics endpoint
+    if (healthy && !timedOut) {
+      reportHealthy(ctx.scenario, platform, api);
+    } else {
+      reportUnhealthy(ctx.scenario, platform, api);
+    }
+
+    // Cleanup performance entries
+    this.cleanupPerformanceEntries(ctx);
+  }
+
+  private cleanupPerformanceEntries(ctx: InternalScenarioContext) {
+    performance.clearMarks(ctx.startMarkName);
+    ctx.config.requiredPhases.forEach((phase) => {
+      performance.clearMarks(`scenario_${ctx.scenario}_${phase}`);
+    });
+    performance.clearMeasures(`scenario_${ctx.scenario}_total`);
+  }
+
+  private buildSnapshot(
+    ctx: InternalScenarioContext,
+    opts: { final: boolean; timedOut: boolean },
+  ): ScenarioContextSnapshot {
+    const phaseTimings = this.getPhaseTimings(ctx);
+
+    // Capture current time once for consistency
+    const currentTime = performance.now();
+
+    // Convert performance timestamps (relative to navigationStart) to absolute timestamps
+    const navigationStart = performance.timeOrigin;
+    const startEntry = performance.getEntriesByName(ctx.startMarkName)[0];
+    const startTimeISO = new Date(navigationStart + (startEntry?.startTime || 0)).toISOString();
+    const endTimeISO = new Date(navigationStart + currentTime).toISOString();
+
+    // Calculate overall scenario duration directly from the timestamps
+    const durationMs = currentTime - (startEntry?.startTime || 0);
+
+    return {
+      scenario: ctx.scenario,
+      startTimeISO,
+      endTimeISO,
+      durationMs,
+      completed: Array.from(ctx.completed),
+      failedPhases: ctx.failed.size > 0 ? Array.from(ctx.failed) : undefined,
+      timedOut: opts.timedOut,
+      vitals: { ...this.vitals },
+      phaseTimings,
+    };
+  }
+}
+
+export const scenarioMonitor = new ScenarioMonitor();

src/Metrics/useMetricPhases.ts

@@ -0,0 +1,40 @@
+import React from "react";
+import MetricScenario from "./MetricEvents";
+import { useMetricScenario } from "./MetricScenarioProvider";
+import { ApplicationMetricPhase, CommonMetricPhase } from "./ScenarioConfig";
+
+/**
+ * Hook to automatically complete the Interactive phase when the component becomes interactive.
+ * Uses requestAnimationFrame to complete after the browser has painted.
+ */
+export function useInteractive(scenario: MetricScenario) {
+  const { completePhase } = useMetricScenario();
+
+  React.useEffect(() => {
+    requestAnimationFrame(() => {
+      completePhase(scenario, CommonMetricPhase.Interactive);
+    });
+  }, [scenario, completePhase]);
+}
+
+/**
+ * Hook to manage DatabaseLoad scenario phase completions.
+ * Tracks tree rendering and completes Interactive phase.
+ * Only completes DatabaseTreeRendered if the database fetch was successful.
+ * Note: Scenario must be started before databases are fetched (in refreshExplorer).
+ */
+export function useDatabaseLoadScenario(databaseTreeNodes: unknown[], fetchSucceeded: boolean) {
+  const { completePhase } = useMetricScenario();
+  const hasCompletedTreeRenderRef = React.useRef(false);
+
+  // Track DatabaseTreeRendered phase (only if fetch succeeded)
+  React.useEffect(() => {
+    if (!hasCompletedTreeRenderRef.current && fetchSucceeded) {
+      hasCompletedTreeRenderRef.current = true;
+      completePhase(MetricScenario.DatabaseLoad, ApplicationMetricPhase.DatabaseTreeRendered);
+    }
+  }, [databaseTreeNodes, fetchSucceeded, completePhase]);
+
+  // Track Interactive phase
+  useInteractive(MetricScenario.DatabaseLoad);
+}