Skip to content

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

[Metabot] Misc. bug fixes (#65255)

Sloan Spargerecd803f067b6
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
index e2349115376..7519be3b823 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.tsx
@@ -3,16 +3,11 @@ import HardBreak from "@tiptap/extension-hard-break";
import Paragraph from "@tiptap/extension-paragraph";
import { Placeholder } from "@tiptap/extension-placeholder";
import Text from "@tiptap/extension-text";
+import { TextSelection } from "@tiptap/pm/state";
import type { EditorView } from "@tiptap/pm/view";
import { EditorContent, useEditor } from "@tiptap/react";
import cx from "classnames";
-import {
- forwardRef,
- useCallback,
- useEffect,
- useImperativeHandle,
- useRef,
-} from "react";
+import { forwardRef, useEffect, useImperativeHandle, useRef } from "react";
import { t } from "ttag";
import { useSelector } from "metabase/lib/redux";
@@ -91,63 +86,74 @@ export const MetabotChatEditor = forwardRef<MetabotChatInputRef | null, Props>(
}),
];
- const handleCopyCut = useCallback((view: EditorView, e: ClipboardEvent) => {
- e.preventDefault();
- const { from, to } = view.state.selection;
- const slice = view.state.doc.slice(from, to);
- const doc = view.state.schema.topNodeType.create(null, slice.content);
- const serialized = serializeTiptapToMetabotMessage(doc.toJSON());
- e.clipboardData?.setData("text/plain", serialized);
- return true;
- }, []);
-
- const editor = useEditor(
- {
- extensions,
- content: value,
- autofocus: autoFocus,
- immediatelyRender: false,
- onUpdate: ({ editor }) => {
- const jsonContent = editor.getJSON();
- serializedRef.current = serializeTiptapToMetabotMessage(jsonContent);
- onChangeRef.current(serializedRef.current);
- },
- editorProps: {
- handleDOMEvents: {
- copy: handleCopyCut,
- cut: handleCopyCut,
+ const editor = useEditor({
+ extensions,
+ content: parseMetabotMessageToTiptapDoc(value),
+ autofocus: autoFocus,
+ onUpdate: ({ editor }) => {
+ const jsonContent = editor.getJSON();
+ serializedRef.current = serializeTiptapToMetabotMessage(jsonContent);
+ onChangeRef.current(serializedRef.current);
+ },
+ editorProps: {
+ handleDOMEvents: {
+ copy: (view: EditorView, e: ClipboardEvent) => {
+ e.preventDefault();
+ const { from, to } = view.state.selection;
+ const slice = view.state.doc.slice(from, to);
+ const doc = view.state.schema.topNodeType.create(
+ null,
+ slice.content,
+ );
+ const serialized = serializeTiptapToMetabotMessage(doc.toJSON());
+ e.clipboardData?.setData("text/plain", serialized);
+ return true;
+ },
+ cut: (view: EditorView, e: ClipboardEvent) => {
+ e.preventDefault();
+ const { from, to } = view.state.selection;
+ const slice = view.state.doc.slice(from, to);
+ const doc = view.state.schema.topNodeType.create(
+ null,
+ slice.content,
+ );
+ const serialized = serializeTiptapToMetabotMessage(doc.toJSON());
+ e.clipboardData?.setData("text/plain", serialized);
+
+ // Delete the selected text and position cursor at cut location
+ const tr = view.state.tr.deleteRange(from, to);
+ tr.setSelection(TextSelection.create(tr.doc, from));
+ view.dispatch(tr);
+
+ return true;
},
- handleKeyDown: (view, event) => {
- if (event.key === "Enter") {
- // Defer enter handling to mention UI if open
- const mentionState = MetabotMentionPluginKey.getState(view.state);
- if (mentionState?.active) {
- return false; // Let the suggestion system handle it
- }
-
- // Check for any modifier keys (shift, ctrl, meta, alt)
- const isModifiedKeyPress =
- event.shiftKey ||
- event.ctrlKey ||
- event.metaKey ||
- event.altKey;
-
- if (!isModifiedKeyPress) {
- event.preventDefault();
- onSubmitRef.current();
- return true;
- }
+ },
+ handleKeyDown: (view, event) => {
+ if (event.key === "Enter") {
+ // Defer enter handling to mention UI if open
+ const mentionState = MetabotMentionPluginKey.getState(view.state);
+ if (mentionState?.active) {
+ return false; // Let the suggestion system handle it
}
- return false;
- },
- clipboardTextSerializer: (content) => {
- return serializeTiptapToMetabotMessage(content.toJSON());
- },
+ // Check for any modifier keys (shift, ctrl, meta, alt)
+ const isModifiedKeyPress =
+ event.shiftKey || event.ctrlKey || event.metaKey || event.altKey;
+
+ if (!isModifiedKeyPress) {
+ event.preventDefault();
+ onSubmitRef.current();
+ return true;
+ }
+ }
+
+ return false;
+ },
+ clipboardTextSerializer: (content) => {
+ return serializeTiptapToMetabotMessage(content.toJSON());
},
},
- [],
- );
+ });
useImperativeHandle(ref, () => {
if (!editor) {
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
index f0fde008f51..141b4874145 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/MetabotChatEditor.unit.spec.tsx
@@ -2,12 +2,15 @@ import { screen } from "@testing-library/react";
import userEvent from "@testing-library/user-event";
import { setupEnterprisePlugins } from "__support__/enterprise";
-import { setupDatabaseEndpoints } from "__support__/server-mocks";
+import {
+ setupCardEndpoints,
+ setupDatabaseEndpoints,
+} from "__support__/server-mocks";
import { setupSearchEndpoints } from "__support__/server-mocks/search";
import { mockSettings } from "__support__/settings";
import { renderWithProviders } from "__support__/ui";
import type { SuggestionModel } from "metabase-enterprise/rich_text_editing/tiptap/extensions/shared/types";
-import { createMockUser } from "metabase-types/api/mocks";
+import { createMockCard, createMockUser } from "metabase-types/api/mocks";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
import { createMockSearchResult } from "metabase-types/api/mocks/search";
import { createMockState } from "metabase-types/store/mocks";
@@ -29,6 +32,7 @@ const defaultProps = {
const setup = (props = {}) => {
setupEnterprisePlugins();
+ setupCardEndpoints(createMockCard({ id: 123, name: "Test Model" }));
const settings = mockSettings({ "site-url": "http://localhost:3000" });
return renderWithProviders(
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/utils.ts b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/utils.ts
index 275d9078993..228bab44707 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/utils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotChat/MetabotChatEditor/utils.ts
@@ -5,6 +5,7 @@ import {
METABSE_PROTOCOL_MD_LINK,
createMetabaseProtocolLink,
} from "metabase-enterprise/metabot/utils/links";
+import { mbProtocolModelToSuggestionModel } from "metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils";
function serializeNodes(nodes: JSONContent[]): string {
return nodes.map((node) => serializeNode(node)).join("");
@@ -44,10 +45,6 @@ export function serializeTiptapToMetabotMessage(content: JSONContent): string {
}
const MENTION_REGEX = new RegExp(METABSE_PROTOCOL_MD_LINK, "g");
-const MODEL_MAP: Record<string, string | undefined> = {
- model: "dataset",
- question: "card",
-};
export function parseMetabotMessageToTiptapDoc(text: string): JSONContent {
// Split text by lines to handle paragraphs
@@ -56,8 +53,8 @@ export function parseMetabotMessageToTiptapDoc(text: string): JSONContent {
let lastIndex = 0;
for (const match of line.matchAll(MENTION_REGEX)) {
- const [fullMatch, label, internalModel, entityId] = match;
- const model = MODEL_MAP[internalModel] || internalModel;
+ const [fullMatch, label, mbProtocolModel, entityId] = match;
+ const model = mbProtocolModelToSuggestionModel(mbProtocolModel);
// Add text before the mention
if (match.index > lastIndex) {
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/metabot.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/metabot.unit.spec.tsx
index 3eafc84643a..6f7ff6ec6b2 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/metabot.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/metabot.unit.spec.tsx
@@ -1026,17 +1026,15 @@ describe("metabot-streaming", () => {
describe("experimental", () => {
describe("debug mode", () => {
const mockResponse = () => {
- mockAgentEndpoint(
- {
- textChunks: [
- `0:"Before"`,
- `9:{"toolCallId":"debug_test","toolName":"debug_test","args":""}`,
- `a:{"toolCallId":"debug_test","result":""}`,
- `0:"After"`,
- `d:{"finishReason":"stop","usage":{"promptTokens":4916,"completionTokens":8}}`,
- ],
- }, // small delay to cause loading state
- );
+ mockAgentEndpoint({
+ textChunks: [
+ `0:"Before"`,
+ `9:{"toolCallId":"debug_test","toolName":"debug_test","args":""}`,
+ `a:{"toolCallId":"debug_test","result":""}`,
+ `0:"After"`,
+ `d:{"finishReason":"stop","usage":{"promptTokens":4916,"completionTokens":8}}`,
+ ],
+ });
};
it("should not show tool_call messages in chat if debug mode is disabled", async () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode.tsx b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode.tsx
index deac0ca9e29..0c88a4099e3 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/SmartLink/SmartLinkNode.tsx
@@ -8,10 +8,12 @@ import { memo, useEffect } from "react";
import { t } from "ttag";
import {
+ useGetActionQuery,
useGetCardQuery,
useGetCollectionQuery,
useGetDashboardQuery,
useGetDatabaseQuery,
+ useGetSegmentQuery,
useGetTableQuery,
} from "metabase/api";
import {
@@ -25,6 +27,7 @@ import { extractEntityId } from "metabase/lib/urls/utils";
import { Icon } from "metabase/ui";
import {
useGetDocumentQuery,
+ useGetTransformQuery,
useListMentionsQuery,
} from "metabase-enterprise/api";
import { updateMentionsCache } from "metabase-enterprise/documents/documents.slice";
@@ -40,13 +43,16 @@ import type {
Database,
Document,
MentionableUser,
+ Segment,
Table,
Transform,
+ WritebackAction,
} from "metabase-types/api";
import {
entityToUrlableModel,
isMentionableUser,
+ mbProtocolModelToSuggestionModel,
} from "../shared/suggestionUtils";
import type { SuggestionModel } from "../shared/types";
@@ -60,6 +66,8 @@ export type SmartLinkEntity =
| Transform
| Database
| Document
+ | WritebackAction
+ | Segment
| MentionableUser;
// Utility function to parse entity URLs and extract entityId and model
@@ -239,9 +247,11 @@ export const SmartLink = Node.create<{
const parsedEntity = parseMetabaseProtocolMarkdownLink(url);
if (parsedEntity) {
+ const model = mbProtocolModelToSuggestionModel(parsedEntity?.model);
+
return {
entityId: parsedEntity.id,
- model: parsedEntity.model,
+ model,
label: parsedEntity.name,
};
}
@@ -253,13 +263,19 @@ export const SmartLink = Node.create<{
},
});
+function assertUnreachable(value: never) {
+ console.warn(`Unhandled model type: ${value}`);
+}
+
export const useEntityData = (
entityId: number | null,
model: SuggestionModel | null,
) => {
const cardQuery = useGetCardQuery(
{ id: entityId! },
- { skip: !entityId || (model !== "card" && model !== "dataset") },
+ {
+ skip: !entityId || (model !== "card" && model !== "dataset"),
+ },
);
const dashboardQuery = useGetDashboardQuery(
@@ -291,70 +307,97 @@ export const useEntityData = (
},
);
- const usersQuery = useListMentionsQuery(undefined, {
- skip: !entityId || model !== "user",
+ const transformQuery = useGetTransformQuery(entityId!, {
+ skip: !entityId || model !== "transform",
});
- // Determine which query is active and return its state
- if (model === "card" || model === "dataset") {
- return {
- entity: cardQuery.data,
- isLoading: cardQuery.isLoading,
- error: cardQuery.error,
- };
- }
-
- if (model === "dashboard") {
- return {
- entity: dashboardQuery.data,
- isLoading: dashboardQuery.isLoading,
- error: dashboardQuery.error,
- };
- }
-
- if (model === "collection") {
- return {
- entity: collectionQuery.data,
- isLoading: collectionQuery.isLoading,
- error: collectionQuery.error,
- };
- }
-
- if (model === "table") {
- return {
- entity: tableQuery.data,
- isLoading: tableQuery.isLoading,
- error: tableQuery.error,
- };
- }
-
- if (model === "database") {
- return {
- entity: databaseQuery.data,
- isLoading: databaseQuery.isLoading,
- error: databaseQuery.error,
- };
- }
+ const actionQuery = useGetActionQuery(
+ { id: entityId! },
+ { skip: !entityId || model !== "action" },
+ );
- if (model === "document") {
- return {
- entity: documentQuery.data,
- isLoading: documentQuery.isLoading,
- error: documentQuery.error,
- };
- }
+ const segmentQuery = useGetSegmentQuery(entityId!, {
+ skip: !entityId || model !== "segment",
+ });
- if (model === "user") {
- const user = usersQuery.data?.data.find((user) => user.id === entityId);
+ const usersQuery = useListMentionsQuery(undefined, {
+ skip: !entityId || model !== "user",
+ });
- return {
- entity: user ? { ...user, name: user.common_name } : null,
- isLoading: usersQuery.isLoading,
- error: usersQuery.error,
- };
+ // Determine which query is active and return its state
+ switch (model) {
+ case "card":
+ case "dataset":
+ case "metric":
+ return {
+ entity: cardQuery.data,
+ isLoading: cardQuery.isLoading,
+ error: cardQuery.error,
+ };
+ case "dashboard":
+ return {
+ entity: dashboardQuery.data,
+ isLoading: dashboardQuery.isLoading,
+ error: dashboardQuery.error,
+ };
+ case "collection":
+ return {
+ entity: collectionQuery.data,
+ isLoading: collectionQuery.isLoading,
+ error: collectionQuery.error,
+ };
+ case "table":
+ return {
+ entity: tableQuery.data,
+ isLoading: tableQuery.isLoading,
+ error: tableQuery.error,
+ };
+ case "database":
+ return {
+ entity: databaseQuery.data,
+ isLoading: databaseQuery.isLoading,
+ error: databaseQuery.error,
+ };
+ case "document":
+ return {
+ entity: documentQuery.data,
+ isLoading: documentQuery.isLoading,
+ error: documentQuery.error,
+ };
+ case "transform":
+ return {
+ entity: transformQuery.data,
+ isLoading: transformQuery.isLoading,
+ error: transformQuery.error,
+ };
+ case "action":
+ return {
+ entity: actionQuery.data,
+ isLoading: actionQuery.isLoading,
+ error: actionQuery.error,
+ };
+ case "segment":
+ return {
+ entity: segmentQuery.data,
+ isLoading: segmentQuery.isLoading,
+ error: segmentQuery.error,
+ };
+ case "user": {
+ const user = usersQuery.data?.data.find((user) => user.id === entityId);
+
+ return {
+ entity: user ? { ...user, name: user.common_name } : null,
+ isLoading: usersQuery.isLoading,
+ error: usersQuery.error,
+ };
+ }
+ case "indexed-entity":
+ case null:
+ return { entity: null, isLoading: false, error: null };
+ default:
+ assertUnreachable(model);
+ return { entity: null, isLoading: false, error: null };
}
-
- return { entity: null, isLoading: false, error: null };
};
export const SmartLinkComponent = memo(
diff --git a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
index 510b3999e94..db89cf96496 100644
--- a/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
+++ b/enterprise/frontend/src/metabase-enterprise/rich_text_editing/tiptap/extensions/shared/suggestionUtils.ts
@@ -1,8 +1,11 @@
+import { match } from "ts-pattern";
+
import { getTranslatedEntityName } from "metabase/common/utils/model-names";
import { getIcon } from "metabase/lib/icon";
import { getName } from "metabase/lib/name";
import type { UrlableModel } from "metabase/lib/urls/modelToUrl";
import type { MenuItem } from "metabase-enterprise/documents/components/Editor/shared/MenuComponents";
+import type { MetabaseProtocolEntityModel } from "metabase-enterprise/metabot/utils/links";
import type {
Database,
MentionableUser,
@@ -130,3 +133,17 @@ export function entityToUrlableModel<
export function isMentionableUser(value: unknown): value is MentionableUser {
return isObject(value) && typeof value.common_name === "string";
}
+
+export function mbProtocolModelToSuggestionModel(inputModel: string): string {
+ // dom nodes record strings and it's better to not to error the input with invalid
+ // data. casting here still afford some amount of internal type awareness as these
+ // two types might diverge in the future.
+ const model: SuggestionModel = match(
+ inputModel as MetabaseProtocolEntityModel,
+ )
+ .with("model", () => "dataset" as const)
+ .with("question", () => "card" as const)
+ .otherwise((x) => x);
+
+ return model;
+}