Skip to content

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

Add Metabot option to the Transforms New menu (#78134)

Oleh Kbf0d55aac56c
diff --git a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
index 9b9597c0947..f26ac31f62a 100644
--- a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.tsx
@@ -99,7 +99,7 @@ export const MetabotPromptInput = forwardRef<
{
extensions,
content: parseMetabotMessageToTiptapDoc(value),
- autofocus: autoFocus,
+ autofocus: autoFocus ? "end" : false,
injectNonce: getCspNonce(),
onUpdate: ({ editor }) => {
const jsonContent = editor.getJSON();
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 9245bc047a5..0dd46ae745b 100644
--- a/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotPromptInput/MetabotPromptInput.unit.spec.tsx
@@ -1,6 +1,7 @@
import { screen, waitFor } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import type { EditorState } from "@tiptap/pm/state";
+import type { Editor } from "@tiptap/react";
import fetchMock from "fetch-mock";
import { createRef } from "react";
@@ -98,6 +99,42 @@ describe("MetabotPromptInput", () => {
expect(mentionState?.active).toBe(true);
});
+ it("places the caret at the end of a prompt seeded on mount", async () => {
+ const ref = createRef<MetabotPromptInputRef>();
+ setup({ ref, value: "Create a transform that " });
+
+ // The imperative handle is `Object.assign(editor, …)`, so `ref.current` is the
+ // underlying tiptap Editor at runtime; the public ref type just narrows it.
+ const editor = ref.current as unknown as Editor;
+ await waitFor(() => {
+ const { selection, doc } = editor.state;
+ expect(selection.empty).toBe(true);
+ expect(selection.from).toBe(doc.content.size - 1);
+ });
+ });
+
+ it("moves the caret to the end when the value is changed externally", async () => {
+ const ref = createRef<MetabotPromptInputRef>();
+ const { rerender } = setup({ ref, value: "" });
+
+ rerender(
+ <MetabotPromptInput
+ {...defaultProps}
+ ref={ref}
+ value="Create a transform that "
+ autoFocus
+ />,
+ );
+
+ // The imperative handle is `Object.assign(editor, …)`, so `ref.current` is the
+ // underlying tiptap Editor at runtime; the public ref type just narrows it.
+ const editor = ref.current as unknown as Editor;
+ await waitFor(() => {
+ const { selection, doc } = editor.state;
+ expect(selection.from).toBe(doc.content.size - 1);
+ });
+ });
+
it("should close mention popup if {escape} is pressed", async () => {
setup();
diff --git a/frontend/src/metabase/transforms/analytics.ts b/frontend/src/metabase/transforms/analytics.ts
index ed07515b35b..d7be9613167 100644
--- a/frontend/src/metabase/transforms/analytics.ts
+++ b/frontend/src/metabase/transforms/analytics.ts
@@ -35,7 +35,7 @@ export function trackTransformJobTriggerManualRun({
export function trackTransformCreate({
creationType,
}: {
- creationType: "query" | "native" | "python" | "saved-question";
+ creationType: "query" | "native" | "python" | "saved-question" | "metabot";
}) {
trackSimpleEvent({
event: "transform_create",
diff --git a/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
index e7e7fbbd04d..165795b054c 100644
--- a/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.tsx
@@ -5,6 +5,11 @@ import { useListDatabasesQuery } from "metabase/api";
import { QuestionPickerModal } from "metabase/common/components/Pickers";
import { UpsellGem } from "metabase/common/components/upsells/components/UpsellGem";
import { useHasTokenFeature } from "metabase/common/hooks";
+import {
+ useMetabotAgent,
+ useMetabotName,
+ useUserMetabotPermissions,
+} from "metabase/metabot/hooks";
import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import { useDispatch, useSelector } from "metabase/redux";
import { push } from "metabase/router";
@@ -40,6 +45,16 @@ export const CreateTransformMenu = () => {
PLUGIN_REMOTE_SYNC.getIsRemoteSyncReadOnly,
);
+ const metabot = useMetabotAgent("omnibot");
+ const metabotName = useMetabotName();
+ const { hasMetabotAccess } = useUserMetabotPermissions();
+
+ const handleMetabotClick = () => {
+ trackTransformCreate({ creationType: "metabot" });
+ metabot.setPrompt(t`Create a transform that `);
+ metabot.setVisible(true);
+ };
+
const handlePythonClick = () => {
dispatch(push(Urls.newPythonTransform())); // Route will show upsell modal if feature is not enabled
@@ -85,6 +100,14 @@ export const CreateTransformMenu = () => {
) : (
<>
<Menu.Label>{t`Create your transform with…`}</Menu.Label>
+ {hasMetabotAccess && (
+ <Menu.Item
+ leftSection={<Icon name="metabot" />}
+ onClick={handleMetabotClick}
+ >
+ {metabotName}
+ </Menu.Item>
+ )}
<Menu.Item
leftSection={<Icon name="notebook" />}
onClick={() => {
diff --git a/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.unit.spec.tsx b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.unit.spec.tsx
new file mode 100644
index 00000000000..661e417116e
--- /dev/null
+++ b/frontend/src/metabase/transforms/pages/TransformListPage/CreateTransformMenu/CreateTransformMenu.unit.spec.tsx
@@ -0,0 +1,67 @@
+import userEvent from "@testing-library/user-event";
+
+import { mockSettings } from "__support__/settings";
+import { screen } from "__support__/ui";
+import { Metabot } from "metabase/metabot/components/Metabot";
+import { getMetabotInitialState } from "metabase/metabot/state/reducer-utils";
+import {
+ assertVisible as assertMetabotVisible,
+ input as metabotInput,
+ setup as setupMetabot,
+} from "metabase/metabot/tests/utils";
+
+import { CreateTransformMenu } from "./CreateTransformMenu";
+
+function setup({
+ isMetabotEnabled = true,
+}: { isMetabotEnabled?: boolean } = {}) {
+ return setupMetabot({
+ ui: (
+ <>
+ <CreateTransformMenu />
+ <Metabot />
+ </>
+ ),
+ metabotInitialState: getMetabotInitialState(),
+ storeInitialState: {
+ settings: mockSettings({
+ "metabot-enabled?": isMetabotEnabled,
+ "llm-metabot-configured?": true,
+ }),
+ },
+ });
+}
+
+async function openMenu() {
+ await userEvent.click(
+ await screen.findByRole("button", { name: "Create a transform" }),
+ );
+}
+
+describe("CreateTransformMenu", () => {
+ it("shows the Metabot item as the first option when Metabot is available", async () => {
+ setup({ isMetabotEnabled: true });
+ await openMenu();
+
+ const items = await screen.findAllByRole("menuitem");
+ expect(items[0]).toHaveTextContent("Metabot");
+ });
+
+ it("hides the Metabot item when Metabot is disabled", async () => {
+ setup({ isMetabotEnabled: false });
+ await openMenu();
+
+ expect(await screen.findByText("SQL query")).toBeInTheDocument();
+ expect(screen.queryByText("Metabot")).not.toBeInTheDocument();
+ });
+
+ it("opens Metabot with a pre-seeded prompt when the Metabot item is clicked", async () => {
+ setup({ isMetabotEnabled: true });
+ await openMenu();
+
+ await userEvent.click(await screen.findByText("Metabot"));
+
+ await assertMetabotVisible();
+ expect(await metabotInput()).toHaveTextContent("Create a transform that");
+ });
+});