Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Fix schema selection in workspace forms (#74811)

Alexander Polyankinda74a8487d1f
diff --git a/e2e/support/helpers/e2e-workspace-helpers.ts b/e2e/support/helpers/e2e-workspace-helpers.ts
index 3fb819e530c..53e8d379dce 100644
--- a/e2e/support/helpers/e2e-workspace-helpers.ts
+++ b/e2e/support/helpers/e2e-workspace-helpers.ts
@@ -95,8 +95,13 @@ export const NewWorkspaceDatabaseModal = {
NewWorkspaceDatabaseModal.get().findByRole("textbox", { name: "Database" }),
schemasGroup: () =>
NewWorkspaceDatabaseModal.get().findByText("Schemas to include"),
- schemaCheckbox: (name: string) =>
- NewWorkspaceDatabaseModal.get().findByRole("checkbox", { name }),
+ schemaSelect: () =>
+ NewWorkspaceDatabaseModal.get().findByLabelText("Schemas to include"),
+ schemaOption: (name: string) => cy.findByRole("option", { name }),
+ selectAllSchemasButton: () =>
+ NewWorkspaceDatabaseModal.get().findByRole("button", {
+ name: "Select all",
+ }),
submitButton: () =>
NewWorkspaceDatabaseModal.get().findByRole("button", {
name: "Add database",
@@ -109,8 +114,13 @@ export const UpdateWorkspaceDatabaseModal = {
get: () => modal(),
schemasGroup: () =>
UpdateWorkspaceDatabaseModal.get().findByText("Schemas to include"),
- schemaCheckbox: (name: string) =>
- UpdateWorkspaceDatabaseModal.get().findByRole("checkbox", { name }),
+ schemaSelect: () =>
+ UpdateWorkspaceDatabaseModal.get().findByLabelText("Schemas to include"),
+ schemaOption: (name: string) => cy.findByRole("option", { name }),
+ selectAllSchemasButton: () =>
+ UpdateWorkspaceDatabaseModal.get().findByRole("button", {
+ name: "Select all",
+ }),
saveButton: () =>
UpdateWorkspaceDatabaseModal.get().findByRole("button", {
name: "Save changes",
diff --git a/e2e/test/scenarios/workspaces/workspace-manager.cy.spec.ts b/e2e/test/scenarios/workspaces/workspace-manager.cy.spec.ts
index f81d9adb1b1..15226e08731 100644
--- a/e2e/test/scenarios/workspaces/workspace-manager.cy.spec.ts
+++ b/e2e/test/scenarios/workspaces/workspace-manager.cy.spec.ts
@@ -86,7 +86,8 @@ describe("scenarios > workspaces > workspace manager", () => {
cy.log("add the writable Postgres database with one schema");
H.WorkspaceDatabaseSection.addDatabaseButton().click();
- H.NewWorkspaceDatabaseModal.schemaCheckbox(PG_SCHEMA_A).click();
+ H.NewWorkspaceDatabaseModal.schemaSelect().click();
+ H.NewWorkspaceDatabaseModal.schemaOption(PG_SCHEMA_A).click();
H.NewWorkspaceDatabaseModal.submitButton().click();
H.WorkspaceDatabaseSection.database(POSTGRES_DB_NAME)
@@ -96,7 +97,8 @@ describe("scenarios > workspaces > workspace manager", () => {
cy.log("edit the database to include a second schema");
H.WorkspaceDatabaseSection.databaseMenuButton(POSTGRES_DB_NAME).click();
H.WorkspaceDatabaseSection.editMenuItem().click();
- H.UpdateWorkspaceDatabaseModal.schemaCheckbox(PG_SCHEMA_B).click();
+ H.UpdateWorkspaceDatabaseModal.schemaSelect().click();
+ H.UpdateWorkspaceDatabaseModal.schemaOption(PG_SCHEMA_B).click();
H.UpdateWorkspaceDatabaseModal.saveButton().click();
H.WorkspaceDatabaseSection.database(POSTGRES_DB_NAME)
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/DatabaseEmptyState/DatabaseEmptyState.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/DatabaseEmptyState/DatabaseEmptyState.unit.spec.tsx
index 9925b67ee83..9d648ee32b3 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/DatabaseEmptyState/DatabaseEmptyState.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/DatabaseEmptyState/DatabaseEmptyState.unit.spec.tsx
@@ -60,7 +60,10 @@ describe("DatabaseEmptyState", () => {
const dialog = await screen.findByRole("dialog");
await userEvent.click(
- await within(dialog).findByRole("checkbox", { name: "public" }),
+ await within(dialog).findByLabelText("Schemas to include"),
+ );
+ await userEvent.click(
+ await screen.findByRole("option", { name: "public" }),
);
await userEvent.click(
within(dialog).getByRole("button", { name: "Add database" }),
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
index db05bec860c..ca2cb2b7619 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/NewDatabaseModal/NewDatabaseModal.unit.spec.tsx
@@ -79,8 +79,9 @@ describe("NewDatabaseModal", () => {
it("can create a workspace database", async () => {
const { onCreate, createdWorkspace } = setup();
+ await userEvent.click(await screen.findByLabelText("Schemas to include"));
await userEvent.click(
- await screen.findByRole("checkbox", { name: "public" }),
+ await screen.findByRole("option", { name: "public" }),
);
await userEvent.click(screen.getByRole("button", { name: "Add database" }));
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.tsx
index f432a301e75..ab775b883c9 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.tsx
@@ -1,9 +1,13 @@
+import { useId } from "react";
import { t } from "ttag";
import { useListDatabaseSchemasQuery } from "metabase/api";
-import { Checkbox, Input, ScrollArea, Stack, Text } from "metabase/ui";
+import { Button, Group, Input, MultiSelect, Stack } from "metabase/ui";
import type { DatabaseId } from "metabase-types/api";
+// to not cover the add database button
+const DROPDOWN_WIDTH = 432;
+
export type SchemaMultiSelectProps = {
databaseId: DatabaseId;
value: string[];
@@ -18,40 +22,32 @@ export function SchemaMultiSelect({
const { data: schemas = [] } = useListDatabaseSchemasQuery({
id: databaseId,
});
+ const inputId = useId();
const isAll = schemas.length > 0 && value.length === schemas.length;
- const isNone = value.length === 0;
const handleToggleAll = () => {
onChange(isAll ? [] : schemas);
};
return (
- <Input.Wrapper label={t`Schemas to include`}>
- {schemas.length > 0 && (
- <Stack gap="sm" mt="xs">
- <Checkbox
- variant="stacked"
- label={
- <Text c="text-secondary" lh="inherit">
- {isAll ? t`Select none` : t`Select all`}
- </Text>
- }
- checked={isAll}
- indeterminate={!isAll && !isNone}
- onChange={handleToggleAll}
- />
- <Checkbox.Group value={value} onChange={onChange}>
- <ScrollArea.Autosize mah={200}>
- <Stack gap="sm">
- {schemas.map((schema) => (
- <Checkbox key={schema} value={schema} label={schema} />
- ))}
- </Stack>
- </ScrollArea.Autosize>
- </Checkbox.Group>
- </Stack>
- )}
- </Input.Wrapper>
+ <Stack gap="xs">
+ <Group justify="space-between" align="center">
+ <Input.Label htmlFor={inputId}>{t`Schemas to include`}</Input.Label>
+ {schemas.length > 0 && (
+ <Button variant="subtle" size="compact-xs" onClick={handleToggleAll}>
+ {isAll ? t`Select none` : t`Select all`}
+ </Button>
+ )}
+ </Group>
+ <MultiSelect
+ id={inputId}
+ data={schemas.map((schema) => ({ value: schema, label: schema }))}
+ value={value}
+ placeholder={isAll ? t`All schemas selected` : t`Select schemas`}
+ comboboxProps={{ width: DROPDOWN_WIDTH, position: "bottom-start" }}
+ onChange={onChange}
+ />
+ </Stack>
);
}
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.unit.spec.tsx
index a2011ab848a..f68e3959a51 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/SchemaMultiSelect/SchemaMultiSelect.unit.spec.tsx
@@ -38,8 +38,9 @@ describe("SchemaMultiSelect", () => {
it("can select the first schema", async () => {
const { onChange } = setup();
+ await userEvent.click(await screen.findByLabelText("Schemas to include"));
await userEvent.click(
- await screen.findByRole("checkbox", { name: "public" }),
+ await screen.findByRole("option", { name: "public" }),
);
expect(onChange).toHaveBeenCalledWith(["public"]);
@@ -48,18 +49,19 @@ describe("SchemaMultiSelect", () => {
it("can select the second schema", async () => {
const { onChange } = setup({ value: ["public"] });
+ await userEvent.click(await screen.findByLabelText("Schemas to include"));
await userEvent.click(
- await screen.findByRole("checkbox", { name: "analytics" }),
+ await screen.findByRole("option", { name: "analytics" }),
);
expect(onChange).toHaveBeenCalledWith(["public", "analytics"]);
});
- it("selects all schemas via the top-level checkbox", async () => {
+ it("selects all schemas via the Select all button", async () => {
const { onChange } = setup({ value: ["public"] });
await userEvent.click(
- await screen.findByRole("checkbox", { name: "Select all" }),
+ await screen.findByRole("button", { name: "Select all" }),
);
expect(onChange).toHaveBeenCalledWith(["public", "analytics"]);
@@ -69,7 +71,7 @@ describe("SchemaMultiSelect", () => {
const { onChange } = setup({ value: ["public", "analytics"] });
await userEvent.click(
- await screen.findByRole("checkbox", { name: "Select none" }),
+ await screen.findByRole("button", { name: "Select none" }),
);
expect(onChange).toHaveBeenCalledWith([]);
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/UpdateDatabaseModal/UpdateDatabaseModal.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/UpdateDatabaseModal/UpdateDatabaseModal.unit.spec.tsx
index eb07bf45543..3b9c2fa31bc 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/UpdateDatabaseModal/UpdateDatabaseModal.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/DatabaseSection/UpdateDatabaseModal/UpdateDatabaseModal.unit.spec.tsx
@@ -81,8 +81,9 @@ describe("UpdateDatabaseModal", () => {
it("can update a workspace database", async () => {
const { onUpdate, updatedWorkspace } = setup();
+ await userEvent.click(await screen.findByLabelText("Schemas to include"));
await userEvent.click(
- await screen.findByRole("checkbox", { name: "analytics" }),
+ await screen.findByRole("option", { name: "analytics" }),
);
await userEvent.click(screen.getByRole("button", { name: "Save changes" }));
diff --git a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/WorkspacePage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/WorkspacePage.unit.spec.tsx
index 0c2d9c0543d..09c7d3b9bdb 100644
--- a/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/WorkspacePage.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/workspaces/pages/WorkspacePage/WorkspacePage.unit.spec.tsx
@@ -66,7 +66,10 @@ describe("WorkspacePage", () => {
const dialog = await screen.findByRole("dialog");
await userEvent.click(
- await within(dialog).findByRole("checkbox", { name: "public" }),
+ await within(dialog).findByLabelText("Schemas to include"),
+ );
+ await userEvent.click(
+ await screen.findByRole("option", { name: "public" }),
);
await userEvent.click(
within(dialog).getByRole("button", { name: "Add database" }),