@oneuptime/common 13.0.8 → 14.0.0

package/Tests/Server/Enterprise/EnterpriseLicenseSnapshot.test.ts

@@ -0,0 +1,294 @@
+import { describe, expect, test } from "@jest/globals";
+import EnterpriseFeature, {
+  ALL_ENTERPRISE_FEATURES,
+  ENTERPRISE_FEATURE_WILDCARD,
+  parseEnterpriseFeature,
+} from "../../../Server/Enterprise/EnterpriseFeature";
+import {
+  ENTERPRISE_LICENSE_GRACE_PERIOD_IN_DAYS,
+  ENTERPRISE_LICENSE_TRIAL_PERIOD_IN_DAYS,
+  EnterpriseLicenseSnapshot,
+  EnterpriseLicenseSnapshotUtil,
+  EnterpriseLicenseStatus,
+} from "../../../Server/Enterprise/EnterpriseLicenseSnapshot";
+import {
+  createLicenseSnapshot,
+  createLicenseSnapshotWithStatus,
+} from "./FakeEnterpriseModule";
+
+describe("EnterpriseFeature", () => {
+  test("the license claim values are the documented strings", () => {
+    /*
+     * These strings are part of every issued license. Changing one silently
+     * revokes that feature from licenses already in the field.
+     */
+    expect(EnterpriseFeature.SSO).toBe("sso");
+    expect(EnterpriseFeature.SCIM).toBe("scim");
+    expect(EnterpriseFeature.TeamCompliance).toBe("team-compliance");
+    expect(EnterpriseFeature.AuditLogs).toBe("audit-logs");
+    expect(EnterpriseFeature.InstanceHealth).toBe("instance-health");
+    expect(ENTERPRISE_FEATURE_WILDCARD).toBe("*");
+  });
+
+  test("ALL_ENTERPRISE_FEATURES lists every feature exactly once", () => {
+    expect([...ALL_ENTERPRISE_FEATURES].sort()).toEqual(
+      [
+        "audit-logs",
+        "instance-health",
+        "scim",
+        "sso",
+        "team-compliance",
+      ].sort(),
+    );
+    expect(new Set(ALL_ENTERPRISE_FEATURES).size).toBe(
+      ALL_ENTERPRISE_FEATURES.length,
+    );
+  });
+
+  test.each(
+    ALL_ENTERPRISE_FEATURES.map((feature: EnterpriseFeature) => {
+      return [feature];
+    }),
+  )("parseEnterpriseFeature accepts %s", (feature: EnterpriseFeature) => {
+    expect(parseEnterpriseFeature(feature)).toBe(feature);
+  });
+
+  test.each([
+    "*",
+    "SSO",
+    " sso",
+    "sso ",
+    "future-feature",
+    "",
+    null,
+    undefined,
+    7,
+    ["sso"],
+    { feature: "sso" },
+  ] as Array<unknown>)(
+    "parseEnterpriseFeature rejects %p without throwing",
+    (value: unknown) => {
+      expect(parseEnterpriseFeature(value)).toBeNull();
+    },
+  );
+});
+
+describe("EnterpriseLicenseSnapshotUtil", () => {
+  /*
+   * Two periods, two lengths (the owner's decision): 30 days of grace after a
+   * license expires, and a 14-day trial for an Enterprise install that never
+   * had a license.
+   */
+  test("the grace period after a license expires is thirty days", () => {
+    expect(ENTERPRISE_LICENSE_GRACE_PERIOD_IN_DAYS).toBe(30);
+  });
+
+  test("the trial of an install with no license is fourteen days", () => {
+    expect(ENTERPRISE_LICENSE_TRIAL_PERIOD_IN_DAYS).toBe(14);
+  });
+
+  test("the server reads the same constants the browser copy derives from", () => {
+    // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
+    const periods: typeof import("../../../Types/EnterpriseLicense/EnterpriseLicensePeriods") = require("../../../Types/EnterpriseLicense/EnterpriseLicensePeriods");
+
+    expect(ENTERPRISE_LICENSE_GRACE_PERIOD_IN_DAYS).toBe(
+      periods.ENTERPRISE_LICENSE_GRACE_PERIOD_IN_DAYS,
+    );
+    expect(ENTERPRISE_LICENSE_TRIAL_PERIOD_IN_DAYS).toBe(
+      periods.ENTERPRISE_LICENSE_TRIAL_PERIOD_IN_DAYS,
+    );
+  });
+
+  test.each([
+    ["valid", true],
+    ["grace", true],
+    ["missing", false],
+    ["expired", false],
+    ["invalid", false],
+  ] as Array<[EnterpriseLicenseStatus, boolean]>)(
+    "a %s license is usable: %s",
+    (status: EnterpriseLicenseStatus, usable: boolean) => {
+      expect(
+        EnterpriseLicenseSnapshotUtil.isUsable(
+          createLicenseSnapshotWithStatus(status),
+        ),
+      ).toBe(usable);
+    },
+  );
+
+  test("no snapshot is not usable and includes nothing", () => {
+    expect(EnterpriseLicenseSnapshotUtil.isUsable(null)).toBe(false);
+    expect(
+      EnterpriseLicenseSnapshotUtil.includesFeature(
+        null,
+        EnterpriseFeature.SSO,
+      ),
+    ).toBe(false);
+    expect(
+      EnterpriseLicenseSnapshotUtil.entitles(null, EnterpriseFeature.SSO),
+    ).toBe(false);
+  });
+
+  test("an 'all' license includes every feature", () => {
+    const snapshot: EnterpriseLicenseSnapshot = createLicenseSnapshot({
+      features: "all",
+    });
+
+    for (const feature of ALL_ENTERPRISE_FEATURES) {
+      expect(
+        EnterpriseLicenseSnapshotUtil.includesFeature(snapshot, feature),
+      ).toBe(true);
+    }
+  });
+
+  test("a subset license includes only its features", () => {
+    const snapshot: EnterpriseLicenseSnapshot = createLicenseSnapshot({
+      features: [EnterpriseFeature.SSO, EnterpriseFeature.AuditLogs],
+    });
+
+    expect(
+      EnterpriseLicenseSnapshotUtil.includesFeature(
+        snapshot,
+        EnterpriseFeature.SSO,
+      ),
+    ).toBe(true);
+    expect(
+      EnterpriseLicenseSnapshotUtil.includesFeature(
+        snapshot,
+        EnterpriseFeature.AuditLogs,
+      ),
+    ).toBe(true);
+    expect(
+      EnterpriseLicenseSnapshotUtil.includesFeature(
+        snapshot,
+        EnterpriseFeature.SCIM,
+      ),
+    ).toBe(false);
+  });
+
+  test("an empty or malformed features value includes nothing", () => {
+    for (const features of [
+      [],
+      "everything",
+      undefined,
+      null,
+    ] as Array<unknown>) {
+      const snapshot: EnterpriseLicenseSnapshot = createLicenseSnapshot({
+        features: features as EnterpriseLicenseSnapshot["features"],
+      });
+
+      expect(
+        EnterpriseLicenseSnapshotUtil.includesFeature(
+          snapshot,
+          EnterpriseFeature.SSO,
+        ),
+      ).toBe(false);
+    }
+  });
+
+  test("entitles needs both a usable status and the feature", () => {
+    expect(
+      EnterpriseLicenseSnapshotUtil.entitles(
+        createLicenseSnapshotWithStatus("grace", {
+          features: [EnterpriseFeature.SCIM],
+        }),
+        EnterpriseFeature.SCIM,
+      ),
+    ).toBe(true);
+    expect(
+      EnterpriseLicenseSnapshotUtil.entitles(
+        createLicenseSnapshotWithStatus("expired", { features: "all" }),
+        EnterpriseFeature.SCIM,
+      ),
+    ).toBe(false);
+    expect(
+      EnterpriseLicenseSnapshotUtil.entitles(
+        createLicenseSnapshotWithStatus("valid", {
+          features: [EnterpriseFeature.SSO],
+        }),
+        EnterpriseFeature.SCIM,
+      ),
+    ).toBe(false);
+  });
+
+  test("createMissing is an unverified-nothing snapshot with a message", () => {
+    const snapshot: EnterpriseLicenseSnapshot =
+      EnterpriseLicenseSnapshotUtil.createMissing();
+
+    expect(snapshot).toEqual({
+      status: "missing",
+      verification: "none",
+      userLimit: null,
+      isEvaluation: false,
+      features: [],
+      message: "No OneUptime Enterprise license is installed.",
+    });
+    expect(EnterpriseLicenseSnapshotUtil.isUsable(snapshot)).toBe(false);
+    expect(EnterpriseLicenseSnapshotUtil.createMissing("custom").message).toBe(
+      "custom",
+    );
+  });
+
+  describe("isTrialStartUnknown", () => {
+    test("is true only for 'missing' with no graceEndsAt", () => {
+      expect(
+        EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(
+          createLicenseSnapshotWithStatus("missing", {
+            graceEndsAt: undefined,
+          }),
+        ),
+      ).toBe(true);
+      // What the provider answers when nothing could be read at all.
+      expect(
+        EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(
+          EnterpriseLicenseSnapshotUtil.createMissing(),
+        ),
+      ).toBe(true);
+    });
+
+    test("a trial that is known to be over is not unknown", () => {
+      expect(
+        EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(
+          createLicenseSnapshotWithStatus("missing", {
+            graceEndsAt: new Date(Date.now() - 1000),
+          }),
+        ),
+      ).toBe(false);
+      // The test kit's "missing" is the known lapse.
+      expect(
+        EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(
+          createLicenseSnapshotWithStatus("missing"),
+        ),
+      ).toBe(false);
+    });
+
+    test("every other status, and no snapshot, is not about the trial start", () => {
+      for (const status of [
+        "valid",
+        "grace",
+        "expired",
+        "invalid",
+      ] as Array<EnterpriseLicenseStatus>) {
+        expect(
+          EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(
+            createLicenseSnapshotWithStatus(status, { graceEndsAt: undefined }),
+          ),
+        ).toBe(false);
+      }
+
+      expect(EnterpriseLicenseSnapshotUtil.isTrialStartUnknown(null)).toBe(
+        false,
+      );
+    });
+  });
+
+  test("createMissing returns a fresh object each time", () => {
+    const first: EnterpriseLicenseSnapshot =
+      EnterpriseLicenseSnapshotUtil.createMissing();
+    const second: EnterpriseLicenseSnapshot =
+      EnterpriseLicenseSnapshotUtil.createMissing();
+
+    expect(first).not.toBe(second);
+    expect(first.features).not.toBe(second.features);
+  });
+});

