@oneuptime/common 14.0.3 → 14.0.5

package/Tests/App/Dashboard/RecommendationsLoadedContext.test.tsx

@@ -0,0 +1,349 @@
+import "@testing-library/jest-dom";
+import {
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  jest,
+  test,
+} from "@jest/globals";
+import { act, cleanup, render, screen, waitFor } from "@testing-library/react";
+import * as React from "react";
+import { MemoryRouter } from "react-router-dom";
+import getJestMockFunction, { MockFunction } from "../../MockType";
+import { PROJECT_ID, goTo } from "./SideMenuHarness";
+
+/*
+ * The Recommendations tab and its side-menu badge, rendered for real, for a
+ * database whose collector heartbeat is fresh.
+ *
+ * The heartbeat (collectorLastSeenAt) is stamped by ANY batch attributed to
+ * the database — its logs, an exporter, a MongoDB Atlas cluster's
+ * `mongodbatlas` receiver, whose metrics are not the `mongodb.*` the MongoDB
+ * monitors read. RecommendationResourceRegistry.loadContext finishes the
+ * answer with a one-row probe for those metrics; these tests pin that the
+ * page and the badge both render from THAT answer, not from the row alone:
+ * no "Engine Metrics Stopped" offered to a database it would page about
+ * forever, and a badge that agrees with the page behind it.
+ */
+
+const DATABASE_ID: string = "84858d6c-1111-4aaa-8bbb-000000000001";
+
+const getItemMock: MockFunction = getJestMockFunction();
+const getListMock: MockFunction = getJestMockFunction();
+const getAnalyticsListMock: MockFunction = getJestMockFunction();
+
+// The arrow wrappers are load bearing: jest.mock is hoisted above the mocks.
+jest.mock("../../../UI/Utils/ModelAPI/ModelAPI", () => {
+  return {
+    __esModule: true,
+    default: {
+      getItem: (...args: Array<unknown>) => {
+        return getItemMock(...args);
+      },
+      getList: (...args: Array<unknown>) => {
+        return getListMock(...args);
+      },
+    },
+  };
+});
+
+jest.mock("../../../UI/Utils/AnalyticsModelAPI/AnalyticsModelAPI", () => {
+  return {
+    __esModule: true,
+    default: {
+      getList: (...args: Array<unknown>) => {
+        return getAnalyticsListMock(...args);
+      },
+    },
+  };
+});
+
+jest.mock("../../../../App/FeatureSet/Dashboard/src/Utils/ProjectUser", () => {
+  return {
+    __esModule: true,
+    default: {
+      fetchProjectUsersAsDropdownOptions: () => {
+        return Promise.resolve([]);
+      },
+    },
+  };
+});
+
+// Only the badge number matters here, not how the menu entry draws it.
+jest.mock("../../../UI/Components/SideMenu/SideMenuItem", () => {
+  return {
+    __esModule: true,
+    default: (props: { badge?: number | undefined }) => {
+      return (
+        <span data-testid="recommendations-badge">
+          {props.badge === undefined ? "no badge" : String(props.badge)}
+        </span>
+      );
+    },
+  };
+});
+
+import DatabaseServerRecommendations from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/Recommendations";
+import RecommendationsSideMenuItem from "../../../../App/FeatureSet/Dashboard/src/Components/Recommendations/RecommendationsSideMenuItem";
+import PageComponentProps from "../../../../App/FeatureSet/Dashboard/src/Pages/PageComponentProps";
+import AlertSeverity from "../../../Models/DatabaseModels/AlertSeverity";
+import DatabaseServer from "../../../Models/DatabaseModels/DatabaseServer";
+import IncidentSeverity from "../../../Models/DatabaseModels/IncidentSeverity";
+import Monitor from "../../../Models/DatabaseModels/Monitor";
+import MonitorStatus from "../../../Models/DatabaseModels/MonitorStatus";
+import Metric from "../../../Models/AnalyticsModels/Metric";
+import Route from "../../../Types/API/Route";
+import { getDatabaseAlertTemplates } from "../../../Types/Monitor/DatabaseAlertTemplates";
+import { MonitorRecommendationResourceType } from "../../../Types/Monitor/Recommendation/MonitorRecommendationTypes";
+import ObjectID from "../../../Types/ObjectID";
+
+const PAGE_PROPS: PageComponentProps = {
+  pageRoute: new Route(
+    `/dashboard/${PROJECT_ID}/databases/${DATABASE_ID}/recommendations`,
+  ),
+  currentProject: null,
+  hasPaymentMethod: true,
+};
+
+interface ProbeAnswer {
+  data: Array<{ time: Date }>;
+  count: number;
+}
+
+const METRICS_ARRIVED: ProbeAnswer = {
+  data: [{ time: new Date() }],
+  count: 1,
+};
+
+const NOTHING_ARRIVED: ProbeAnswer = { data: [], count: 0 };
+
+// A database row with a fresh collector heartbeat, as the tab fetches it.
+function databaseRow(dbSystem: string): DatabaseServer {
+  const row: DatabaseServer = new DatabaseServer();
+  row._id = DATABASE_ID;
+  row.projectId = new ObjectID(PROJECT_ID);
+  row.name = "orders";
+  row.dbSystem = dbSystem;
+  row.collectorLastSeenAt = new Date();
+  return row;
+}
+
+// Everything MonitorRecommendations needs to build a monitor step.
+function projectList(modelType: unknown): { data: Array<unknown> } {
+  if (modelType === MonitorStatus) {
+    const online: MonitorStatus = new MonitorStatus();
+    online._id = ObjectID.generate().toString();
+    online.isOperationalState = true;
+    const offline: MonitorStatus = new MonitorStatus();
+    offline._id = ObjectID.generate().toString();
+    offline.isOfflineState = true;
+    return { data: [online, offline] };
+  }
+
+  if (modelType === IncidentSeverity || modelType === AlertSeverity) {
+    const severity: IncidentSeverity = new IncidentSeverity();
+    severity._id = ObjectID.generate().toString();
+    severity.name = "Critical";
+    return { data: [severity] };
+  }
+
+  // No monitors yet, no dismissals, no policies / teams / labels.
+  return { data: [] };
+}
+
+function probeCalls(): Array<{ modelType: unknown }> {
+  return getAnalyticsListMock.mock.calls.map(
+    (call: Array<unknown>): { modelType: unknown } => {
+      return call[0] as { modelType: unknown };
+    },
+  );
+}
+
+function monitorListCalls(): number {
+  return getListMock.mock.calls.filter((call: Array<unknown>): boolean => {
+    return (call[0] as { modelType: unknown }).modelType === Monitor;
+  }).length;
+}
+
+async function flushEffects(): Promise<void> {
+  for (let i: number = 0; i < 10; i++) {
+    await act(async () => {
+      await Promise.resolve();
+    });
+  }
+}
+
+beforeEach(() => {
+  getItemMock.mockReset();
+  getListMock.mockReset();
+  getAnalyticsListMock.mockReset();
+
+  goTo(`/dashboard/${PROJECT_ID}/databases/${DATABASE_ID}/recommendations`);
+
+  getListMock.mockImplementation((args: unknown) => {
+    return Promise.resolve(
+      projectList((args as { modelType: unknown }).modelType),
+    );
+  });
+});
+
+afterEach(() => {
+  cleanup();
+});
+
+describe("the database Recommendations tab renders from the loaded context", () => {
+  function renderPage(): void {
+    render(
+      <MemoryRouter>
+        <DatabaseServerRecommendations {...PAGE_PROPS} />
+      </MemoryRouter>,
+    );
+  }
+
+  test("a MongoDB Atlas database (heartbeat, but no mongodb.* metric) is offered nothing, and the tab says why", async () => {
+    getItemMock.mockResolvedValue(databaseRow("mongodb"));
+    getAnalyticsListMock.mockResolvedValue(NOTHING_ARRIVED);
+
+    renderPage();
+
+    expect(
+      await screen.findByText(/No recommendations for this database yet/),
+    ).toBeInTheDocument();
+    expect(screen.getByText(/does not count/)).toBeInTheDocument();
+    expect(screen.getByText(/mongodb receiver/)).toBeInTheDocument();
+
+    expect(screen.queryByText("Engine Metrics Stopped")).toBeNull();
+
+    // The probe the tab asked: one row of the Metric table.
+    expect(probeCalls()).toHaveLength(1);
+    expect(probeCalls()[0]!.modelType).toBe(Metric);
+  });
+
+  test("a PostgreSQL database whose engine metrics arrive is offered its engine's library", async () => {
+    getItemMock.mockResolvedValue(databaseRow("postgresql"));
+    getAnalyticsListMock.mockResolvedValue(METRICS_ARRIVED);
+
+    renderPage();
+
+    expect(
+      await screen.findByText("Engine Metrics Stopped"),
+    ).toBeInTheDocument();
+    expect(screen.queryByText(/does not count/)).toBeNull();
+    expect(
+      screen.getByText(/Recommended for PostgreSQL, from the metrics/),
+    ).toBeInTheDocument();
+  });
+
+  test("the list waits for the probe: nothing is offered from the heartbeat alone first", async () => {
+    getItemMock.mockResolvedValue(databaseRow("mongodb"));
+
+    let answerProbe: (answer: ProbeAnswer) => void = (): void => {};
+    getAnalyticsListMock.mockReturnValue(
+      new Promise<ProbeAnswer>((resolve: (answer: ProbeAnswer) => void) => {
+        answerProbe = resolve;
+      }),
+    );
+
+    renderPage();
+
+    await waitFor(() => {
+      expect(getAnalyticsListMock).toHaveBeenCalledTimes(1);
+    });
+    await flushEffects();
+
+    // The row alone says "metrics reported": it must not reach the list.
+    expect(screen.queryByText("Engine Metrics Stopped")).toBeNull();
+    expect(screen.queryByText("Recommended Monitors")).toBeNull();
+    // Nor did the list start fetching what it needs to create monitors.
+    expect(monitorListCalls()).toBe(0);
+
+    await act(async () => {
+      answerProbe(NOTHING_ARRIVED);
+    });
+
+    expect(
+      await screen.findByText(/No recommendations for this database yet/),
+    ).toBeInTheDocument();
+    expect(screen.queryByText("Engine Metrics Stopped")).toBeNull();
+  });
+
+  test("a failed probe keeps the heartbeat's answer rather than failing the tab", async () => {
+    getItemMock.mockResolvedValue(databaseRow("postgresql"));
+    /*
+     * Rejected on a later tick, once the probe is awaiting it: a promise
+     * rejected before its handler attaches is reported by zone.js as
+     * unhandled, which is test noise, not the behaviour under test.
+     */
+    getAnalyticsListMock.mockImplementation((): Promise<ProbeAnswer> => {
+      return new Promise<ProbeAnswer>(
+        (
+          _resolve: (answer: ProbeAnswer) => void,
+          reject: (error: Error) => void,
+        ) => {
+          setTimeout(() => {
+            reject(new Error("ClickHouse is down"));
+          }, 0);
+        },
+      );
+    });
+
+    renderPage();
+
+    expect(
+      await screen.findByText("Engine Metrics Stopped"),
+    ).toBeInTheDocument();
+  });
+});
+
+describe("the Recommendations side-menu badge counts from the same loaded context", () => {
+  function renderBadge(): void {
+    render(
+      <RecommendationsSideMenuItem
+        link={{
+          title: "Recommendations",
+          to: new Route(
+            `/dashboard/${PROJECT_ID}/databases/${DATABASE_ID}/recommendations`,
+          ),
+        }}
+        resourceType={MonitorRecommendationResourceType.DatabaseServer}
+        resourceId={new ObjectID(DATABASE_ID)}
+      />,
+    );
+  }
+
+  test("no badge for a MongoDB Atlas database: the page behind it offers nothing", async () => {
+    getItemMock.mockResolvedValue(databaseRow("mongodb"));
+    getAnalyticsListMock.mockResolvedValue(NOTHING_ARRIVED);
+
+    renderBadge();
+
+    await waitFor(() => {
+      expect(getAnalyticsListMock).toHaveBeenCalledTimes(1);
+    });
+    await flushEffects();
+
+    expect(screen.getByTestId("recommendations-badge")).toHaveTextContent(
+      "no badge",
+    );
+    // Nothing to count, so nothing else was fetched.
+    expect(monitorListCalls()).toBe(0);
+  });
+
+  test("the badge counts the engine's library once its metrics arrive", async () => {
+    getItemMock.mockResolvedValue(databaseRow("postgresql"));
+    getAnalyticsListMock.mockResolvedValue(METRICS_ARRIVED);
+
+    renderBadge();
+
+    const expected: number = getDatabaseAlertTemplates("postgresql").length;
+    expect(expected).toBeGreaterThan(0);
+
+    await waitFor(() => {
+      expect(screen.getByTestId("recommendations-badge")).toHaveTextContent(
+        String(expected),
+      );
+    });
+    expect(probeCalls()[0]!.modelType).toBe(Metric);
+  });
+});

