Skip to content

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

chore: optimize add member onboarding step (#21343)

ecmadao2e25666cea53
diff --git a/frontend/src/app/router/guard.test.ts b/frontend/src/app/router/guard.test.ts
index fc14d6cad6..9c0530ef4c 100644
--- a/frontend/src/app/router/guard.test.ts
+++ b/frontend/src/app/router/guard.test.ts
@@ -256,6 +256,36 @@ describe("rootGuard", () => {
).toBe("/landing");
});
+ test("rejects a same-origin full URL setup redirect", async () => {
+ session.isLoggedIn = true;
+
+ expect(
+ location(
+ await runWorkspaceSetupLoader(
+ "/auth/setup?redirect=https%3A%2F%2Fapp.example.com%2Fprojects%2Fexample"
+ )
+ )
+ ).toBe("/landing");
+ });
+
+ test("rejects a backslash-normalized external setup redirect", async () => {
+ session.isLoggedIn = true;
+
+ expect(
+ location(
+ await runWorkspaceSetupLoader("/auth/setup?redirect=%2F%5Cevil.example")
+ )
+ ).toBe("/landing");
+ });
+
+ test("rejects a malformed setup redirect", async () => {
+ session.isLoggedIn = true;
+
+ expect(
+ location(await runWorkspaceSetupLoader("/auth/setup?redirect=%2F%5C"))
+ ).toBe("/landing");
+ });
+
test("redirects away from workspace setup when IAM loading fails", async () => {
session.isLoggedIn = true;
session.enableOnboarding = true;
diff --git a/frontend/src/app/router/guard.ts b/frontend/src/app/router/guard.ts
index 97fdc6f821..2d61327292 100644
--- a/frontend/src/app/router/guard.ts
+++ b/frontend/src/app/router/guard.ts
@@ -96,7 +96,9 @@ export async function workspaceSetupGuard(url: URL): Promise<Response | null> {
const redirectParam = url.searchParams.get("redirect");
const target =
- redirectParam?.startsWith("/") && !redirectParam.startsWith("//")
+ redirectParam?.startsWith("/") &&
+ !redirectParam.startsWith("//") &&
+ !redirectParam.includes("\\")
? redirectParam
: resolvePath(WORKSPACE_ROUTE_LANDING);
return redirect(target);
diff --git a/frontend/src/locales/en-US.json b/frontend/src/locales/en-US.json
index ed7d1269a2..b951ce0e1f 100644
--- a/frontend/src/locales/en-US.json
+++ b/frontend/src/locales/en-US.json
@@ -3572,7 +3572,6 @@
"workspace-setup-guide": {
"actions": {
"change": "Create database change",
- "done": "Done",
"query": "Go to SQL Editor"
},
"descriptions": {
diff --git a/frontend/src/locales/es-ES.json b/frontend/src/locales/es-ES.json
index 21e9bbf4ab..3d15f2ddbc 100644
--- a/frontend/src/locales/es-ES.json
+++ b/frontend/src/locales/es-ES.json
@@ -3572,7 +3572,6 @@
"workspace-setup-guide": {
"actions": {
"change": "Crear cambio de base de datos",
- "done": "Listo",
"query": "Ir a SQL Editor"
},
"descriptions": {
diff --git a/frontend/src/locales/ja-JP.json b/frontend/src/locales/ja-JP.json
index da5cdd294f..6daef50f0e 100644
--- a/frontend/src/locales/ja-JP.json
+++ b/frontend/src/locales/ja-JP.json
@@ -3572,7 +3572,6 @@
"workspace-setup-guide": {
"actions": {
"change": "データベース変更を作成",
- "done": "完了",
"query": "SQL Editor に移動"
},
"descriptions": {
diff --git a/frontend/src/locales/vi-VN.json b/frontend/src/locales/vi-VN.json
index 035879919d..5ee9561758 100644
--- a/frontend/src/locales/vi-VN.json
+++ b/frontend/src/locales/vi-VN.json
@@ -3572,7 +3572,6 @@
"workspace-setup-guide": {
"actions": {
"change": "Tạo thay đổi cơ sở dữ liệu",
- "done": "Xong",
"query": "Đi tới SQL Editor"
},
"descriptions": {
diff --git a/frontend/src/locales/zh-CN.json b/frontend/src/locales/zh-CN.json
index 5ebd1dd46f..b12594103f 100644
--- a/frontend/src/locales/zh-CN.json
+++ b/frontend/src/locales/zh-CN.json
@@ -3572,7 +3572,6 @@
"workspace-setup-guide": {
"actions": {
"change": "创建数据库变更",
- "done": "完成",
"query": "前往 SQL Editor"
},
"descriptions": {
diff --git a/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.test.tsx b/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.test.tsx
index b800e6dd11..5ff775d1fc 100644
--- a/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.test.tsx
+++ b/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.test.tsx
@@ -94,11 +94,23 @@ vi.mock("@/components/HowBytebaseWorksSheet", () => ({
vi.mock("@/components/SQLEditorButton", () => ({
SQLEditorButton: ({
label,
+ size,
+ className,
"data-testid": testId,
}: {
label?: ReactNode;
+ size?: string;
+ className?: string;
"data-testid"?: string;
- }) => <button data-testid={testId ?? "sql-editor-action"}>{label}</button>,
+ }) => (
+ <button
+ className={className}
+ data-testid={testId ?? "sql-editor-action"}
+ data-size={size}
+ >
+ {label}
+ </button>
+ ),
}));
vi.mock("@/hooks/useAppState", () => ({
@@ -218,6 +230,10 @@ describe("WorkspaceSetupGuide", () => {
expect(screen.getByTestId("active-action")).toHaveTextContent(
"workspace-setup-guide.actions.query"
);
+ expect(screen.getByTestId("active-action")).toHaveAttribute(
+ "data-size",
+ "sm"
+ );
expect(screen.getByTestId("open-product-model")).toBeVisible();
});
@@ -258,7 +274,7 @@ describe("WorkspaceSetupGuide", () => {
expect(screen.getByTestId("setup-step-add-teammate")).toBeEnabled();
});
- test("keeps a completed multi-member team journey until Done", () => {
+ test("acknowledges a completed multi-member team journey when closed", () => {
mocks.scenarioId = "query-data";
mocks.workspaceUsage = "team";
mocks.guideUserCount = 2;
@@ -274,36 +290,52 @@ describe("WorkspaceSetupGuide", () => {
});
const first = render(<WorkspaceSetupGuide />);
- expect(screen.getByTestId("complete-guide")).toBeVisible();
- fireEvent.click(screen.getByTestId("complete-guide"));
+ expect(screen.queryByTestId("complete-guide")).not.toBeInTheDocument();
+ fireEvent.click(screen.getByTestId("dismiss-guide"));
first.unmount();
render(<WorkspaceSetupGuide />);
- expect(screen.queryByTestId("complete-guide")).not.toBeInTheDocument();
+ expect(screen.queryByTestId("dismiss-guide")).not.toBeInTheDocument();
});
- test.each([false, true])(
- "keeps the self-host teammate action fixed when a user exists: %s",
- (hasOtherHumanUser) => {
+ test("opens Users for a self-host team journey without another user", () => {
mocks.workspaceUsage = "team";
mocks.guideContext = guideContext({
hasProject: true,
hasInstance: true,
hasExploredDatabase: true,
- hasOtherHumanUser,
databaseProjectName: "projects/app",
databaseName: "instances/sample/databases/employee",
});
render(<WorkspaceSetupGuide />);
- fireEvent.click(screen.getByTestId("setup-step-add-teammate"));
+ fireEvent.click(screen.getByTestId("setup-step-add-teammate"));
expect(mocks.routerPush).toHaveBeenCalledWith({
- name: "workspace.users",
- query: { intro: "create-user" },
+ name: "workspace.users",
+ query: { intro: "create-user" },
});
- }
- );
+ });
+
+ test("opens Members for a self-host team journey with an existing user", () => {
+ mocks.workspaceUsage = "team";
+ mocks.guideContext = guideContext({
+ hasProject: true,
+ hasInstance: true,
+ hasExploredDatabase: true,
+ hasOtherHumanUser: true,
+ databaseProjectName: "projects/app",
+ databaseName: "instances/sample/databases/employee",
+ });
+ render(<WorkspaceSetupGuide />);
+
+ fireEvent.click(screen.getByTestId("setup-step-add-teammate"));
+
+ expect(mocks.routerPush).toHaveBeenCalledWith({
+ name: "workspace.members",
+ query: { intro: "grant-access" },
+ });
+ });
test("uses the fixed SaaS grant-access teammate action", () => {
mocks.isSaaS = true;
@@ -463,6 +495,54 @@ describe("WorkspaceSetupGuide", () => {
expect(await screen.findAllByRole("menuitem")).toHaveLength(5);
});
+ test("sizes the active action independently of step overflow", () => {
+ mocks.scenarioId = "query-data";
+ mocks.guideContext = guideContext({
+ hasProject: true,
+ hasInstance: true,
+ hasExploredDatabase: true,
+ databaseProjectName: "projects/app",
+ databaseName: "instances/sample/databases/employee",
+ });
+ render(<WorkspaceSetupGuide />);
+
+ expect(screen.getByTestId("active-action")).toHaveAttribute(
+ "data-size",
+ "sm"
+ );
+ expect(screen.getByTestId("active-action")).toHaveClass(
+ "2xl:h-9",
+ "2xl:px-3",
+ "2xl:text-sm"
+ );
+
+ const viewport = screen.getByTestId("guide-step-viewport");
+ const measurement = screen.getByTestId("guide-step-measurement");
+ Object.defineProperty(viewport, "clientWidth", {
+ configurable: true,
+ value: 500,
+ });
+ Object.defineProperty(measurement, "scrollWidth", {
+ configurable: true,
+ value: 900,
+ });
+
+ act(() => {
+ for (const callback of resizeObserverCallbacks) {
+ callback([], {} as ResizeObserver);
+ }
+ });
+ expect(screen.getByTestId("active-action")).toHaveAttribute(
+ "data-size",
+ "sm"
+ );
+
+ expect(screen.getByTestId("active-action")).toHaveAttribute(
+ "data-size",
+ "sm"
+ );
+ });
+
test("routes generic actions without recording guide analytics", () => {
render(<WorkspaceSetupGuide />);
fireEvent.click(screen.getByTestId("setup-step-create-project"));
@@ -505,13 +585,80 @@ describe("WorkspaceSetupGuide", () => {
).toBeVisible();
expect(screen.getByText("workspace-setup-guide.actions.change")).toBeVisible();
expect(screen.getByText("workspace-setup-guide.actions.query")).toBeVisible();
- fireEvent.click(screen.getByTestId("complete-guide"));
+ expect(screen.queryByTestId("complete-guide")).not.toBeInTheDocument();
+ fireEvent.click(screen.getByTestId("dismiss-guide"));
expect(mocks.saveIntroStateByKey).toHaveBeenCalledWith({
key: guideCompletionAcknowledgedKey("workspace-setup"),
newState: true,
});
});
+ test("compacts completion actions only when the completion row overflows", () => {
+ mocks.guideContext = guideContext({
+ hasProject: true,
+ hasInstance: true,
+ hasExploredDatabase: true,
+ databaseProjectName: "projects/app",
+ databaseName: "instances/sample/databases/employee",
+ });
+
+ render(<WorkspaceSetupGuide />);
+
+ const guideBar = screen.getByTestId("workspace-setup-guide");
+ const completionTitle = screen.getByTestId("completion-title");
+ Object.defineProperty(guideBar, "clientWidth", {
+ configurable: true,
+ value: 800,
+ });
+ Object.defineProperty(completionTitle, "clientWidth", {
+ configurable: true,
+ value: 160,
+ });
+ Object.defineProperty(completionTitle, "scrollWidth", {
+ configurable: true,
+ value: 260,
+ });
+
+ act(() => {
+ for (const callback of resizeObserverCallbacks) {
+ callback([], {} as ResizeObserver);
+ }
+ });
+
+ expect(
+ screen.queryByText("workspace-setup-guide.generic.completion-description")
+ ).not.toBeInTheDocument();
+ expect(
+ screen.queryByText("workspace-setup-guide.actions.change")
+ ).not.toBeInTheDocument();
+ expect(screen.getByTestId("sql-editor-action")).toHaveAttribute(
+ "data-size",
+ "sm"
+ );
+
+ Object.defineProperty(guideBar, "clientWidth", {
+ configurable: true,
+ value: 900,
+ });
+ Object.defineProperty(completionTitle, "clientWidth", {
+ configurable: true,
+ value: 260,
+ });
+ act(() => {
+ for (const callback of resizeObserverCallbacks) {
+ callback([], {} as ResizeObserver);
+ }
+ });
+
+ expect(
+ screen.getByText("workspace-setup-guide.generic.completion-description")
+ ).toBeVisible();
+ expect(screen.getByText("workspace-setup-guide.actions.change")).toBeVisible();
+ expect(screen.getByTestId("sql-editor-action")).not.toHaveAttribute(
+ "data-size"
+ );
+ });
+
test("Query completion offers a database change", () => {
mocks.scenarioId = "query-data";
mocks.guideContext = guideContext({
@@ -543,6 +690,9 @@ describe("WorkspaceSetupGuide", () => {
render(<WorkspaceSetupGuide />);
expect(screen.getByText("workspace-setup-guide.actions.query")).toBeVisible();
+ expect(screen.getByTestId("sql-editor-action")).not.toHaveAttribute(
+ "data-size"
+ );
expect(screen.queryByText("workspace-setup-guide.actions.change")).not.toBeInTheDocument();
});
diff --git a/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.tsx b/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.tsx
index 52bb34ae01..285559ffbc 100644
--- a/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.tsx
+++ b/frontend/src/modules/workspace-setup-guide/WorkspaceSetupGuide.tsx
@@ -39,10 +39,9 @@ export function WorkspaceSetupGuide() {
const currentRoute = useCurrentRoute();
const scenarioId = readSelectedGuideScenarioId();
const workspaceUsage = readGuideWorkspaceUsage();
- const isSaaS = useAppStore((state) => state.isSaaSMode());
const journey = useMemo(
- () => getGuideJourney(scenarioId, workspaceUsage, isSaaS),
- [isSaaS, scenarioId, workspaceUsage]
+ () => getGuideJourney(scenarioId, workspaceUsage),
+ [scenarioId, workspaceUsage]
);
const dismissed = useIntroStateByKey(GUIDE_PROGRESS_KEYS.dismissed);
const completionAcknowledged = useIntroStateByKey(
@@ -68,6 +67,10 @@ export function WorkspaceSetupGuide() {
const [productModelOpen, setProductModelOpen] = useState(false);
const [selectedStepId, setSelectedStepId] = useState<GuideStepId>();
const [stepsOverflow, setStepsOverflow] = useState(false);
+ const [completionCompact, setCompletionCompact] = useState(false);
+ const guideBarRef = useRef<HTMLDivElement>(null);
+ const completionTitleRef = useRef<HTMLDivElement>(null);
+ const completionWideWidthRef = useRef(0);
const stepViewportRef = useRef<HTMLDivElement>(null);
const stepMeasurementRef = useRef<HTMLDivElement>(null);
const guide = useMemo(
@@ -107,6 +110,44 @@ export function WorkspaceSetupGuide() {
updateOverflow();
return () => observer.disconnect();
}, [guide.complete, guide.steps, i18n.resolvedLanguage]);
+
+ useLayoutEffect(() => {
+ completionWideWidthRef.current = 0;
+ setCompletionCompact(false);
+ }, [i18n.resolvedLanguage, journey.id]);
+
+ useLayoutEffect(() => {
+ if (!guide.complete) {
+ completionWideWidthRef.current = 0;
+ setCompletionCompact(false);
+ return;
+ }
+ const guideBar = guideBarRef.current;
+ const completionTitle = completionTitleRef.current;
+ if (!guideBar || !completionTitle) return;
+
+ const updateOverflow = () => {
+ if (guideBar.clientWidth === 0) return;
+ if (completionCompact) {
+ if (guideBar.clientWidth >= completionWideWidthRef.current) {
+ setCompletionCompact(false);
+ }
+ return;
+ }
+
+ const clippedWidth =
+ completionTitle.scrollWidth - completionTitle.clientWidth;
+ if (clippedWidth > 0) {
+ completionWideWidthRef.current = guideBar.clientWidth + clippedWidth;
+ setCompletionCompact(true);
+ }
+ };
+ const observer = new ResizeObserver(updateOverflow);
+ observer.observe(guideBar);
+ observer.observe(completionTitle);
+ updateOverflow();
+ return () => observer.disconnect();
+ }, [completionCompact, guide.complete, i18n.resolvedLanguage, journey.id]);
const onSelectStep = (step: ResolvedGuideStep) => {
setSelectedStepId(step.definition.id);
const action = step.actions.select;
@@ -118,7 +159,9 @@ export function WorkspaceSetupGuide() {
const handleDismiss = () => {
useAppStore.getState().saveIntroStateByKey({
- key: GUIDE_PROGRESS_KEYS.dismissed,
+ key: guide.complete
+ ? guideCompletionAcknowledgedKey(journey.id)
+ : GUIDE_PROGRESS_KEYS.dismissed,
newState: true,
});
};
@@ -134,10 +177,15 @@ export function WorkspaceSetupGuide() {
const hasDatabaseTarget =
!!context.databaseName && !!context.databaseProjectName;
+ const completionPrimaryAction = journey.completionActions[0];
return (
<>
- <div className="flex w-full shrink-0 items-center gap-x-2 border-t border-block-border bg-background px-4 py-3 shadow-[0_-2px_10px_rgba(0,0,0,0.04)] 2xl:gap-x-4 2xl:px-5 2xl:py-4">
+ <div
+ ref={guideBarRef}
+ data-testid="workspace-setup-guide"
+ className="flex w-full shrink-0 items-center gap-x-2 border-t border-block-border bg-background px-4 py-3 shadow-[0_-2px_10px_rgba(0,0,0,0.04)] 2xl:gap-x-4 2xl:px-5 2xl:py-4"
+ >
<div className="flex min-w-0 flex-1 items-center gap-x-2 overflow-hidden 2xl:gap-x-4">
<div className="flex shrink-0 items-center gap-x-1">
<div className="shrink-0 text-sm font-semibold text-main 2xl:text-base">
@@ -160,12 +208,18 @@ export function WorkspaceSetupGuide() {
</div>
{guide.complete ? (
<div className="min-w-0 flex-1">
- <div className="text-sm font-medium text-main">
+ <div
+ ref={completionTitleRef}
+ data-testid="completion-title"
+ className="truncate text-sm font-medium whitespace-nowrap text-main"
+ >
{t(journey.completionTitleKey)}
</div>
- <div className="truncate text-sm text-control-light">
- {t(journey.completionDescriptionKey)}
- </div>
+ {!completionCompact && (
+ <div className="truncate text-sm text-control-light">
+ {t(journey.completionDescriptionKey)}
+ </div>
+ )}
</div>
) : (
<div
@@ -346,10 +400,13 @@ export function WorkspaceSetupGuide() {
<div className="ml-auto flex shrink-0 items-center gap-x-2">
{guide.complete &&
hasDatabaseTarget &&
- journey.completionActions.includes("create-change") && (
+ journey.completionActions.includes("create-change") &&
+ (!completionCompact ||
+ completionPrimaryAction === "create-change") && (
<Button
type="button"
appearance="secondary"
+ size={completionCompact ? "sm" : undefined}
onClick={() => {
void preCreateIssue(context.databaseProjectName, [
context.databaseName,
@@ -361,37 +418,26 @@ export function WorkspaceSetupGuide() {
)}
{guide.complete &&
hasDatabaseTarget &&
- journey.completionActions.includes("open-sql-editor") && (
+ journey.completionActions.includes("open-sql-editor") &&
+ (!completionCompact ||
+ completionPrimaryAction === "open-sql-editor") && (
<SQLEditorButton
database={{
name: context.databaseName,
project: context.databaseProjectName,
}}
openInNewTab
- size="sm"
+ size={completionCompact ? "sm" : undefined}
label={t("workspace-setup-guide.actions.query")}
/>
)}
- {guide.complete && (
- <Button
- type="button"
- data-testid="complete-guide"
- onClick={() =>
- useAppStore.getState().saveIntroStateByKey({
- key: guideCompletionAcknowledgedKey(journey.id),
- newState: true,
- })
- }
- >
- {t("workspace-setup-guide.actions.done")}
- </Button>
- )}
{!guide.complete && primaryAction?.type === "open-sql-editor" && (
<SQLEditorButton
data-testid="active-action"
database={primaryAction.database}
openInNewTab
size="sm"
+ className="2xl:h-9 2xl:gap-1.5 2xl:px-3 2xl:text-sm 2xl:leading-5"
label={t("workspace-setup-guide.actions.query")}
/>
)}
diff --git a/frontend/src/modules/workspace-setup-guide/resolve.test.ts b/frontend/src/modules/workspace-setup-guide/resolve.test.ts
index f3a43948ff..76c1b3951c 100644
--- a/frontend/src/modules/workspace-setup-guide/resolve.test.ts
+++ b/frontend/src/modules/workspace-setup-guide/resolve.test.ts
@@ -18,8 +18,7 @@ const STEP_IDS: GuideStepId[] = [
"explore-database",
"query-data",
"create-database-change",
- "create-user",
- "grant-access",
+ "add-member",
];
const createContext = (
@@ -47,14 +46,12 @@ const completionById: Record<GuideStepId, keyof GuideContext> = {
"explore-database": "hasExploredDatabase",
"query-data": "hasRunStatement",
"create-database-change": "hasCreatedChangeIssue",
- "create-user": "hasOtherWorkspaceMember",
- "grant-access": "hasOtherWorkspaceMember",
+ "add-member": "hasOtherWorkspaceMember",
};
const definition = (id: GuideStepId): GuideStepDefinition => ({
id,
- analyticsKey:
- id === "create-user" || id === "grant-access" ? "add-teammate" : id,
+ analyticsKey: id === "add-member" ? "add-teammate" : id,
labelKey: `label.${id}`,
descriptionKey: `description.${id}`,
isComplete: (context) => Boolean(context[completionById[id]]),
diff --git a/frontend/src/modules/workspace-setup-guide/scenarios.test.ts b/frontend/src/modules/workspace-setup-guide/scenarios.test.ts
index 310d79aad8..99a448f281 100644
--- a/frontend/src/modules/workspace-setup-guide/scenarios.test.ts
+++ b/frontend/src/modules/workspace-setup-guide/scenarios.test.ts
@@ -85,30 +85,20 @@ describe("workspace setup guide journeys", () => {
])(
"appends the team modifier after the %s journey",
(scenarioId, baseSteps) => {
- const journey = getGuideJourney(scenarioId, "team", false);
+ const journey = getGuideJourney(scenarioId, "team");
expect(journey.steps.map(({ stepId }) => stepId)).toEqual([
...baseSteps,
- "create-user",
+ "add-member",
]);
expect(journey.steps.at(-1)).toEqual({
- stepId: "create-user",
+ stepId: "add-member",
kind: "modifier",
dependsOn: [baseSteps.at(-1)],
});
}
);
- test("uses a fixed grant-access step for SaaS team journeys", () => {
- const journey = getGuideJourney("query-data", "team", true);
-
- expect(journey.steps.at(-1)).toEqual({
- stepId: "grant-access",
- kind: "modifier",
- dependsOn: ["query-data"],
- });
- });
-
test.each([undefined, "solo" as const])(
"does not append the team modifier for workspace usage %s",
(workspaceUsage) => {
diff --git a/frontend/src/modules/workspace-setup-guide/scenarios.ts b/frontend/src/modules/workspace-setup-guide/scenarios.ts
index 4f3c6569c1..38806bdfab 100644
--- a/frontend/src/modules/workspace-setup-guide/scenarios.ts
+++ b/frontend/src/modules/workspace-setup-guide/scenarios.ts
@@ -64,8 +64,7 @@ export const GUIDE_SCENARIO_REGISTRY: Readonly<
export const getGuideJourney = (
scenarioId: GuideScenarioId | undefined,
- workspaceUsage?: GuideWorkspaceUsage,
- isSaaS = false
+ workspaceUsage?: GuideWorkspaceUsage
): GuideJourney => {
const journey = scenarioId
? GUIDE_SCENARIO_REGISTRY[scenarioId]
@@ -79,7 +78,7 @@ export const getGuideJourney = (
steps: [
...journey.steps,
{
- stepId: isSaaS ? "grant-access" : "create-user",
+ stepId: "add-member",
kind: "modifier",
dependsOn: [previousStep.stepId],
},
diff --git a/frontend/src/modules/workspace-setup-guide/steps.test.ts b/frontend/src/modules/workspace-setup-guide/steps.test.ts
index ef1710bc14..cfa875d070 100644
--- a/frontend/src/modules/workspace-setup-guide/steps.test.ts
+++ b/frontend/src/modules/workspace-setup-guide/steps.test.ts
@@ -45,8 +45,7 @@ describe("GUIDE_STEP_REGISTRY", () => {
"explore-database",
"query-data",
"create-database-change",
- "create-user",
- "grant-access",
+ "add-member",
]);
});
@@ -63,8 +62,7 @@ describe("GUIDE_STEP_REGISTRY", () => {
],
["query-data", { hasRunStatement: true }],
["create-database-change", { hasCreatedChangeIssue: true }],
- ["create-user", { hasOtherWorkspaceMember: true }],
- ["grant-access", { hasOtherWorkspaceMember: true }],
+ ["add-member", { hasOtherWorkspaceMember: true }],
] as const)("uses observable evidence for %s", (stepId, completed) => {
expect(
GUIDE_STEP_REGISTRY[stepId].isComplete(createContext(completed))
@@ -209,43 +207,38 @@ describe("GUIDE_STEP_REGISTRY", () => {
}
);
- test.each([createContext(), createContext({ isSaaS: true })])(
- "always opens Users for the self-host teammate step",
- (context) => {
- expect(
- GUIDE_STEP_REGISTRY["create-user"].resolveActions(context)
- ).toEqual({
- select: {
- type: "navigate",
- target: {
- name: WORKSPACE_ROUTE_USERS,
- query: {
- [PRODUCT_INTRO_QUERY_KEY]: CREATE_USER_PRODUCT_INTRO,
- },
+ test("opens Users when self-host has no other human user", () => {
+ const context = createContext();
+
+ expect(GUIDE_STEP_REGISTRY["add-member"].resolveActions(context)).toEqual({
+ select: {
+ type: "navigate",
+ target: {
+ name: WORKSPACE_ROUTE_USERS,
+ query: {
+ [PRODUCT_INTRO_QUERY_KEY]: CREATE_USER_PRODUCT_INTRO,
},
},
- });
- }
- );
+ },
+ });
+ });
- test.each([createContext(), createContext({ hasOtherHumanUser: true })])(
- "always opens Members for the SaaS teammate step",
- (context) => {
- expect(
- GUIDE_STEP_REGISTRY["grant-access"].resolveActions(context)
- ).toEqual({
- select: {
- type: "navigate",
- target: {
- name: WORKSPACE_ROUTE_MEMBERS,
- query: {
- [PRODUCT_INTRO_QUERY_KEY]: GRANT_ACCESS_PRODUCT_INTRO,
- },
+ test.each([
+ createContext({ isSaaS: true }),
+ createContext({ hasOtherHumanUser: true }),
+ ])("opens Members when the teammate can be granted access", (context) => {
+ expect(GUIDE_STEP_REGISTRY["add-member"].resolveActions(context)).toEqual({
+ select: {
+ type: "navigate",
+ target: {
+ name: WORKSPACE_ROUTE_MEMBERS,
+ query: {
+ [PRODUCT_INTRO_QUERY_KEY]: GRANT_ACCESS_PRODUCT_INTRO,
},
},
- });
- }
- );
+ },
+ });
+ });
test.each([
["create-project", PROJECT_V1_ROUTE_DASHBOARD, true],
@@ -253,8 +246,8 @@ describe("GUIDE_STEP_REGISTRY", () => {
["explore-database", "workspace.project.database.detail", true],
["query-data", "sql-editor.database", true],
["create-database-change", PROJECT_V1_ROUTE_PLAN_DETAIL, true],
- ["create-user", WORKSPACE_ROUTE_USERS, true],
- ["grant-access", WORKSPACE_ROUTE_MEMBERS, true],
+ ["add-member", WORKSPACE_ROUTE_USERS, true],
+ ["add-member", WORKSPACE_ROUTE_MEMBERS, true],
] as const)("matches %s on %s", (stepId, name, expected) => {
expect(
GUIDE_STEP_REGISTRY[stepId as GuideStepId].matchesRoute({
diff --git a/frontend/src/modules/workspace-setup-guide/steps.ts b/frontend/src/modules/workspace-setup-guide/steps.ts
index b29d9057b9..5bd1f2856d 100644
--- a/frontend/src/modules/workspace-setup-guide/steps.ts
+++ b/frontend/src/modules/workspace-setup-guide/steps.ts
@@ -134,42 +134,35 @@ export const GUIDE_STEP_REGISTRY: GuideStepRegistry = {
},
}),
},
- "create-user": {
- id: "create-user",
+ "add-member": {
+ id: "add-member",
analyticsKey: "add-teammate",
labelKey: "workspace-setup-guide.steps.add-teammate",
descriptionKey: "workspace-setup-guide.descriptions.add-teammate",
isComplete: (context) => context.hasOtherWorkspaceMember,
- matchesRoute: (route) => isRouteInside(route.name, WORKSPACE_ROUTE_USERS),
- resolveActions: () => ({
- select: {
- type: "navigate",
- target: {
- name: WORKSPACE_ROUTE_USERS,
- query: {
- [PRODUCT_INTRO_QUERY_KEY]: CREATE_USER_PRODUCT_INTRO,
- },
- },
- },
- }),
- },
- "grant-access": {
- id: "grant-access",
- analyticsKey: "add-teammate",
- labelKey: "workspace-setup-guide.steps.add-teammate",
- descriptionKey: "workspace-setup-guide.descriptions.add-teammate",
- isComplete: (context) => context.hasOtherWorkspaceMember,
- matchesRoute: (route) => isRouteInside(route.name, WORKSPACE_ROUTE_MEMBERS),
- resolveActions: () => ({
- select: {
- type: "navigate",
- target: {
- name: WORKSPACE_ROUTE_MEMBERS,
- query: {
- [PRODUCT_INTRO_QUERY_KEY]: GRANT_ACCESS_PRODUCT_INTRO,
- },
+ matchesRoute: (route) =>
+ isRouteInside(route.name, WORKSPACE_ROUTE_USERS) ||
+ isRouteInside(route.name, WORKSPACE_ROUTE_MEMBERS),
+ resolveActions: (context) => {
+ const grantAccess = context.isSaaS || context.hasOtherHumanUser;
+ return {
+ select: {
+ type: "navigate",
+ target: grantAccess
+ ? {
+ name: WORKSPACE_ROUTE_MEMBERS,
+ query: {
+ [PRODUCT_INTRO_QUERY_KEY]: GRANT_ACCESS_PRODUCT_INTRO,
+ },
+ }
+ : {
+ name: WORKSPACE_ROUTE_USERS,
+ query: {
+ [PRODUCT_INTRO_QUERY_KEY]: CREATE_USER_PRODUCT_INTRO,
+ },
+ },
},
- },
- }),
+ };
+ },
},
};
diff --git a/frontend/src/modules/workspace-setup-guide/types.ts b/frontend/src/modules/workspace-setup-guide/types.ts
index 80a043586c..bf177799ae 100644
--- a/frontend/src/modules/workspace-setup-guide/types.ts
+++ b/frontend/src/modules/workspace-setup-guide/types.ts
@@ -6,8 +6,7 @@ export type GuideStepId =
| "explore-database"
| "query-data"
| "create-database-change"
- | "create-user"
- | "grant-access";
+ | "add-member";
export type GuideScenarioId = "query-data" | "create-database-change";
@@ -16,7 +15,7 @@ export type GuideWorkspaceUsage = "team" | "solo";
export type GuideJourneyId = "workspace-setup" | GuideScenarioId;
export type GuideAnalyticsKey =
- | Exclude<GuideStepId, "create-user" | "grant-access">
+ | Exclude<GuideStepId, "add-member">
| "add-teammate";
export type GuideRoute = Pick<ReactRoute, "name" | "params">;
diff --git a/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx b/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
index 21db565b31..7e456d8c3d 100644
--- a/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupPage.test.tsx
@@ -409,6 +409,25 @@ describe("WorkspaceSetupPage", () => {
);
expect(mocks.saveGuideWorkspaceUsage).toHaveBeenCalledWith("team");
expect(mocks.captureMetric).not.toHaveBeenCalled();
+
+ const submit = [...page.container.querySelectorAll("button")].find(
+ (button) => button.textContent?.includes("Setup my workspace")
+ )!;
+ await act(async () => {
+ fireEvent.click(submit);
+ await Promise.resolve();
+ await Promise.resolve();
+ });
+
+ expect(mocks.captureMetric).toHaveBeenCalledWith({
+ event: "workspace setup submitted",
+ properties: {
+ scenario: "query-data",
+ collaboration_type: "team",
+ result: "finished",
+ sample_enabled: true,
+ },
+ });
page.unmount();
});
@@ -453,6 +472,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "query-data",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: true,
},
@@ -528,6 +548,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "query-data",
+ collaboration_type: "unselected",
result: "skipped",
sample_enabled: false,
},
@@ -565,6 +586,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: true,
},
@@ -762,6 +784,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: false,
},
@@ -825,6 +848,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: false,
},
@@ -863,6 +887,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: true,
},
@@ -917,6 +942,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "skipped",
sample_enabled: false,
},
@@ -949,6 +975,7 @@ describe("WorkspaceSetupPage", () => {
event: "workspace setup submitted",
properties: {
scenario: "unselected",
+ collaboration_type: "unselected",
result: "finished",
sample_enabled: true,
},
diff --git a/frontend/src/routes/auth/WorkspaceSetupPage.tsx b/frontend/src/routes/auth/WorkspaceSetupPage.tsx
index bc8c240a03..aa9f786854 100644
--- a/frontend/src/routes/auth/WorkspaceSetupPage.tsx
+++ b/frontend/src/routes/auth/WorkspaceSetupPage.tsx
@@ -200,6 +200,7 @@ export function WorkspaceSetupPage() {
createBehaviorMetric("workspace setup submitted", {
properties: {
scenario: selectedScenarioId ?? "unselected",
+ collaboration_type: workspaceUsage ?? "unselected",
result: "finished",
sample_enabled: sampleRequested,
},
@@ -249,6 +250,7 @@ export function WorkspaceSetupPage() {
createBehaviorMetric("workspace setup submitted", {
properties: {
scenario: selectedScenarioId ?? "unselected",
+ collaboration_type: workspaceUsage ?? "unselected",
result: "skipped",
sample_enabled: false,
},