Skip to content

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

Fix template tag parsing for model references in transforms generated by metabot (#65630)

Noah Mossf04fb1bff2c0
diff --git a/e2e/test/scenarios/metabot/transforms-codegen.cy.spec.ts b/e2e/test/scenarios/metabot/transforms-codegen.cy.spec.ts
index f05e3409195..8a340b598c7 100644
--- a/e2e/test/scenarios/metabot/transforms-codegen.cy.spec.ts
+++ b/e2e/test/scenarios/metabot/transforms-codegen.cy.spec.ts
@@ -228,6 +228,59 @@ describe("scenarios > metabot > transforms codegen", () => {
assertEditorContent("python", "pd.DataFrame({'value': [3]})");
assertAcceptRejectUI({ visible: false });
});
+
+ it("should create SQL transform with model reference via metabot and run successfully", () => {
+ // Create a model first
+ H.getTableId({ name: SOURCE_TABLE, databaseId: WRITABLE_DB_ID }).as(
+ "tableId",
+ );
+
+ cy.get("@tableId").then((tableId) => {
+ H.createQuestion({
+ name: "Test Model",
+ type: "model",
+ query: {
+ "source-table": tableId,
+ limit: 5,
+ },
+ }).as("model");
+ });
+
+ cy.get("@model").then(({ body: model }) => {
+ visitTransformListPage();
+ H.openMetabotViaSearchButton(true);
+
+ cy.log("Ask metabot for a new transform that references the model");
+ const modelTagName = `#${model.id}-test-model`;
+ const queryWithModelRef = `SELECT * FROM {{${modelTagName}}}`;
+
+ H.mockMetabotResponse({
+ body: createMockTransformSuggestionResponse(
+ "I'll create a transform that queries your model.",
+ createMockNativeTransformJSON(
+ null,
+ WRITABLE_DB_ID,
+ queryWithModelRef,
+ ),
+ ),
+ });
+ H.sendMetabotMessage(
+ "Create a transform that queries the Test Model",
+ );
+ assertSuggestionInSidebar({ newSourcePartial: "SELECT * FROM" });
+
+ cy.log("Should be able to visit the new transform");
+ viewLastSuggestion();
+ cy.url().should("include", "/admin/transforms/new/native");
+ assertEditorContent("native", "SELECT * FROM");
+
+ cy.log(
+ "Should be able to run the transform successfully (verifies template tags were parsed)",
+ );
+ cy.findByTestId("native-query-editor-container").icon("play").click();
+ cy.findByTestId("query-visualization-root").should("be.visible");
+ });
+ });
});
describe("update existing transform", () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/hooks/use-source-state.ts b/enterprise/frontend/src/metabase-enterprise/transforms/hooks/use-source-state.ts
index 960c45fc4e2..01070a8f959 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/hooks/use-source-state.ts
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/hooks/use-source-state.ts
@@ -1,10 +1,14 @@
import { useMemo, useState } from "react";
import { useDispatch, useSelector } from "metabase/lib/redux";
+import { getMetadata } from "metabase/selectors/metadata";
import {
deactivateSuggestedTransform,
getMetabotSuggestedTransform,
} from "metabase-enterprise/metabot/state";
+import * as Lib from "metabase-lib";
+import Question from "metabase-lib/v1/Question";
+import type Metadata from "metabase-lib/v1/metadata/Metadata";
import type {
DraftTransformSource,
SuggestedTransform,
@@ -29,28 +33,62 @@ type UseSourceStateResult = {
rejectProposed: () => void;
};
+/**
+ * Normalizes a transform source by ensuring template tags are properly parsed.
+ * Necessary for model references in a SQL transform to work correctly.
+ */
+function normalizeSource(
+ source: DraftTransformSource,
+ metadata: Metadata,
+): DraftTransformSource {
+ if (source.type !== "query") {
+ return source;
+ }
+
+ const question = Question.create({ dataset_query: source.query, metadata });
+ const query = question.query();
+ const { isNative } = Lib.queryDisplayInfo(query);
+
+ if (isNative) {
+ const updatedQuery = Lib.withNativeQuery(query, Lib.rawNativeQuery(query));
+ return {
+ type: "query",
+ // question.setQuery ensures template tags get processed
+ query: question.setQuery(updatedQuery).datasetQuery(),
+ };
+ }
+
+ return source;
+}
+
export function useSourceState({
transformId,
initialSource,
}: UseSourceStateProps): UseSourceStateResult {
const dispatch = useDispatch();
+ const metadata = useSelector(getMetadata);
const suggestedTransform = useSelector((state) =>
getMetabotSuggestedTransform(state, transformId),
);
- const [source, setSource] = useState(
- transformId != null
- ? initialSource
- : (suggestedTransform?.source ?? initialSource),
- );
+ const [source, setSource] = useState(() => {
+ const rawSource =
+ transformId != null
+ ? initialSource
+ : (suggestedTransform?.source ?? initialSource);
+ return normalizeSource(rawSource, metadata);
+ });
const proposedSource = useMemo(() => {
- return suggestedTransform != null &&
+ if (
+ suggestedTransform != null &&
!isSameSource(suggestedTransform.source, source)
- ? suggestedTransform.source
- : undefined;
- }, [source, suggestedTransform]);
+ ) {
+ return normalizeSource(suggestedTransform.source, metadata);
+ }
+ return undefined;
+ }, [source, suggestedTransform, metadata]);
const isDirty = useMemo(() => {
return (
@@ -69,7 +107,7 @@ export function useSourceState({
const acceptProposed = () => {
if (suggestedTransform != null) {
- setSource(suggestedTransform.source);
+ setSource(normalizeSource(suggestedTransform.source, metadata));
dispatch(deactivateSuggestedTransform(suggestedTransform.id));
}
};