Skip to content

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

Show location of minipicker search items (#66736)

Ryan Lauriee7c1fc0c1944
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/oss.unit.spec.tsx b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/oss.unit.spec.tsx
index 5463e212119..793fd53b3ee 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/oss.unit.spec.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/oss.unit.spec.tsx
@@ -212,6 +212,28 @@ describe("MiniPicker", () => {
expect(await screen.findByText("Bingley")).toBeInTheDocument();
});
+ it("shows the collection name for collection items in search results", async () => {
+ await setup({ searchQuery: "bing" });
+ expect(await screen.findByText("Bingley")).toBeInTheDocument();
+ expect(await screen.findByText("Misc Metrics")).toBeInTheDocument();
+ });
+
+ it("shows db and schema names for table items in search results", async () => {
+ await setup({ searchQuery: "wick" });
+ expect(await screen.findByText("wickham")).toBeInTheDocument();
+ expect(await screen.findByText("london (lydia)")).toBeInTheDocument();
+ });
+
+ it("shows collection name for a table in a collection", async () => {
+ await setup({ searchQuery: "kit" });
+ expect(await screen.findByText("Kitty")).toBeInTheDocument();
+ expect(await screen.findByText("Misc Tables")).toBeInTheDocument();
+
+ // should not show table or schema
+ expect(screen.queryByText(/big_secret/)).not.toBeInTheDocument();
+ expect(screen.queryByText(/also_secret/)).not.toBeInTheDocument();
+ });
+
it("properly filters search results", async () => {
await setup({ searchQuery: "a" });
expect(await screen.findByText("Lucas")).toBeInTheDocument();
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/setup.tsx b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/setup.tsx
index 854bc1f0b0b..27fdb37fed6 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/setup.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPicker/test/setup.tsx
@@ -213,9 +213,40 @@ export const setup = async (
setupSearchEndpoints([
createMockSearchResult({ id: 301, model: "card", name: "Lucas" }),
createMockSearchResult({ id: 302, model: "dataset", name: "Forster" }),
- createMockSearchResult({ id: 303, model: "metric", name: "Bingley" }),
+ createMockSearchResult({
+ id: 303,
+ model: "metric",
+ name: "Bingley",
+ collection: {
+ id: 789,
+ name: "Misc Metrics",
+ },
+ }),
+ createMockSearchResult({
+ id: 303,
+ model: "table",
+ name: "Kitty",
+ database_name: "big_secret",
+ table_schema: "also_secret",
+ collection: {
+ id: 7891,
+ name: "Misc Tables",
+ },
+ }),
createMockSearchResult({ id: 304, model: "document", name: "Wickham" }),
createMockSearchResult({ id: 305, model: "collection", name: "Reynolds" }),
+ createMockSearchResult({
+ id: 401,
+ model: "table",
+ name: "wickham",
+ table_schema: "lydia",
+ database_name: "london",
+ collection: {
+ // @ts-expect-error - can be null in search results
+ id: null,
+ name: "",
+ },
+ }),
]);
setupRecentViewsAndSelectionsEndpoints([], ["selections", "views"], {}, true);
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx
index afa3a24354a..e8223c27549 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx
@@ -1,3 +1,4 @@
+import { useDebouncedValue } from "@mantine/hooks";
import { t } from "ttag";
import _ from "underscore";
@@ -10,12 +11,14 @@ import {
useListDatabasesQuery,
useSearchQuery,
} from "metabase/api";
+import { Ellipsified } from "metabase/common/components/Ellipsified";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
import { canCollectionCardBeUsed } from "metabase/common/components/Pickers/utils";
import { VirtualizedList } from "metabase/common/components/VirtualizedList";
import { useSetting } from "metabase/common/hooks";
+import { getIcon } from "metabase/lib/icon";
import { PLUGIN_DATA_STUDIO } from "metabase/plugins";
-import { Box, Text } from "metabase/ui";
+import { Box, Flex, Icon, Text } from "metabase/ui";
import type { SchemaName, SearchModel } from "metabase-types/api";
import { useMiniPickerContext } from "../context";
@@ -291,9 +294,10 @@ function CollectionItemList({ parent }: { parent: MiniPickerCollectionItem }) {
function SearchItemList({ query }: { query: string }) {
const { onChange, models, isHidden } = useMiniPickerContext();
+ const [debouncedQuery] = useDebouncedValue(query, 500);
const { data: searchResponse, isLoading } = useSearchQuery({
- q: query,
+ q: debouncedQuery,
models: models as SearchModel[],
limit: 50,
});
@@ -319,6 +323,7 @@ function SearchItemList({ query }: { query: string }) {
onClick={() => {
onChange(item);
}}
+ rightSection={<LocationInfo item={item} />}
/>
);
})}
@@ -332,6 +337,40 @@ export const MiniPickerListLoader = () => (
</Box>
);
+const isInCollection = (
+ item: MiniPickerPickableItem,
+): item is MiniPickerCollectionItem => {
+ return "collection" in item && !!item.collection && !!item.collection.name;
+};
+
const ItemList = ({ children }: { children: React.ReactNode[] }) => {
return <VirtualizedList extraPadding={2}>{children}</VirtualizedList>;
};
+
+const LocationInfo = ({ item }: { item: MiniPickerPickableItem }) => {
+ const isCollectionItem = isInCollection(item);
+
+ const itemText = isCollectionItem
+ ? item?.collection?.name
+ : `${item.database_name}${item.table_schema ? ` (${item.table_schema})` : ""}`;
+
+ if (!itemText) {
+ return null;
+ }
+
+ const iconProps = isCollectionItem
+ ? getIcon({
+ ...item.collection,
+ model: "collection",
+ })
+ : null;
+
+ return (
+ <Flex gap="xs" align="center">
+ {iconProps && <Icon {...iconProps} size={12} />}
+ <Text size="sm" c="text-medium">
+ <Ellipsified maw="18rem">{itemText}</Ellipsified>
+ </Text>
+ </Flex>
+ );
+};
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerPane.tsx b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerPane.tsx
index a97886e4888..09a9e6eb849 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerPane.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerPane.tsx
@@ -12,7 +12,7 @@ export function MiniPickerPane() {
const isRoot = path.length === 0;
return (
- <Stack mah="30rem" w="20rem" gap={0}>
+ <Stack mah="30rem" w={searchQuery ? "40rem" : "20rem"} gap={0}>
{!isRoot && !searchQuery && <MiniPickerHeader />}
<MiniPickerItemList />
{(isRoot || searchQuery) && <MiniPickerFooter />}
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts b/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
index 0cf3ef57f4f..4ff050d59a0 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
@@ -8,7 +8,7 @@ import type {
export type MiniPickerCollectionItem = Pick<
CollectionItem,
- "id" | "name" | "model" | "here" | "below" | "display"
+ "id" | "name" | "model" | "here" | "below" | "display" | "collection"
> & {
id: CollectionItem["id"] | CollectionId;
};
@@ -33,9 +33,17 @@ export type MiniPickerTableItem = {
model: "table";
id: TableId;
db_id: DatabaseId;
+ database_name?: string;
+ table_schema?: string;
name: string;
};
+export const isTableItem = (
+ item: MiniPickerItem,
+): item is MiniPickerTableItem => {
+ return item.model === "table";
+};
+
export type MiniPickerDatabaseItem = {
model: "database";
id: DatabaseId;