Skip to content

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

Allow @-mentioning databases in Metabot (#82379)

Maksym Yakubyche795326c38fb
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 91e2d380510..add52a6ee33 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
@@ -316,6 +316,29 @@ describe("MiniPicker", () => {
);
});
+ it("does not show databases in search results unless they are pickable", async () => {
+ await setup({ searchQuery: "pem" });
+ expect(await screen.findByText("No search results")).toBeInTheDocument();
+ expect(screen.queryByText("Pemberley")).not.toBeInTheDocument();
+ });
+
+ it("can pick a database search result when databases are pickable", async () => {
+ const { onChangeSpy } = await setup({
+ searchQuery: "pem",
+ models: ["table", "database"],
+ });
+ await userEvent.click(await screen.findByText("Pemberley"));
+
+ expect(screen.queryByText("Our analytics")).not.toBeInTheDocument();
+ expect(onChangeSpy).toHaveBeenCalledWith(
+ expect.objectContaining({
+ id: 501,
+ model: "database",
+ name: "Pemberley",
+ }),
+ );
+ });
+
it("passes the local search input query to searchParams callbacks", async () => {
const searchParams = jest.fn((params: SearchRequest) => {
return params.q ? {} : { collection: 123 };
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 7bc92df928b..c8adcae1f14 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
@@ -262,6 +262,7 @@ export const setup = async (
name: null,
},
}),
+ createMockSearchResult({ id: 501, model: "database", name: "Pemberley" }),
]);
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 745d09a11dc..bb31d99fb99 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/components/MiniPickerItemList.tsx
@@ -641,6 +641,12 @@ const isSchema = (
return item.model === "schema";
};
+const isDatabase = (
+ item: MiniPickerPickableItem,
+): item is MiniPickerDatabaseItem => {
+ return item.model === "database";
+};
+
const useLocationDetails = (item: MiniPickerPickableItem) => {
const getIcon = useGetIcon();
@@ -664,6 +670,9 @@ const useLocationDetails = (item: MiniPickerPickableItem) => {
iconProps: { name: "database" as const },
};
}
+ if (isDatabase(item)) {
+ return { itemText: null, iconProps: null };
+ }
return {
itemText: item?.collection?.name ?? t`Our analytics`,
iconProps: getIcon({ ...item.collection, model: "collection" }),
diff --git a/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts b/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
index 6d983e4c642..9a1dfa3e3a2 100644
--- a/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
+++ b/frontend/src/metabase/common/components/Pickers/MiniPicker/types.ts
@@ -95,7 +95,8 @@ export type MiniPickerPickableItem =
| MiniPickerPickableCollectionItem
| MiniPickerTableItem
| MiniPickerMeasureItem
- | MiniPickerSchemaItem;
+ | MiniPickerSchemaItem
+ | MiniPickerDatabaseItem;
// can't get schemas in search results
export type SearchableMiniPickerItem =
diff --git a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
index 548f0d84a6b..06a7d1ba340 100644
--- a/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
@@ -7,11 +7,12 @@ import {
setupCardEndpoints,
setupCollectionByIdEndpoint,
setupDatabasesEndpoints,
+ setupRecentViewsAndSelectionsEndpoints,
} from "__support__/server-mocks";
import { setupSearchEndpoints } from "__support__/server-mocks/search";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
-import { renderWithProviders } from "__support__/ui";
+import { mockGetBoundingClientRect, renderWithProviders } from "__support__/ui";
import { ROOT_COLLECTION } from "metabase/common/collections/constants";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import {
@@ -186,6 +187,7 @@ describe("MetabotChatEditor", () => {
q: "test",
models: asFetchMockModelParams([
"table",
+ "database",
"card",
"dashboard",
"collection",
@@ -215,6 +217,7 @@ describe("MetabotChatEditor", () => {
q: "test",
models: asFetchMockModelParams([
"table",
+ "database",
"card",
"dashboard",
"collection",
@@ -225,6 +228,41 @@ describe("MetabotChatEditor", () => {
});
});
+ it("can mention a database found by search", async () => {
+ mockGetBoundingClientRect();
+ const onChange = jest.fn();
+ setup(
+ { onChange },
+ {
+ searchItems: [
+ createMockSearchResult({ id: 1, name: "DB 1", model: "database" }),
+ ],
+ },
+ );
+
+ await userEvent.type(await input(), "@DB");
+ await userEvent.click(await screen.findByText("DB 1"));
+
+ expect(onChange).toHaveBeenLastCalledWith("[DB 1](metabase://database/1)");
+ });
+
+ it("can mention a database picked in the browse all modal", async () => {
+ mockGetBoundingClientRect();
+ setupRecentViewsAndSelectionsEndpoints([], ["selections"]);
+ const onChange = jest.fn();
+ setup({ onChange });
+
+ await userEvent.type(await input(), "@");
+ await userEvent.click(await screen.findByText("Browse all"));
+ await userEvent.click(await screen.findByText("Databases"));
+ await userEvent.click(await screen.findByRole("link", { name: /DB 1/ }));
+ await userEvent.click(
+ await screen.findByTestId("entity-picker-select-button"),
+ );
+
+ expect(onChange).toHaveBeenLastCalledWith("[DB 1](metabase://database/1)");
+ });
+
it("should handle paste events with metabase protocol links", async () => {
const onChange = jest.fn();
setup({ onChange });
diff --git a/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
index d8ba956ba41..7080b4fa8cf 100644
--- a/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
@@ -93,9 +93,8 @@ const MetabotMentionSuggestionComponent = forwardRef<
},
}));
- const searchModelsReal = searchModels?.filter(
+ const mentionModels = (searchModels ?? []).filter(
(model) =>
- model !== "database" &&
model !== "action" &&
model !== "segment" &&
model !== "user" &&
@@ -142,7 +141,7 @@ const MetabotMentionSuggestionComponent = forwardRef<
opened
searchQuery={query}
shouldShowLibrary
- models={searchModelsReal ?? []}
+ models={mentionModels}
closeOnClickOutside={false}
onChange={onSelectEntity}
onClose={onClose}
@@ -170,7 +169,7 @@ const MetabotMentionSuggestionComponent = forwardRef<
}
: undefined
}
- models={searchModelsReal ?? []}
+ models={mentionModels}
options={{
hasDatabases: true,
hasRootCollection: true,
@@ -178,7 +177,7 @@ const MetabotMentionSuggestionComponent = forwardRef<
hasSearch: true,
hasRecents: true,
hasLibrary: true,
- hasConfirmButtons: false,
+ hasConfirmButtons: true,
canCreateCollections: false,
canCreateDashboards: false,
}}