package/Tests/App/Dashboard/ResourceArchiveSettings.test.tsx

@@ -20,13 +20,16 @@ import { MemoryRouter, Route as PageRoute, Routes } from "react-router-dom";
 import RumSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Rum/View/Settings";
 import CloudSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Cloud/View/Settings";
 import ServerlessSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Serverless/View/Settings";
+import DatabaseServerSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/Settings";
 import RumSideMenu from "../../../../App/FeatureSet/Dashboard/src/Pages/Rum/View/SideMenu";
 import CloudSideMenu from "../../../../App/FeatureSet/Dashboard/src/Pages/Cloud/View/SideMenu";
 import ServerlessSideMenu from "../../../../App/FeatureSet/Dashboard/src/Pages/Serverless/View/SideMenu";
+import DatabaseServerSideMenu from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/SideMenu";
 import PageComponentProps from "../../../../App/FeatureSet/Dashboard/src/Pages/PageComponentProps";
 import { getRumBreadcrumbs } from "../../../../App/FeatureSet/Dashboard/src/Utils/Breadcrumbs/RumBreadcrumbs";
 import { getCloudBreadcrumbs } from "../../../../App/FeatureSet/Dashboard/src/Utils/Breadcrumbs/CloudBreadcrumbs";
 import { getServerlessBreadcrumbs } from "../../../../App/FeatureSet/Dashboard/src/Utils/Breadcrumbs/ServerlessBreadcrumbs";
