@oneuptime/common 14.0.12 → 14.0.14

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

@@ -0,0 +1,613 @@
+import "@testing-library/jest-dom";
+import { cleanup, fireEvent, render, screen } from "@testing-library/react";
+import React, { ReactElement } from "react";
+import { afterEach, describe, expect, jest, test } from "@jest/globals";
+import { JSONObject } from "../../../Types/JSON";
+
+/*
+ * "The idea is to make software as simple as possible to use and reduce
+ * decision paralysis." - the maintainer, asking for the same fix wherever
+ * the same problem is.
+ *
+ * The log, trace and exception monitors' filter forms were among the last
+ * to show their extra filters with a "Show / Hide Advanced Options" link of
+ * their own: each with its own rule for when it opened (the log and trace
+ * forms took an empty filter list for a set one, so theirs never started
+ * folded; the exception form's folded itself again as soon as a filter
+ * above it was typed into), no word of what was inside, and nothing to say
+ * that a hidden filter was in force. They now fold those filters under More
+ * fields, the section every form folds its rarely needed fields into:
+ *
+ *   - folded on a new monitor and on an edited one alike, its header naming
+ *     what it holds;
+ *   - each filter a monitor uses drawn on that header as a chip with what it
+ *     is set to ("Filter by Telemetry Service: 1"), so nothing in force is
+ *     hidden;
+ *   - the filters most monitors use (text, time window, severity, span
+ *     status, exception types, environments) left on screen;
+ *   - folded fields still mounted, so what is picked in them reaches the
+ *     saved step and the preview with every other filter.
+ *
+ * The security event monitor's form has the same section and its own suite
+ * (SecurityEventsMonitorStepForm.test.tsx).
+ */
+
+interface MockPreviews {
+  logs: Array<JSONObject>;
+  traces: Array<JSONObject>;
+  exceptions: Array<JSONObject>;
+}
+
+// What each form's preview was last handed: the filters it shows the data of.
+const mockPreviews: MockPreviews = { logs: [], traces: [], exceptions: [] };
+
+jest.mock(
+  "../../../../App/FeatureSet/Dashboard/src/Components/Monitor/LogMonitor/LogMonitorPreview",
+  () => {
+    return {
+      __esModule: true,
+      default: (props: { monitorStepLogMonitor: JSONObject }): ReactElement => {
+        mockPreviews.logs.push(props.monitorStepLogMonitor);
+        return <div data-testid="logs-preview" />;
+      },
+    };
+  },
+);
+
+jest.mock(
+  "../../../../App/FeatureSet/Dashboard/src/Components/Monitor/TraceMonitor/TraceMonitorPreview",
+  () => {
+    return {
+      __esModule: true,
+      default: (props: {
+        monitorStepTraceMonitor: JSONObject;
+      }): ReactElement => {
+        mockPreviews.traces.push(props.monitorStepTraceMonitor);
+        return <div data-testid="spans-preview" />;
+      },
+    };
+  },
+);
+
+jest.mock(
+  "../../../../App/FeatureSet/Dashboard/src/Components/Exceptions/ExceptionInstanceTable",
+  () => {
+    return {
+      __esModule: true,
+      default: (props: { query: JSONObject }): ReactElement => {
+        mockPreviews.exceptions.push(props.query);
+        return <div data-testid="exceptions-preview" />;
+      },
+    };
+  },
+);
+
+// The resolved/archived fingerprint lookup the exception preview runs.
+jest.mock("../../../UI/Utils/ModelAPI/ModelAPI", () => {
+  return {
+    __esModule: true,
+    default: {
+      getList: () => {
+        return Promise.resolve({ data: [], count: 0, skip: 0, limit: 0 });
+      },
+    },
+  };
+});
+
+import LogMonitorStepForm from "../../../../App/FeatureSet/Dashboard/src/Components/Form/Monitor/LogMonitor/LogMonitorStepFrom";
+import TraceMonitorStepForm from "../../../../App/FeatureSet/Dashboard/src/Components/Form/Monitor/TraceMonitor/TraceMonitorStepForm";
+import ExceptionMonitorStepForm from "../../../../App/FeatureSet/Dashboard/src/Components/Form/Monitor/ExceptionMonitor/ExceptionMonitorStepForm";
+import MonitorStepLogMonitor, {
+  MonitorStepLogMonitorUtil,
+} from "../../../Types/Monitor/MonitorStepLogMonitor";
+import MonitorStepTraceMonitor, {
+  MonitorStepTraceMonitorUtil,
+} from "../../../Types/Monitor/MonitorStepTraceMonitor";
+import MonitorStepExceptionMonitor, {
+  MonitorStepExceptionMonitorUtil,
+} from "../../../Types/Monitor/MonitorStepExceptionMonitor";
+import Service from "../../../Models/DatabaseModels/Service";
+import InventoryItem from "../../../Models/DatabaseModels/InventoryItem";
+import LogSeverity from "../../../Types/Log/LogSeverity";
+import { SpanStatus } from "../../../Models/AnalyticsModels/Span";
+import ObjectID from "../../../Types/ObjectID";
+import {
+  getByTextOutsideFoldedHeaders,
+  listedNames,
+  setChips,
+} from "../../UI/Components/FoldedSection/FoldedSectionQueries";
+
+const SERVICE_ID: ObjectID = new ObjectID(
+  "22222222-2222-4222-8222-222222222222",
+);
+const ENTITY_KEY: string = "k8s.pod/checkout-7d9f";
+
+function services(): Array<Service> {
+  const service: Service = new Service();
+  service.id = SERVICE_ID;
+  service.name = "checkout";
+  return [service];
+}
+
+function entities(): Array<InventoryItem> {
+  const entity: InventoryItem = new InventoryItem();
+  entity.entityKey = ENTITY_KEY;
+  entity.entityType = "k8s.pod" as never;
+  entity.displayName = "checkout-7d9f";
+  return [entity];
+}
+
+function moreFields(): HTMLElement {
+  return screen.getByRole("button", { name: "More fields" });
+}
+
+// A field's own label, not the name the folded header lists it by.
+function fieldLabel(title: string): HTMLElement {
+  return getByTextOutsideFoldedHeaders(document.body, title);
+}
+
+// The dropdown of the field with this title.
+function comboboxOf(title: string): HTMLElement {
+  let node: HTMLElement | null = fieldLabel(title);
+
+  while (node) {
+    const combobox: HTMLElement | null =
+      node.querySelector<HTMLElement>('[role="combobox"]');
+
+    if (combobox) {
+      return combobox;
+    }
+
+    node = node.parentElement;
+  }
+
+  throw new Error(`No dropdown found for "${title}".`);
+}
+
+// Picks an option of a react-select, the way a pointer does.
+function pick(combobox: HTMLElement, optionText: string): void {
+  fireEvent.keyDown(combobox, { key: "ArrowDown" });
+  const option: HTMLElement = screen.getByText(optionText);
+  fireEvent.mouseDown(option);
+  fireEvent.click(option);
+}
+
+function attributeKeyInput(): HTMLInputElement {
+  const input: HTMLInputElement | undefined = Array.from(
+    document.querySelectorAll<HTMLInputElement>(
+      'input[aria-controls^="autocomplete-suggestions-"]',
+    ),
+  ).find((candidate: HTMLInputElement): boolean => {
+    return candidate.getAttribute("placeholder") !== "Value";
+  });
+
+  if (!input) {
+    throw new Error("No attribute key box in the attributes filter.");
+  }
+
+  return input;
+}
+
+function attributeValueInput(): HTMLInputElement {
+  const input: HTMLInputElement | null =
+    document.querySelector<HTMLInputElement>('input[placeholder="Value"]');
+
+  if (!input) {
+    throw new Error("No attribute value box in the attributes filter.");
+  }
+
+  return input;
+}
+
+function expectNoOldAdvancedLink(): void {
+  expect(screen.queryByText("Show Advanced Options")).not.toBeInTheDocument();
+  expect(screen.queryByText("Hide Advanced Options")).not.toBeInTheDocument();
+}
+
+afterEach(() => {
+  cleanup();
+  mockPreviews.logs = [];
+  mockPreviews.traces = [];
+  mockPreviews.exceptions = [];
+});
+
+describe("Log monitor filters", () => {
+  interface Recorder {
+    latest: MonitorStepLogMonitor | null;
+  }
+
+  // Hands every change back as MonitorStep does: a new object each time.
+  const Harness: React.FunctionComponent<{
+    recorder: Recorder;
+    initial: MonitorStepLogMonitor;
+  }> = (props: {
+    recorder: Recorder;
+    initial: MonitorStepLogMonitor;
+  }): ReactElement => {
+    const [logMonitor, setLogMonitor] = React.useState<MonitorStepLogMonitor>(
+      props.initial,
+    );
+
+    return (
+      <LogMonitorStepForm
+        monitorStepLogMonitor={logMonitor}
+        onMonitorStepLogMonitorChanged={(value: MonitorStepLogMonitor) => {
+          props.recorder.latest = value;
+          setLogMonitor({ ...value });
+        }}
+        attributeKeys={["http.route"]}
+        telemetryServices={services()}
+        telemetryEntities={entities()}
+      />
+    );
+  };
+
+  function renderForm(initial: Partial<MonitorStepLogMonitor> = {}): Recorder {
+    const recorder: Recorder = { latest: null };
+
+    render(
+      <Harness
+        recorder={recorder}
+        initial={{ ...MonitorStepLogMonitorUtil.getDefault(), ...initial }}
+      />,
+    );
+
+    return recorder;
+  }
+
+  test("a new monitor shows the text, the time window and the severity, and folds the rest under More fields", () => {
+    renderForm();
+
+    expect(fieldLabel("Monitor Logs that include this text")).toBeVisible();
+    expect(fieldLabel("Monitor Logs for (time)")).toBeVisible();
+    // The filter most log monitors use is never folded away.
+    expect(fieldLabel("Log Severity")).toBeVisible();
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(listedNames(moreFields())).toEqual([
+      "Filter by Telemetry Service",
+      "Filter by Infrastructure Entity",
+      "Filter by Attributes",
+    ]);
+    expect(setChips(moreFields())).toEqual([]);
+
+    expect(fieldLabel("Filter by Telemetry Service")).not.toBeVisible();
+    expect(fieldLabel("Filter by Infrastructure Entity")).not.toBeVisible();
+    expect(fieldLabel("Filter by Attributes")).not.toBeVisible();
+
+    expectNoOldAdvancedLink();
+  });
+
+  test("opening More fields shows its filters, and nothing else changes", () => {
+    renderForm();
+
+    fireEvent.click(moreFields());
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "true");
+    expect(fieldLabel("Filter by Telemetry Service")).toBeVisible();
+    expect(fieldLabel("Filter by Infrastructure Entity")).toBeVisible();
+    expect(fieldLabel("Filter by Attributes")).toBeVisible();
+    expectNoOldAdvancedLink();
+  });
+
+  test("an edited monitor keeps More fields folded, its filters in force shown as chips", () => {
+    renderForm({
+      body: "timeout",
+      severityTexts: [LogSeverity.Error],
+      telemetryServiceIds: [SERVICE_ID],
+      entityKeys: [ENTITY_KEY],
+      attributes: { "http.route": "/checkout" },
+    });
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(setChips(moreFields())).toEqual([
+      "Filter by Telemetry Service: 1",
+      "Filter by Infrastructure Entity: 1",
+      "Filter by Attributes: 1",
+    ]);
+
+    // And the folded filters still scope what the preview shows.
+    expect(mockPreviews.logs[mockPreviews.logs.length - 1]).toMatchObject({
+      body: "timeout",
+      severityTexts: [LogSeverity.Error],
+      telemetryServiceIds: [SERVICE_ID],
+      entityKeys: [ENTITY_KEY],
+      attributes: { "http.route": "/checkout" },
+    });
+  });
+
+  test("a filter picked under More fields reaches the step and the preview with the others", () => {
+    const recorder: Recorder = renderForm({ body: "timeout" });
+
+    fireEvent.click(moreFields());
+    pick(comboboxOf("Filter by Telemetry Service"), "checkout");
+
+    expect(recorder.latest).toMatchObject({
+      body: "timeout",
+      telemetryServiceIds: [SERVICE_ID.toString()],
+    });
+    expect(mockPreviews.logs[mockPreviews.logs.length - 1]).toMatchObject({
+      body: "timeout",
+      telemetryServiceIds: [SERVICE_ID.toString()],
+    });
+
+    fireEvent.click(screen.getByText("Add Filter by Attributes"));
+    fireEvent.change(attributeKeyInput(), { target: { value: "http.route" } });
+    fireEvent.change(attributeValueInput(), {
+      target: { value: "/checkout" },
+    });
+
+    expect(recorder.latest).toMatchObject({
+      body: "timeout",
+      telemetryServiceIds: [SERVICE_ID.toString()],
+      attributes: { "http.route": "/checkout" },
+    });
+
+    // Folded again, the header says what is now in force.
+    fireEvent.click(moreFields());
+
+    expect(setChips(moreFields())).toEqual([
+      "Filter by Telemetry Service: 1",
+      "Filter by Attributes: 1",
+    ]);
+  });
+
+  test("typing in a filter above it leaves More fields as it was", () => {
+    renderForm();
+
+    fireEvent.click(moreFields());
+    fireEvent.change(
+      screen.getByRole("textbox", {
+        name: "Monitor Logs that include this text",
+      }),
+      { target: { value: "database" } },
+    );
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "true");
+  });
+});
+
+describe("Trace monitor filters", () => {
+  interface Recorder {
+    latest: MonitorStepTraceMonitor | null;
+  }
+
+  const Harness: React.FunctionComponent<{
+    recorder: Recorder;
+    initial: MonitorStepTraceMonitor;
+  }> = (props: {
+    recorder: Recorder;
+    initial: MonitorStepTraceMonitor;
+  }): ReactElement => {
+    const [traceMonitor, setTraceMonitor] =
+      React.useState<MonitorStepTraceMonitor>(props.initial);
+
+    return (
+      <TraceMonitorStepForm
+        monitorStepTraceMonitor={traceMonitor}
+        onMonitorStepTraceMonitorChanged={(value: MonitorStepTraceMonitor) => {
+          props.recorder.latest = value;
+          setTraceMonitor({ ...value });
+        }}
+        attributeKeys={["http.route"]}
+        telemetryServices={services()}
+        telemetryEntities={entities()}
+      />
+    );
+  };
+
+  function renderForm(
+    initial: Partial<MonitorStepTraceMonitor> = {},
+  ): Recorder {
+    const recorder: Recorder = { latest: null };
+
+    render(
+      <Harness
+        recorder={recorder}
+        initial={{ ...MonitorStepTraceMonitorUtil.getDefault(), ...initial }}
+      />,
+    );
+
+    return recorder;
+  }
+
+  test("a new monitor shows the span name, the time window and the span status, and folds the rest under More fields", () => {
+    renderForm();
+
+    expect(fieldLabel("Span Name")).toBeVisible();
+    expect(fieldLabel("Monitor Traces for (time)")).toBeVisible();
+    // Filtering on ERROR is how a trace monitor alerts on failures.
+    expect(fieldLabel("Filter by Span Status")).toBeVisible();
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(listedNames(moreFields())).toEqual([
+      "Filter by Telemetry Service",
+      "Filter by Infrastructure Entity",
+      "Filter by Attributes",
+    ]);
+    expect(setChips(moreFields())).toEqual([]);
+    expect(fieldLabel("Filter by Attributes")).not.toBeVisible();
+
+    expectNoOldAdvancedLink();
+  });
+
+  test("an edited monitor keeps More fields folded, its filters in force shown as chips", () => {
+    renderForm({
+      spanStatuses: [SpanStatus.Error],
+      telemetryServiceIds: [SERVICE_ID],
+      attributes: { "http.route": "/checkout" },
+    });
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(setChips(moreFields())).toEqual([
+      "Filter by Telemetry Service: 1",
+      "Filter by Attributes: 1",
+    ]);
+    expect(mockPreviews.traces[mockPreviews.traces.length - 1]).toMatchObject({
+      spanStatuses: [SpanStatus.Error],
+      telemetryServiceIds: [SERVICE_ID],
+      attributes: { "http.route": "/checkout" },
+    });
+  });
+
+  test("a filter picked under More fields reaches the step with the others", () => {
+    const recorder: Recorder = renderForm({ spanName: "POST /checkout" });
+
+    fireEvent.click(moreFields());
+    pick(
+      comboboxOf("Filter by Infrastructure Entity"),
+      "checkout-7d9f (k8s.pod)",
+    );
+
+    expect(recorder.latest).toMatchObject({
+      spanName: "POST /checkout",
+      entityKeys: [ENTITY_KEY],
+    });
+
+    fireEvent.click(moreFields());
+
+    expect(setChips(moreFields())).toEqual([
+      "Filter by Infrastructure Entity: 1",
+    ]);
+  });
+});
+
+describe("Exception monitor filters", () => {
+  interface Recorder {
+    latest: MonitorStepExceptionMonitor | null;
+  }
+
+  // As MonitorStep does: every change handed back as a new object.
+  const Harness: React.FunctionComponent<{
+    recorder: Recorder;
+    initial: MonitorStepExceptionMonitor;
+  }> = (props: {
+    recorder: Recorder;
+    initial: MonitorStepExceptionMonitor;
+  }): ReactElement => {
+    const [exceptionMonitor, setExceptionMonitor] =
+      React.useState<MonitorStepExceptionMonitor>(props.initial);
+
+    return (
+      <ExceptionMonitorStepForm
+        monitorStepExceptionMonitor={exceptionMonitor}
+        onMonitorStepExceptionMonitorChanged={(
+          value: MonitorStepExceptionMonitor,
+        ) => {
+          props.recorder.latest = value;
+          setExceptionMonitor(value);
+        }}
+        telemetryServices={services()}
+        telemetryEntities={entities()}
+      />
+    );
+  };
+
+  function renderForm(
+    initial: Partial<MonitorStepExceptionMonitor> = {},
+  ): Recorder {
+    const recorder: Recorder = { latest: null };
+
+    render(
+      <Harness
+        recorder={recorder}
+        initial={{
+          ...MonitorStepExceptionMonitorUtil.getDefault(),
+          ...initial,
+        }}
+      />,
+    );
+
+    return recorder;
+  }
+
+  test("a new monitor shows the message, types, environments and time window, and folds the rest under More fields", () => {
+    renderForm();
+
+    expect(fieldLabel("Filter Exception Message")).toBeVisible();
+    expect(fieldLabel("Exception Types")).toBeVisible();
+    expect(fieldLabel("Environments")).toBeVisible();
+    expect(fieldLabel("Monitor exceptions for (time)")).toBeVisible();
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(listedNames(moreFields())).toEqual([
+      "Filter by Telemetry Service",
+      "Filter by Infrastructure Entity",
+      "Include Resolved Exceptions",
+      "Include Archived Exceptions",
+    ]);
+    expect(setChips(moreFields())).toEqual([]);
+    expect(fieldLabel("Filter by Telemetry Service")).not.toBeVisible();
+
+    expectNoOldAdvancedLink();
+  });
+
+  test("an edited monitor keeps More fields folded, its filters in force shown as chips", () => {
+    /*
+     * The old link opened by itself for any of these. Folded, the header
+     * still says each one is in force, and what it is set to.
+     */
+    renderForm({
+      telemetryServiceIds: [SERVICE_ID],
+      includeResolved: true,
+    });
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "false");
+    expect(setChips(moreFields())).toEqual([
+      "Filter by Telemetry Service: 1",
+      "Include Resolved Exceptions: On",
+    ]);
+
+    // The folded service filter still scopes the preview.
+    expect(
+      JSON.stringify(
+        mockPreviews.exceptions[mockPreviews.exceptions.length - 1]?.[
+          "primaryEntityId"
+        ],
+      ),
+    ).toContain(SERVICE_ID.toString());
+  });
+
+  test("a switch under More fields reaches the step with the other filters", () => {
+    const recorder: Recorder = renderForm({ exceptionTypes: ["TypeError"] });
+
+    fireEvent.click(moreFields());
+    fireEvent.click(
+      screen.getByRole("checkbox", { name: "Include Archived Exceptions" }),
+    );
+
+    expect(recorder.latest).toMatchObject({
+      exceptionTypes: ["TypeError"],
+      includeArchived: true,
+      includeResolved: false,
+    });
+
+    fireEvent.click(moreFields());
+
+    expect(setChips(moreFields())).toEqual(["Include Archived Exceptions: On"]);
+  });
+
+  test("typing in a filter above it no longer folds More fields again", () => {
+    /*
+     * The old link re-read "is anything advanced set?" every time the step
+     * came back from MonitorStep, so typing an exception type with it open
+     * and nothing in it set folded it shut under the cursor.
+     */
+    const recorder: Recorder = renderForm();
+
+    fireEvent.click(moreFields());
+
+    expect(moreFields()).toHaveAttribute("aria-expanded", "true");
+
+    fireEvent.change(
+      screen.getByPlaceholderText("TypeError, NullReferenceException"),
+      { target: { value: "TypeError" } },
+    );
+
+    expect(recorder.latest?.exceptionTypes).toEqual(["TypeError"]);
+    expect(moreFields()).toHaveAttribute("aria-expanded", "true");
+    expect(
+      screen.getByRole("checkbox", { name: "Include Resolved Exceptions" }),
+    ).toBeVisible();
+  });
+});

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

