Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

chore: make setup required (#21496)

ecmadao8012a23b8206
diff --git a/frontend/src/app/router/guard.test.ts b/frontend/src/app/router/guard.test.ts
index 9c0530ef4c..4092a97102 100644
--- a/frontend/src/app/router/guard.test.ts
+++ b/frontend/src/app/router/guard.test.ts
@@ -13,6 +13,7 @@ const session = {
disallowSignup: false,
enableOnboarding: false,
currentUser: undefined as { mfaEnabled: boolean } | undefined,
+ workspaceSetupFinished: undefined as boolean | undefined,
// Mirrors the store default: PIPELINE until the workspace profile loads.
databaseChangeMode: DatabaseChangeMode.PIPELINE,
};
@@ -57,6 +58,10 @@ vi.mock("@/modules/ai/store", () => ({
useConversationStore: { getState: () => ({ reset: vi.fn() }) },
}));
+vi.mock("@/modules/workspace-setup-guide/setup", () => ({
+ readWorkspaceSetupFinished: () => session.workspaceSetupFinished,
+}));
+
import { buildSigninRedirectQuery, rootGuard } from "./guard";
import {
ACCOUNT_ROUTE,
@@ -64,6 +69,7 @@ import {
AUTH_2FA_SETUP_MODULE,
AUTH_OAUTH_CALLBACK_MODULE,
AUTH_PASSWORD_RESET_MODULE,
+ AUTH_SETUP_MODULE,
AUTH_SIGNIN_MODULE,
AUTH_SIGNUP_MODULE,
PROJECT_V1_ROUTE_DASHBOARD,
@@ -85,6 +91,7 @@ beforeEach(() => {
session.disallowSignup = false;
session.enableOnboarding = false;
session.currentUser = undefined;
+ session.workspaceSetupFinished = undefined;
session.databaseChangeMode = DatabaseChangeMode.PIPELINE;
vi.clearAllMocks();
workspaceSetup.fetchServerInfo.mockResolvedValue({});
@@ -94,6 +101,7 @@ beforeEach(() => {
[AUTH_SIGNIN_MODULE, "/auth"],
[AUTH_2FA_SETUP_MODULE, "/auth/2fa-setup"],
[AUTH_PASSWORD_RESET_MODULE, "/auth/password-reset"],
+ [AUTH_SETUP_MODULE, "/auth/setup"],
[WORKSPACE_ROUTE_404, "/404"],
[SQL_EDITOR_HOME_MODULE, "/sql-editor"],
[WORKSPACE_ROUTE_LANDING, "/landing"],
@@ -215,6 +223,14 @@ describe("rootGuard", () => {
expect(await runWorkspaceSetupLoader()).toBeNull();
});
+ test("ignores the SaaS setup marker for self-host onboarding", async () => {
+ session.isLoggedIn = true;
+ session.enableOnboarding = true;
+ session.workspaceSetupFinished = true;
+
+ expect(await runWorkspaceSetupLoader()).toBeNull();
+ });
+
test("redirects an ineligible user away from workspace setup", async () => {
session.isLoggedIn = true;
@@ -380,6 +396,47 @@ describe("rootGuard", () => {
expect(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1")).toBeNull();
});
+ test("redirects unfinished SaaS setup back to the setup route", () => {
+ session.isLoggedIn = true;
+ session.isSaaSMode = true;
+ session.workspaceSetupFinished = false;
+
+ expect(location(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1"))).toBe(
+ "/auth/setup"
+ );
+ });
+
+ test("does not gate legacy or finished SaaS workspaces", () => {
+ session.isLoggedIn = true;
+ session.isSaaSMode = true;
+
+ expect(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1")).toBeNull();
+ session.workspaceSetupFinished = true;
+ expect(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1")).toBeNull();
+ });
+
+ test("does not apply the local setup gate to self-host", () => {
+ session.isLoggedIn = true;
+ session.workspaceSetupFinished = false;
+
+ expect(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1")).toBeNull();
+ });
+
+ test("password reset takes priority over unfinished SaaS setup", () => {
+ session.isLoggedIn = true;
+ session.isSaaSMode = true;
+ session.requireResetPassword = true;
+ session.workspaceSetupFinished = false;
+
+ expect(location(run(PROJECT_V1_ROUTE_DASHBOARD, "/projects/p1"))).toBe(
+ "/auth/password-reset"
+ );
+ });
+
+ test("revalidates the root guard on client-side navigation", () => {
+ expect(routes[0].shouldRevalidate?.({} as never)).toBe(true);
+ });
+
// Personal account routes live outside the /setting tree, so they need
// their own entry in the allowlist. Without it a full page load of /account
// lands on 404 while in-app navigation still appears to work.
diff --git a/frontend/src/app/router/guard.ts b/frontend/src/app/router/guard.ts
index 2372a815c6..079f9f4282 100644
--- a/frontend/src/app/router/guard.ts
+++ b/frontend/src/app/router/guard.ts
@@ -1,4 +1,5 @@
import { redirect } from "react-router";
+import { readWorkspaceSetupFinished } from "@/modules/workspace-setup-guide/setup";
import { useAppStore } from "@/stores/app";
import { DatabaseChangeMode } from "@/types/proto-es/v1/setting_service_pb";
import { PlanFeature } from "@/types/proto-es/v1/subscription_service_pb";
@@ -89,7 +90,16 @@ export async function workspaceSetupGuard(url: URL): Promise<Response | null> {
} catch {
return redirect(resolvePath(WORKSPACE_ROUTE_LANDING));
}
- if (store.enableOnboarding()) {
+ const setupFinished = readWorkspaceSetupFinished(
+ store.currentUser?.workspace ?? store.serverInfo?.workspace ?? ""
+ );
+ if (store.isSaaSMode() && setupFinished === false) {
+ return null;
+ }
+ if (
+ (!store.isSaaSMode() || setupFinished === undefined) &&
+ store.enableOnboarding()
+ ) {
return null;
}
@@ -301,6 +311,15 @@ export function rootGuard({
return redirect(resolvePath(AUTH_PASSWORD_RESET_MODULE));
}
+ if (
+ store.isSaaSMode() &&
+ readWorkspaceSetupFinished(
+ store.currentUser?.workspace ?? store.serverInfo?.workspace ?? ""
+ ) === false
+ ) {
+ return redirect(resolvePath(AUTH_SETUP_MODULE));
+ }
+
// The bare workspace root ("/") has no page, so always redirect.
if (toName === WORKSPACE_ROOT_MODULE) {
return redirect(resolveRootRedirect(store));
diff --git a/frontend/src/app/router/routes.tsx b/frontend/src/app/router/routes.tsx
index e676ff7893..6bf4c07a3d 100644
--- a/frontend/src/app/router/routes.tsx
+++ b/frontend/src/app/router/routes.tsx
@@ -12,6 +12,7 @@ import { sqlEditorRoutes } from "@/app/router/routes/sqlEditor";
export const routes: RouteObject[] = [
{
element: <RootLayout />,
+ shouldRevalidate: () => true,
// Catch-all for uncaught render/loader exceptions anywhere in the
// tree: show a user-facing recovery page instead of react-router's
// developer default screen.
diff --git a/frontend/src/components/ResourceIdField.test.tsx b/frontend/src/components/ResourceIdField.test.tsx
new file mode 100644
index 0000000000..11c2abd850
--- /dev/null
+++ b/frontend/src/components/ResourceIdField.test.tsx
@@ -0,0 +1,28 @@
+import { cleanup, fireEvent, render } from "@testing-library/react";
+import { afterEach, describe, expect, test, vi } from "vitest";
+import { ResourceIdField } from "./ResourceIdField";
+
+vi.mock("react-i18next", () => ({
+ initReactI18next: { type: "3rdParty", init: () => {} },
+ useTranslation: () => ({ t: (key: string) => key }),
+}));
+
+describe("ResourceIdField", () => {
+ afterEach(cleanup);
+
+ test("forwards autocomplete to the editable input", () => {
+ const { container } = render(
+ <ResourceIdField
+ value="project-id"
+ resourceName="Project"
+ autoComplete="off"
+ />
+ );
+ fireEvent.click(container.querySelector("button")!);
+
+ expect(container.querySelector("input")).toHaveAttribute(
+ "autocomplete",
+ "off"
+ );
+ });
+});
diff --git a/frontend/src/components/ResourceIdField.tsx b/frontend/src/components/ResourceIdField.tsx
index d1bed7ea41..4d00abb35e 100644
--- a/frontend/src/components/ResourceIdField.tsx
+++ b/frontend/src/components/ResourceIdField.tsx
@@ -1,4 +1,5 @@
import {
+ type ComponentProps,
forwardRef,
useCallback,
useEffect,
@@ -29,6 +30,7 @@ interface ResourceIdFieldProps {
// messages — NOT the user-entered title/name of the resource.
resourceName: string;
resourceTitle?: string;
+ autoComplete?: ComponentProps<"input">["autoComplete"];
suffix?: boolean;
readonly?: boolean;
validate?: (resourceId: string) => Promise<ValidatedMessage[]>;
@@ -65,6 +67,7 @@ export const ResourceIdField = forwardRef<
value,
resourceName,
resourceTitle,
+ autoComplete,
suffix = false,
readonly = false,
validate,
@@ -231,6 +234,7 @@ export const ResourceIdField = forwardRef<
</p>
<Input
value={value}
+ autoComplete={autoComplete}
onChange={(e) => handleManualInput(e.target.value)}
placeholder={t("resource-id.self", { resource: resourceName })}
className={
diff --git a/frontend/src/modules/workspace-setup-guide/selection.test.ts b/frontend/src/modules/workspace-setup-guide/selection.test.ts
index 651aadb278..7a6b45869b 100644
--- a/frontend/src/modules/workspace-setup-guide/selection.test.ts
+++ b/frontend/src/modules/workspace-setup-guide/selection.test.ts
@@ -1,5 +1,6 @@
import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
import {
+ storageKeyWorkspaceSetupFinished,
storageKeyWorkspaceSetupGuideScenario,
storageKeyWorkspaceSetupGuideWorkspaceUsage,
} from "@/utils/storage-keys";
@@ -13,6 +14,10 @@ import {
saveGuideWorkspaceUsage,
saveSelectedGuideScenarioId,
} from "./selection";
+import {
+ readWorkspaceSetupFinished,
+ saveWorkspaceSetupFinished,
+} from "./setup";
const mocks = vi.hoisted(() => ({
state: {
@@ -161,3 +166,36 @@ describe("workspace setup guide workspace usage", () => {
expect(readGuideWorkspaceUsage()).toBeUndefined();
});
});
+
+describe("workspace setup completion", () => {
+ beforeEach(() => {
+ localStorage.clear();
+ });
+
+ test("scopes completion by workspace without a user suffix", () => {
+ expect(storageKeyWorkspaceSetupFinished("workspaces/ws1")).toBe(
+ "bb.workspace-setup.finished.workspaces/ws1"
+ );
+ expect(saveWorkspaceSetupFinished("workspaces/ws1", false)).toBe(true);
+
+ expect(readWorkspaceSetupFinished("workspaces/ws1")).toBe(false);
+ expect(readWorkspaceSetupFinished("workspaces/ws2")).toBeUndefined();
+ });
+
+ test("distinguishes finished from legacy workspaces", () => {
+ expect(readWorkspaceSetupFinished("workspaces/ws1")).toBeUndefined();
+
+ expect(saveWorkspaceSetupFinished("workspaces/ws1", true)).toBe(true);
+
+ expect(readWorkspaceSetupFinished("workspaces/ws1")).toBe(true);
+ });
+
+ test("ignores malformed stored completion values", () => {
+ localStorage.setItem(
+ storageKeyWorkspaceSetupFinished("workspaces/ws1"),
+ JSON.stringify("false")
+ );
+
+ expect(readWorkspaceSetupFinished("workspaces/ws1")).toBeUndefined();
+ });
+});
diff --git a/frontend/src/modules/workspace-setup-guide/setup.ts b/frontend/src/modules/workspace-setup-guide/setup.ts
new file mode 100644
index 0000000000..2ed3e3c81c
--- /dev/null
+++ b/frontend/src/modules/workspace-setup-guide/setup.ts
@@ -0,0 +1,36 @@
+import { storageKeyWorkspaceSetupFinished } from "@/utils/storage-keys";
+
+export function readWorkspaceSetupFinished(
+ workspace: string
+): boolean | undefined {
+ if (!workspace) return undefined;
+
+ try {
+ const raw = localStorage.getItem(
+ storageKeyWorkspaceSetupFinished(workspace)
+ );
+ if (raw === null) return undefined;
+
+ const value: unknown = JSON.parse(raw);
+ return typeof value === "boolean" ? value : undefined;
+ } catch {
+ return undefined;
+ }
+}
+
+export function saveWorkspaceSetupFinished(
+ workspace: string,
+ finished: boolean
+): boolean {
+ if (!workspace) return false;
+
+ try {
+ localStorage.setItem(
+ storageKeyWorkspaceSetupFinished(workspace),
+ JSON.stringify(finished)
+ );
+ return true;
+ } catch {
+ return false;
+ }
+}
diff --git a/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx b/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
index 5ec5ad055d..955da348af 100644
--- a/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
@@ -43,6 +43,7 @@ const mocks = vi.hoisted(() => ({
clearSelectedGuideScenarioId: vi.fn(),
saveGuideWorkspaceUsage: vi.fn(),
saveSelectedGuideScenarioId: vi.fn(),
+ saveWorkspaceSetupFinished: vi.fn(() => true),
pushNotification: vi.fn(),
hasWorkspacePermissionV2: vi.fn(() => false),
canCreateProject: true,
@@ -68,6 +69,10 @@ vi.mock("@/modules/workspace-setup-guide/selection", () => ({
saveSelectedGuideScenarioId: mocks.saveSelectedGuideScenarioId,
}));
+vi.mock("@/modules/workspace-setup-guide/setup", () => ({
+ saveWorkspaceSetupFinished: mocks.saveWorkspaceSetupFinished,
+}));
+
vi.mock("@/hooks/useAppState", () => ({
useCurrentUser: () => mocks.currentUser,
useWorkspace: () => mocks.workspace,
@@ -131,11 +136,13 @@ vi.mock("@/components/ResourceIdField", async () => {
ResourceIdField: ({
value,
resourceTitle,
+ autoComplete,
onChange,
onValidationChange,
}: {
value: string;
resourceTitle?: string;
+ autoComplete?: string;
onChange?: (value: string) => void;
onValidationChange?: (valid: boolean) => void;
}) => {
@@ -148,6 +155,7 @@ vi.mock("@/components/ResourceIdField", async () => {
<input
data-testid="project-resource-id"
value={value}
+ autoComplete={autoComplete}
onChange={(event) => {
onChange?.(event.target.value);
onValidationChange?.(event.target.value.length > 0);
@@ -250,6 +258,17 @@ const renderIntoContainer = (element: ReactElement) => {
const renderWorkspaceForm = () => {
const page = renderIntoContainer(<WorkspaceSetupPage />);
page.render();
+ if (mocks.isSaaSMode) {
+ const labels = [...page.container.querySelectorAll("label")];
+ act(() => {
+ fireEvent.click(
+ labels.find((label) => label.textContent?.includes("Query data"))!
+ );
+ fireEvent.click(
+ labels.find((label) => label.textContent?.includes("Just me"))!
+ );
+ });
+ }
const continueWithoutSelection = [
...page.container.querySelectorAll("button"),
].find((button) => button.textContent === "Continue");
@@ -409,6 +428,42 @@ describe("WorkspaceSetupPage", () => {
page.unmount();
});
+ test("requires both questionnaire answers in SaaS", async () => {
+ mocks.isSaaSMode = true;
+ const page = renderIntoContainer(<WorkspaceSetupPage />);
+ page.render();
+ const continueButton = page.container.querySelector("button")!;
+
+ expect(continueButton).toBeDisabled();
+
+ const labels = [...page.container.querySelectorAll("label")];
+ await act(async () => {
+ fireEvent.click(
+ labels.find((label) => label.textContent?.includes("Query data"))!
+ );
+ await Promise.resolve();
+ });
+ expect(continueButton).toBeDisabled();
+
+ await act(async () => {
+ fireEvent.click(
+ labels.find((label) => label.textContent?.includes("Just me"))!
+ );
+ await Promise.resolve();
+ });
+ expect(continueButton).toBeEnabled();
+ page.unmount();
+ });
+
+ test("removes the skip action from SaaS workspace setup", () => {
+ mocks.isSaaSMode = true;
+ const page = renderWorkspaceForm();
+
+ expect(page.container.textContent).not.toContain("I'll do this later");
+ expect(page.container.textContent).toContain("Setup my workspace");
+ page.unmount();
+ });
+
test("persists Create a database change when the questionnaire continues", async () => {
const page = renderIntoContainer(<WorkspaceSetupPage />);
page.render();
@@ -685,6 +740,23 @@ describe("WorkspaceSetupPage", () => {
page.unmount();
});
+ test("disables browser autocomplete for setup inputs", () => {
+ const page = renderWorkspaceForm();
+
+ for (const testId of [
+ "profile-display-name",
+ "profile-workspace-title",
+ "profile-project-title",
+ "project-resource-id",
+ ]) {
+ expect(
+ page.container.querySelector(`[data-testid='${testId}']`)
+ ).toHaveAttribute("autocomplete", "off");
+ }
+
+ page.unmount();
+ });
+
test("hides workspace name for users joining an existing workspace", () => {
mocks.workspacePolicy = {
bindings: [
@@ -797,6 +869,10 @@ describe("WorkspaceSetupPage", () => {
const projectNameInput = page.container.querySelector(
"[data-testid='profile-project-title']"
) as HTMLInputElement;
+ expect(projectNameInput).not.toBeRequired();
+ expect(
+ page.container.querySelector("[data-testid='project-required-indicator']")
+ ).toBeNull();
await act(async () => {
fireEvent.change(projectNameInput, { target: { value: "" } });
await Promise.resolve();
@@ -845,6 +921,30 @@ describe("WorkspaceSetupPage", () => {
page.unmount();
});
+ test("requires the first project in SaaS", async () => {
+ mocks.isSaaSMode = true;
+ const page = renderWorkspaceForm();
+
+ const projectNameInput = page.container.querySelector(
+ "[data-testid='profile-project-title']"
+ ) as HTMLInputElement;
+ expect(projectNameInput).toBeRequired();
+ expect(
+ page.container.querySelector("[data-testid='project-required-indicator']")
+ ).toHaveClass("ml-1");
+ await act(async () => {
+ fireEvent.change(projectNameInput, { target: { value: "" } });
+ await Promise.resolve();
+ });
+
+ const save = Array.from(page.container.querySelectorAll("button")).find(
+ (button) => button.textContent?.includes("Setup my workspace")
+ ) as HTMLButtonElement;
+ expect(save).toBeDisabled();
+
+ page.unmount();
+ });
+
test("requires a project ID while the project title is present", async () => {
const page = renderWorkspaceForm();
@@ -1021,12 +1121,20 @@ describe("WorkspaceSetupPage", () => {
expect(mocks.captureMetric).toHaveBeenCalledWith({
event: "workspace setup submitted",
properties: {
- scenario: "unselected",
- collaboration_type: "unselected",
+ scenario: isSaaSMode ? "query-data" : "unselected",
+ collaboration_type: isSaaSMode ? "solo" : "unselected",
result: "finished",
sample_enabled: true,
},
});
+ if (isSaaSMode) {
+ expect(mocks.saveWorkspaceSetupFinished).toHaveBeenCalledWith(
+ "workspaces/ws1",
+ true
+ );
+ } else {
+ expect(mocks.saveWorkspaceSetupFinished).not.toHaveBeenCalled();
+ }
page.unmount();
}
diff --git a/frontend/src/routes/auth/WorkspaceSetupPage.tsx b/frontend/src/routes/auth/WorkspaceSetupPage.tsx
index 6266f8051a..45091a09db 100644
--- a/frontend/src/routes/auth/WorkspaceSetupPage.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupPage.tsx
@@ -35,6 +35,7 @@ import {
saveGuideWorkspaceUsage,
saveSelectedGuideScenarioId,
} from "@/modules/workspace-setup-guide/selection";
+import { saveWorkspaceSetupFinished } from "@/modules/workspace-setup-guide/setup";
import type {
GuideScenarioId,
GuideWorkspaceUsage,
@@ -63,6 +64,7 @@ export function WorkspaceSetupPage() {
const prepareSampleProjectInstance = useAppStore(
(state) => state.prepareSampleProjectInstance
);
+ const isSaaSMode = useAppStore((state) => state.isSaaSMode());
const sampleAvailable = useAppStore(
(state) => state.serverInfo?.sample?.available ?? false
);
@@ -117,6 +119,8 @@ export function WorkspaceSetupPage() {
const [enableSampleDatabases, setEnableSampleDatabases] = useState(true);
const [saving, setSaving] = useState(false);
const shouldCreateProject = canCreateProject && !!projectTitle.trim();
+ const projectIsReady =
+ shouldCreateProject && !!projectResourceId && isProjectResourceIdValid;
const sampleRequested =
shouldCreateProject && enableSampleDatabases && canPrepareSample;
const canEnableSample = !!projectTitle.trim() && !!projectResourceId;
@@ -171,7 +175,7 @@ export function WorkspaceSetupPage() {
const canSave =
!!name.trim() &&
!saving &&
- (!shouldCreateProject || (!!projectResourceId && isProjectResourceIdValid));
+ (isSaaSMode ? projectIsReady : !shouldCreateProject || projectIsReady);
const handleSave = async () => {
if (!currentUser?.name || !canSave) return;
@@ -227,6 +231,12 @@ export function WorkspaceSetupPage() {
style: "SUCCESS",
title: t("settings.profile.setup-success"),
});
+ if (isSaaSMode) {
+ saveWorkspaceSetupFinished(
+ workspace?.name ?? currentUser.workspace,
+ true
+ );
+ }
behaviorAnalytics.captureMetric(
createBehaviorMetric("workspace setup submitted", {
properties: {
@@ -309,6 +319,7 @@ export function WorkspaceSetupPage() {
<WorkspaceSetupQuestionnaireStep
scenarioValue={selectedScenarioId}
workspaceUsageValue={workspaceUsage}
+ required={isSaaSMode}
onScenarioChange={setSelectedScenarioId}
onWorkspaceUsageChange={setWorkspaceUsage}
onContinue={() => {
@@ -347,6 +358,7 @@ export function WorkspaceSetupPage() {
<Input
data-testid="profile-display-name"
value={name}
+ autoComplete="off"
onChange={(e) => setName(e.target.value)}
placeholder={t("settings.profile.display-name-placeholder")}
autoFocus
@@ -363,6 +375,7 @@ export function WorkspaceSetupPage() {
<Input
data-testid="profile-workspace-title"
value={workspaceTitle}
+ autoComplete="off"
onChange={(event) => setWorkspaceTitle(event.target.value)}
placeholder={t("settings.profile.workspace-name-placeholder")}
/>
@@ -370,10 +383,27 @@ export function WorkspaceSetupPage() {
)}
{canCreateProject && (
- <FormField title={t("settings.profile.setup-first-project")}>
+ <FormField
+ title={
+ <>
+ {t("settings.profile.setup-first-project")}
+ {isSaaSMode && (
+ <span
+ aria-hidden="true"
+ className="ml-1 text-error"
+ data-testid="project-required-indicator"
+ >
+ *
+ </span>
+ )}
+ </>
+ }
+ >
<Input
data-testid="profile-project-title"
value={projectTitle}
+ autoComplete="off"
+ required={isSaaSMode}
onChange={(event) => {
const title = event.target.value;
setProjectTitle(title);
@@ -388,6 +418,7 @@ export function WorkspaceSetupPage() {
<ResourceIdField
suffix
value={projectResourceId}
+ autoComplete="off"
resourceName={t("common.project")}
resourceTitle={projectTitle}
validate={validateProjectResourceId}
@@ -435,9 +466,11 @@ export function WorkspaceSetupPage() {
{t("common.back")}
</Button>
<div className="flex flex-col items-end gap-y-2 sm:flex-row sm:items-center sm:gap-x-2 sm:gap-y-0">
- <Button appearance="secondary" onClick={handleSkip}>
- {t("settings.profile.setup-skip")}
- </Button>
+ {!isSaaSMode && (
+ <Button appearance="secondary" onClick={handleSkip}>
+ {t("settings.profile.setup-skip")}
+ </Button>
+ )}
<Button onClick={() => void handleSave()} disabled={!canSave}>
{t("settings.profile.setup-submit")}
</Button>
diff --git a/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.test.tsx b/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.test.tsx
index 4389b3ae17..6737ca6b33 100644
--- a/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.test.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.test.tsx
@@ -62,6 +62,7 @@ const renderQuestionnaire = (
props: Partial<{
scenarioValue: GuideScenarioId;
workspaceUsageValue: GuideWorkspaceUsage;
+ required: boolean;
onScenarioChange: (value: GuideScenarioId) => void;
onWorkspaceUsageChange: (value: GuideWorkspaceUsage) => void;
onContinue: () => void;
@@ -71,6 +72,7 @@ const renderQuestionnaire = (
<WorkspaceSetupQuestionnaireStep
scenarioValue={props.scenarioValue}
workspaceUsageValue={props.workspaceUsageValue}
+ required={props.required}
onScenarioChange={props.onScenarioChange ?? vi.fn()}
onWorkspaceUsageChange={props.onWorkspaceUsageChange ?? vi.fn()}
onContinue={props.onContinue ?? vi.fn()}
@@ -111,6 +113,50 @@ describe("WorkspaceSetupQuestionnaireStep", () => {
page.unmount();
});
+ test("requires both answers when configured for SaaS", () => {
+ const unanswered = renderQuestionnaire({ required: true });
+ const unansweredContinue = unanswered.container.querySelector("button")!;
+ expect(unansweredContinue).toBeDisabled();
+ const requiredIndicators = unanswered.container.querySelectorAll(
+ "[data-testid='required-indicator']"
+ );
+ expect(requiredIndicators).toHaveLength(2);
+ for (const indicator of requiredIndicators) {
+ expect(indicator).toHaveClass("ml-1");
+ }
+ expect(
+ unanswered.container.querySelectorAll("[aria-required='true']")
+ ).toHaveLength(2);
+ unanswered.unmount();
+
+ const partiallyAnswered = renderQuestionnaire({
+ required: true,
+ scenarioValue: "query-data",
+ });
+ expect(partiallyAnswered.container.querySelector("button")).toBeDisabled();
+ partiallyAnswered.unmount();
+
+ const answered = renderQuestionnaire({
+ required: true,
+ scenarioValue: "query-data",
+ workspaceUsageValue: "solo",
+ });
+ expect(answered.container.querySelector("button")).toBeEnabled();
+ answered.unmount();
+ });
+
+ test("does not show required markers when answers are optional", () => {
+ const page = renderQuestionnaire({ required: false });
+
+ expect(
+ page.container.querySelectorAll("[data-testid='required-indicator']")
+ ).toHaveLength(0);
+ expect(
+ page.container.querySelectorAll("[aria-required='true']")
+ ).toHaveLength(0);
+ page.unmount();
+ });
+
test("reports each answer independently", () => {
const onScenarioChange = vi.fn();
const onWorkspaceUsageChange = vi.fn();
diff --git a/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.tsx b/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.tsx
index d8d3f59048..ad2fd0ec88 100644
--- a/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupQuestionnaireStep.tsx
@@ -17,6 +17,7 @@ type WorkspaceSetupQuestionnaireStepProps = {
onScenarioChange: (value: GuideScenarioId) => void;
onWorkspaceUsageChange: (value: GuideWorkspaceUsage) => void;
onContinue: () => void;
+ required?: boolean;
};
const SCENARIO_OPTIONS: Array<{
@@ -76,6 +77,7 @@ export function WorkspaceSetupQuestionnaireStep({
onScenarioChange,
onWorkspaceUsageChange,
onContinue,
+ required = false,
}: WorkspaceSetupQuestionnaireStepProps) {
const { t } = useTranslation();
@@ -84,9 +86,19 @@ export function WorkspaceSetupQuestionnaireStep({
<div className="flex flex-col gap-y-3">
<h1 className="font-medium text-main">
{t("settings.profile.setup-scenario.outcome-title")}
+ {required && (
+ <span
+ aria-hidden="true"
+ className="ml-1 text-error"
+ data-testid="required-indicator"
+ >
+ *
+ </span>
+ )}
</h1>
<RadioGroup
aria-label={t("settings.profile.setup-scenario.outcome-title")}
+ aria-required={required}
value={scenarioValue ?? ""}
onValueChange={(nextValue) => {
if (isGuideScenarioId(nextValue)) onScenarioChange(nextValue);
@@ -113,11 +125,21 @@ export function WorkspaceSetupQuestionnaireStep({
<div className="flex flex-col gap-y-3">
<h2 className="font-medium text-main">
{t("settings.profile.setup-scenario.workspace-usage.title")}
+ {required && (
+ <span
+ aria-hidden="true"
+ className="ml-1 text-error"
+ data-testid="required-indicator"
+ >
+ *
+ </span>
+ )}
</h2>
<RadioGroup
aria-label={t(
"settings.profile.setup-scenario.workspace-usage.title"
)}
+ aria-required={required}
value={workspaceUsageValue ?? ""}
onValueChange={(nextValue) => {
if (isGuideWorkspaceUsage(nextValue)) {
@@ -144,7 +166,10 @@ export function WorkspaceSetupQuestionnaireStep({
</div>
<div className="flex items-center justify-end gap-x-2 border-t border-block-border pt-4">
- <Button onClick={onContinue}>
+ <Button
+ onClick={onContinue}
+ disabled={required && (!scenarioValue || !workspaceUsageValue)}
+ >
{t("settings.profile.setup-scenario.continue")}
</Button>
</div>
diff --git a/frontend/src/stores/app/auth.ts b/frontend/src/stores/app/auth.ts
index 3b12658f06..cd6b3f991c 100644
--- a/frontend/src/stores/app/auth.ts
+++ b/frontend/src/stores/app/auth.ts
@@ -15,6 +15,7 @@ import {
navigateToPath,
resolvePath,
} from "@/app/router/navigation";
+import { saveWorkspaceSetupFinished } from "@/modules/workspace-setup-guide/setup";
import {
LoginRequestSchema,
SendEmailLoginCodeRequestSchema,
@@ -204,6 +205,9 @@ export const createAuthSlice: AppSliceCreator<AuthSlice> = (set, get) => ({
.fetchWorkspaceIamPolicy(true)
.catch(() => undefined);
if (get().enableOnboarding()) {
+ if (get().isSaaSMode()) {
+ saveWorkspaceSetupFinished(user?.workspace ?? "", false);
+ }
navigateByName(AUTH_SETUP_MODULE, {
query: { redirect: nextPage },
});
@@ -245,6 +249,9 @@ export const createAuthSlice: AppSliceCreator<AuthSlice> = (set, get) => ({
set({ authSessionKey: uniqueId() });
if (get().enableOnboarding()) {
+ if (get().isSaaSMode()) {
+ saveWorkspaceSetupFinished(user?.workspace ?? "", false);
+ }
navigateByName(AUTH_SETUP_MODULE, { replace: true });
return;
}
diff --git a/frontend/src/stores/app/index.test.ts b/frontend/src/stores/app/index.test.ts
index 546fbb1f2b..e36e574c0e 100644
--- a/frontend/src/stores/app/index.test.ts
+++ b/frontend/src/stores/app/index.test.ts
@@ -725,6 +725,9 @@ describe("useAppStore", () => {
expect(mocks.navigateByName).toHaveBeenCalledWith("auth.setup", {
query: { redirect: "/" },
});
+ expect(
+ localStorage.getItem("bb.workspace-setup.finished.workspaces/default")
+ ).toBe("false");
});
test("invited self-host user leaves root navigation to the router on first login", async () => {
@@ -934,6 +937,9 @@ describe("useAppStore", () => {
expect(mocks.navigateByName).toHaveBeenCalledWith("auth.setup", {
replace: true,
});
+ expect(
+ localStorage.getItem("bb.workspace-setup.finished.workspaces/default")
+ ).toBe("false");
});
test("invited SaaS signup skips workspace setup and opens the workspace landing page", async () => {
diff --git a/frontend/src/utils/storage-keys.ts b/frontend/src/utils/storage-keys.ts
index d2db446031..a72e5179fc 100644
--- a/frontend/src/utils/storage-keys.ts
+++ b/frontend/src/utils/storage-keys.ts
@@ -71,6 +71,8 @@ export const storageKeyWorkspaceSetupGuideWorkspaceUsage = (
scope: string,
email: string
) => withScope("bb.workspace-setup-guide.workspace-usage", scope, email);
+export const storageKeyWorkspaceSetupFinished = (workspace: string) =>
+ withScope("bb.workspace-setup.finished", workspace);
// Workspace-scoped: value keys embed project resource names.
export const storageKeyIamRemind = (scope: string, email: string) =>
withScope("bb.iam-remind", scope, email);