@oneuptime/common 14.0.9 → 14.0.11

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

@@ -13,18 +13,22 @@ import getJestMockFunction, { MockFunction } from "../../MockType";
 
 /*
  * Who sees an enterprise feature and who sees its upsell - one tier-aware
- * rule, shared by the enterprise card and the audit log card.
+ * rule, shared by the enterprise card and the audit log card - and the
+ * plan-only rule for what every edition includes but OneUptime Cloud sells
+ * on a plan (single sign-on).
  *
  * OneUptime Cloud (billing on) compares the project's plan with the tier the
  * feature's model is sold at: Scale for SSO / OIDC / SCIM / team compliance,
  * Enterprise for audit logs. The Cloud runs the Enterprise image, so the
  * edition flag is always true there and must not be consulted. Self-hosted
- * (billing off) asks only whether this is the Enterprise Edition.
+ * (billing off), an enterprise feature (SCIM, team compliance, audit logs)
+ * asks whether this is the Enterprise Edition, and single sign-on asks
+ * nothing at all: every self-hosted install has it.
  *
  * Before this, both cards demanded the Enterprise plan: a Scale customer was
- * walled off from SSO their plan includes. And the edition flag was checked
- * first, which on an Enterprise-image Cloud would unlock everything for
- * every plan.
+ * walled off from features their plan includes. And the edition flag was
+ * checked first, which on an Enterprise-image Cloud would unlock everything
+ * for every plan.
  *
  * Both billing and the edition are pinned in every test: CI's config.env sets
  * BILLING_ENABLED=true, so anything left to the environment tests the Cloud
@@ -36,6 +40,7 @@ let enterpriseEditionForTest: boolean = false;
 let currentPlanForTest: string | null = null;
 let currentPlanThrows: boolean = false;
 let planEnvForTest: Record<string, string> = {};
+let editionReads: number = 0;
 
 // jsdom does not implement window.open; the call to action uses it.
 const openMock: MockFunction = getJestMockFunction();
@@ -64,6 +69,7 @@ jest.mock("../../../UI/Config", () => {
 
   Object.defineProperty(mocked, "IS_ENTERPRISE_EDITION", {
     get: (): boolean => {
+      editionReads += 1;
       return enterpriseEditionForTest;
     },
   });
@@ -109,10 +115,18 @@ import AuditLogsEnterpriseUpgrade, {
 import {
   AUDIT_LOGS_REQUIRED_PLAN,
   IDENTITY_REQUIRED_PLAN,
+  SSO_REQUIRED_PLAN,
   getCurrentPlanOrNull,
   isEnterpriseFeatureEligible,
   isPlanAtLeast,
+  isPlanFeatureEligible,
 } from "../../../../App/FeatureSet/Dashboard/src/Enterprise/EnterpriseEligibility";
+import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
+import Project from "../../../Models/DatabaseModels/Project";
+import ProjectOIDC from "../../../Models/DatabaseModels/ProjectOidc";
+import ProjectSSO from "../../../Models/DatabaseModels/ProjectSso";
+import StatusPageOIDC from "../../../Models/DatabaseModels/StatusPageOidc";
+import StatusPageSSO from "../../../Models/DatabaseModels/StatusPageSso";
 import { PlanType } from "../../../Types/Billing/SubscriptionPlan";
 import IconProp from "../../../Types/Icon/IconProp";
 
@@ -135,6 +149,7 @@ beforeEach(() => {
   currentPlanForTest = null;
   currentPlanThrows = false;
   planEnvForTest = CLOUD_PLAN_ENV;
+  editionReads = 0;
   openMock.mockReset();
   window.open = openMock as unknown as typeof window.open;
 });
@@ -147,8 +162,127 @@ afterEach(() => {
 describe("which plan each enterprise feature needs", () => {
   test("SSO, OIDC, SCIM and compliance are Scale; audit logs are Enterprise", () => {
     expect(IDENTITY_REQUIRED_PLAN).toBe(PlanType.Scale);
+    expect(SSO_REQUIRED_PLAN).toBe(PlanType.Scale);
     expect(AUDIT_LOGS_REQUIRED_PLAN).toBe(PlanType.Enterprise);
   });
+
+  test.each([
+    ["ProjectSso", ProjectSSO],
+    ["ProjectOidc", ProjectOIDC],
+    ["StatusPageSso", StatusPageSSO],
+    ["StatusPageOidc", StatusPageOIDC],
+  ])(
+    "single sign-on's plan is what %s is billed at, so the upsell never contradicts the server",
+    (_name: string, modelType: { new (): BaseModel }) => {
+      const model: BaseModel = new modelType();
+
+      expect(model.getCreateBillingPlan()).toBe(SSO_REQUIRED_PLAN);
+      expect(model.getReadBillingPlan()).toBe(SSO_REQUIRED_PLAN);
+      expect(model.getUpdateBillingPlan()).toBe(SSO_REQUIRED_PLAN);
+      expect(model.getDeleteBillingPlan()).toBe(SSO_REQUIRED_PLAN);
+    },
+  );
+
+  test('"Force SSO for Login" on a project is changed on the same plan', () => {
+    expect(
+      new Project().getColumnBillingAccessControl("requireSsoForLogin").update,
+    ).toBe(SSO_REQUIRED_PLAN);
+  });
+});
+
+describe("isPlanFeatureEligible (what every edition includes, sold on a plan on the Cloud)", () => {
+  test.each([
+    ["the Community Edition", "self-hosted-community"],
+    ["the Enterprise Edition", "self-hosted-enterprise"],
+  ])(
+    "self-hosted, %s is eligible for every plan, without reading the edition",
+    (_edition: string, deployment: string) => {
+      pinDeployment(deployment as Deployment);
+
+      expect(isPlanFeatureEligible(PlanType.Scale)).toBe(true);
+      expect(isPlanFeatureEligible(PlanType.Enterprise)).toBe(true);
+      expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(true);
+      expect(editionReads).toBe(0);
+    },
+  );
+
+  test("self-hosted, it does not even ask for the plan (none is configured there)", () => {
+    pinDeployment("self-hosted-community");
+    currentPlanThrows = true;
+
+    expect(isPlanFeatureEligible(PlanType.Scale)).toBe(true);
+  });
+
+  test("self-hosted Community: eligible here, where the enterprise rule would say no", () => {
+    pinDeployment("self-hosted-community");
+
+    expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(true);
+    expect(isEnterpriseFeatureEligible(SSO_REQUIRED_PLAN)).toBe(false);
+  });
+
+  describe("on OneUptime Cloud", () => {
+    beforeEach(() => {
+      pinDeployment("cloud");
+    });
+
+    test.each([
+      [PlanType.Free, false],
+      [PlanType.Growth, false],
+      [PlanType.Scale, true],
+      [PlanType.Enterprise, true],
+    ])(
+      "a %s project gets single sign-on: %s",
+      (plan: PlanType, expected: boolean) => {
+        currentPlanForTest = plan;
+
+        expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(expected);
+      },
+    );
+
+    test.each([
+      [PlanType.Growth, false],
+      [PlanType.Scale, false],
+      [PlanType.Enterprise, true],
+    ])(
+      "a %s project gets an Enterprise-plan feature: %s",
+      (plan: PlanType, expected: boolean) => {
+        currentPlanForTest = plan;
+
+        expect(isPlanFeatureEligible(PlanType.Enterprise)).toBe(expected);
+      },
+    );
+
+    test("no plan, or one the Dashboard cannot read, fails closed", () => {
+      currentPlanForTest = null;
+      expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(false);
+
+      currentPlanThrows = true;
+      expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(false);
+    });
+
+    test("never falls back to the edition flag - the Cloud runs the Enterprise image", () => {
+      enterpriseEditionForTest = true;
+      currentPlanForTest = PlanType.Free;
+
+      expect(isPlanFeatureEligible(SSO_REQUIRED_PLAN)).toBe(false);
+      expect(editionReads).toBe(0);
+    });
+
+    test("agrees with the enterprise rule on the Cloud, where only the plan ever counted", () => {
+      for (const plan of [
+        PlanType.Free,
+        PlanType.Growth,
+        PlanType.Scale,
+        PlanType.Enterprise,
+      ]) {
+        currentPlanForTest = plan;
+
+        expect(isPlanFeatureEligible(PlanType.Scale)).toBe(
+          isEnterpriseFeatureEligible(PlanType.Scale),
+        );
+      }
+    });
+  });
 });
 
 describe("isPlanAtLeast", () => {
@@ -336,7 +470,7 @@ describe("the upsell wording (getEnterpriseUpgradeCopy)", () => {
 
   test("points at the Enterprise Edition when the plan is not the problem", () => {
     const copy: EnterpriseUpgradeCopy = getEnterpriseUpgradeCopy({
-      featureName: "OIDC",
+      featureName: "SCIM",
       requiredPlan: PlanType.Scale,
       reason: EnterpriseUpgradeReason.Edition,
     });
@@ -349,7 +483,7 @@ describe("the upsell wording (getEnterpriseUpgradeCopy)", () => {
       "https://oneuptime.com/docs/self-hosted/enterprise",
     );
     expect(copy.pitchLine).toBe(
-      "OIDC is a OneUptime Enterprise Edition feature. Switch to the Enterprise Edition build to enable it.",
+      "SCIM is a OneUptime Enterprise Edition feature. Switch to the Enterprise Edition build to enable it.",
     );
     // Never a plan upgrade.
     expect(copy.pitchLine).not.toContain("plan");

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

@@ -19,7 +19,7 @@ import React, {
  * The Dashboard's Enterprise plugin door and the component every enterprise
  * shell renders.
  *
- * A shell (Settings > SSO, the audit log table, ...) stays at its original
+ * A shell (Settings > SCIM, the audit log table, ...) stays at its original
  * path in core and renders <EnterprisePluginPage>: the ee plugin when the
  * project may use the feature AND this bundle includes it, the upsell card
  * otherwise. The plugins come from getDashboardPlugins(), which in every
@@ -117,7 +117,7 @@ const pinDeployment: (deployment: Deployment) => void = (
 };
 
 const PAGE_PROPS: PageComponentProps = {
-  pageRoute: new Route("/dashboard/project-id/settings/sso"),
+  pageRoute: new Route("/dashboard/project-id/settings/scim"),
   currentProject: null,
   hasPaymentMethod: true,
 };
@@ -128,23 +128,23 @@ const UPSELL: {
   featureName: string;
   benefits: Array<{ icon: IconProp; title: string; subtitle: string }>;
 } = {
-  title: "Single Sign On (SSO)",
-  description: "Configure SAML SSO for your project.",
-  featureName: "SAML Single Sign On",
+  title: "SCIM",
+  description: "Automate user provisioning via SCIM.",
+  featureName: "SCIM User Provisioning",
   benefits: [
     {
-      icon: IconProp.Lock,
-      title: "Centralized auth",
-      subtitle: "Revoke access from one place.",
+      icon: IconProp.User,
+      title: "Automatic provisioning",
+      subtitle: "Users created in your IdP are added without manual invites.",
     },
   ],
 };
 
-const FakeSSOPage: FunctionComponent<PageComponentProps> = (
+const FakeSCIMPage: FunctionComponent<PageComponentProps> = (
   props: PageComponentProps,
 ): ReactElement => {
   return (
-    <div data-testid="fake-sso-plugin">
+    <div data-testid="fake-scim-plugin">
       {props.pageRoute.toString()}|{String(props.hasPaymentMethod)}
     </div>
   );
@@ -173,7 +173,7 @@ const makeLazyPlugin: (
         });
       }
 
-      return { default: FakeSSOPage };
+      return { default: FakeSCIMPage };
     },
   );
 };
@@ -214,17 +214,19 @@ describe("EnterprisePluginPage", () => {
 
     render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={IDENTITY_REQUIRED_PLAN}
         upsell={UPSELL}
       />,
     );
 
-    expect(screen.getByTestId("fake-sso-plugin")).toHaveTextContent(
-      "/dashboard/project-id/settings/sso|true",
+    expect(screen.getByTestId("fake-scim-plugin")).toHaveTextContent(
+      "/dashboard/project-id/settings/scim|true",
     );
-    expect(screen.queryByText("SAML Single Sign On")).not.toBeInTheDocument();
+    expect(
+      screen.queryByText("SCIM User Provisioning"),
+    ).not.toBeInTheDocument();
   });
 
   test("shows the plan upsell, and never downloads the plugin, below the tier", () => {
@@ -241,8 +243,8 @@ describe("EnterprisePluginPage", () => {
     );
 
     expect(screen.getAllByText("Upgrade to Scale")).toHaveLength(2);
-    expect(screen.getByText("SAML Single Sign On")).toBeInTheDocument();
-    expect(screen.queryByTestId("fake-sso-plugin")).not.toBeInTheDocument();
+    expect(screen.getByText("SCIM User Provisioning")).toBeInTheDocument();
+    expect(screen.queryByTestId("fake-scim-plugin")).not.toBeInTheDocument();
     expect(lazyLoads).toBe(0);
   });
 
@@ -252,7 +254,7 @@ describe("EnterprisePluginPage", () => {
 
     render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={AUDIT_LOGS_REQUIRED_PLAN}
         upsell={UPSELL}
@@ -260,7 +262,7 @@ describe("EnterprisePluginPage", () => {
     );
 
     expect(screen.getAllByText("Upgrade to Enterprise")).toHaveLength(2);
-    expect(screen.queryByTestId("fake-sso-plugin")).not.toBeInTheDocument();
+    expect(screen.queryByTestId("fake-scim-plugin")).not.toBeInTheDocument();
   });
 
   test("an eligible Cloud project on a Community bundle is pointed at the edition, never told to upgrade", () => {
@@ -287,14 +289,14 @@ describe("EnterprisePluginPage", () => {
 
     render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={AUDIT_LOGS_REQUIRED_PLAN}
         upsell={UPSELL}
       />,
     );
 
-    expect(screen.getByTestId("fake-sso-plugin")).toBeInTheDocument();
+    expect(screen.getByTestId("fake-scim-plugin")).toBeInTheDocument();
   });
 
   test("self-hosted Community Edition shows the edition upsell, plugin or not", () => {
@@ -302,7 +304,7 @@ describe("EnterprisePluginPage", () => {
 
     render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={IDENTITY_REQUIRED_PLAN}
         upsell={UPSELL}
@@ -312,7 +314,7 @@ describe("EnterprisePluginPage", () => {
     expect(screen.getAllByText("Learn about Enterprise Edition")).toHaveLength(
       2,
     );
-    expect(screen.queryByTestId("fake-sso-plugin")).not.toBeInTheDocument();
+    expect(screen.queryByTestId("fake-scim-plugin")).not.toBeInTheDocument();
   });
 
   test("self-hosted Enterprise Edition on a Community bundle shows the edition upsell", () => {
@@ -345,13 +347,13 @@ describe("EnterprisePluginPage", () => {
     );
 
     expect(await screen.findByTestId("component-loader")).toBeInTheDocument();
-    expect(screen.queryByTestId("fake-sso-plugin")).not.toBeInTheDocument();
+    expect(screen.queryByTestId("fake-scim-plugin")).not.toBeInTheDocument();
 
     await act(async () => {
       releaseLazyPlugin?.();
     });
 
-    expect(await screen.findByTestId("fake-sso-plugin")).toBeInTheDocument();
+    expect(await screen.findByTestId("fake-scim-plugin")).toBeInTheDocument();
     expect(screen.queryByTestId("component-loader")).not.toBeInTheDocument();
     expect(lazyLoads).toBe(1);
   });
@@ -376,7 +378,7 @@ describe("EnterprisePluginPage", () => {
       releaseLazyPlugin?.();
     });
 
-    expect(await screen.findByTestId("fake-sso-plugin")).toBeInTheDocument();
+    expect(await screen.findByTestId("fake-scim-plugin")).toBeInTheDocument();
   });
 
   test("isEligible overrides the plan and edition check, both ways", () => {
@@ -385,28 +387,28 @@ describe("EnterprisePluginPage", () => {
 
     const { unmount } = render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={IDENTITY_REQUIRED_PLAN}
         upsell={UPSELL}
         isEligible={true}
       />,
     );
-    expect(screen.getByTestId("fake-sso-plugin")).toBeInTheDocument();
+    expect(screen.getByTestId("fake-scim-plugin")).toBeInTheDocument();
     unmount();
 
     pinDeployment("self-hosted-enterprise");
     render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={IDENTITY_REQUIRED_PLAN}
         upsell={UPSELL}
         isEligible={false}
       />,
     );
-    expect(screen.queryByTestId("fake-sso-plugin")).not.toBeInTheDocument();
-    expect(screen.getByText("SAML Single Sign On")).toBeInTheDocument();
+    expect(screen.queryByTestId("fake-scim-plugin")).not.toBeInTheDocument();
+    expect(screen.getByText("SCIM User Provisioning")).toBeInTheDocument();
   });
 
   test("renderUpsell replaces the card and is told why it is showing", () => {
@@ -430,7 +432,7 @@ describe("EnterprisePluginPage", () => {
     currentPlanForTest = PlanType.Scale;
     const { unmount } = render(
       <EnterprisePluginPage
-        plugin={FakeSSOPage}
+        plugin={FakeSCIMPage}
         pluginProps={PAGE_PROPS}
         requiredPlan={AUDIT_LOGS_REQUIRED_PLAN}
         renderUpsell={renderAuditUpsell}
@@ -572,13 +574,11 @@ describe("the Community plugin door (what this jest config resolves)", () => {
       [
         "AuditLogsTable",
         "SettingsAuditLogsSettings",
-        "SettingsOIDC",
         "SettingsSCIM",
-        "SettingsSSO",
-        "StatusPageOIDC",
         "StatusPageSCIM",
-        "StatusPageSSO",
         "TeamCompliance",
+        "SettingsTelemetryRetentionByType",
+        "TelemetryResourceRetentionSettings",
         "LicenseManager",
       ].sort(),
     );
@@ -591,13 +591,26 @@ describe("the Community plugin door (what this jest config resolves)", () => {
     );
   });
 
+  test("has no key for the single sign-on screens: they are core in every edition", () => {
+    for (const retiredKey of [
+      "SettingsSSO",
+      "SettingsOIDC",
+      "StatusPageSSO",
+      "StatusPageOIDC",
+    ]) {
+      expect(
+        DASHBOARD_ENTERPRISE_PLUGIN_KEYS as ReadonlyArray<string>,
+      ).not.toContain(retiredKey);
+    }
+  });
+
   test("a shell reading the real door on a Community build shows the upsell even when eligible", () => {
     pinDeployment("cloud");
     currentPlanForTest = PlanType.Enterprise;
 
     render(
       <EnterprisePluginPage
-        plugin={getDashboardPlugins().SettingsSSO}
+        plugin={getDashboardPlugins().SettingsSCIM}
         pluginProps={PAGE_PROPS}
         requiredPlan={IDENTITY_REQUIRED_PLAN}
         upsell={UPSELL}
@@ -627,7 +640,7 @@ describe("the plugin door with other plugin modules", () => {
   test("hands back the Enterprise plugin object as is", async () => {
     const enterprisePlugins: DashboardEnterprisePlugins = {
       buildMarker: "ONEUPTIME_EE_DASHBOARD_PLUGIN_v1",
-      SettingsSSO: FakeSSOPage,
+      SettingsSCIM: FakeSCIMPage,
     };
 
     jest.doMock("@oneuptime/ee-dashboard", () => {
@@ -640,7 +653,7 @@ describe("the plugin door with other plugin modules", () => {
       );
 
     expect(door.getDashboardPlugins()).toBe(enterprisePlugins);
-    expect(door.getDashboardPlugins().SettingsSSO).toBe(FakeSSOPage);
+    expect(door.getDashboardPlugins().SettingsSCIM).toBe(FakeSCIMPage);
   });
 
   test("fails loudly, naming the rule, when read before the plugin module finished loading", async () => {

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

@@ -2894,7 +2894,13 @@ describe("alert-only behaviour", () => {
       expect(within(grid).getByTestId("monitor-element")).toHaveTextContent(
         "Developer portal",
       );
-      expect(within(view.container).getByText("1 resource")).toBeVisible();
+      // One category counts itself in its heading; no total line above it.
+      expect(
+        within(grid).getByRole("heading", { level: 3, name: "Monitors 1" }),
+      ).toBeVisible();
+      expect(
+        within(view.container).queryByTestId("affected-resources-summary"),
+      ).toBeNull();
     });
 
     test("shows both the monitor and an SLO, the monitor first", () => {