@@ -30,7 +30,9 @@ import getJestMockFunction, { MockFunction } from "../../MockType";
  *   - an eligible project on a Community bundle is pointed at the edition,
  *     never told to upgrade its plan;
  *   - the plugin gets each page's own model, record id, resource name and a
- *     DOM id prefix no other page uses;
+ *     DOM id prefix no other page uses, and the database's scope note (which
+ *     of its telemetry the retention covers; it used to be a banner above
+ *     the cards);
  *   - Settings > Telemetry keeps the project's default retention everywhere.
  *
  * The plugins come from a stand-in for src/Enterprise/Plugins; `null` means
@@ -179,7 +181,9 @@ jest.mock(
 
 import CephSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Ceph/View/Settings";
 import CloudSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Cloud/View/Settings";
-import DatabaseServerSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/Settings";
+import DatabaseServerSettings, {
+  DATABASE_RETENTION_SCOPE_NOTE,
+} from "../../../../App/FeatureSet/Dashboard/src/Pages/Database/View/Settings";
 import DockerSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Docker/View/Settings";
 import DockerSwarmSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/DockerSwarm/View/Settings";
 import HostSettings from "../../../../App/FeatureSet/Dashboard/src/Pages/Host/View/Settings";
@@ -234,6 +238,8 @@ interface ResourcePageCase {
   settingsKey: PageMap;
   resourceName: string;
   detailIdPrefix: string;
+  // Which of the resource's telemetry its retention covers, when not all.
+  scopeNote?: string | undefined;
 }
 
 /*
@@ -354,6 +360,7 @@ const RESOURCE_PAGES: Array<ResourcePageCase> = [
     settingsKey: PageMap.DATABASE_SERVER_VIEW_SETTINGS,
     resourceName: "database",
     detailIdPrefix: "database-server",
+    scopeNote: DATABASE_RETENTION_SCOPE_NOTE,
   },
 ];
 
@@ -580,6 +587,13 @@ describe.each(RESOURCE_PAGES)(
       expect(overrideReads()).toEqual([]);
       // The rest of the page is still there.
       expect(screen.getByTestId("archive-resource-card")).toBeInTheDocument();
+      // No banner above the retention: a scope note is the cards' to say.
+      expect(
+        screen.queryByText("Which telemetry this covers."),
+      ).not.toBeInTheDocument();
+      expect(
+        screen.queryByTestId("database-retention-scope-note"),
+      ).not.toBeInTheDocument();
     });
 
     test("on the Enterprise Edition: the plugin gets this page's model, record, name and id prefix", async () => {
@@ -605,6 +619,7 @@ describe.each(RESOURCE_PAGES)(
       expect(props.modelId.toString()).toBe(MODEL_ID.toString());
       expect(props.resourceName).toBe(pageCase.resourceName);
       expect(props.modelDetailIdPrefix).toBe(pageCase.detailIdPrefix);
+      expect(props.scopeNote).toBe(pageCase.scopeNote);
     });
 
     test("an Enterprise flag on a Community bundle points at the edition, not a plan", async () => {
@@ -645,6 +660,26 @@ describe.each(RESOURCE_PAGES)(
   },
 );
 
+describe("the database's scope note", () => {
+  test("is one whole note, English in the source, for the card to translate", () => {
+    expect(DATABASE_RETENTION_SCOPE_NOTE).toBe(
+      "This covers the engine metrics and logs the Database Agent or your OpenTelemetry Collector collects from it. The traces of the queries your applications send it belong to the calling services and follow their retention.",
+    );
+  });
+
+  test("only the database passes one", () => {
+    const withNotes: Array<string> = RESOURCE_PAGES.filter(
+      (pageCase: ResourcePageCase): boolean => {
+        return Boolean(pageCase.scopeNote);
+      },
+    ).map((pageCase: ResourcePageCase): string => {
+      return pageCase.name;
+    });
+
+    expect(withNotes).toEqual(["database"]);
+  });
+});
+
 describe("the resource pages together", () => {
   test("every page hands the plugin its own DOM id prefix", async () => {
     enterpriseEditionForTest = true;