Skip to content

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

Move Metabot editor extensions out of rich_text_editing (#79295)

Fraser96dd9ac1220b
diff --git a/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx b/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx
new file mode 100644
index 00000000000..7b9a90136a3
--- /dev/null
+++ b/frontend/src/metabase/documents/components/Editor/DocumentCommandSuggestion.tsx
@@ -0,0 +1,33 @@
+import { forwardRef, useMemo } from "react";
+
+import {
+ useMetabotName,
+ useUserMetabotPermissions,
+} from "metabase/metabot/hooks";
+import {
+ CommandSuggestion,
+ type CommandSuggestionProps,
+ type CommandSuggestionRef,
+} from "metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion";
+
+type DocumentCommandSuggestionProps = Omit<
+ CommandSuggestionProps,
+ "metabotCommand"
+>;
+
+export const DocumentCommandSuggestion = forwardRef<
+ CommandSuggestionRef,
+ DocumentCommandSuggestionProps
+>(function DocumentCommandSuggestion(props, ref) {
+ const { canUseMetabot } = useUserMetabotPermissions();
+ const metabotName = useMetabotName();
+
+ const metabotCommand = useMemo(
+ () => (canUseMetabot ? { name: metabotName } : null),
+ [canUseMetabot, metabotName],
+ );
+
+ return (
+ <CommandSuggestion {...props} ref={ref} metabotCommand={metabotCommand} />
+ );
+});
diff --git a/frontend/src/metabase/documents/components/Editor/Editor.tsx b/frontend/src/metabase/documents/components/Editor/Editor.tsx
index ae202d62b33..016b8106979 100644
--- a/frontend/src/metabase/documents/components/Editor/Editor.tsx
+++ b/frontend/src/metabase/documents/components/Editor/Editor.tsx
@@ -11,13 +11,18 @@ import { DND_IGNORE_CLASS_NAME } from "metabase/common/components/dnd";
import { getMentionsCache } from "metabase/documents/selectors";
import { isMetabotBlock } from "metabase/documents/utils/editorNodeUtils";
import { getMentionsCacheKey } from "metabase/documents/utils/mentionsUtils";
+import {
+ MetabotNode,
+ type PromptSerializer,
+} from "metabase/metabot/components/editor-extensions/MetabotEmbed";
+import { MetabotMentionExtension } from "metabase/metabot/components/editor-extensions/MetabotMention/MetabotMentionExtension";
+import { MetabotMentionSuggestion } from "metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion";
import { useDispatch, useSelector, useStore } from "metabase/redux";
import type { State } from "metabase/redux/store";
import type { CardEmbedRef } from "metabase/redux/store/documents";
import { EditorBubbleMenu } from "metabase/rich_text_editing/tiptap/components/EditorBubbleMenu/EditorBubbleMenu";
import { CardEmbed } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/CardEmbedNode";
import { CommandExtension } from "metabase/rich_text_editing/tiptap/extensions/Command/CommandExtension";
-import { CommandSuggestion } from "metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion";
import { CustomStarterKit } from "metabase/rich_text_editing/tiptap/extensions/CustomStarterKit/CustomStarterKit";
import { DisableMetabotSidebar } from "metabase/rich_text_editing/tiptap/extensions/DisableMetabotSidebar";
import { FlexContainer } from "metabase/rich_text_editing/tiptap/extensions/FlexContainer/FlexContainer";
@@ -25,12 +30,6 @@ import { HandleEditorDrop } from "metabase/rich_text_editing/tiptap/extensions/H
import { LinkHoverMenu } from "metabase/rich_text_editing/tiptap/extensions/LinkHoverMenu/LinkHoverMenu";
import { MentionExtension } from "metabase/rich_text_editing/tiptap/extensions/Mention/MentionExtension";
import { MentionSuggestion } from "metabase/rich_text_editing/tiptap/extensions/Mention/MentionSuggestion";
-import {
- MetabotNode,
- type PromptSerializer,
-} from "metabase/rich_text_editing/tiptap/extensions/MetabotEmbed";
-import { MetabotMentionExtension } from "metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotMentionExtension";
-import { MetabotMentionSuggestion } from "metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion";
import { PlainLink } from "metabase/rich_text_editing/tiptap/extensions/PlainLink/PlainLink";
import { ResizeNode } from "metabase/rich_text_editing/tiptap/extensions/ResizeNode/ResizeNode";
import { SmartLink } from "metabase/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode";
@@ -41,6 +40,7 @@ import { getSetting } from "metabase/settings";
import { Box, Center, Loader } from "metabase/ui";
import { DocumentBlockShell } from "./DocumentBlockShell";
+import { DocumentCommandSuggestion } from "./DocumentCommandSuggestion";
import { DocumentEditorHostProvider } from "./DocumentEditorHost";
import DropCursorS from "./DropCursor.module.css";
import S from "./Editor.module.css";
@@ -151,7 +151,7 @@ export const Editor: React.FC<EditorProps> = React.memo(
CommandExtension.configure({
suggestion: {
allow: ({ state }) => !isMetabotBlock(state),
- render: createSuggestionRenderer(CommandSuggestion),
+ render: createSuggestionRenderer(DocumentCommandSuggestion),
},
}),
MetabotNode.configure({
diff --git a/frontend/src/metabase/documents/hooks/use-block-menus.unit.spec.ts b/frontend/src/metabase/documents/hooks/use-block-menus.unit.spec.ts
index e0a3503d73f..1029db1b33e 100644
--- a/frontend/src/metabase/documents/hooks/use-block-menus.unit.spec.ts
+++ b/frontend/src/metabase/documents/hooks/use-block-menus.unit.spec.ts
@@ -10,7 +10,7 @@ import { initialState as documentsInitialState } from "metabase/documents/docume
import {
createMockNodeViewProps,
createMockProseMirrorNode,
-} from "metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/__support__/node-view-mocks";
+} from "metabase/metabot/components/editor-extensions/MetabotEmbed/__support__/node-view-mocks";
import type { Comment } from "metabase-types/api";
import { createMockDocument } from "metabase-types/api/mocks";
import { createMockComment } from "metabase-types/api/mocks/comment";
diff --git a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
index 62b7bfba603..30f077091b9 100644
--- a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
@@ -11,12 +11,12 @@ import { forwardRef, useEffect, useImperativeHandle, useRef } from "react";
import { t } from "ttag";
import type { MetabotPromptInputRef } from "metabase/metabot";
-import { useSelector } from "metabase/redux";
import {
MetabotMentionExtension,
MetabotMentionPluginKey,
-} from "metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotMentionExtension";
-import { createMetabotMentionSuggestionNew } from "metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew";
+} from "metabase/metabot/components/editor-extensions/MetabotMention/MetabotMentionExtension";
+import { createMetabotMentionSuggestionNew } from "metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew";
+import { useSelector } from "metabase/redux";
import { SmartLink } from "metabase/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import { createBareSuggestionRenderer } from "metabase/rich_text_editing/tiptap/extensions/suggestionRenderer";
diff --git a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx
index 0dd46ae745b..844abeb02f1 100644
--- a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx
@@ -14,8 +14,8 @@ import { mockSettings } from "__support__/settings";
import { renderWithProviders } from "__support__/ui";
import { ROOT_COLLECTION } from "metabase/common/collections/constants";
import type { MetabotPromptInputRef } from "metabase/metabot";
+import { MetabotMentionPluginKey } from "metabase/metabot/components/editor-extensions/MetabotMention/MetabotMentionExtension";
import { createMockState } from "metabase/redux/store/mocks";
-import { MetabotMentionPluginKey } from "metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotMentionExtension";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import {
createMockCollection,
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.module.css b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.module.css
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
similarity index 98%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
index f03e10a457a..9ad98b81356 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
@@ -20,12 +20,11 @@ import {
} from "metabase/metabot/hooks";
import { useDispatch, useSelector } from "metabase/redux";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
+import { buildDraftCard } from "metabase/rich_text_editing/tiptap/extensions/shared/draft-card";
+import { wrapCardEmbed } from "metabase/rich_text_editing/tiptap/extensions/shared/layout";
import { Box, Button, Flex, Icon, Text, Tooltip } from "metabase/ui";
import type { MetabotGenerateContentRequest } from "metabase-types/api";
-import { buildDraftCard } from "../shared/draft-card";
-import { wrapCardEmbed } from "../shared/layout";
-
import S from "./MetabotEmbed.module.css";
declare module "@tiptap/core" {
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/__support__/editor-mocks.ts b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/__support__/editor-mocks.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/__support__/editor-mocks.ts
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/__support__/editor-mocks.ts
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/__support__/node-view-mocks.ts b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/__support__/node-view-mocks.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/__support__/node-view-mocks.ts
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/__support__/node-view-mocks.ts
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/index.ts b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/index.ts
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/index.ts
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/index.ts
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotMentionExtension.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotMentionExtension.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotMentionExtension.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotMentionExtension.tsx
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion.module.css b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion.module.css
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion.module.css
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion.module.css
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion.tsx
similarity index 97%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion.tsx
index dd1f233cf08..2998db23dc7 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestion.tsx
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestion.tsx
@@ -19,11 +19,10 @@ import { useMetabotName } from "metabase/metabot/hooks";
import type { MenuItem } from "metabase/rich_text_editing/tiptap/extensions/shared/MenuComponents";
import { MenuItemComponent } from "metabase/rich_text_editing/tiptap/extensions/shared/MenuComponents";
import { SuggestionPaper } from "metabase/rich_text_editing/tiptap/extensions/shared/SuggestionPaper";
+import { useBuildDbMenuItems } from "metabase/rich_text_editing/tiptap/extensions/shared/suggestionHooks";
import { Box, Group, Loader, Text } from "metabase/ui";
import type { Database, SearchResult } from "metabase-types/api";
-import { useBuildDbMenuItems } from "../shared/suggestionHooks";
-
interface MentionSuggestionProps {
items: SearchResult[];
command: (item: MentionCommandItem) => void;
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
similarity index 95%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
index bbc7169b0c2..d8ba956ba41 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew.tsx
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.tsx
@@ -19,15 +19,14 @@ import type {
MiniPickerItem,
MiniPickerPickableItem,
} from "metabase/common/components/Pickers/MiniPicker/types";
-import type { DatabaseId } from "metabase-types/api";
-
-import { ExternalMenuTarget } from "../shared/ExternalMenuTarget";
-import type { SuggestionModel } from "../shared/types";
-import type { EntitySearchOptions } from "../shared/useEntitySearch";
+import { ExternalMenuTarget } from "metabase/rich_text_editing/tiptap/extensions/shared/ExternalMenuTarget";
+import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
+import type { EntitySearchOptions } from "metabase/rich_text_editing/tiptap/extensions/shared/useEntitySearch";
import type {
BareSuggestionRendererProps,
BareSuggestionRendererRef,
-} from "../suggestionRenderer";
+} from "metabase/rich_text_editing/tiptap/extensions/suggestionRenderer";
+import type { DatabaseId } from "metabase-types/api";
import type { MentionProps } from "./MetabotMentionExtension";
import styles from "./MetabotSuggestion.module.css";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew.unit.spec.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.unit.spec.tsx
similarity index 100%
rename from frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotMention/MetabotSuggestionNew.unit.spec.tsx
rename to frontend/src/metabase/metabot/components/editor-extensions/MetabotMention/MetabotSuggestionNew.unit.spec.tsx
diff --git a/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx b/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
index 549c5009a33..4f2cac4d866 100644
--- a/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
+++ b/frontend/src/metabase/public/containers/PublicDocument/PublicDocument.tsx
@@ -10,6 +10,7 @@ import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErr
import CS from "metabase/css/core/index.css";
import { DocumentEditorHostProvider } from "metabase/documents/components/Editor/DocumentEditorHost";
import { EmbeddingEntityContextProvider } from "metabase/embedding/context";
+import { MetabotNode } from "metabase/metabot/components/editor-extensions/MetabotEmbed";
import { EmbedFrame } from "metabase/public/components/EmbedFrame";
import { useEmbedFrameOptions } from "metabase/public/hooks";
import { useDispatch, useSelector } from "metabase/redux";
@@ -18,7 +19,6 @@ import { CardEmbed } from "metabase/rich_text_editing/tiptap/extensions/CardEmbe
import { ExternalCardDataProvider } from "metabase/rich_text_editing/tiptap/extensions/CardEmbed/ExternalCardDataContext";
import { CustomStarterKit } from "metabase/rich_text_editing/tiptap/extensions/CustomStarterKit/CustomStarterKit";
import { FlexContainer } from "metabase/rich_text_editing/tiptap/extensions/FlexContainer/FlexContainer";
-import { MetabotNode } from "metabase/rich_text_editing/tiptap/extensions/MetabotEmbed";
import { ResizeNode } from "metabase/rich_text_editing/tiptap/extensions/ResizeNode/ResizeNode";
import { SmartLink } from "metabase/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode";
import { SupportingText } from "metabase/rich_text_editing/tiptap/extensions/SupportingText/SupportingText";
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
index 2c562cd6f91..6bb0384d4ac 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
@@ -11,10 +11,6 @@ import {
} from "react";
import { t } from "ttag";
-import {
- useMetabotName,
- useUserMetabotPermissions,
-} from "metabase/metabot/hooks";
import { useSelector } from "metabase/redux";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
import {
@@ -48,7 +44,7 @@ import CommandS from "./CommandSuggestion.module.css";
import { NewQuestionTypeMenuView } from "./NewQuestionTypeMenuView";
import type { CommandOption, CommandSection } from "./types";
import { useCreateQuestionsMenuItems } from "./use-create-questions-menu-items";
-import { getAllCommandSections } from "./utils";
+import { type MetabotCommandConfig, getAllCommandSections } from "./utils";
export interface CommandSuggestionProps {
items: SearchResult[];
@@ -56,9 +52,10 @@ export interface CommandSuggestionProps {
editor: Editor;
range: Range;
query: string;
+ metabotCommand?: MetabotCommandConfig | null;
}
-interface SuggestionRef {
+export interface CommandSuggestionRef {
onKeyDown: (props: { event: KeyboardEvent }) => boolean;
}
@@ -101,13 +98,14 @@ const CommandMenuItem = forwardRef<
});
export const CommandSuggestion = forwardRef<
- SuggestionRef,
+ CommandSuggestionRef,
CommandSuggestionProps
->(function CommandSuggestionComponent({ command, editor, query }, ref) {
+>(function CommandSuggestionComponent(
+ { command, editor, query, metabotCommand },
+ ref,
+) {
const host = useEditorHost();
const document = useSelector(host.selectors.getCurrentDocument);
- const { canUseMetabot: isMetabotEnabled } = useUserMetabotPermissions();
- const metabotName = useMetabotName();
const [selectedIndex, setSelectedIndex] = useState(0);
const [viewMode, setViewMode] = useState<SuggestionPickerViewMode>(null);
@@ -118,8 +116,8 @@ export const CommandSuggestion = forwardRef<
const itemRefs = useRef<(HTMLButtonElement | null)[]>([]);
const allCommandSections: CommandSection[] = useMemo(
- () => getAllCommandSections(isMetabotEnabled, metabotName),
- [isMetabotEnabled, metabotName],
+ () => getAllCommandSections(metabotCommand),
+ [metabotCommand],
);
const allCommandOptions = useMemo(
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
index 9663fd89a5b..672cfb7a067 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
@@ -1,9 +1,7 @@
import userEvent from "@testing-library/user-event";
import type { Editor } from "@tiptap/core";
-import fetchMock from "fetch-mock";
import { useState } from "react";
-import { setupEnterprisePlugins } from "__support__/enterprise";
import {
setupCollectionByIdEndpoint,
setupCollectionItemsEndpoint,
@@ -13,7 +11,6 @@ import {
} from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen, within } from "__support__/ui";
-import type { SettingsState } from "metabase/redux/store";
import { createMockState } from "metabase/redux/store/mocks";
import { Input } from "metabase/ui";
import { registerVisualizations } from "metabase/visualizations/register";
@@ -24,7 +21,6 @@ import {
createMockRecentTableItem,
createMockSearchResult,
createMockUser,
- createMockUserMetabotPermissions,
createMockUserPermissions,
} from "metabase-types/api/mocks";
@@ -32,6 +28,7 @@ import {
CommandSuggestion,
type CommandSuggestionProps,
} from "./CommandSuggestion";
+import type { MetabotCommandConfig } from "./utils";
registerVisualizations();
@@ -111,13 +108,10 @@ const TestWrapper = (props: CommandSuggestionProps) => {
type SetupProps = {
query?: string;
- settings?: SettingsState;
+ metabotCommand?: MetabotCommandConfig | null;
};
-const setup = ({
- query = "",
- settings = mockSettings({}),
-}: SetupProps = {}) => {
+const setup = ({ query = "", metabotCommand = null }: SetupProps = {}) => {
const command = jest.fn();
const editor = {
@@ -131,10 +125,6 @@ const setup = ({
setupSearchEndpoints(SEARCH_ITEMS);
setupRecentViewsEndpoints(RECENT_ITEMS);
setupDatabasesEndpoints([MOCK_DATABASE]);
- fetchMock.get(
- "path:/api/metabot/permissions/user-permissions",
- createMockUserMetabotPermissions(),
- );
renderWithProviders(
<TestWrapper
@@ -144,8 +134,9 @@ const setup = ({
query={query}
items={[]}
range={{ from: 0, to: 0 }}
+ metabotCommand={metabotCommand}
/>,
- { storeInitialState: createMockState({ settings }) },
+ { storeInitialState: createMockState({ settings: mockSettings({}) }) },
);
return {
@@ -154,13 +145,6 @@ const setup = ({
};
describe("CommandSuggestion", () => {
- beforeEach(() => {
- fetchMock.get(
- "path:/api/metabot/permissions/user-permissions",
- createMockUserMetabotPermissions(),
- );
- });
-
it("renders with default commands", async () => {
setup();
@@ -448,37 +432,29 @@ describe("CommandSuggestion", () => {
jest.clearAllMocks();
});
- describe("when metabot is disabled", () => {
+ describe("when no metabot command is provided", () => {
it("should show all available commands except Metabot", async () => {
- setup({
- settings: mockSettings({
- "metabot-enabled?": false,
- "llm-metabot-configured?": false,
- }),
- });
+ setup({ metabotCommand: null });
expect(screen.queryByText("Ask Metabot")).not.toBeInTheDocument();
await expectStandardCommandsToBePresent();
});
});
- describe("when metabot is enabled", () => {
- beforeEach(() => {
- mockSettings({});
- setupEnterprisePlugins();
- });
-
+ describe("when a metabot command is provided", () => {
it("should show all available commands including Metabot", async () => {
- setup({
- settings: mockSettings({
- "metabot-enabled?": true,
- "llm-metabot-configured?": true,
- }),
- });
+ setup({ metabotCommand: { name: "Metabot" } });
expect(await screen.findByText("Ask Metabot")).toBeInTheDocument();
await expectStandardCommandsToBePresent();
});
+
+ it("should use the provided metabot name", async () => {
+ setup({ metabotCommand: { name: "Ada" } });
+
+ expect(await screen.findByText("Ask Ada")).toBeInTheDocument();
+ await expectStandardCommandsToBePresent();
+ });
});
});
});
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
index 34ce4a84264..3872927f4ff 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
@@ -2,18 +2,21 @@ import { t } from "ttag";
import type { CommandSection } from "./types";
+export type MetabotCommandConfig = {
+ name: string;
+};
+
export const getAllCommandSections = (
- isMetabotEnabled: boolean,
- metabotName: string = "Metabot",
+ metabotCommand?: MetabotCommandConfig | null,
): CommandSection[] => {
return [
{
items: [
- ...(isMetabotEnabled
+ ...(metabotCommand
? ([
{
icon: "metabot" as const,
- label: t`Ask ${metabotName}`,
+ label: t`Ask ${metabotCommand.name}`,
command: "metabot",
isAllowedAtPosition: (editor) =>
!editor.isActive("supportingText"),