187 lines
6.3 KiB
TypeScript
187 lines
6.3 KiB
TypeScript
import { describe, expect, it, vi } from "vitest";
|
|
import { DefaultFeatures } from "~/application/dtos/shared/DefaultFeatures";
|
|
import {
|
|
evaluateOnboardingStepGates,
|
|
getOnboardingStepDiagnostics,
|
|
getVisibleOnboardingSteps,
|
|
type OnboardingStepGateDiagnostic,
|
|
} from "./gating.server";
|
|
import type { OnboardingRegisteredStepDefinition } from "./registry.server";
|
|
|
|
const request = new Request("https://app.example.com/acme/onboarding?tenantId=tenant_123&token=secret-token");
|
|
const params = { tenant: "acme", tenantId: "tenant_123" };
|
|
const profileStep = {
|
|
id: "profile-basics",
|
|
title: "Profile basics",
|
|
description: "Ungated profile setup",
|
|
} as const satisfies OnboardingRegisteredStepDefinition;
|
|
const featureStep = {
|
|
id: "team-invites",
|
|
title: "Team invites",
|
|
description: "Feature gated team invites",
|
|
featureFlagKey: "workspace-roles",
|
|
} as const satisfies OnboardingRegisteredStepDefinition;
|
|
const planStep = {
|
|
id: "priority-support-setup",
|
|
title: "Priority support setup",
|
|
description: "Plan gated priority support",
|
|
planFeatureKey: DefaultFeatures.PrioritySupport,
|
|
} as const satisfies OnboardingRegisteredStepDefinition;
|
|
|
|
function entitlementService(allowed: boolean) {
|
|
return vi.fn(() => ({
|
|
allowed,
|
|
reason: allowed ? ("included" as const) : ("missing-subscription" as const),
|
|
featureKey: DefaultFeatures.PrioritySupport,
|
|
}));
|
|
}
|
|
|
|
const sensitiveSamples = [
|
|
"tenant_123",
|
|
"secret-token",
|
|
"user_456",
|
|
"subscription_789",
|
|
"provider_api_key_live",
|
|
"raw-feature-input=workspace-roles",
|
|
"DATABASE_URL",
|
|
"bearer jwt-token",
|
|
] as const;
|
|
|
|
function expectSafeStaticPayload(payload: unknown) {
|
|
const serialized = JSON.stringify(payload);
|
|
|
|
for (const sample of sensitiveSamples) {
|
|
expect(serialized).not.toContain(sample);
|
|
}
|
|
|
|
expect(serialized).not.toMatch(/user[_-]?\d+|subscription[_-]?\d+|provider[_-]?api[_-]?key|bearer\s+jwt|jwt-token|secret-token/i);
|
|
}
|
|
|
|
function expectDiagnosticsRedacted(diagnostics: readonly OnboardingStepGateDiagnostic[]) {
|
|
expectSafeStaticPayload(diagnostics);
|
|
}
|
|
|
|
describe("evaluateOnboardingStepGates", () => {
|
|
it("returns visible onboarding steps when all gates allow access", async () => {
|
|
const hasFeatureFlag = vi.fn(async () => true);
|
|
const evaluateSubscriptionEntitlement = entitlementService(true);
|
|
|
|
const decisions = await evaluateOnboardingStepGates({
|
|
request,
|
|
params,
|
|
definitions: [profileStep, featureStep, planStep],
|
|
services: {
|
|
hasFeatureFlag,
|
|
evaluateSubscriptionEntitlement,
|
|
},
|
|
});
|
|
|
|
expect(getVisibleOnboardingSteps(decisions).map((step) => step.id)).toEqual(["profile-basics", "team-invites", "priority-support-setup"]);
|
|
expect(getOnboardingStepDiagnostics(decisions)).toEqual([]);
|
|
expect(hasFeatureFlag).toHaveBeenCalledWith({ request, params, flagName: "workspace-roles" });
|
|
expect(evaluateSubscriptionEntitlement).toHaveBeenCalledWith({
|
|
featureKey: DefaultFeatures.PrioritySupport,
|
|
subscription: undefined,
|
|
trial: undefined,
|
|
});
|
|
});
|
|
|
|
it("denies only a disabled feature-flagged onboarding step", async () => {
|
|
const decisions = await evaluateOnboardingStepGates({
|
|
request,
|
|
params,
|
|
definitions: [profileStep, featureStep, planStep],
|
|
services: {
|
|
hasFeatureFlag: vi.fn(async () => false),
|
|
evaluateSubscriptionEntitlement: entitlementService(true),
|
|
},
|
|
});
|
|
|
|
expect(getVisibleOnboardingSteps(decisions).map((step) => step.id)).toEqual(["profile-basics", "priority-support-setup"]);
|
|
expect(getOnboardingStepDiagnostics(decisions)).toEqual([
|
|
{
|
|
stepId: "team-invites",
|
|
source: "feature-flag",
|
|
reason: "feature-disabled",
|
|
redirectPath: "/feature-disabled",
|
|
},
|
|
]);
|
|
});
|
|
|
|
it("denies only the feature-gated onboarding step when feature lookup fails", async () => {
|
|
const decisions = await evaluateOnboardingStepGates({
|
|
request,
|
|
params,
|
|
definitions: [profileStep, featureStep],
|
|
services: {
|
|
hasFeatureFlag: vi.fn(async () => {
|
|
throw new Error("backend unavailable for tenant_123 with token secret-token and provider_api_key_live");
|
|
}),
|
|
},
|
|
});
|
|
|
|
expect(getVisibleOnboardingSteps(decisions).map((step) => step.id)).toEqual(["profile-basics"]);
|
|
expect(getOnboardingStepDiagnostics(decisions)).toEqual([
|
|
{
|
|
stepId: "team-invites",
|
|
source: "feature-flag",
|
|
reason: "feature-check-failed",
|
|
redirectPath: "/feature-disabled",
|
|
},
|
|
]);
|
|
expectDiagnosticsRedacted(getOnboardingStepDiagnostics(decisions));
|
|
});
|
|
|
|
it("denies missing plan entitlement with plan-required diagnostics", async () => {
|
|
const evaluateSubscriptionEntitlement = entitlementService(false);
|
|
|
|
const decisions = await evaluateOnboardingStepGates({
|
|
request,
|
|
params,
|
|
definitions: [profileStep, planStep],
|
|
subscription: { products: [] },
|
|
services: {
|
|
evaluateSubscriptionEntitlement,
|
|
},
|
|
});
|
|
|
|
expect(getVisibleOnboardingSteps(decisions).map((step) => step.id)).toEqual(["profile-basics"]);
|
|
expect(getOnboardingStepDiagnostics(decisions)).toEqual([
|
|
{
|
|
stepId: "priority-support-setup",
|
|
source: "plan",
|
|
reason: "plan-required",
|
|
redirectPath: "plan-required",
|
|
},
|
|
]);
|
|
expect(evaluateSubscriptionEntitlement).toHaveBeenCalledWith({
|
|
featureKey: DefaultFeatures.PrioritySupport,
|
|
subscription: { products: [] },
|
|
trial: undefined,
|
|
});
|
|
});
|
|
|
|
it("keeps denied diagnostics redacted from tenant, subscription, user, token, and raw gate inputs", async () => {
|
|
const decisions = await evaluateOnboardingStepGates({
|
|
request,
|
|
params,
|
|
definitions: [featureStep, planStep],
|
|
subscription: { products: [] },
|
|
services: {
|
|
hasFeatureFlag: vi.fn(async () => false),
|
|
evaluateSubscriptionEntitlement: entitlementService(false),
|
|
},
|
|
redirectPaths: {
|
|
"feature-flag": "/feature-disabled",
|
|
plan: "plan-required",
|
|
},
|
|
});
|
|
|
|
expect(getOnboardingStepDiagnostics(decisions)).toEqual([
|
|
expect.objectContaining({ stepId: "team-invites", source: "feature-flag", reason: "feature-disabled" }),
|
|
expect.objectContaining({ stepId: "priority-support-setup", source: "plan", reason: "plan-required" }),
|
|
]);
|
|
expectDiagnosticsRedacted(getOnboardingStepDiagnostics(decisions));
|
|
});
|
|
});
|