Skip to content

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

Improve design of no-owner state in data structure side panel (#67772)

Anderson5c6c0751039c
diff --git a/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts b/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts
index b895d435022..487f6c5be67 100644
--- a/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/data-model/data-studio-single-table.cy.spec.ts
@@ -105,7 +105,7 @@ describe("Table editing", () => {
TablePicker.getDatabase("QA Postgres12").click();
TablePicker.getTable("Orders").click();
- H.selectHasValue("Owner", "Unspecified").click();
+ H.selectHasValue("Owner", "No owner").click();
H.selectDropdown().contains("Bobby Tables").click();
H.undoToastListContainer()
.findByText("Table owner updated")
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributes.module.css b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributes.module.css
index 29814580b69..709345bfc80 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributes.module.css
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributes.module.css
@@ -12,6 +12,18 @@
align-items: center;
grid-template-columns: subgrid;
grid-column: 1 / 3;
+
+ .label {
+ grid-column: 1;
+ }
+
+ .input {
+ grid-column: 2;
+
+ &.unset {
+ color: var(--mb-color-text-secondary);
+ }
+ }
}
.transformLink {
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditSingle.tsx b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditSingle.tsx
index 65c1ea3c399..cfa4bca9300 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditSingle.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/data-model/components/TableSection/TableAttributesEditSingle.tsx
@@ -1,3 +1,4 @@
+import cx from "classnames";
import { Link } from "react-router";
import { t } from "ttag";
@@ -142,55 +143,36 @@ export function TableAttributesEditSingle({ table }: Props) {
}
};
+ const isOwnerSpecified = table.owner_email || table.owner_user_id;
+
return (
<TableSectionGroup title={t`Attributes`}>
<div className={S.container}>
<UserInput
email={table.owner_email}
label={t`Owner`}
- userId={
- !table.owner_email && !table.owner_user_id
- ? "unknown"
- : table.owner_user_id
- }
+ userId={isOwnerSpecified ? table.owner_user_id : "unknown"}
onEmailChange={handleOwnerEmailChange}
onUserIdChange={handleOwnerUserIdChange}
- styles={{
- label: {
- gridColumn: 1,
- },
- input: {
- gridColumn: 2,
- },
- }}
className={S.gridLabelInput}
+ unknownUserLabel={t`No owner`}
+ classNames={{
+ input: cx(S.input, !isOwnerSpecified && S.unset),
+ label: S.label,
+ }}
/>
<LayerInput
value={table.data_layer ?? "copper"}
onChange={handleLayerChange}
- styles={{
- label: {
- gridColumn: 1,
- },
- input: {
- gridColumn: 2,
- },
- }}
+ classNames={{ input: S.input, label: S.label }}
className={S.gridLabelInput}
/>
<EntityTypeInput
value={table.entity_type ?? "entity/GenericTable"}
onChange={handleEntityTypeChange}
- styles={{
- label: {
- gridColumn: 1,
- },
- input: {
- gridColumn: 2,
- },
- }}
+ classNames={{ input: S.input, label: S.label }}
className={S.gridLabelInput}
/>
@@ -198,14 +180,7 @@ export function TableAttributesEditSingle({ table }: Props) {
disabled={table.data_source === "metabase-transform"}
value={table.data_source ?? "unknown"}
onChange={handleDataSourceChange}
- styles={{
- label: {
- gridColumn: 1,
- },
- input: {
- gridColumn: 2,
- },
- }}
+ classNames={{ input: S.input, label: S.label }}
className={S.gridLabelInput}
/>
diff --git a/frontend/src/metabase/metadata/components/UserInput.tsx b/frontend/src/metabase/metadata/components/UserInput.tsx
index aa993521314..ff54b401680 100644
--- a/frontend/src/metabase/metadata/components/UserInput.tsx
+++ b/frontend/src/metabase/metadata/components/UserInput.tsx
@@ -11,6 +11,7 @@ interface Props extends Omit<SelectProps, "data" | "value" | "onChange"> {
userId: UserId | "unknown" | null;
onEmailChange: (email: string) => void;
onUserIdChange: (value: UserId | "unknown" | null) => void;
+ unknownUserLabel?: string;
}
export const UserInput = ({
@@ -20,12 +21,16 @@ export const UserInput = ({
onEmailChange,
onFocus,
onUserIdChange,
+ unknownUserLabel = t`Unspecified`,
...props
}: Props) => {
const [search, setSearch] = useState(email ?? "");
const { data: usersData } = useListUsersQuery();
const users = useMemo(() => usersData?.data ?? [], [usersData]);
- const data = useMemo(() => getData(search, users), [search, users]);
+ const data = useMemo(
+ () => getData(search, users, unknownUserLabel),
+ [search, unknownUserLabel, users],
+ );
const userName = useMemo(() => {
if (userId == null) {
@@ -76,7 +81,9 @@ export const UserInput = ({
<Icon name="mail" />
</Avatar>
) : userId === "unknown" ? (
- <Avatar name={t`?`} />
+ <Avatar color="bg-light" name="unknown">
+ <Icon name="person" c="text-medium" />
+ </Avatar>
) : null
}
placeholder={t`Pick someone, or type an email`}
@@ -88,7 +95,11 @@ export const UserInput = ({
return (
<Group gap="sm" p="sm">
{option.type === "user" && <Avatar name={item.option.label} />}
- {option.type === "unknown" && <Avatar name={t`?`} />}
+ {option.type === "unknown" && (
+ <Avatar>
+ <Icon name="person" c="text-medium" />
+ </Avatar>
+ )}
{option.type === "email" && (
<Avatar color="initials" name="emails">
<Icon name="mail" />
@@ -116,10 +127,14 @@ type Option = {
type: "email" | "user" | "unknown";
};
-function getData(email: string | null, users: User[]): Option[] {
+function getData(
+ email: string | null,
+ users: User[],
+ unknownUserLabel?: string,
+): Option[] {
return [
{
- label: t`Unspecified`,
+ label: unknownUserLabel ?? t`Unspecified`,
value: "unknown",
type: "unknown" as const,
},
diff --git a/frontend/src/metabase/metadata/components/UserInput.unit.spec.tsx b/frontend/src/metabase/metadata/components/UserInput.unit.spec.tsx
new file mode 100644
index 00000000000..7f6a7a18361
--- /dev/null
+++ b/frontend/src/metabase/metadata/components/UserInput.unit.spec.tsx
@@ -0,0 +1,134 @@
+import userEvent from "@testing-library/user-event";
+import type { ComponentProps } from "react";
+
+import { setupUsersEndpoints } from "__support__/server-mocks";
+import { renderWithProviders, screen } from "__support__/ui";
+import { UserInput } from "metabase/metadata/components/UserInput";
+import { createMockUserListResult } from "metabase-types/api/mocks";
+
+const handleEmailChange = jest.fn();
+const handleUserIdChange = jest.fn();
+
+const setup = (props?: Partial<ComponentProps<typeof UserInput>>) => {
+ renderWithProviders(
+ <UserInput
+ email={null}
+ userId={null}
+ onEmailChange={handleEmailChange}
+ onUserIdChange={handleUserIdChange}
+ label="Owner"
+ {...props}
+ />,
+ );
+};
+
+describe("UserInput", () => {
+ beforeEach(() => {
+ jest.clearAllMocks();
+
+ setupUsersEndpoints([
+ createMockUserListResult({
+ id: 1,
+ common_name: "Alice Anderson",
+ email: "[email protected]",
+ }),
+ createMockUserListResult({
+ id: 2,
+ common_name: "Bob Builder",
+ email: "[email protected]",
+ }),
+ createMockUserListResult({
+ id: 3,
+ common_name: "Charlie Chen",
+ email: "[email protected]",
+ }),
+ ]);
+ });
+
+ describe("basic component functionality", () => {
+ it("should render user list when opened", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("textbox", { name: "Owner" }));
+
+ expect(
+ screen.getByRole("option", { name: /Alice Anderson/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.getByRole("option", { name: /Bob Builder/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.getByRole("option", { name: /Charlie Chen/ }),
+ ).toBeInTheDocument();
+ });
+
+ it("should call onUserIdChange when selecting a user", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("textbox", { name: "Owner" }));
+ await userEvent.click(
+ screen.getByRole("option", { name: /Bob Builder/ }),
+ );
+
+ expect(handleUserIdChange).toHaveBeenCalledWith(2);
+ expect(handleEmailChange).not.toHaveBeenCalled();
+ });
+
+ it("should handle email input and call onEmailChange", async () => {
+ setup();
+
+ const input = screen.getByRole("textbox", { name: "Owner" });
+ await userEvent.type(input, "[email protected]");
+ await userEvent.click(screen.getByText("[email protected]"));
+
+ expect(handleEmailChange).toHaveBeenCalledWith("[email protected]");
+ });
+
+ it("should call onUserIdChange with 'unknown' when selecting unknown option", async () => {
+ setup();
+
+ await userEvent.click(screen.getByRole("textbox", { name: "Owner" }));
+ await userEvent.click(
+ screen.getByRole("option", { name: /Unspecified/ }),
+ );
+
+ expect(handleUserIdChange).toHaveBeenCalledWith("unknown");
+ expect(handleEmailChange).not.toHaveBeenCalled();
+ });
+
+ it("should filter users based on search input", async () => {
+ setup();
+
+ const input = screen.getByRole("textbox", { name: "Owner" });
+ await userEvent.type(input, "Bob");
+
+ expect(
+ screen.queryByRole("option", { name: /Alice Anderson/ }),
+ ).not.toBeInTheDocument();
+ expect(
+ screen.getByRole("option", { name: /Bob Builder/ }),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByRole("option", { name: /Charlie Chen/ }),
+ ).not.toBeInTheDocument();
+ });
+ });
+
+ describe("unknownUserLabel prop", () => {
+ it("should display custom unknown user label when provided", async () => {
+ setup({ userId: "unknown", unknownUserLabel: "No owner" });
+
+ expect(screen.getByRole("textbox", { name: "Owner" })).toHaveValue(
+ "No owner",
+ );
+ });
+
+ it("should display default unknown user label when prop is not provided", async () => {
+ setup({ userId: "unknown", unknownUserLabel: undefined });
+
+ expect(screen.getByRole("textbox", { name: "Owner" })).toHaveValue(
+ "Unspecified",
+ );
+ });
+ });
+});