package/Tests/Server/Enterprise/EnterpriseModelFeatureMap.test.ts

@@ -0,0 +1,93 @@
+import { describe, expect, test } from "@jest/globals";
+import AllModelTypes from "../../../Models/DatabaseModels/Index";
+import BaseModel from "../../../Models/DatabaseModels/DatabaseBaseModel/DatabaseBaseModel";
+import GlobalOIDC from "../../../Models/DatabaseModels/GlobalOidc";
+import GlobalOIDCProject from "../../../Models/DatabaseModels/GlobalOidcProject";
+import GlobalSSO from "../../../Models/DatabaseModels/GlobalSso";
+import GlobalSSOProject from "../../../Models/DatabaseModels/GlobalSsoProject";
+import ProjectOIDC from "../../../Models/DatabaseModels/ProjectOidc";
+import ProjectSCIM from "../../../Models/DatabaseModels/ProjectSCIM";
+import ProjectSSO from "../../../Models/DatabaseModels/ProjectSso";
+import StatusPageOIDC from "../../../Models/DatabaseModels/StatusPageOidc";
+import StatusPageSCIM from "../../../Models/DatabaseModels/StatusPageSCIM";
+import StatusPageSSO from "../../../Models/DatabaseModels/StatusPageSso";
+import TeamComplianceSetting from "../../../Models/DatabaseModels/TeamComplianceSetting";
+import Project from "../../../Models/DatabaseModels/Project";
+import Monitor from "../../../Models/DatabaseModels/Monitor";
+import EnterpriseEdition from "../../../Server/Enterprise/EnterpriseEdition";
+import EnterpriseFeature from "../../../Server/Enterprise/EnterpriseFeature";
+
+type ModelType = { new (): BaseModel };
+
+/*
+ * The facade owns the model -> feature map so the eleven model files stay
+ * unchanged. These guards keep that map and the models'
+ * @TableEditionAccessControl({ requiresEnterprise: true }) decorators from
+ * drifting apart: a new enterprise model with no feature would otherwise be
+ * gated by nothing, or by the wrong license feature.
+ */
+describe("EnterpriseEdition.getModelFeature against the real models", () => {
+  test.each([
+    [GlobalSSO, EnterpriseFeature.SSO],
+    [GlobalOIDC, EnterpriseFeature.SSO],
+    [GlobalSSOProject, EnterpriseFeature.SSO],
+    [GlobalOIDCProject, EnterpriseFeature.SSO],
+    [ProjectSSO, EnterpriseFeature.SSO],
+    [ProjectOIDC, EnterpriseFeature.SSO],
+    [StatusPageSSO, EnterpriseFeature.SSO],
+    [StatusPageOIDC, EnterpriseFeature.SSO],
+    [ProjectSCIM, EnterpriseFeature.SCIM],
+    [StatusPageSCIM, EnterpriseFeature.SCIM],
+    [TeamComplianceSetting, EnterpriseFeature.TeamCompliance],
+  ] as Array<[ModelType, EnterpriseFeature]>)(
+    "%p is gated by the expected feature",
+    (modelType: ModelType, feature: EnterpriseFeature) => {
+      expect(EnterpriseEdition.getModelFeature(modelType)).toBe(feature);
+      expect(new modelType().requiresEnterprise).toBe(true);
+    },
+  );
+
+  test("ordinary models map to no feature", () => {
+    expect(EnterpriseEdition.getModelFeature(Project)).toBeNull();
+    expect(EnterpriseEdition.getModelFeature(Monitor)).toBeNull();
+  });
+
+  test("every model marked requiresEnterprise has a feature", () => {
+    const unmapped: Array<string> = [];
+
+    for (const modelType of AllModelTypes as Array<ModelType>) {
+      const model: BaseModel = new modelType();
+
+      if (!model.requiresEnterprise) {
+        continue;
+      }
+
+      if (!EnterpriseEdition.getModelFeature(modelType)) {
+        unmapped.push(model.tableName || modelType.name);
+      }
+    }
+
+    expect(unmapped).toEqual([]);
+  });
+
+  test("every mapped table belongs to a registered model marked requiresEnterprise", () => {
+    const enterpriseTables: Set<string> = new Set<string>();
+
+    for (const modelType of AllModelTypes as Array<ModelType>) {
+      const model: BaseModel = new modelType();
+
+      if (model.requiresEnterprise && model.tableName) {
+        enterpriseTables.add(model.tableName);
+      }
+    }
+
+    expect(
+      EnterpriseEdition.getMappedTableNames().filter((tableName: string) => {
+        return !enterpriseTables.has(tableName);
+      }),
+    ).toEqual([]);
+    expect(enterpriseTables.size).toBe(
+      EnterpriseEdition.getMappedTableNames().length,
+    );
+  });
+});