+import { getDatabaseBreadcrumbs } from "../../../../App/FeatureSet/Dashboard/src/Utils/Breadcrumbs/DatabaseBreadcrumbs";
 import PageMap from "../../../../App/FeatureSet/Dashboard/src/Utils/PageMap";
 import RouteMap, {
   RouteUtil,
@@ -34,6 +37,7 @@ import RouteMap, {
 import RumApplication from "../../../Models/DatabaseModels/RumApplication";
 import CloudResource from "../../../Models/DatabaseModels/CloudResource";
 import ServerlessFunction from "../../../Models/DatabaseModels/ServerlessFunction";
+import DatabaseServer from "../../../Models/DatabaseModels/DatabaseServer";
 import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
 import HTTPResponse from "../../../Types/API/HTTPResponse";
 import Route from "../../../Types/API/Route";
@@ -81,6 +85,50 @@ jest.mock(
   },
 );
 
+/*
+ * The Databases menu badges Incidents / Alerts / Scheduled Maintenance with
+ * open counts, which first look up the project's unresolved states. None
+ * here, so the badges settle at zero without reaching for the network.
+ */
+jest.mock(
+  "../../../../App/FeatureSet/Dashboard/src/Utils/IncidentState",
+  () => {
+    return {
+      __esModule: true,
+      default: {
+        getUnresolvedIncidentStates: () => {
+          return Promise.resolve([]);
+        },
+      },
+    };
+  },
+);
+
+jest.mock("../../../../App/FeatureSet/Dashboard/src/Utils/AlertState", () => {
+  return {
+    __esModule: true,
+    default: {
+      getUnresolvedAlertStates: () => {
+        return Promise.resolve([]);
+      },
+    },
+  };
+});
+
+jest.mock(
+  "../../../../App/FeatureSet/Dashboard/src/Utils/ScheduledMaintenanceState",
+  () => {
+    return {
+      __esModule: true,
+      default: {
+        getActiveScheduledMaintenanceStates: () => {
+          return Promise.resolve([]);
+        },
+      },
+    };
+  },
+);
+
 const MODEL_ID: ObjectID = new ObjectID("22222222-0000-4000-8000-000000000001");
 
 interface ResourceSettingsCase {
@@ -143,6 +191,18 @@ const RESOURCES: Array<ResourceSettingsCase> = [
       "Settings",
     ],
   },
+  {
+    name: "Database",
+    Page: DatabaseServerSettings,
+    SideMenu: DatabaseServerSideMenu,
+    modelType: DatabaseServer,
+    singularName: "database",
+    settingsKey: PageMap.DATABASE_SERVER_VIEW_SETTINGS,
+    overviewKey: PageMap.DATABASE_SERVER_VIEW,
+    productPath: "databases",
+    getBreadcrumbs: getDatabaseBreadcrumbs,
+    breadcrumbTitles: ["Project", "Databases", "View Database", "Settings"],
+  },
 ];
 
 function resourceRoute(key: PageMap): string {
@@ -185,6 +245,8 @@ beforeEach(() => {
   const resource: RumApplication = new RumApplication();
   resource.isArchived = false;
   jest.spyOn(ModelAPI, "getItem").mockResolvedValue(resource);
+  // Side-menu badges (the Databases menu counts open incidents and alerts).
+  jest.spyOn(ModelAPI, "count").mockResolvedValue(0);
 });
 
 afterEach(() => {

package/Tests/App/Dashboard/ResourceFeedPageWiring.test.ts

@@ -105,6 +105,13 @@ const FEED_PAGES: Array<FeedPageSpec> = [
     pagesDirectory: "Cloud",
     routesFile: "CloudResourceRoutes.tsx",
   },
+  {
+    product: "Databases",
+    pageMapKey: "DATABASE_SERVER_VIEW_FEED",
+    urlPrefix: "databases",
+    pagesDirectory: "Database",
+    routesFile: "DatabaseRoutes.tsx",
+  },
   {
     product: "Service Catalog",
     pageMapKey: "SERVICE_VIEW_FEED",
@@ -129,7 +136,7 @@ function read(...segments: Array<string>): string {
 
 describe("Resource feed pages", () => {
   test("every product that grew a feed is covered here", () => {
-    expect(FEED_PAGES.length).toBe(11);
+    expect(FEED_PAGES.length).toBe(12);
   });
 
   test.each(FEED_PAGES)(

package/Tests/App/Dashboard/ResourceFeedPagesFilterSort.test.tsx

@@ -70,6 +70,7 @@ import CephClusterFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/
 import VMwareVCenterFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/VMware/View/Feed";
 import HostFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/Host/View/Feed";
 import CloudResourceFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/Cloud/View/Feed";
+import DatabaseServerFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/Feed";
 import ServiceFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/Service/View/Feed";
 import SloFeedPage from "../../../../App/FeatureSet/Dashboard/src/Pages/Slo/View/Feed";
 import SloFeed from "../../../../App/FeatureSet/Dashboard/src/Components/Slo/SloFeed";
@@ -111,6 +112,9 @@ import HostFeed, {
 import CloudResourceFeed, {
   CloudResourceFeedEventType,
 } from "../../../Models/DatabaseModels/CloudResourceFeed";
+import DatabaseServerFeed, {
+  DatabaseServerFeedEventType,
+} from "../../../Models/DatabaseModels/DatabaseServerFeed";
 import ServiceFeed, {
   ServiceFeedEventType,
 } from "../../../Models/DatabaseModels/ServiceFeed";
@@ -297,6 +301,16 @@ const FEED_PAGES: Array<FeedPageSpec> = [
     eventTypeColumn: "cloudResourceFeedEventType",
     enumObject: CloudResourceFeedEventType,
   },
+  {
+    product: "Databases",
+    file: "Pages/Database/View/Feed.tsx",
+    Page: DatabaseServerFeedPage,
+    route: RouteMap[PageMap.DATABASE_SERVER_VIEW_FEED] as Route,
+    modelType: DatabaseServerFeed,
+    resourceIdColumn: "databaseServerId",
+    eventTypeColumn: "databaseServerFeedEventType",
+    enumObject: DatabaseServerFeedEventType,
+  },
   {
     product: "Service Catalog",
     file: "Pages/Service/View/Feed.tsx",

package/Tests/App/Dashboard/ScheduledMaintenanceOverviewPage.test.tsx

@@ -1102,6 +1102,7 @@ describe("Scheduled maintenance overview page", () => {
       "cephClusters",
       "dockerSwarmClusters",
       "iotFleets",
+      "databaseServers",
       "networkSites",
       "services",
     ];
@@ -1130,6 +1131,7 @@ describe("Scheduled maintenance overview page", () => {
         "CephCluster",
         "DockerSwarmCluster",
         "IoTFleet",
+        "DatabaseServer",
         "NetworkSite",
         "Service",
       ]);