Skip to content

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

Uxw 4531 replace the group picker dropdown with a multiselect (#76648)

Andrei Chernykh7876a7420218
diff --git a/e2e/test/scenarios/admin-2/people.cy.spec.js b/e2e/test/scenarios/admin-2/people.cy.spec.js
index 7567779fbd2..7b7c96ec69e 100644
--- a/e2e/test/scenarios/admin-2/people.cy.spec.js
+++ b/e2e/test/scenarios/admin-2/people.cy.spec.js
@@ -196,8 +196,10 @@ describe("scenarios > admin > people", () => {
cy.findByLabelText(/Email/).type(email);
// Add user to Administrators group
- H.modal().findByText("Default").click();
+ H.modal().findByRole("combobox", { name: "Groups" }).click();
H.popover().findByText("Administrators").click();
+ // dismiss the open dropdown so it doesn't cover the submit button
+ H.modal().findByText("Create user").click();
clickButton("Create");
diff --git a/e2e/test/scenarios/admin-2/tenants.cy.spec.ts b/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
index 4a2ef86c58a..38dc7860b2b 100644
--- a/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
+++ b/e2e/test/scenarios/admin-2/tenants.cy.spec.ts
@@ -899,16 +899,12 @@ describe("tenant users", () => {
.click();
H.popover().findByText("Edit user").click();
- H.modal().within(() => {
- cy.findByText("Tenant groups");
- cy.findByText("All tenant users").click();
- });
-
+ H.modal().findByRole("combobox", { name: "Groups" }).click();
H.popover().findByText(GROUP_NAME).click();
H.modal().within(() => {
- cy.findByText("Tenant groups").click(); // trigger blur
- cy.findByText("2 other groups").should("be.visible");
+ cy.findByText("Tenant groups").click(); // dismiss the dropdown
+ cy.findByRole("list").findByText(GROUP_NAME).should("be.visible");
cy.button("Update").click();
});
@@ -930,12 +926,12 @@ describe("tenant users", () => {
});
H.popover().findByText(GIZMO_TENANT.name).click();
- H.modal().findByText("All tenant users").click();
+ H.modal().findByRole("combobox", { name: "Groups" }).click();
H.popover().findByText(GROUP_NAME).click();
H.modal().within(() => {
- cy.findByText("Tenant groups").click(); // trigger blur
- cy.findByText("2 other groups").should("be.visible");
+ cy.findByText("Tenant groups").click(); // dismiss the dropdown
+ cy.findByRole("list").findByText(GROUP_NAME).should("be.visible");
cy.button("Create").click();
});
cy.wait("@createUser").then(
diff --git a/enterprise/frontend/src/metabase-enterprise/group_managers/components/UserTypeToggle/UserTypeToggle.tsx b/enterprise/frontend/src/metabase-enterprise/group_managers/components/UserTypeToggle/UserTypeToggle.tsx
index 300777c3917..6a4947a69ac 100644
--- a/enterprise/frontend/src/metabase-enterprise/group_managers/components/UserTypeToggle/UserTypeToggle.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/group_managers/components/UserTypeToggle/UserTypeToggle.tsx
@@ -28,7 +28,7 @@ export const UserTypeToggle = ({
<Box
component="button"
className={S.toggle}
- c="core-filter"
+ c="brand"
px="sm"
py={0}
aria-label={tooltipText}
diff --git a/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.module.css b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.module.css
new file mode 100644
index 00000000000..52e8ed2bfde
--- /dev/null
+++ b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.module.css
@@ -0,0 +1,21 @@
+/* White, outlined pill (same approach as DimensionPill / ReorderableTagsInput).
+ Color, background and weight are set via Pill props. */
+.pill {
+ gap: var(--mantine-spacing-xs);
+ padding: rem(2px) rem(6px) rem(2px) var(--mantine-spacing-sm);
+ border: 1px solid var(--mb-color-border-neutral);
+ border-radius: 0.75rem;
+
+ /* Tighten the label so its row matches the remove button height. */
+ > span {
+ line-height: var(--mantine-line-height-sm);
+ }
+}
+
+/* Drop Mantine's default side margins so `gap` is the only inner spacing.
+ translateY seats the X on the lowercase text: flex centers it on the line
+ box, which sits ~1px above the text's optical center. */
+.remove {
+ margin: 0 !important;
+ transform: translateY(1px);
+}
diff --git a/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.tsx b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.tsx
new file mode 100644
index 00000000000..28099bfdeb2
--- /dev/null
+++ b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.tsx
@@ -0,0 +1,236 @@
+import { Fragment, type KeyboardEvent, useState } from "react";
+import { t } from "ttag";
+
+import {
+ canEditMembership,
+ getGroupNameLocalized,
+ getGroupSortOrder,
+ isAdminGroup,
+ isDataAnalystGroup,
+ isDefaultGroup,
+} from "metabase/admin/utils/groups";
+import { PLUGIN_GROUP_MANAGERS, PLUGIN_TENANTS } from "metabase/plugins";
+import {
+ Box,
+ Checkbox,
+ Combobox,
+ Divider,
+ Flex,
+ Pill,
+ PillsInput,
+ useCombobox,
+} from "metabase/ui";
+import { isNotNull } from "metabase/utils/types";
+import type { GroupId, GroupInfo } from "metabase-types/api";
+
+import S from "./GroupsMultiSelect.module.css";
+
+interface GroupsMultiSelectProps {
+ groups: GroupInfo[];
+ value: GroupId[];
+ onChange: (groupIds: GroupId[]) => void;
+ managerGroupIds?: GroupId[];
+ onToggleManager?: (groupId: GroupId) => void;
+ isCurrentUser?: boolean;
+ placeholder?: string;
+ "aria-label"?: string;
+}
+
+export const GroupsMultiSelect = ({
+ groups,
+ value,
+ onChange,
+ managerGroupIds,
+ onToggleManager,
+ isCurrentUser = false,
+ placeholder,
+ "aria-label": ariaLabel = t`Groups`,
+}: GroupsMultiSelectProps) => {
+ const combobox = useCombobox();
+ const [search, setSearch] = useState("");
+
+ const groupsById = new Map(groups.map((group) => [group.id, group]));
+
+ // All Users (or the tenant default) can't be removed, and admins can't leave Administrators.
+ const isGroupLocked = (group: GroupInfo) =>
+ !canEditMembership(group) || (isAdminGroup(group) && isCurrentUser);
+
+ const adminGroup = groups.find(isAdminGroup);
+ const isUserAdmin = adminGroup ? value.includes(adminGroup.id) : false;
+
+ const isManager = (groupId: GroupId) =>
+ managerGroupIds?.includes(groupId) ?? false;
+
+ // The member/manager toggle applies only to regular groups a non-admin user belongs to.
+ const canEditManager = (group: GroupInfo) =>
+ value.includes(group.id) &&
+ !isUserAdmin &&
+ !isGroupLocked(group) &&
+ !isAdminGroup(group) &&
+ !PLUGIN_TENANTS.isTenantGroup(group);
+
+ // Built-in "magic" groups sit above custom groups, matching the People table picker.
+ const isPinnedGroup = (group: GroupInfo) =>
+ isDefaultGroup(group) ||
+ isAdminGroup(group) ||
+ isDataAnalystGroup(group) ||
+ PLUGIN_TENANTS.isExternalUsersGroup(group);
+
+ const selectedGroups = value
+ .map((id) => groupsById.get(id))
+ .filter(isNotNull)
+ .sort(
+ (a, b) =>
+ Number(isGroupLocked(b)) - Number(isGroupLocked(a)) ||
+ getGroupSortOrder(a) - getGroupSortOrder(b),
+ );
+
+ const visibleGroups = groups
+ .filter((group) =>
+ getGroupNameLocalized(group)
+ .toLowerCase()
+ .includes(search.trim().toLowerCase()),
+ )
+ // Pinned groups lead so the divider sits at the single pinned-to-custom boundary;
+ // getGroupSortOrder alone leaves the external default (rank 3) among custom groups.
+ .sort(
+ (a, b) =>
+ Number(isPinnedGroup(b)) - Number(isPinnedGroup(a)) ||
+ getGroupSortOrder(a) - getGroupSortOrder(b),
+ );
+
+ const toggleGroup = (groupId: GroupId) =>
+ onChange(
+ value.includes(groupId)
+ ? value.filter((id) => id !== groupId)
+ : [...value, groupId],
+ );
+
+ const handleOptionSubmit = (groupIdString: string) => {
+ const group = groupsById.get(Number(groupIdString));
+ if (group && !isGroupLocked(group)) {
+ toggleGroup(group.id);
+ setSearch("");
+ }
+ };
+
+ const handleRemove = (group: GroupInfo) => {
+ if (!isGroupLocked(group)) {
+ onChange(value.filter((id) => id !== group.id));
+ }
+ };
+
+ const handleKeyDown = (event: KeyboardEvent<HTMLInputElement>) => {
+ if (event.key === "Backspace" && search === "") {
+ const removable = selectedGroups.filter((group) => !isGroupLocked(group));
+ const last = removable[removable.length - 1];
+ if (last) {
+ event.preventDefault();
+ handleRemove(last);
+ }
+ }
+ };
+
+ return (
+ <Combobox
+ store={combobox}
+ floatingStrategy="fixed"
+ onOptionSubmit={handleOptionSubmit}
+ >
+ <Combobox.DropdownTarget>
+ <PillsInput
+ onClick={() => combobox.openDropdown()}
+ rightSectionPointerEvents="none"
+ rightSection={<Combobox.Chevron />}
+ >
+ <Pill.Group role="list">
+ {selectedGroups.map((group) => (
+ <Pill
+ key={group.id}
+ className={S.pill}
+ bg="background_page-primary"
+ c="text-primary"
+ fw="normal"
+ withRemoveButton={!isGroupLocked(group)}
+ removeButtonProps={{
+ "aria-label": t`Remove ${getGroupNameLocalized(group)}`,
+ "aria-hidden": false,
+ className: S.remove,
+ }}
+ onRemove={() => handleRemove(group)}
+ >
+ {getGroupNameLocalized(group)}
+ {isManager(group.id) && ` ${t`(Manager)`}`}
+ </Pill>
+ ))}
+ <Combobox.EventsTarget>
+ <PillsInput.Field
+ aria-label={ariaLabel}
+ role="combobox"
+ value={search}
+ placeholder={value.length === 0 ? placeholder : undefined}
+ onChange={(event) => {
+ setSearch(event.currentTarget.value);
+ combobox.openDropdown();
+ combobox.updateSelectedOptionIndex();
+ }}
+ onFocus={() => combobox.openDropdown()}
+ onBlur={() => combobox.closeDropdown()}
+ onKeyDown={handleKeyDown}
+ />
+ </Combobox.EventsTarget>
+ </Pill.Group>
+ </PillsInput>
+ </Combobox.DropdownTarget>
+
+ <Combobox.Dropdown>
+ <Combobox.Options>
+ {visibleGroups.length === 0 ? (
+ <Combobox.Empty>{t`No groups found`}</Combobox.Empty>
+ ) : (
+ visibleGroups.map((group, index) => {
+ const isSelected = value.includes(group.id);
+ const previousGroup = visibleGroups[index - 1];
+ const showDivider =
+ previousGroup != null &&
+ isPinnedGroup(previousGroup) &&
+ !isPinnedGroup(group);
+ return (
+ <Fragment key={group.id}>
+ {showDivider && <Divider my="sm" />}
+ <Combobox.Option
+ value={String(group.id)}
+ aria-label={getGroupNameLocalized(group)}
+ active={isSelected}
+ disabled={isGroupLocked(group)}
+ >
+ <Flex align="center" justify="space-between" gap="sm">
+ <Flex align="center" gap="sm">
+ <Checkbox
+ checked={isSelected}
+ readOnly
+ aria-hidden
+ tabIndex={-1}
+ style={{ pointerEvents: "none" }}
+ />
+ <span>{getGroupNameLocalized(group)}</span>
+ </Flex>
+ {canEditManager(group) && (
+ <Box onMouseDown={(event) => event.preventDefault()}>
+ <PLUGIN_GROUP_MANAGERS.UserTypeToggle
+ isManager={isManager(group.id)}
+ onChange={() => onToggleManager?.(group.id)}
+ />
+ </Box>
+ )}
+ </Flex>
+ </Combobox.Option>
+ </Fragment>
+ );
+ })
+ )}
+ </Combobox.Options>
+ </Combobox.Dropdown>
+ </Combobox>
+ );
+};
diff --git a/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.unit.spec.tsx b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.unit.spec.tsx
new file mode 100644
index 00000000000..18da6174717
--- /dev/null
+++ b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/GroupsMultiSelect.unit.spec.tsx
@@ -0,0 +1,262 @@
+import userEvent from "@testing-library/user-event";
+import { useState } from "react";
+
+import { setupEnterprisePlugins } from "__support__/enterprise";
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen, within } from "__support__/ui";
+import type { GroupId, GroupInfo } from "metabase-types/api";
+import {
+ createMockGroup,
+ createMockTokenFeatures,
+} from "metabase-types/api/mocks";
+
+import { GroupsMultiSelect } from "./GroupsMultiSelect";
+
+const ALL_USERS = createMockGroup({
+ id: 1,
+ name: "All Users",
+ magic_group_type: "all-internal-users",
+});
+const ADMINISTRATORS = createMockGroup({
+ id: 2,
+ name: "Administrators",
+ magic_group_type: "admin",
+});
+const MARKETING = createMockGroup({
+ id: 3,
+ name: "Marketing",
+ magic_group_type: null,
+});
+const SALES = createMockGroup({
+ id: 4,
+ name: "Sales",
+ magic_group_type: null,
+});
+const GROUPS = [ALL_USERS, ADMINISTRATORS, MARKETING, SALES];
+
+const ALL_TENANT_USERS = createMockGroup({
+ id: 10,
+ name: "All tenant users",
+ magic_group_type: "all-external-users",
+});
+const CONTRACTORS = createMockGroup({
+ id: 11,
+ name: "Contractors",
+ magic_group_type: null,
+});
+
+function setup(
+ initialValue: GroupId[] = [ALL_USERS.id],
+ {
+ managerGroupIds = [],
+ groups = GROUPS,
+ }: { managerGroupIds?: GroupId[]; groups?: GroupInfo[] } = {},
+) {
+ const onChange = jest.fn<void, [GroupId[]]>();
+ const onToggleManager = jest.fn<void, [GroupId]>();
+
+ function Wrapper() {
+ const [value, setValue] = useState<GroupId[]>(initialValue);
+ const [managers, setManagers] = useState<GroupId[]>(managerGroupIds);
+ return (
+ <GroupsMultiSelect
+ groups={groups}
+ value={value}
+ onChange={(ids) => {
+ onChange(ids);
+ setValue(ids);
+ }}
+ managerGroupIds={managers}
+ onToggleManager={(id) => {
+ onToggleManager(id);
+ setManagers((prev) =>
+ prev.includes(id)
+ ? prev.filter((groupId) => groupId !== id)
+ : [...prev, id],
+ );
+ }}
+ />
+ );
+ }
+
+ renderWithProviders(<Wrapper />);
+ return { onChange, onToggleManager };
+}
+
+// Selected groups render as pills inside the input's `list`; the dropdown
+// options live in a separate `listbox`, so scope pill assertions to the list.
+const getPills = () => within(screen.getByRole("list"));
+const getRemoveButtons = () =>
+ screen.queryAllByRole("button", { name: /^Remove / });
+
+// True when `a` precedes `b` in DOM order.
+const isBefore = (a: Element, b: Element) =>
+ Boolean(a.compareDocumentPosition(b) & Node.DOCUMENT_POSITION_FOLLOWING);
+
+// Asserts exactly one dropdown divider, sitting between the two named options.
+const expectSingleDividerBetween = (before: string, after: string) => {
+ const separators = screen.getAllByRole("separator");
+ expect(separators).toHaveLength(1);
+ expect(
+ isBefore(screen.getByRole("option", { name: before }), separators[0]),
+ ).toBe(true);
+ expect(
+ isBefore(separators[0], screen.getByRole("option", { name: after })),
+ ).toBe(true);
+};
+
+describe("GroupsMultiSelect", () => {
+ it("renders the selected groups as pills", () => {
+ setup([ALL_USERS.id, ADMINISTRATORS.id]);
+
+ expect(getPills().getByText("All Users")).toBeInTheDocument();
+ expect(getPills().getByText("Administrators")).toBeInTheDocument();
+ });
+
+ it("removes a non-default group via its pill", async () => {
+ const { onChange } = setup([ALL_USERS.id, ADMINISTRATORS.id]);
+
+ // All Users stays locked, so Administrators has the only remove control,
+ // and its label names the group so pills stay distinguishable.
+ expect(getRemoveButtons()).toHaveLength(1);
+ await userEvent.click(
+ screen.getByRole("button", { name: "Remove Administrators" }),
+ );
+
+ expect(onChange).toHaveBeenLastCalledWith([ALL_USERS.id]);
+ });
+
+ it("adds a group selected from the dropdown", async () => {
+ const { onChange } = setup([ALL_USERS.id]);
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ await userEvent.click(
+ await screen.findByRole("option", { name: "Marketing" }),
+ );
+
+ expect(onChange).toHaveBeenLastCalledWith([ALL_USERS.id, MARKETING.id]);
+ });
+
+ it("tags a managed group's pill with (Manager)", () => {
+ setup([ALL_USERS.id, MARKETING.id], { managerGroupIds: [MARKETING.id] });
+
+ expect(getPills().getByText("Marketing (Manager)")).toBeInTheDocument();
+ // A group the user does not manage keeps a plain pill, with no tag.
+ expect(getPills().getByText("All Users")).toBeInTheDocument();
+ expect(
+ getPills().queryByText(/All Users \(Manager\)/),
+ ).not.toBeInTheDocument();
+ });
+
+ it("separates the built-in groups from custom groups in the dropdown", async () => {
+ setup([ALL_USERS.id]);
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ await screen.findByRole("option", { name: "Marketing" });
+
+ // Built-in groups (Administrators, All Users) sort above the custom ones
+ // (Marketing, Sales), with a single divider at exactly that boundary.
+ expectSingleDividerBetween("All Users", "Marketing");
+ });
+
+ it("removes the last removable group on Backspace in an empty field", async () => {
+ const { onChange } = setup([ALL_USERS.id, ADMINISTRATORS.id]);
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ await userEvent.keyboard("{Backspace}");
+
+ // All Users stays locked; Administrators is the last removable group.
+ expect(onChange).toHaveBeenLastCalledWith([ALL_USERS.id]);
+ });
+
+ it("does not remove a group on Backspace when only whitespace is typed", async () => {
+ const { onChange } = setup([ALL_USERS.id, ADMINISTRATORS.id]);
+
+ const input = screen.getByRole("combobox", { name: "Groups" });
+ await userEvent.click(input);
+ await userEvent.type(input, " ");
+ await userEvent.keyboard("{Backspace}");
+
+ expect(onChange).not.toHaveBeenCalled();
+ });
+
+ it("does not render the manager toggle without the group-managers feature", async () => {
+ setup([ALL_USERS.id, MARKETING.id]);
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ // Wait for the dropdown so the toggle would have rendered if it were going to.
+ await screen.findByRole("option", { name: "Marketing" });
+
+ // In OSS the group-managers plugin is a no-op, so no toggle appears.
+ expect(
+ screen.queryByRole("button", { name: /Turn into (Manager|Member)/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ describe("with the group-managers feature (EE)", () => {
+ beforeEach(() => {
+ mockSettings({
+ "token-features": createMockTokenFeatures({
+ advanced_permissions: true,
+ }),
+ });
+ setupEnterprisePlugins();
+ });
+
+ it("calls onToggleManager when the dropdown toggle is clicked", async () => {
+ const { onToggleManager } = setup([ALL_USERS.id, MARKETING.id]);
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+
+ // The toggle only shows for eligible selected groups (Marketing).
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Turn into Manager" }),
+ );
+
+ expect(onToggleManager).toHaveBeenCalledWith(MARKETING.id);
+ });
+
+ it("un-tags a manager's pill when demoted via the dropdown toggle", async () => {
+ const { onToggleManager } = setup([ALL_USERS.id, MARKETING.id], {
+ managerGroupIds: [MARKETING.id],
+ });
+
+ // The pill starts tagged as a manager.
+ expect(getPills().getByText("Marketing (Manager)")).toBeInTheDocument();
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Turn into Member" }),
+ );
+
+ expect(onToggleManager).toHaveBeenCalledWith(MARKETING.id);
+ // Demotion drops the tag, leaving a plain pill.
+ expect(await getPills().findByText("Marketing")).toBeInTheDocument();
+ expect(
+ getPills().queryByText("Marketing (Manager)"),
+ ).not.toBeInTheDocument();
+ });
+ });
+
+ describe("with tenants (EE)", () => {
+ beforeEach(() => {
+ mockSettings({
+ "token-features": createMockTokenFeatures({ tenants: true }),
+ });
+ setupEnterprisePlugins();
+ });
+
+ it("sorts the external default group above custom groups regardless of input order", async () => {
+ // Input order puts the custom group first to prove the pinned default floats up.
+ setup([ALL_TENANT_USERS.id], {
+ groups: [CONTRACTORS, ALL_TENANT_USERS],
+ });
+
+ await userEvent.click(screen.getByRole("combobox", { name: "Groups" }));
+ await screen.findByRole("option", { name: "Contractors" });
+
+ // "All tenant users" is pinned, so it leads with the divider before Contractors.
+ expectSingleDividerBetween("All tenant users", "Contractors");
+ });
+ });
+});
diff --git a/frontend/src/metabase/admin/people/components/GroupsMultiSelect/index.ts b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/index.ts
new file mode 100644
index 00000000000..970248cecf0
--- /dev/null
+++ b/frontend/src/metabase/admin/people/components/GroupsMultiSelect/index.ts
@@ -0,0 +1 @@
+export { GroupsMultiSelect } from "./GroupsMultiSelect";
diff --git a/frontend/src/metabase/admin/people/forms/UserForm.tsx b/frontend/src/metabase/admin/people/forms/UserForm.tsx
index 58808986b8d..019af2a5cc8 100644
--- a/frontend/src/metabase/admin/people/forms/UserForm.tsx
+++ b/frontend/src/metabase/admin/people/forms/UserForm.tsx
@@ -4,8 +4,8 @@ import { t } from "ttag";
import _ from "underscore";
import * as Yup from "yup";
-import { MembershipSelect } from "metabase/admin/people/components/MembershipSelect";
-import { isAdminGroup, isDefaultGroup } from "metabase/admin/utils/groups";
+import { GroupsMultiSelect } from "metabase/admin/people/components/GroupsMultiSelect";
+import { isDefaultGroup } from "metabase/admin/utils/groups";
import { useListPermissionsGroupsQuery } from "metabase/api";
import { FormField } from "metabase/common/components/FormField";
import { FormFooter } from "metabase/common/components/FormFooter";
@@ -22,7 +22,7 @@ import {
} from "metabase/plugins";
import { Button } from "metabase/ui";
import * as Errors from "metabase/utils/errors";
-import type { GroupId, Member, User, UserId } from "metabase-types/api";
+import type { GroupId, User, UserId } from "metabase-types/api";
const localUserSchema = Yup.object({
first_name: Yup.string().nullable().max(100, Errors.maxLength).default(null),
@@ -57,81 +57,58 @@ const FormGroupsWidget = ({
return null;
}
- const adminGroup = _.find(groups, isAdminGroup);
const defaultGroup = _.find(
groups,
external ? PLUGIN_TENANTS.isExternalUsersGroup : isDefaultGroup,
);
- const value = formValue ?? [
- { id: defaultGroup?.id, is_group_manager: false },
- ];
-
- const memberships = value.reduce((acc, { id, ...membershipData }) => {
- if (id != null) {
- acc.set(id, membershipData);
- }
- return acc;
- }, new Map());
-
- const isUserAdmin = memberships.has(adminGroup?.id);
-
- const handleAdd = (groupId: GroupId, membershipData: Partial<Member>) => {
- const updatedValue = Array.from(memberships.entries()).map(
- ([id, membershipData]) => {
- return {
- id,
- ...membershipData,
- };
- },
- );
+ const memberships =
+ formValue ??
+ (defaultGroup ? [{ id: defaultGroup.id, is_group_manager: false }] : []);
- updatedValue.push({ id: groupId, ...membershipData });
- setValue(updatedValue);
- };
+ // Preserve each group's manager flag across selection changes.
+ const managerFlagByGroupId = new Map(
+ memberships.map((membership) => [
+ membership.id,
+ membership.is_group_manager ?? false,
+ ]),
+ );
- const handleRemove = (groupId: GroupId) => {
- const updatedValue = Array.from(memberships.entries())
- .map(([id, membershipData]) => {
- if (id === groupId) {
- return null;
- }
-
- return {
- id,
- ...membershipData,
- };
- })
- .filter(Boolean);
-
- setValue(updatedValue);
- };
- const handleChange = (
- groupId: GroupId,
- newMembershipData: Partial<Member>,
- ) => {
- const updatedValue = Array.from(memberships.entries()).map(
- ([id, membershipData]) => {
- const data = groupId === id ? newMembershipData : membershipData;
- return {
- id,
- ...data,
- };
- },
+ const handleChange = (groupIds: GroupId[]) => {
+ const ids = defaultGroup
+ ? Array.from(new Set([defaultGroup.id, ...groupIds]))
+ : groupIds;
+
+ setValue(
+ ids.map((id) => ({
+ id,
+ is_group_manager: managerFlagByGroupId.get(id) ?? false,
+ })),
);
+ };
- setValue(updatedValue);
+ const managerGroupIds = memberships
+ .filter((membership) => membership.is_group_manager)
+ .map((membership) => membership.id);
+
+ const handleToggleManager = (groupId: GroupId) => {
+ setValue(
+ memberships.map((membership) =>
+ membership.id === groupId
+ ? { ...membership, is_group_manager: !membership.is_group_manager }
+ : membership,
+ ),
+ );
};
return (
<FormField className={className} style={style} title={title}>
- <MembershipSelect
+ <GroupsMultiSelect
groups={groups}
- memberships={memberships}
- onAdd={handleAdd}
- onRemove={handleRemove}
+ value={memberships.map((membership) => membership.id)}
onChange={handleChange}
- isUserAdmin={isUserAdmin}
+ managerGroupIds={managerGroupIds}
+ onToggleManager={handleToggleManager}
/>
</FormField>
);
diff --git a/frontend/src/metabase/admin/people/forms/UserForm.unit.spec.tsx b/frontend/src/metabase/admin/people/forms/UserForm.unit.spec.tsx
index 479db442b9f..3fa71c31e06 100644
--- a/frontend/src/metabase/admin/people/forms/UserForm.unit.spec.tsx
+++ b/frontend/src/metabase/admin/people/forms/UserForm.unit.spec.tsx
@@ -4,7 +4,7 @@ import fetchMock from "fetch-mock";
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
import { setupTenantEntpoints } from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
-import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
import { createMockState } from "metabase/redux/store/mocks";
import type { Tenant } from "metabase-types/api";
import {
@@ -41,6 +41,7 @@ interface SetupOpts {
tenants?: Tenant[];
hideNameFields?: boolean;
hideAttributes?: boolean;
+ tokenFeatures?: Parameters<typeof createMockTokenFeatures>[0];
}
const setup = ({
@@ -50,6 +51,7 @@ const setup = ({
tenants = [] as Tenant[],
hideNameFields = false,
hideAttributes = false,
+ tokenFeatures = { sandboxes: true, tenants: true },
}: SetupOpts = {}) => {
const onSubmit = jest.fn();
const onCancel = jest.fn();
@@ -60,10 +62,7 @@ const setup = ({
const state = createMockState({
settings: mockSettings({
- "token-features": createMockTokenFeatures({
- sandboxes: true,
- tenants: true,
- }),
+ "token-features": createMockTokenFeatures(tokenFeatures),
}),
});
@@ -105,7 +104,9 @@ describe("UserForm", () => {
// This isn't a proper form input, so we need to grab the label specifically,
// And can ensure the proper default group is applied
expect(await screen.findByText("Groups")).toBeInTheDocument();
- expect(await screen.findByText("foo")).toBeInTheDocument();
+ expect(
+ within(await screen.findByRole("list")).getByText("foo"),
+ ).toBeInTheDocument();
expect(screen.queryByText("Attributes")).not.toBeInTheDocument();
});
@@ -120,18 +121,13 @@ describe("UserForm", () => {
it("should allow you to add groups", async () => {
const { onSubmit } = setup();
- await userEvent.click(await screen.findByText("foo"));
- await userEvent.click(await screen.findByText("Administrators"));
-
- expect(
- await screen.findByRole("generic", { name: "group-summary" }),
- ).toHaveTextContent("Admin and 1 other group");
-
- await userEvent.click(await screen.findByText("bar"));
-
- expect(
- await screen.findByRole("generic", { name: "group-summary" }),
- ).toHaveTextContent("Admin and 2 other groups");
+ await userEvent.click(
+ await screen.findByRole("combobox", { name: "Groups" }),
+ );
+ await userEvent.click(
+ await screen.findByRole("option", { name: "Administrators" }),
+ );
+ await userEvent.click(await screen.findByRole("option", { name: "bar" }));
expect(
await screen.findByRole("button", { name: "Update" }),
@@ -146,22 +142,10 @@ describe("UserForm", () => {
{
...USER,
user_group_memberships: [
- {
- id: 1,
- is_group_manager: false,
- },
- {
- id: 3,
- is_group_manager: false,
- },
- {
- id: 2,
- is_group_manager: false,
- },
- {
- id: 4,
- is_group_manager: false,
- },
+ { id: 1, is_group_manager: false },
+ { id: 3, is_group_manager: false },
+ { id: 2, is_group_manager: false },
+ { id: 4, is_group_manager: false },
],
},
expect.anything(),
@@ -169,18 +153,14 @@ describe("UserForm", () => {
});
});
- it("should allow you to remove a group", async () => {
+ it("should allow you to remove a non-default group", async () => {
const { onSubmit } = setup();
- await userEvent.click(await screen.findByText("foo"));
+ // foo (id 3) is the only removable selected group; All Users is locked.
await userEvent.click(
- await screen.findByRole("listitem", { name: "foo" }),
+ await screen.findByRole("button", { name: "Remove foo" }),
);
- expect(
- await screen.findByRole("generic", { name: "group-summary" }),
- ).toHaveTextContent("Default");
-
await userEvent.click(
await screen.findByRole("button", { name: "Update" }),
);
@@ -189,17 +169,25 @@ describe("UserForm", () => {
expect(onSubmit).toHaveBeenCalledWith(
{
...USER,
- user_group_memberships: [
- {
- id: 1,
- is_group_manager: false,
- },
- ],
+ user_group_memberships: [{ id: 1, is_group_manager: false }],
},
expect.anything(),
);
});
});
+
+ it("keeps the default group locked and non-removable", async () => {
+ setup();
+
+ // All Users renders as a pill...
+ expect(
+ within(await screen.findByRole("list")).getByText("All Users"),
+ ).toBeInTheDocument();
+ // ...but without a remove control, so only foo (non-default) is removable.
+ expect(screen.getAllByRole("button", { name: /^Remove / })).toHaveLength(
+ 1,
+ );
+ });
});
describe("EE", () => {
@@ -414,4 +402,85 @@ describe("UserForm", () => {
expect(screen.queryByText("Attributes")).not.toBeInTheDocument();
});
});
+
+ describe("group manager memberships (EE)", () => {
+ const eeTokenFeatures = {
+ sandboxes: true,
+ tenants: true,
+ advanced_permissions: true,
+ };
+
+ const managerUser = {
+ ...USER,
+ user_group_memberships: [
+ { id: 1, is_group_manager: false },
+ { id: 3, is_group_manager: true },
+ ],
+ };
+
+ it("preserves a group's manager flag when another group is added", async () => {
+ const { onSubmit } = setup({
+ enterprisePlugins: ["group_managers"],
+ tokenFeatures: eeTokenFeatures,
+ initialValues: managerUser,
+ });
+
+ await userEvent.click(
+ await screen.findByRole("combobox", { name: "Groups" }),
+ );
+ await userEvent.click(await screen.findByRole("option", { name: "bar" }));
+
+ expect(
+ await screen.findByRole("button", { name: "Update" }),
+ ).toBeEnabled();
+ await userEvent.click(screen.getByRole("button", { name: "Update" }));
+
+ await waitFor(() => {
+ expect(onSubmit).toHaveBeenCalledWith(
+ {
+ ...USER,
+ user_group_memberships: [
+ { id: 1, is_group_manager: false },
+ { id: 3, is_group_manager: true },
+ { id: 4, is_group_manager: false },
+ ],
+ },
+ expect.anything(),
+ );
+ });
+ });
+
+ it("promotes a member to manager via the dropdown toggle", async () => {
+ const { onSubmit } = setup({
+ enterprisePlugins: ["group_managers"],
+ tokenFeatures: eeTokenFeatures,
+ });
+
+ await userEvent.click(
+ await screen.findByRole("combobox", { name: "Groups" }),
+ );
+ // foo (id 3) is a selected regular group, so its dropdown row offers promotion.
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Turn into Manager" }),
+ );
+
+ expect(
+ await screen.findByRole("button", { name: "Update" }),
+ ).toBeEnabled();
+ await userEvent.click(screen.getByRole("button", { name: "Update" }));
+
+ await waitFor(() => {
+ expect(onSubmit).toHaveBeenCalledWith(
+ {
+ ...USER,
+ user_group_memberships: [
+ { id: 1, is_group_manager: false },
+ { id: 3, is_group_manager: true },
+ ],
+ },
+ expect.anything(),
+ );
+ });
+ });
+ });
});