Skip to content

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

Show that Metabot is working in the inline SQL prompt (#84385)

Andrei Simionescu50dc40874b4e
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.tsx
index ae670d12160..9a79754698d 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.tsx
@@ -8,6 +8,7 @@ import { AIProviderConfigurationModal } from "metabase/metabot/components/AIProv
import { MetabotManagedProviderLimitHoverCard } from "metabase/metabot/components/MetabotManagedProviderLimit";
import { MetabotPromptInput } from "metabase/metabot/components/MetabotPromptInput";
import { MetabotSendButton } from "metabase/metabot/components/MetabotSendButton";
+import { MetabotWorkingIndicator } from "metabase/metabot/components/MetabotWorkingIndicator";
import { useUserMetabotPermissions } from "metabase/metabot/hooks";
import type { MetabotAgentTurnDisplayError } from "metabase/metabot/state";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
@@ -142,17 +143,33 @@ export const MetabotInlineSQLPrompt = ({
/>
</Tooltip>
)}
- <Box
- data-testid="metabot-inline-sql-error"
- pr="0.125rem"
- ta="right"
- flex={1}
- miw={0}
- fz="sm"
- c={error?.type === "aborted" ? "text-secondary" : "feedback-negative"}
- >
- {isLocked ? <MetabotManagedProviderLimitHoverCard /> : error?.message}
- </Box>
+ {isLoading ? (
+ <MetabotWorkingIndicator
+ pr="0.125rem"
+ ta="right"
+ flex={1}
+ fz="sm"
+ ff="var(--mb-default-font-family)"
+ />
+ ) : (
+ <Box
+ data-testid="metabot-inline-sql-error"
+ pr="0.125rem"
+ ta="right"
+ flex={1}
+ miw={0}
+ fz="sm"
+ c={
+ error?.type === "aborted" ? "text-secondary" : "feedback-negative"
+ }
+ >
+ {isLocked ? (
+ <MetabotManagedProviderLimitHoverCard />
+ ) : (
+ error?.message
+ )}
+ </Box>
+ )}
<Button
className={S.cancelButton}
data-testid="metabot-inline-sql-cancel"
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.unit.spec.tsx
index 0f832f6c147..5255d474bba 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/MetabotInlineSQLPrompt.unit.spec.tsx
@@ -5,6 +5,7 @@ import { setupUserMetabotPermissionsEndpoint } from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { renderWithProviders, screen } from "__support__/ui";
+import type { MetabotAgentTurnDisplayError } from "metabase/metabot/state";
import { createMockUser } from "metabase-types/api/mocks";
import { MetabotInlineSQLPrompt } from "./MetabotInlineSQLPrompt";
@@ -22,25 +23,39 @@ const defaultProps: ComponentProps<typeof MetabotInlineSQLPrompt> = {
onValueChange: jest.fn(),
};
-function setup(
- props?: Partial<ComponentProps<typeof MetabotInlineSQLPrompt>>,
- options?: { isAdmin?: boolean },
-) {
- const { isAdmin = true } = options ?? {};
+interface SetupOpts {
+ props?: Partial<ComponentProps<typeof MetabotInlineSQLPrompt>>;
+ isAdmin?: boolean;
+ isConfigured?: boolean;
+}
+
+function setup({
+ props,
+ isAdmin = true,
+ isConfigured = false,
+}: SetupOpts = {}) {
const settings = mockSettings({
- "llm-metabot-configured?": false,
+ "llm-metabot-configured?": isConfigured,
"metabot-enabled?": true,
});
setupUserMetabotPermissionsEndpoint();
setupEnterprisePlugins();
- renderWithProviders(<MetabotInlineSQLPrompt {...defaultProps} {...props} />, {
- storeInitialState: createMockState({
- settings,
- currentUser: createMockUser({ is_superuser: isAdmin }),
- }),
- });
+ const { rerender } = renderWithProviders(
+ <MetabotInlineSQLPrompt {...defaultProps} {...props} />,
+ {
+ storeInitialState: createMockState({
+ settings,
+ currentUser: createMockUser({ is_superuser: isAdmin }),
+ }),
+ },
+ );
+
+ return {
+ rerender: (nextProps: SetupOpts["props"]) =>
+ rerender(<MetabotInlineSQLPrompt {...defaultProps} {...nextProps} />),
+ };
}
describe("MetabotInlineSQLPrompt", () => {
@@ -63,7 +78,7 @@ describe("MetabotInlineSQLPrompt", () => {
});
it("shows the admin message when the user cannot configure AI", async () => {
- setup(undefined, { isAdmin: false });
+ setup({ isAdmin: false });
expect(
await screen.findByText(
@@ -71,4 +86,34 @@ describe("MetabotInlineSQLPrompt", () => {
),
).toBeInTheDocument();
});
+
+ it.each<{ replacement: string; error: MetabotAgentTurnDisplayError }>([
+ {
+ replacement: "error",
+ error: { type: "message", message: "Sorry, I ran into an error." },
+ },
+ {
+ replacement: "interruption notice",
+ error: {
+ type: "aborted",
+ message: "Response from Metabot was interrupted",
+ },
+ },
+ ])(
+ "replaces the working status with the $replacement when loading ends",
+ async ({ error }) => {
+ const { rerender } = setup({
+ props: { isLoading: true },
+ isConfigured: true,
+ });
+ expect(
+ await screen.findByRole("button", { name: "Stop generating" }),
+ ).toBeInTheDocument();
+ expect(screen.getByRole("status")).toHaveTextContent("Working on it...");
+
+ rerender({ isLoading: false, error });
+ expect(screen.queryByRole("status")).not.toBeInTheDocument();
+ expect(screen.getByText(error.message)).toBeInTheDocument();
+ },
+ );
});
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
index 887df60ac51..366b37bc82b 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
@@ -13,8 +13,10 @@ import {
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
-import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import { renderWithProviders, screen, waitFor, within } from "__support__/ui";
+import type { SSEEvent } from "metabase/api/ai-streaming/sse-types";
import { MetabotProvider } from "metabase/metabot/context";
+import { mockAgentEndpoint } from "metabase/metabot/tests/utils";
import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditor";
import { NATIVE_EDITOR_ICON_SIZE } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons";
import { checkNotNull } from "metabase/utils/types";
@@ -46,6 +48,13 @@ const TEST_CARD = createMockCard({
}),
});
+const CODE_EDIT_RESPONSE: SSEEvent[] = [
+ {
+ type: "data-code_edit",
+ data: { buffer_id: "qb", mode: "rewrite", value: "SELECT 2" },
+ },
+];
+
function TestEditor({ question }: { question: Question }) {
const { extensions, portalElement, togglePrompt, isPromptOpen } =
useInlineSQLPrompt(question, "qb");
@@ -145,6 +154,30 @@ describe("useInlineSQLPrompt", () => {
expect(button).toHaveAttribute("aria-pressed", "false");
});
+ it("shows that Metabot is working until the SQL arrives", async () => {
+ const agent = mockAgentEndpoint({
+ events: CODE_EDIT_RESPONSE,
+ waitForResponse: true,
+ });
+ setup();
+
+ expect(await screen.findByText("SELECT")).toBeInTheDocument();
+ await userEvent.click(await screen.findByLabelText("Ask Metabot"));
+ const prompt = await screen.findByTestId("metabot-inline-sql-prompt");
+ await userEvent.type(within(prompt).getByRole("textbox"), "count orders");
+ await userEvent.click(
+ within(prompt).getByRole("button", { name: "Send to Metabot" }),
+ );
+ expect(await within(prompt).findByRole("status")).toHaveTextContent(
+ "Working on it...",
+ );
+
+ agent.sendResponse();
+ await waitFor(() => {
+ expect(screen.queryByText("Working on it...")).not.toBeInTheDocument();
+ });
+ });
+
it("does not render when metabot is not enabled", async () => {
setup({ isMetabotEnabled: false });
diff --git a/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.module.css b/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.module.css
new file mode 100644
index 00000000000..0b012650733
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.module.css
@@ -0,0 +1,31 @@
+.root {
+ --spread: 160px;
+ --base-gradient-color: var(--mb-color-background_page-primary);
+ --base-color: var(--mb-color-text-primary);
+ --bg: linear-gradient(
+ 90deg,
+ transparent calc(50% - var(--spread)),
+ var(--base-gradient-color),
+ transparent calc(50% + var(--spread))
+ );
+
+ color: transparent;
+ background-clip: text;
+ background-size:
+ 250% 100%,
+ auto;
+ background-image:
+ var(--bg), linear-gradient(var(--base-color), var(--base-color));
+ background-position: 50%;
+ animation: rotate-background 1500ms ease infinite;
+}
+
+@keyframes rotate-background {
+ 0% {
+ background-position: 120%;
+ }
+
+ 100% {
+ background-position: -20%;
+ }
+}
diff --git a/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.tsx b/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.tsx
new file mode 100644
index 00000000000..06ec59f6b05
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotWorkingIndicator.tsx
@@ -0,0 +1,12 @@
+import cx from "classnames";
+import { t } from "ttag";
+
+import { Text, type TextProps } from "metabase/ui";
+
+import S from "./MetabotWorkingIndicator.module.css";
+
+export const MetabotWorkingIndicator = ({ className, ...props }: TextProps) => (
+ <Text className={cx(S.root, className)} role="status" {...props}>
+ {t`Working on it...`}
+ </Text>
+);
diff --git a/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css
index a5f36b72f47..a80acbd2234 100644
--- a/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.module.css
@@ -32,35 +32,3 @@
.iconShrink {
flex-shrink: 0;
}
-
-.toolCallStarted {
- --spread: 160px;
- --base-gradient-color: var(--mb-color-background_page-primary);
- --base-color: var(--mb-color-text-primary);
- --bg: linear-gradient(
- 90deg,
- #0000 calc(50% - var(--spread)),
- var(--base-gradient-color),
- #0000 calc(50% + var(--spread))
- );
-
- color: transparent;
- background-clip: text;
- background-size:
- 250% 100%,
- auto;
- background-image:
- var(--bg), linear-gradient(var(--base-color), var(--base-color));
- background-position: 50%;
- animation: rotate-background 1500ms ease infinite;
-}
-
-@keyframes rotate-background {
- 0% {
- background-position: 120%;
- }
-
- 100% {
- background-position: -20%;
- }
-}
diff --git a/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
index 2ceb93253dc..be2631d9464 100644
--- a/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
+++ b/frontend/src/metabase/metabot/components/editor-extensions/MetabotEmbed/MetabotEmbed.tsx
@@ -11,6 +11,7 @@ import { memo, useEffect, useMemo, useRef, useState } from "react";
import { useLatest } from "react-use";
import { t } from "ttag";
+import { MetabotWorkingIndicator } from "metabase/metabot/components/MetabotWorkingIndicator";
import { useUserMetabotPermissions } from "metabase/metabot/hooks";
import { useDispatch, useSelector } from "metabase/redux";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
@@ -302,9 +303,7 @@ export const MetabotComponent = memo(
<Flex px="lg" pb="lg" pt="sm" gap="sm" contentEditable={false}>
<Flex flex={1} my="auto">
{isLoading ? (
- <Text flex={1} className={S.toolCallStarted}>
- {t`Working on it...`}
- </Text>
+ <MetabotWorkingIndicator flex={1} />
) : errorText ? (
<Flex gap="sm" c="text-secondary">
<Icon name="warning" h="1.2rem" className={S.iconShrink} />