Skip to content

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

Transforms with params UI (#69728)

Romeo Van Snickb08d62e31630
diff --git a/e2e/support/helpers/e2e-data-studio-helpers.ts b/e2e/support/helpers/e2e-data-studio-helpers.ts
index c08b5b588f4..ece94a175cc 100644
--- a/e2e/support/helpers/e2e-data-studio-helpers.ts
+++ b/e2e/support/helpers/e2e-data-studio-helpers.ts
@@ -49,6 +49,8 @@ export const DataStudio = {
DataStudio.Transforms.getEditDefinitionLink().click();
},
queryEditor: () => cy.findByTestId("transform-query-editor"),
+ definitionTab: () =>
+ DataStudio.Transforms.header().findByText("Definition"),
runTab: () => DataStudio.Transforms.header().findByText("Run"),
targetTab: () => DataStudio.Transforms.header().findByText("Target"),
settingsTab: () => DataStudio.Transforms.header().findByText("Settings"),
diff --git a/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
new file mode 100644
index 00000000000..3e1dc1f72da
--- /dev/null
+++ b/e2e/test/scenarios/data-studio/transforms/template-tags.cy.spec.ts
@@ -0,0 +1,366 @@
+import { WRITABLE_DB_ID } from "e2e/support/cypress_data";
+
+const { H } = cy;
+
+const DB_NAME = "Writable Postgres12";
+const SOURCE_TABLE = "Animals";
+const TARGET_SCHEMA = "Schema A";
+const TARGET_TABLE = "transform_table";
+
+describe("scenarios > admin > transforms", () => {
+ beforeEach(() => {
+ H.restore("postgres-writable");
+ H.resetTestTable({ type: "postgres", table: "many_schemas" });
+ H.resetSnowplow();
+ cy.signInAsAdmin();
+ H.activateToken("bleeding-edge");
+ H.resyncDatabase({ dbId: WRITABLE_DB_ID, tableName: SOURCE_TABLE });
+
+ cy.intercept("PUT", "/api/field/*").as("updateField");
+ cy.intercept("POST", "/api/transform").as("createTransform");
+ cy.intercept("PUT", "/api/transform/*").as("updateTransform");
+ cy.intercept("DELETE", "/api/transform/*").as("deleteTransform");
+ cy.intercept("DELETE", "/api/transform/*/table").as("deleteTransformTable");
+ cy.intercept("POST", "/api/transform-tag").as("createTag");
+ cy.intercept("PUT", "/api/transform-tag/*").as("updateTag");
+ cy.intercept("DELETE", "/api/transform-tag/*").as("deleteTag");
+ cy.intercept("POST", "/api/ee/dependencies/check_transform").as(
+ "checkTransformDependencies",
+ );
+ });
+
+ it("should be able to use the data reference and snippets when writing a SQL transform", () => {
+ H.createSnippet({
+ name: "snippet1",
+ content: "'foo'",
+ });
+
+ visitTransformListPage();
+ cy.button("Create a transform").click();
+ H.popover().findByText("SQL query").click();
+ H.popover().findByText(DB_NAME).click();
+
+ function testDataReference() {
+ cy.log("open the data reference");
+ cy.findByTestId("native-query-editor-action-buttons")
+ .findByLabelText("Learn about your data")
+ .click();
+
+ editorSidebar()
+ .should("be.visible")
+ .within(() => {
+ cy.log("The current database should be opened by default");
+ cy.findByText("Data Reference").should("not.exist");
+ cy.findByText("Writable Postgres12").should("be.visible");
+ });
+
+ cy.findByTestId("native-query-editor-action-buttons")
+ .findByLabelText("Learn about your data")
+ .click();
+
+ editorSidebar().should("not.exist");
+ }
+
+ function testSnippets() {
+ cy.findByTestId("native-query-editor-action-buttons")
+ .findByLabelText("SQL Snippets")
+ .click();
+
+ editorSidebar()
+ .should("be.visible")
+ .within(() => {
+ cy.findByText("snippet1").should("be.visible");
+ cy.icon("snippet").click();
+ });
+
+ H.NativeEditor.value().should("eq", "{{snippet: snippet1}}");
+
+ cy.findByTestId("native-query-editor-action-buttons")
+ .findByLabelText("SQL Snippets")
+ .click();
+
+ editorSidebar().should("not.exist");
+
+ cy.findByTestId("native-query-editor-action-buttons")
+ .findByLabelText("Preview the query")
+ .click();
+
+ H.modal().findByText("'foo'").should("be.visible");
+ }
+
+ testDataReference();
+ testSnippets();
+ });
+
+ it("should be possible to use template tags in SQL transform", () => {
+ H.createTestNativeQuery({
+ database: WRITABLE_DB_ID,
+ query: "SELECT 1",
+ })
+ .then((query) =>
+ H.createTransform(
+ {
+ name: "MBQL",
+ source: {
+ type: "query",
+ query,
+ },
+ target: {
+ type: "table",
+ database: WRITABLE_DB_ID,
+ name: TARGET_TABLE,
+ schema: TARGET_SCHEMA,
+ },
+ },
+ { wrapId: true },
+ ),
+ )
+ .then((transformId) => {
+ cy.visit(`/data-studio/transforms/${transformId}`);
+ });
+
+ function testSimpleTemplateTag(
+ name: string,
+ type: string,
+ setDefaultValue: () => void,
+ ) {
+ H.DataStudio.Transforms.clickEditDefinition();
+
+ H.NativeEditor.clear()
+ .type(`SELECT {{ ${name} }}`, {
+ allowFastSet: true,
+ })
+ .blur();
+
+ cy.findByTestId("native-query-top-bar")
+ .findByLabelText("Variables")
+ .click();
+
+ editorSidebar().findByLabelText("Variable type").click();
+ H.popover().findByText(type).click();
+
+ cy.log(
+ "try saving transform, an error is shown about missing parameters",
+ );
+ queryEditor().button("Save").should("be.enabled").click();
+ H.undoToast()
+ .should("contain.text", "missing required parameters")
+ .icon("close")
+ .click();
+
+ editorSidebar()
+ .findByText("Always require a value")
+ .scrollIntoView()
+ .should("be.visible")
+ .click();
+
+ queryEditor().button("Save").should("be.disabled");
+
+ editorSidebar()
+ .findByText(/Default filter widget value/)
+ .scrollIntoView();
+ setDefaultValue();
+
+ queryEditor().button("Save").should("be.enabled").click();
+ H.undoToast()
+ .should("have.text", "Transform query updated")
+ .icon("close")
+ .click();
+ assertIsTransformRunnable();
+ }
+
+ function testFieldTemplateTag() {
+ H.DataStudio.Transforms.clickEditDefinition();
+
+ H.NativeEditor.clear()
+ .type('SELECT * from "Schema A"."Animals" WHERE {{ dim }}', {
+ allowFastSet: true,
+ })
+ .blur();
+
+ cy.findByTestId("native-query-top-bar")
+ .findByLabelText("Variables")
+ .click();
+
+ editorSidebar().findByLabelText("Variable type").click();
+ H.popover().findByText("Field Filter").click();
+
+ H.popover().findByText("Schema a").click();
+ H.popover().findByText("Animals").click();
+ H.popover().findByText("Score").click();
+
+ editorSidebar()
+ .findByText("Always require a value")
+ .scrollIntoView()
+ .should("be.visible")
+ .click();
+
+ queryEditor().button("Save").should("be.disabled");
+
+ editorSidebar()
+ .findByText("Enter a default value…")
+ .scrollIntoView()
+ .click();
+
+ H.popover().within(() => {
+ cy.findByText("10").click();
+ cy.button("Update filter").click();
+ });
+
+ cy.log("saving works");
+ queryEditor().button("Save").should("be.enabled").click();
+ H.undoToast()
+ .should("have.text", "Transform query updated")
+ .icon("close")
+ .click();
+ assertIsTransformRunnable();
+ }
+
+ function testTableTemplateTag() {
+ H.DataStudio.Transforms.clickEditDefinition();
+
+ H.NativeEditor.clear()
+ .type("SELECT * from {{ table }}", { allowFastSet: true })
+ .blur();
+
+ cy.findByTestId("native-query-top-bar")
+ .findByLabelText("Variables")
+ .click();
+
+ editorSidebar().findByLabelText("Variable type").click();
+ H.popover().findByText("Table").click();
+
+ H.popover().findByText("Schema a").click();
+ H.popover().findByText("Animals").click();
+
+ queryEditor().button("Save").should("be.enabled").click();
+ H.undoToast()
+ .should("have.text", "Transform query updated")
+ .icon("close")
+ .click();
+ assertIsTransformRunnable();
+ }
+
+ testSimpleTemplateTag("text", "Text", () =>
+ editorSidebar()
+ .findByPlaceholderText("Enter a default value…")
+ .type("Foo"),
+ );
+ testSimpleTemplateTag("number", "Number", () =>
+ editorSidebar()
+ .findByPlaceholderText("Enter a default value…")
+ .type("42"),
+ );
+ testSimpleTemplateTag("bool", "Boolean", () => {
+ editorSidebar()
+ .findByText("Enter a default value…")
+ .scrollIntoView()
+ .click();
+ H.popover().button("Add filter").click();
+ });
+ testSimpleTemplateTag("date", "Date", () => {
+ editorSidebar().findByText("Select a default value…").click();
+ H.popover().button("Add filter").click();
+ });
+ testFieldTemplateTag();
+ testTableTemplateTag();
+ });
+
+ it("should be possible to add multiple template tags", () => {
+ cy.log("create a new transform");
+ visitTransformListPage();
+ cy.button("Create a transform").click();
+ H.popover().findByText("SQL query").click();
+
+ cy.log("Add a query with multiple template tags");
+ H.NativeEditor.clear()
+ .type(
+ 'SELECT * from "Schema A"."Animals" WHERE name = {{ name }} AND score > {{ min_score }}',
+ { allowFastSet: true },
+ )
+ .blur();
+
+ cy.log("saving does not work out of the box");
+ queryEditor().button("Save").click();
+ H.modal().within(() => {
+ cy.findByPlaceholderText("My Great Transform").type("Foo");
+ cy.button("Save").click();
+ cy.findByText(/missing required parameters/i).should("be.visible");
+ cy.button("Back").click();
+ });
+
+ cy.log("Open the variables sidebar");
+ cy.findByTestId("native-query-top-bar")
+ .findByLabelText("Variables")
+ .click();
+
+ editorSidebar()
+ .findAllByText("Always require a value")
+ .should("have.length", 2)
+ .eq(0)
+ .scrollIntoView()
+ .click();
+
+ editorSidebar()
+ .findAllByText("Always require a value")
+ .should("have.length", 2)
+ .eq(1)
+ .scrollIntoView()
+ .click();
+
+ queryEditor().button("Save").should("be.disabled");
+
+ cy.log("Configure the first template tag default");
+ editorSidebar()
+ .findAllByPlaceholderText("Enter a default value…")
+ .should("have.length", 2)
+ .eq(0)
+ .type("Default Name");
+
+ queryEditor().button("Save").should("be.disabled");
+
+ cy.log("Configure the second template tag");
+ editorSidebar()
+ .findAllByLabelText("Variable type")
+ .should("have.length", 2)
+ .eq(1)
+ .click();
+ H.popover().findByText("Number").click();
+ editorSidebar()
+ .findAllByPlaceholderText("Enter a default value…")
+ .should("have.length", 2)
+ .eq(1)
+ .type("42");
+
+ cy.log("Save the transform with all template tags configured");
+ queryEditor().button("Save").should("be.enabled").click();
+ H.modal().within(() => {
+ cy.findByPlaceholderText("My Great Transform").type("Foo");
+ cy.button("Save").click();
+ });
+ assertIsTransformRunnable();
+ });
+});
+
+function visitTransformListPage() {
+ return cy.visit("/data-studio/transforms");
+}
+
+function queryEditor() {
+ return cy.findByTestId("transform-query-editor");
+}
+
+function editorSidebar() {
+ return cy.findByTestId("editor-sidebar");
+}
+
+function assertIsTransformRunnable() {
+ H.DataStudio.Transforms.runTab().click();
+ getRunButton().click();
+ getRunButton().should("have.text", "Ran successfully");
+ H.DataStudio.Transforms.definitionTab().click();
+}
+
+function getRunButton(options: { timeout?: number } = {}) {
+ return cy.findAllByTestId("run-button").eq(0, options);
+}
diff --git a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
index 64677e61dbe..2270234c864 100644
--- a/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/data-studio/transforms/transforms.cy.spec.ts
@@ -169,69 +169,6 @@ describe("scenarios > admin > transforms", () => {
H.assertQueryBuilderRowCount(3);
});
- it("should be able to use the data reference and snippets when writing a SQL transform", () => {
- H.createSnippet({
- name: "snippet1",
- content: "'foo'",
- });
-
- visitTransformListPage();
- cy.button("Create a transform").click();
- H.popover().findByText("SQL query").click();
- H.popover().findByText(DB_NAME).click();
-
- function testDataReference() {
- cy.log("open the data reference");
- cy.findByTestId("native-query-editor-action-buttons")
- .findByLabelText("Learn about your data")
- .click();
-
- editorSidebar()
- .should("be.visible")
- .within(() => {
- cy.log("The current database should be opened by default");
- cy.findByText("Data Reference").should("not.exist");
- cy.findByText("Writable Postgres12").should("be.visible");
- });
-
- cy.findByTestId("native-query-editor-action-buttons")
- .findByLabelText("Learn about your data")
- .click();
-
- editorSidebar().should("not.exist");
- }
-
- function testSnippets() {
- cy.findByTestId("native-query-editor-action-buttons")
- .findByLabelText("SQL Snippets")
- .click();
-
- editorSidebar()
- .should("be.visible")
- .within(() => {
- cy.findByText("snippet1").should("be.visible");
- cy.icon("snippet").click();
- });
-
- H.NativeEditor.value().should("eq", "{{snippet: snippet1}}");
-
- cy.findByTestId("native-query-editor-action-buttons")
- .findByLabelText("SQL Snippets")
- .click();
-
- editorSidebar().should("not.exist");
-
- cy.findByTestId("native-query-editor-action-buttons")
- .findByLabelText("Preview the query")
- .click();
-
- H.modal().findByText("'foo'").should("be.visible");
- }
-
- testDataReference();
- testSnippets();
- });
-
it(
"should be possible to create and run a Python transform",
{ tags: ["@python"] },
@@ -4115,10 +4052,6 @@ function assertOptionNotSelected(name: string) {
getTagsInputContainer().findByText(name).should("not.exist");
}
-function editorSidebar() {
- return cy.findByTestId("editor-sidebar");
-}
-
function getPythonDataPicker() {
return cy.findByTestId("python-data-picker");
}
diff --git a/frontend/src/metabase-lib/native.ts b/frontend/src/metabase-lib/native.ts
index 58955cc050f..85df45959fb 100644
--- a/frontend/src/metabase-lib/native.ts
+++ b/frontend/src/metabase-lib/native.ts
@@ -1,8 +1,25 @@
import * as ML from "cljs/metabase.lib.js";
-import type { DatabaseId, TemplateTags } from "metabase-types/api";
+import type { DatabaseId, TemplateTag, TemplateTags } from "metabase-types/api";
import type { MetadataProvider, Query, ValidationError } from "./types";
+export const variableTemplateTags = new Set([
+ "boolean",
+ "date",
+ "dimension",
+ "number",
+ "table",
+ "temporal-unit",
+ "text",
+]);
+
+export function isVariableTemplateTag(type: string | TemplateTag): boolean {
+ if (typeof type === "string") {
+ return variableTemplateTags.has(type);
+ }
+ return variableTemplateTags.has(type.type);
+}
+
export function nativeQuery(
databaseId: DatabaseId,
metadata: MetadataProvider,
diff --git a/frontend/src/metabase-lib/v1/queries/NativeQuery.ts b/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
index 2d67290fe0a..53215de8cf5 100644
--- a/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
+++ b/frontend/src/metabase-lib/v1/queries/NativeQuery.ts
@@ -267,17 +267,7 @@ export default class NativeQuery {
}
variableTemplateTags(): TemplateTag[] {
- return this.templateTags().filter((t) =>
- [
- "dimension",
- "text",
- "number",
- "date",
- "boolean",
- "temporal-unit",
- "table",
- ].includes(t.type),
- );
+ return this.templateTags().filter(Lib.isVariableTemplateTag);
}
hasVariableTemplateTags(): boolean {
diff --git a/frontend/src/metabase/api/utils/errors.ts b/frontend/src/metabase/api/utils/errors.ts
index d7527487fe9..6dad4d8a1c8 100644
--- a/frontend/src/metabase/api/utils/errors.ts
+++ b/frontend/src/metabase/api/utils/errors.ts
@@ -22,21 +22,25 @@ export const getErrorMessage = (
return fallback;
}
- if ("message" in payload) {
+ if ("message" in payload && !isEmpty(payload.message)) {
return getErrorMessage(payload.message, fallback);
}
- if ("error" in payload) {
+ if ("error" in payload && !isEmpty(payload.error)) {
return getErrorMessage(payload.error, fallback);
}
- if ("error_message" in payload) {
+ if ("error_message" in payload && !isEmpty(payload.error_message)) {
return getErrorMessage(payload.error_message, fallback);
}
- if ("data" in payload) {
+ if ("data" in payload && !isEmpty(payload.data)) {
return getErrorMessage(payload.data, fallback);
}
return fallback;
};
+
+function isEmpty(value: unknown): boolean {
+ return value == null || value === "";
+}
diff --git a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditor.tsx b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditor.tsx
index 3042e786a94..3d3845f5874 100644
--- a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditor.tsx
+++ b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditor.tsx
@@ -167,6 +167,7 @@ export const NativeQueryEditor = forwardRef<
},
toggleDataReference,
toggleSnippetSidebar,
+ toggleTemplateTagsEditor,
topBarInnerContent,
} = props;
const isRemoteSyncReadOnly = useSelector(
@@ -308,6 +309,7 @@ export const NativeQueryEditor = forwardRef<
toggleEditor={toggleEditor}
toggleDataReference={toggleDataReference}
toggleSnippetSidebar={toggleSnippetSidebar}
+ toggleTemplateTagsEditor={toggleTemplateTagsEditor}
setParameterValue={setParameterValue}
setDatasetQuery={setDatasetQuery}
onFormatQuery={handleFormatQuery}
diff --git a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
index 1be58d487e4..4456c54f813 100644
--- a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
+++ b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
@@ -30,6 +30,7 @@ interface NativeQueryEditorActionButtonsProps {
cancelQuery?: () => void;
toggleDataReference?: () => void;
toggleSnippetSidebar?: () => void;
+ toggleTemplateTagsEditor?: () => void;
onOpenModal?: (modalType: QueryModalType) => void;
onFormatQuery?: () => void;
}
@@ -43,6 +44,7 @@ export const NativeQueryEditorActionButtons = (
snippets,
features,
toggleDataReference,
+ toggleTemplateTagsEditor,
onFormatQuery,
} = props;
@@ -78,7 +80,11 @@ export const NativeQueryEditorActionButtons = (
<SnippetSidebarButton {...props} size={ICON_SIZE} />
)}
{features.variables && (
- <NativeVariablesButton {...props} size={ICON_SIZE} />
+ <NativeVariablesButton
+ {...props}
+ size={ICON_SIZE}
+ onClick={toggleTemplateTagsEditor}
+ />
)}
{showFormatButton && onFormatQuery && (
<Tooltip label={t`Auto-format`}>
diff --git a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorTopBar/NativeQueryEditorTopBar.tsx b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorTopBar/NativeQueryEditorTopBar.tsx
index 7c7c142da01..12f511b0004 100644
--- a/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorTopBar/NativeQueryEditorTopBar.tsx
+++ b/frontend/src/metabase/query_builder/components/NativeQueryEditor/NativeQueryEditorTopBar/NativeQueryEditorTopBar.tsx
@@ -45,6 +45,7 @@ interface NativeQueryEditorTopBarProps extends PropsWithChildren {
toggleEditor?: () => void;
toggleDataReference?: () => void;
toggleSnippetSidebar?: () => void;
+ toggleTemplateTagsEditor?: () => void;
setIsNativeEditorOpen?: (isOpen: boolean) => void;
onFormatQuery?: () => void;
onSetDatabaseId?: (id: DatabaseId) => void;
@@ -85,6 +86,7 @@ export const NativeQueryEditorTopBar = forwardRef<
toggleEditor,
toggleDataReference,
toggleSnippetSidebar,
+ toggleTemplateTagsEditor,
onSetDatabaseId,
hasParametersList = true,
setDatasetQuery,
@@ -165,6 +167,7 @@ export const NativeQueryEditorTopBar = forwardRef<
isShowingSnippetSidebar={isShowingSnippetSidebar}
toggleDataReference={toggleDataReference}
toggleSnippetSidebar={toggleSnippetSidebar}
+ toggleTemplateTagsEditor={toggleTemplateTagsEditor}
onOpenModal={onOpenModal}
/>
)}
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
index 19ab351353e..e230aa7b036 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorParam.tsx
@@ -2,7 +2,7 @@ import { Component } from "react";
import { t } from "ttag";
import _ from "underscore";
-import { connect } from "metabase/lib/redux";
+import { type DispatchFn, connect } from "metabase/lib/redux";
import { TemporalUnitSettings } from "metabase/parameters/components/ParameterSettings/TemporalUnitSettings";
import { ValuesSourceSettings } from "metabase/parameters/components/ValuesSourceSettings";
import { isSingleOrMultiSelectable } from "metabase/parameters/utils/parameter-type";
@@ -79,6 +79,10 @@ interface OwnProps {
database?: Database | null;
databases: Database[];
setTemplateTag: (tag: TemplateTag) => void;
+ setTemplateTagConfig?: (
+ tag: TemplateTag,
+ config: ParameterValuesConfig,
+ ) => void;
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
}
@@ -89,7 +93,23 @@ function mapStateToProps(state: State) {
};
}
-const mapDispatchToProps = { fetchField, setTemplateTagConfig };
+const mapDispatchToProps = (
+ dispatch: DispatchFn,
+ props: OwnProps,
+): DispatchProps => {
+ return {
+ fetchField(fieldId, force) {
+ dispatch(fetchField(fieldId, force));
+ },
+ setTemplateTagConfig(tag, config) {
+ if (props.setTemplateTagConfig) {
+ props.setTemplateTagConfig(tag, config);
+ return;
+ }
+ dispatch(setTemplateTagConfig(tag, config));
+ },
+ };
+};
const EMPTY_VALUES_CONFIG: ParameterValuesConfig = {
isMultiSelect: false,
diff --git a/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx b/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
index b6a3915f0f3..1c2dc2c5627 100644
--- a/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/template_tags/TagEditorSidebar.tsx
@@ -13,6 +13,7 @@ import type {
NativeDatasetQuery,
Parameter,
ParameterId,
+ ParameterValuesConfig,
RowValue,
TemplateTag,
TemplateTagId,
@@ -34,6 +35,10 @@ interface TagEditorSidebarProps {
sampleDatabaseId: DatabaseId;
setDatasetQuery: (query: NativeDatasetQuery) => void;
setTemplateTag: (tag: TemplateTag) => void;
+ setTemplateTagConfig?: (
+ tag: TemplateTag,
+ config: ParameterValuesConfig,
+ ) => void;
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
onClose: () => void;
getEmbeddedParameterVisibility: GetEmbeddedParamVisibility;
@@ -46,6 +51,7 @@ export function TagEditorSidebar({
sampleDatabaseId,
setDatasetQuery,
setTemplateTag,
+ setTemplateTagConfig,
setParameterValue,
onClose,
getEmbeddedParameterVisibility,
@@ -85,6 +91,7 @@ export function TagEditorSidebar({
database={database}
databases={databases as Database[]}
setTemplateTag={setTemplateTag}
+ setTemplateTagConfig={setTemplateTagConfig}
setParameterValue={setParameterValue}
getEmbeddedParameterVisibility={getEmbeddedParameterVisibility}
/>
@@ -109,6 +116,10 @@ interface SettingsPaneProps {
databases: Database[];
parametersById: Record<ParameterId, Parameter>;
setTemplateTag: (tag: TemplateTag) => void;
+ setTemplateTagConfig?: (
+ tag: TemplateTag,
+ config: ParameterValuesConfig,
+ ) => void;
setParameterValue: (tagId: TemplateTagId, value: RowValue) => void;
getEmbeddedParameterVisibility: GetEmbeddedParamVisibility;
}
@@ -119,6 +130,7 @@ const SettingsPane = ({
database,
databases,
setTemplateTag,
+ setTemplateTagConfig,
setParameterValue,
getEmbeddedParameterVisibility,
}: SettingsPaneProps) => {
@@ -136,6 +148,7 @@ const SettingsPane = ({
database={database}
databases={databases}
setTemplateTag={setTemplateTag}
+ setTemplateTagConfig={setTemplateTagConfig}
setParameterValue={setParameterValue}
/>
</div>
diff --git a/frontend/src/metabase/query_builder/components/view/NativeVariablesButton/NativeVariablesButton.tsx b/frontend/src/metabase/query_builder/components/view/NativeVariablesButton/NativeVariablesButton.tsx
index 079050b51b1..0a29261f909 100644
--- a/frontend/src/metabase/query_builder/components/view/NativeVariablesButton/NativeVariablesButton.tsx
+++ b/frontend/src/metabase/query_builder/components/view/NativeVariablesButton/NativeVariablesButton.tsx
@@ -10,12 +10,14 @@ import NativeVariablesButtonS from "./NativeVariablesButton.module.css";
interface NativeVariablesButtonProps {
className?: string;
isShowingTemplateTagsEditor: boolean;
+ onClick?: () => void;
size: number;
}
export const NativeVariablesButton = ({
className,
isShowingTemplateTagsEditor,
+ onClick,
size,
}: NativeVariablesButtonProps) => {
const dispatch = useDispatch();
@@ -33,7 +35,11 @@ export const NativeVariablesButton = ({
name="variable"
size={size}
onClick={() => {
- dispatch(toggleTemplateTagsEditor());
+ if (onClick) {
+ onClick();
+ } else {
+ dispatch(toggleTemplateTagsEditor());
+ }
}}
/>
</Box>
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
index 9edf9f2bea5..b590a0ec28f 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
@@ -2,44 +2,66 @@ import { useState } from "react";
import { useMount } from "react-use";
import { match } from "ts-pattern";
+import { useSelector } from "metabase/lib/redux";
import { DataReference } from "metabase/query_builder/components/dataref/DataReference";
import { SnippetSidebar } from "metabase/query_builder/components/template_tags/SnippetSidebar";
+import { TagEditorSidebar } from "metabase/query_builder/components/template_tags/TagEditorSidebar";
+import { getSampleDatabaseId } from "metabase/query_builder/selectors";
import { Box } from "metabase/ui";
+import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
-import type { NativeQuerySnippet } from "metabase-types/api";
+import type { NativeQuerySnippet, RowValue } from "metabase-types/api";
import S from "./NativeQuerySidebar.module.css";
type NativeQuerySidebarProps = {
question: Question;
+ query: Lib.Query;
+ onChangeQuery: (newQuery: Lib.Query) => void;
isNative: boolean;
isSnippetSidebarOpen?: boolean;
isDataReferenceOpen?: boolean;
+ isTemplateTagsSidebarOpen?: boolean;
onInsertSnippet: (snippet: NativeQuerySnippet) => void;
onToggleDataReference: () => void;
onToggleSnippetSidebar: () => void;
+ onToggleTemplateTagsSidebar: () => void;
onChangeModalSnippet: (snippet: NativeQuerySnippet) => void;
onOpenSnippetModalWithSelectedText: () => void;
+ parameterValues: Record<string, RowValue>;
+ setParameterValues: (newParameterValues: Record<string, RowValue>) => void;
};
export function NativeQuerySidebar({
isSnippetSidebarOpen,
isDataReferenceOpen,
+ isTemplateTagsSidebarOpen,
...props
}: NativeQuerySidebarProps) {
- if (!isSnippetSidebarOpen && !isDataReferenceOpen) {
+ if (
+ !isSnippetSidebarOpen &&
+ !isDataReferenceOpen &&
+ !isTemplateTagsSidebarOpen
+ ) {
return null;
}
return (
<Box className={S.sidebar} h="100%" w="40%" data-testid="editor-sidebar">
- {match({ isSnippetSidebarOpen, isDataReferenceOpen })
+ {match({
+ isSnippetSidebarOpen,
+ isDataReferenceOpen,
+ isTemplateTagsSidebarOpen,
+ })
.with({ isSnippetSidebarOpen: true }, () => (
<QuerySnippetSidebar {...props} />
))
.with({ isDataReferenceOpen: true }, () => (
<QueryDataReferenceSidebar {...props} />
))
+ .with({ isTemplateTagsSidebarOpen: true }, () => (
+ <TemplateTagsSidebar {...props} />
+ ))
.otherwise(() => null)}
</Box>
);
@@ -96,3 +118,45 @@ function QuerySnippetSidebar({
/>
);
}
+
+const VISIBILITY_ALWAYS_ENABLED = () => "enabled" as const;
+
+function TemplateTagsSidebar({
+ question,
+ query,
+ onToggleTemplateTagsSidebar,
+ setParameterValues,
+ parameterValues,
+ onChangeQuery,
+}: NativeQuerySidebarProps) {
+ const sampleDatabaseId = useSelector(getSampleDatabaseId);
+
+ return (
+ <TagEditorSidebar
+ question={question}
+ query={question.legacyNativeQuery()!}
+ onClose={onToggleTemplateTagsSidebar}
+ sampleDatabaseId={sampleDatabaseId}
+ setTemplateTag={(tag) => {
+ const templateTags = Lib.templateTags(query);
+ const newQuery = Lib.withTemplateTags(query, {
+ ...templateTags,
+ [tag.name]: tag,
+ });
+
+ onChangeQuery(newQuery);
+ }}
+ setParameterValue={(tagId, value) => {
+ setParameterValues({
+ ...parameterValues,
+ [tagId]: value,
+ });
+ }}
+ setDatasetQuery={(newQuery) => {
+ const newQuestion = question.setDatasetQuery(newQuery);
+ onChangeQuery(newQuestion.query());
+ }}
+ getEmbeddedParameterVisibility={VISIBILITY_ALWAYS_ENABLED}
+ />
+ );
+}
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
index 00b26ebb1d9..485a3102a02 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
@@ -63,9 +63,11 @@ export function QueryEditor({
isRunning,
isResultDirty,
setQuestion,
+ setParameterValues,
runQuery,
cancelQuery,
openModal,
+ parameterValues,
setSelectionRange,
setModalSnippet,
openSnippetModalWithSelectedText,
@@ -74,6 +76,7 @@ export function QueryEditor({
toggleDataReferenceSidebar,
toggleSnippetSidebar,
toggleNativeQuerySidebar,
+ toggleTemplateTagsSidebar,
togglePreviewQueryModal,
} = useQueryEditor({
query,
@@ -114,6 +117,9 @@ export function QueryEditor({
resizable={uiOptions?.resizable}
isShowingDataReference={uiState.sidebarType === "data-reference"}
isShowingSnippetSidebar={uiState.sidebarType === "snippet"}
+ isShowingTemplateTagsSidebar={
+ uiState.sidebarType === "template-tags"
+ }
shouldDisableItem={uiOptions?.shouldDisableDataPickerItem}
shouldDisableDatabase={uiOptions?.shouldDisableDatabasePickerItem}
shouldShowLibrary={uiOptions?.shouldShowLibrary}
@@ -122,6 +128,7 @@ export function QueryEditor({
onCancelQuery={cancelQuery}
onToggleDataReference={toggleDataReferenceSidebar}
onToggleSnippetSidebar={toggleSnippetSidebar}
+ onToggleTemplateTagsSidebar={toggleTemplateTagsSidebar}
onOpenModal={openModal}
onChangeModalSnippet={setModalSnippet}
onInsertSnippet={insertSnippet}
@@ -159,16 +166,22 @@ export function QueryEditor({
{isNative && (
<NativeQuerySidebar
question={question}
+ query={query}
+ parameterValues={parameterValues}
+ setParameterValues={setParameterValues}
isNative={isNative}
isDataReferenceOpen={uiState.sidebarType === "data-reference"}
isSnippetSidebarOpen={uiState.sidebarType === "snippet"}
+ isTemplateTagsSidebarOpen={uiState.sidebarType === "template-tags"}
onInsertSnippet={insertSnippet}
onToggleDataReference={toggleDataReferenceSidebar}
onToggleSnippetSidebar={toggleSnippetSidebar}
+ onToggleTemplateTagsSidebar={toggleTemplateTagsSidebar}
onChangeModalSnippet={setModalSnippet}
onOpenSnippetModalWithSelectedText={
openSnippetModalWithSelectedText
}
+ onChangeQuery={onChangeQuery}
/>
)}
{!isNative && uiState.sidebarType === "native-query" && (
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx
index 436f8f748c2..2d0d683f18f 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx
@@ -32,7 +32,7 @@ const NATIVE_EDITOR_SIDEBAR_FEATURES = {
dataReference: true,
snippets: true,
formatQuery: true,
- variables: false,
+ variables: true,
promptInput: false,
};
@@ -54,6 +54,7 @@ type QueryEditorBodyProps = {
isResultDirty: boolean;
isShowingDataReference: boolean;
isShowingSnippetSidebar: boolean;
+ isShowingTemplateTagsSidebar: boolean;
shouldDisableDatabase?: (database: QueryEditorDatabasePickerItem) => boolean;
shouldDisableItem?: (item: OmniPickerItem | RecentCollectionItem) => boolean;
shouldShowLibrary?: boolean;
@@ -62,6 +63,7 @@ type QueryEditorBodyProps = {
onRunQuery: () => Promise<void>;
onToggleDataReference: () => void;
onToggleSnippetSidebar: () => void;
+ onToggleTemplateTagsSidebar: () => void;
onCancelQuery: () => void;
onInsertSnippet: (snippet: NativeQuerySnippet) => void;
onChangeModalSnippet: (snippet: NativeQuerySnippet | null) => void;
@@ -90,6 +92,7 @@ export function QueryEditorBody({
isResultDirty,
isShowingDataReference,
isShowingSnippetSidebar,
+ isShowingTemplateTagsSidebar,
shouldDisableDatabase,
shouldDisableItem,
shouldShowLibrary,
@@ -98,6 +101,7 @@ export function QueryEditorBody({
onRunQuery,
onToggleDataReference,
onToggleSnippetSidebar,
+ onToggleTemplateTagsSidebar,
onCancelQuery,
onInsertSnippet,
onChangeModalSnippet,
@@ -155,12 +159,14 @@ export function QueryEditorBody({
readOnly={readOnly}
resizable={resizable}
canChangeDatabase={canChangeDatabase}
- hasParametersList={false}
+ hasParametersList
+ hasEditingSidebar
isRunnable={isRunnable}
isRunning={isRunning}
isResultDirty={isResultDirty}
isShowingDataReference={isShowingDataReference}
isShowingSnippetSidebar={isShowingSnippetSidebar}
+ isShowingTemplateTagsEditor={isShowingTemplateTagsSidebar}
runQuery={hideRunButton ? undefined : onRunQuery}
cancelQuery={onCancelQuery}
databaseIsDisabled={shouldDisableDatabase}
@@ -168,6 +174,7 @@ export function QueryEditorBody({
sidebarFeatures={NATIVE_EDITOR_SIDEBAR_FEATURES}
toggleDataReference={onToggleDataReference}
toggleSnippetSidebar={onToggleSnippetSidebar}
+ toggleTemplateTagsEditor={onToggleTemplateTagsSidebar}
modalSnippet={modalSnippet}
insertSnippet={onInsertSnippet}
closeSnippetModal={() => onChangeModalSnippet(null)}
diff --git a/frontend/src/metabase/querying/editor/hooks/use-query-controls/use-query-controls.ts b/frontend/src/metabase/querying/editor/hooks/use-query-controls/use-query-controls.ts
index b25d069fa25..caa41997e5f 100644
--- a/frontend/src/metabase/querying/editor/hooks/use-query-controls/use-query-controls.ts
+++ b/frontend/src/metabase/querying/editor/hooks/use-query-controls/use-query-controls.ts
@@ -91,6 +91,10 @@ export function useQueryControls(
toggleSidebar("native-query");
};
+ const toggleTemplateTagsSidebar = () => {
+ toggleSidebar("template-tags");
+ };
+
const toggleModal = (modalType: QueryEditorModalType) => {
onChangeUiState({
...uiState,
@@ -113,6 +117,7 @@ export function useQueryControls(
toggleDataReferenceSidebar,
toggleSnippetSidebar,
toggleNativeQuerySidebar,
+ toggleTemplateTagsSidebar,
togglePreviewQueryModal,
};
}
diff --git a/frontend/src/metabase/querying/editor/hooks/use-query-editor/use-query-editor.ts b/frontend/src/metabase/querying/editor/hooks/use-query-editor/use-query-editor.ts
index fefe717bee3..eb7ce67798d 100644
--- a/frontend/src/metabase/querying/editor/hooks/use-query-editor/use-query-editor.ts
+++ b/frontend/src/metabase/querying/editor/hooks/use-query-editor/use-query-editor.ts
@@ -26,12 +26,13 @@ export function useQueryEditor({
onChangeUiState,
onRunQueryStart,
}: UseQueryEditorProps) {
- const { question, proposedQuestion, setQuestion } = useQueryQuestion(
- query,
- proposedQuery,
- uiOptions,
- onChangeQuery,
- );
+ const {
+ question,
+ proposedQuestion,
+ setQuestion,
+ setParameterValues,
+ parameterValues,
+ } = useQueryQuestion(query, proposedQuery, uiOptions, onChangeQuery);
const { isLoading, error } = useQueryMetadata(question);
const {
result,
@@ -53,6 +54,7 @@ export function useQueryEditor({
toggleDataReferenceSidebar,
toggleSnippetSidebar,
toggleNativeQuerySidebar,
+ toggleTemplateTagsSidebar,
togglePreviewQueryModal,
} = useQueryControls(question, uiState, setQuestion, onChangeUiState);
const { isNative } = Lib.queryDisplayInfo(question.query());
@@ -70,17 +72,20 @@ export function useQueryEditor({
isRunning,
isResultDirty,
setQuestion,
+ setParameterValues,
runQuery,
cancelQuery,
openModal,
setSelectionRange,
setModalSnippet,
openSnippetModalWithSelectedText,
+ parameterValues,
insertSnippet,
convertToNative,
toggleDataReferenceSidebar,
toggleSnippetSidebar,
togglePreviewQueryModal,
toggleNativeQuerySidebar,
+ toggleTemplateTagsSidebar,
};
}
diff --git a/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts b/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
index caa4ace7f30..b490290a7e5 100644
--- a/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
+++ b/frontend/src/metabase/querying/editor/hooks/use-query-question/use-query-question.ts
@@ -1,4 +1,4 @@
-import { useMemo } from "react";
+import { useMemo, useState } from "react";
import { useSelector } from "metabase/lib/redux";
import { getMetadata } from "metabase/selectors/metadata";
@@ -23,6 +23,7 @@ export function useQueryQuestion(
onChangeQuery: (newQuery: Lib.Query) => void,
) {
const metadata = useSelector(getMetadata);
+ const [parameterValues, setParameterValues] = useState({});
const { question, proposedQuestion } = useMemo(
() => ({
@@ -32,6 +33,7 @@ export function useQueryQuestion(
cardType,
display: cardDisplay,
visualization_settings: cardVizSettings,
+ parameterValues,
}),
proposedQuestion:
proposedQuery != null
@@ -42,12 +44,26 @@ export function useQueryQuestion(
})
: undefined,
}),
- [query, proposedQuery, metadata, cardType, cardDisplay, cardVizSettings],
+ [
+ query,
+ proposedQuery,
+ metadata,
+ cardType,
+ cardDisplay,
+ cardVizSettings,
+ parameterValues,
+ ],
);
const setQuestion = (newQuestion: Question) => {
onChangeQuery(newQuestion.query());
};
- return { question, proposedQuestion, setQuestion };
+ return {
+ question,
+ proposedQuestion,
+ setQuestion,
+ parameterValues,
+ setParameterValues,
+ };
}
diff --git a/frontend/src/metabase/querying/editor/types.ts b/frontend/src/metabase/querying/editor/types.ts
index 27b7211f7e7..790a2157b10 100644
--- a/frontend/src/metabase/querying/editor/types.ts
+++ b/frontend/src/metabase/querying/editor/types.ts
@@ -15,7 +15,8 @@ import type {
export type QueryEditorSidebarType =
| "data-reference"
| "snippet"
- | "native-query";
+ | "native-query"
+ | "template-tags";
export type QueryEditorModalType = "preview-query";
diff --git a/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx b/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
index 77de73778b3..22724afc00b 100644
--- a/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
+++ b/frontend/src/metabase/transforms/pages/TransformQueryPage/TransformQueryPage.tsx
@@ -9,6 +9,7 @@ import {
useGetTransformQuery,
useUpdateTransformMutation,
} from "metabase/api";
+import { getErrorMessage } from "metabase/api/utils";
import { EmptyState } from "metabase/common/components/EmptyState/EmptyState";
import { LeaveRouteConfirmModal } from "metabase/common/components/LeaveConfirmModal";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
@@ -74,6 +75,8 @@ export function TransformQueryPage({ params, route }: TransformQueryPageProps) {
return (
<TransformQueryPageBody
+ // Add key so the ui state gets reset when switching between edit and view
+ key={route.path}
transform={transform}
databases={transformsDatabases}
route={route}
@@ -132,7 +135,12 @@ function TransformQueryPageBody({
onSave: async (request) => {
const { error } = await updateTransform(request);
if (error) {
- sendErrorToast(t`Failed to update transform query`);
+ const message = getErrorMessage(error);
+ sendErrorToast(
+ message
+ ? t`Failed to update transform query: ${message}`
+ : t`Failed to update transform query`,
+ );
} else {
sendSuccessToast(t`Transform query updated`);
diff --git a/frontend/src/metabase/transforms/utils.ts b/frontend/src/metabase/transforms/utils.ts
index 8ee16f47360..bd2e61ea97f 100644
--- a/frontend/src/metabase/transforms/utils.ts
+++ b/frontend/src/metabase/transforms/utils.ts
@@ -11,6 +11,7 @@ import type {
Database,
DatabaseId,
DraftTransformSource,
+ TemplateTag,
Transform,
TransformRun,
TransformRunMethod,
@@ -166,8 +167,6 @@ export function isCompleteSource(
return source.type !== "python" || source["source-database"] != null;
}
-const ALLOWED_TRANSFORM_VARIABLES = [CHECKPOINT_TEMPLATE_TAG];
-
export type ValidationResult = {
isValid: boolean;
errorMessage?: string;
@@ -177,24 +176,43 @@ export function getValidationResult(query: Lib.Query): ValidationResult {
const { isNative } = Lib.queryDisplayInfo(query);
if (isNative) {
const tags = Object.values(Lib.templateTags(query));
- // Allow snippets, cards, and the special transform variables ({checkpoint})
- const hasInvalidTags = tags.some(
- (t) =>
- t.type !== "card" &&
- t.type !== "snippet" &&
- !ALLOWED_TRANSFORM_VARIABLES.includes(t.name),
- );
- if (hasInvalidTags) {
- return {
- isValid: false,
- errorMessage: t`In transforms, you can use snippets and question or model references, but not variables.`,
- };
+
+ const invalidResults = tags
+ .map(validateTemplateTag)
+ .filter((result) => !result.isValid);
+
+ if (invalidResults.length > 0) {
+ return invalidResults[0];
}
}
return { isValid: Lib.canSave(query, "question") };
}
+const ALLOWED_TEMPLATE_TYPES = new Set([
+ "card",
+ "snippet",
+ CHECKPOINT_TEMPLATE_TAG,
+]);
+
+function validateTemplateTag(tag: TemplateTag): ValidationResult {
+ // Allow snippets, cards, and the special transform variables ({checkpoint})
+ if (ALLOWED_TEMPLATE_TYPES.has(tag.type)) {
+ return { isValid: true };
+ }
+
+ // Variable template tags need to be either optional in the query text
+ // or have a default value.
+ if (Lib.isVariableTemplateTag(tag) && tag.required && tag.default == null) {
+ return {
+ isValid: false,
+ errorMessage: t`Variables in transforms must either be optional or have a default value.`,
+ };
+ }
+
+ return { isValid: true };
+}
+
export const getLibQuery = (
source: DraftTransformSource,
metadata: Metadata,