Skip to content

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

Fix crashes and broken behavior in the native transform variables sidebar (#78047)

Oleh Kec0a9ceaeaef
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/common.unit.spec.ts b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/common.unit.spec.ts
index 819d8f70e32..8100ee91923 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/common.unit.spec.ts
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/common.unit.spec.ts
@@ -4,14 +4,30 @@ import { setup } from "./setup";
describe("TagEditorHelp (OSS)", () => {
it("should show a help link when `show-metabase-links: true`", () => {
- setup({ showMetabaseLinks: true });
+ setup({ showMetabaseLinks: true, sampleDatabaseId: 99 });
expect(screen.getByText("Read the full documentation")).toBeInTheDocument();
});
it("should show a help link when `show-metabase-links: false`", () => {
- setup({ showMetabaseLinks: false });
+ setup({ showMetabaseLinks: false, sampleDatabaseId: 99 });
expect(screen.getByText("Read the full documentation")).toBeInTheDocument();
});
+
+ it("should offer 'Try it' example buttons when a sample database is available", () => {
+ setup({ sampleDatabaseId: 99 });
+
+ expect(
+ screen.getAllByRole("button", { name: "Try it" }).length,
+ ).toBeGreaterThan(0);
+ });
+
+ it("should hide 'Try it' example buttons when no sample database is available (metabase#78037)", () => {
+ setup({ sampleDatabaseId: null });
+
+ expect(
+ screen.queryByRole("button", { name: "Try it" }),
+ ).not.toBeInTheDocument();
+ });
});
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/enterprise.unit.spec.ts b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/enterprise.unit.spec.ts
index 8980a64115f..66278c970f6 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/enterprise.unit.spec.ts
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/enterprise.unit.spec.ts
@@ -11,13 +11,13 @@ function setup(opts: SetupOpts) {
describe("TagEditorHelp (EE without token)", () => {
it("should show a help link when `show-metabase-links: true`", () => {
- setup({ showMetabaseLinks: true });
+ setup({ showMetabaseLinks: true, sampleDatabaseId: 99 });
expect(screen.getByText("Read the full documentation")).toBeInTheDocument();
});
it("should show a help link when `show-metabase-links: false`", () => {
- setup({ showMetabaseLinks: false });
+ setup({ showMetabaseLinks: false, sampleDatabaseId: 99 });
expect(screen.getByText("Read the full documentation")).toBeInTheDocument();
});
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/premium.unit.spec.ts b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/premium.unit.spec.ts
index f5ae641bec8..03173a3d0b5 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/premium.unit.spec.ts
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/premium.unit.spec.ts
@@ -13,13 +13,13 @@ function setup(opts: SetupOpts) {
describe("TagEditorHelp (EE with token)", () => {
it("should show a help link when `show-metabase-links: true`", () => {
- setup({ showMetabaseLinks: true });
+ setup({ showMetabaseLinks: true, sampleDatabaseId: 99 });
expect(screen.getByText("Read the full documentation")).toBeInTheDocument();
});
it("should not show a help link when `show-metabase-links: false`", () => {
- setup({ showMetabaseLinks: false });
+ setup({ showMetabaseLinks: false, sampleDatabaseId: 99 });
expect(
screen.queryByText("Read the full documentation"),
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/setup.tsx b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/setup.tsx
index ea398ec6d06..00375dafe67 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/setup.tsx
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorHelp/tests/setup.tsx
@@ -3,7 +3,7 @@ import { mockSettings } from "__support__/settings";
import { renderWithProviders } from "__support__/ui";
import { createMockState } from "metabase/redux/store/mocks";
import Database from "metabase-lib/v1/metadata/Database";
-import type { TokenFeatures } from "metabase-types/api";
+import type { DatabaseId, TokenFeatures } from "metabase-types/api";
import {
createMockDatabase,
createMockTokenFeatures,
@@ -15,13 +15,15 @@ export interface SetupOpts {
showMetabaseLinks?: boolean;
tokenFeatures?: Partial<TokenFeatures>;
enterprisePlugins?: Parameters<typeof setupEnterpriseOnlyPlugin>[0][];
+ sampleDatabaseId: DatabaseId | null;
}
export const setup = ({
showMetabaseLinks = true,
tokenFeatures = {},
enterprisePlugins = [],
-}: SetupOpts = {}) => {
+ sampleDatabaseId,
+}: SetupOpts) => {
const state = createMockState({
settings: mockSettings({
"show-metabase-links": showMetabaseLinks,
@@ -36,7 +38,7 @@ export const setup = ({
renderWithProviders(
<TagEditorHelp
database={new Database({ ...createMockDatabase(), tables: [] })}
- sampleDatabaseId={99}
+ sampleDatabaseId={sampleDatabaseId ?? undefined}
setDatasetQuery={jest.fn()}
switchToSettings={jest.fn()}
/>,
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.tsx b/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.tsx
index f9e4213c3ae..d51ef6fede5 100644
--- a/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.tsx
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.tsx
@@ -2,6 +2,7 @@ import { useState } from "react";
import { t } from "ttag";
import _ from "underscore";
+import { EmptyState } from "metabase/common/components/EmptyState";
import { SidebarContent } from "metabase/common/components/SidebarContent";
import { Box, Tabs } from "metabase/ui";
import type Question from "metabase-lib/v1/Question";
@@ -60,18 +61,13 @@ export function TagEditorSidebar({
getEmbeddedParameterVisibility,
parametersAreUserVisible = true,
}: TagEditorSidebarProps) {
- const [section, setSection] = useState<TabId>(() => {
- const tags = query.variableTemplateTags();
- return tags.length === 0 ? "help" : "settings";
- });
+ const [section, setSection] = useState<TabId>("settings");
const tags = query.variableTemplateTags();
const database = question.database();
const parameters = question.parameters();
const parametersById = _.indexBy(parameters, "id");
- const effectiveSection = tags.length === 0 ? "help" : section;
-
const handleTabChange = (tab: string | null) => {
if (tab) {
// Unjustified type cast. FIXME
@@ -82,14 +78,14 @@ export function TagEditorSidebar({
return (
<SidebarContent title={t`Variables and parameters`} onClose={onClose}>
<div data-testid="tag-editor-sidebar">
- <Tabs radius={0} value={effectiveSection} onChange={handleTabChange}>
+ <Tabs radius={0} value={section} onChange={handleTabChange}>
<Tabs.List grow>
<Tabs.Tab value="settings">{t`Settings`}</Tabs.Tab>
<Tabs.Tab value="help">{t`Help`}</Tabs.Tab>
</Tabs.List>
</Tabs>
- {effectiveSection === "settings" ? (
+ {section === "settings" ? (
<SettingsPane
tags={tags}
parametersById={parametersById}
@@ -146,6 +142,16 @@ const SettingsPane = ({
getEmbeddedParameterVisibility,
parametersAreUserVisible = true,
}: SettingsPaneProps) => {
+ if (tags.length === 0) {
+ return (
+ <Box p="lg">
+ <EmptyState
+ message={t`Add a variable to your query, like {{variable_name}}, to configure it here.`}
+ />
+ </Box>
+ );
+ }
+
return tags.map((tag) => (
<div key={tag.id}>
<TagEditorParam
diff --git a/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.unit.spec.tsx b/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.unit.spec.tsx
new file mode 100644
index 00000000000..c4b7f63dbad
--- /dev/null
+++ b/frontend/src/metabase/querying/components/template_tags/TagEditorSidebar.unit.spec.tsx
@@ -0,0 +1,94 @@
+import {
+ setupDatabasesEndpoints,
+ setupParameterValuesEndpoints,
+ setupSearchEndpoints,
+} from "__support__/server-mocks";
+import { createMockEntitiesState } from "__support__/store";
+import { renderWithProviders, screen } from "__support__/ui";
+import { createMockState } from "metabase/redux/store/mocks";
+import { getMetadata } from "metabase/selectors/metadata";
+import { checkNotNull } from "metabase/utils/types";
+import Question from "metabase-lib/v1/Question";
+import type { TemplateTag } from "metabase-types/api";
+import {
+ createMockCard,
+ createMockNativeDatasetQuery,
+ createMockTemplateTag,
+} from "metabase-types/api/mocks";
+import { createSampleDatabase } from "metabase-types/api/mocks/presets";
+
+import { TagEditorSidebar } from "./TagEditorSidebar";
+
+interface SetupOpts {
+ query: string;
+ templateTags?: Record<string, TemplateTag>;
+}
+
+const setup = ({ query, templateTags = {} }: SetupOpts) => {
+ const database = createSampleDatabase();
+ const card = createMockCard({
+ dataset_query: createMockNativeDatasetQuery({
+ database: database.id,
+ native: { query, "template-tags": templateTags },
+ }),
+ });
+ const state = createMockState({
+ entities: createMockEntitiesState({ databases: [database] }),
+ });
+ const metadata = getMetadata(state);
+ const question = new Question(card, metadata);
+
+ setupDatabasesEndpoints([database]);
+ setupSearchEndpoints([]);
+ setupParameterValuesEndpoints({ values: [], has_more_values: false });
+
+ renderWithProviders(
+ <TagEditorSidebar
+ query={checkNotNull(question.legacyNativeQuery())}
+ question={question}
+ databases={Object.values(metadata.databases)}
+ setDatasetQuery={jest.fn()}
+ setTemplateTag={jest.fn()}
+ setTemplateTagConfig={jest.fn()}
+ setParameterValue={jest.fn()}
+ onClose={jest.fn()}
+ getEmbeddedParameterVisibility={jest.fn()}
+ />,
+ );
+};
+
+describe("TagEditorSidebar", () => {
+ it("keeps the Settings/Help tabs visible even when the query has no variables (metabase#78037)", () => {
+ setup({ query: "SELECT 1" });
+
+ expect(screen.getByRole("tab", { name: "Settings" })).toBeInTheDocument();
+ expect(screen.getByRole("tab", { name: "Help" })).toBeInTheDocument();
+ });
+
+ it("shows an empty state in the Settings tab when the query has no variables", () => {
+ setup({ query: "SELECT 1" });
+
+ expect(
+ screen.getByText(/Add a variable to your query/),
+ ).toBeInTheDocument();
+ });
+
+ it("shows the variable's settings when the query has a variable", () => {
+ setup({
+ query: "SELECT {{x}}",
+ templateTags: {
+ x: createMockTemplateTag({
+ name: "x",
+ "display-name": "X",
+ type: "text",
+ }),
+ },
+ });
+
+ expect(screen.getByRole("tab", { name: "Settings" })).toBeInTheDocument();
+ expect(
+ screen.queryByText(/Add a variable to your query/),
+ ).not.toBeInTheDocument();
+ expect(screen.getByDisplayValue("X")).toBeInTheDocument();
+ });
+});
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 3d70b1d44bd..ac40d1bc694 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.tsx
@@ -32,6 +32,7 @@ type NativeQuerySidebarProps = {
parameterValues: Record<string, RowValue>;
setParameterValues: (newParameterValues: Record<string, RowValue>) => void;
parametersAreUserVisible?: boolean;
+ canUseSampleDatabase?: boolean;
};
export function NativeQuerySidebar({
@@ -132,6 +133,7 @@ function TemplateTagsSidebar({
parameterValues,
parametersAreUserVisible,
onChangeQuery,
+ canUseSampleDatabase,
}: NativeQuerySidebarProps) {
const sampleDatabaseId = useSelector(getSampleDatabaseId);
@@ -153,7 +155,9 @@ function TemplateTagsSidebar({
question={question}
query={question.legacyNativeQuery()!}
onClose={onToggleTemplateTagsSidebar}
- sampleDatabaseId={sampleDatabaseId}
+ sampleDatabaseId={
+ canUseSampleDatabase === false ? undefined : sampleDatabaseId
+ }
setTemplateTag={(tag) => {
const currentQuery = latestQueryRef.current;
const templateTags = Lib.templateTags(currentQuery);
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.unit.spec.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.unit.spec.tsx
new file mode 100644
index 00000000000..0f45fe40209
--- /dev/null
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/NativeQuerySidebar/NativeQuerySidebar.unit.spec.tsx
@@ -0,0 +1,108 @@
+import userEvent from "@testing-library/user-event";
+
+import {
+ setupDatabasesEndpoints,
+ setupParameterValuesEndpoints,
+ setupSearchEndpoints,
+} from "__support__/server-mocks";
+import { createMockEntitiesState } from "__support__/store";
+import { renderWithProviders, screen } from "__support__/ui";
+import { createMockState } from "metabase/redux/store/mocks";
+import { getMetadata } from "metabase/selectors/metadata";
+import Question from "metabase-lib/v1/Question";
+import {
+ createMockCard,
+ createMockDatabase,
+ createMockNativeDatasetQuery,
+ createMockTemplateTag,
+} from "metabase-types/api/mocks";
+
+import { NativeQuerySidebar } from "./NativeQuerySidebar";
+
+const SAMPLE_DB_ID = 1;
+const WRITABLE_DB_ID = 2;
+
+interface SetupOpts {
+ canUseSampleDatabase?: boolean;
+}
+
+const setup = ({ canUseSampleDatabase }: SetupOpts = {}) => {
+ const sampleDatabase = createMockDatabase({
+ id: SAMPLE_DB_ID,
+ name: "Sample Database",
+ is_sample: true,
+ });
+ const writableDatabase = createMockDatabase({
+ id: WRITABLE_DB_ID,
+ name: "Writable Postgres",
+ engine: "postgres",
+ });
+ const card = createMockCard({
+ dataset_query: createMockNativeDatasetQuery({
+ database: WRITABLE_DB_ID,
+ native: {
+ query: "SELECT {{x}}",
+ "template-tags": {
+ x: createMockTemplateTag({
+ name: "x",
+ "display-name": "X",
+ type: "text",
+ }),
+ },
+ },
+ }),
+ });
+ const state = createMockState({
+ entities: createMockEntitiesState({
+ databases: [sampleDatabase, writableDatabase],
+ }),
+ });
+ const metadata = getMetadata(state);
+ const question = new Question(card, metadata);
+
+ setupDatabasesEndpoints([sampleDatabase, writableDatabase]);
+ setupSearchEndpoints([]);
+ setupParameterValuesEndpoints({ values: [], has_more_values: false });
+
+ renderWithProviders(
+ <NativeQuerySidebar
+ question={question}
+ query={question.query()}
+ isNative
+ isTemplateTagsSidebarOpen
+ onChangeQuery={jest.fn()}
+ onInsertSnippet={jest.fn()}
+ onToggleDataReference={jest.fn()}
+ onToggleSnippetSidebar={jest.fn()}
+ onToggleTemplateTagsSidebar={jest.fn()}
+ onChangeModalSnippet={jest.fn()}
+ onOpenSnippetModalWithSelectedText={jest.fn()}
+ parameterValues={{}}
+ setParameterValues={jest.fn()}
+ canUseSampleDatabase={canUseSampleDatabase}
+ />,
+ { storeInitialState: state },
+ );
+};
+
+describe("NativeQuerySidebar template-tag help", () => {
+ it("hides the 'Try it' examples when the sample database can't be used, e.g. in transforms (metabase#78037)", async () => {
+ setup({ canUseSampleDatabase: false });
+
+ await userEvent.click(screen.getByRole("tab", { name: "Help" }));
+
+ expect(
+ screen.queryByRole("button", { name: "Try it" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("shows the 'Try it' examples when the sample database is available", async () => {
+ setup({});
+
+ await userEvent.click(screen.getByRole("tab", { name: "Help" }));
+
+ expect(
+ screen.getAllByRole("button", { name: "Try it" }).length,
+ ).toBeGreaterThan(0);
+ });
+});
diff --git a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
index f2851b48fdb..ab9d5ae8ef8 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditor.tsx
@@ -186,6 +186,7 @@ export function QueryEditor({
}
onChangeQuery={onChangeQuery}
parametersAreUserVisible={parametersAreUserVisible}
+ canUseSampleDatabase={uiOptions?.canUseSampleDatabase}
/>
)}
{!isNative && uiState.sidebarType === "native-query" && (
diff --git a/frontend/src/metabase/querying/editor/types.ts b/frontend/src/metabase/querying/editor/types.ts
index 98aa286a02f..beedbee8d87 100644
--- a/frontend/src/metabase/querying/editor/types.ts
+++ b/frontend/src/metabase/querying/editor/types.ts
@@ -75,6 +75,7 @@ export type QueryEditorUiOptions = {
item: QueryEditorDatabasePickerItem,
) => boolean;
editorHeight?: number;
+ canUseSampleDatabase?: boolean;
shouldShowLibrary?: false;
hidePreview?: boolean;
hideRunButton?: boolean;
diff --git a/frontend/src/metabase/transforms/components/TransformEditor/utils.ts b/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
index 8a95afe42cb..04f7a0714d7 100644
--- a/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
+++ b/frontend/src/metabase/transforms/components/TransformEditor/utils.ts
@@ -61,6 +61,7 @@ export function getEditorOptions(
return undefined;
},
shouldShowLibrary: false,
+ canUseSampleDatabase: false,
readOnly,
};
}
diff --git a/frontend/src/metabase/transforms/components/TransformEditor/utils.unit.spec.ts b/frontend/src/metabase/transforms/components/TransformEditor/utils.unit.spec.ts
index 573426f0d97..9eb0ac43b8c 100644
--- a/frontend/src/metabase/transforms/components/TransformEditor/utils.unit.spec.ts
+++ b/frontend/src/metabase/transforms/components/TransformEditor/utils.unit.spec.ts
@@ -16,6 +16,10 @@ function createTransformCapableDatabase(opts = {}) {
}
describe("getEditorOptions", () => {
+ it("disables the sample database in transforms (metabase#78037)", () => {
+ expect(getEditorOptions([]).canUseSampleDatabase).toBe(false);
+ });
+
describe("getDataPickerItemTooltip", () => {
it("returns a tooltip for a database item with DB routing enabled via router_user_attribute", () => {
const database = createTransformCapableDatabase({
diff --git a/src/metabase/queries/metadata.clj b/src/metabase/queries/metadata.clj
index 91b363c8c65..e7c1e4ac120 100644
--- a/src/metabase/queries/metadata.clj
+++ b/src/metabase/queries/metadata.clj
@@ -150,10 +150,7 @@
(batch-fetch-query-metadata queries nil))
([queries opts]
(batch-fetch-query-metadata*
- (into []
- (comp (filter not-empty)
- (map lib-be/normalize-query))
- queries)
+ (into [] (keep (comp not-empty lib-be/normalize-query)) queries)
opts)))
(mu/defn batch-fetch-card-metadata
diff --git a/test/metabase/queries/metadata_test.clj b/test/metabase/queries/metadata_test.clj
index bf1d6933df9..1bdc0a79e47 100644
--- a/test/metabase/queries/metadata_test.clj
+++ b/test/metabase/queries/metadata_test.clj
@@ -3,6 +3,7 @@
(:require
[clojure.test :refer :all]
[medley.core :as m]
+ [metabase.lib-be.core :as lib-be]
[metabase.queries.metadata :as queries.metadata]
[metabase.test :as mt]
[metabase.util.malli :as mu]
@@ -14,6 +15,15 @@
(is (= {:databases [], :fields [], :snippets [], :tables []}
(queries.metadata/batch-fetch-card-metadata [{}])))))
+(deftest ^:parallel batch-fetch-query-metadata-skips-unnormalizable-queries-test
+ (testing "A query that can't be normalized should be skipped (metabase#78037)"
+ (let [unnormalizable {:type :native
+ :native {:query "SELECT 1"}}]
+ (testing "sanity check: this query is degraded to {} by normalize-query"
+ (is (= {} (lib-be/normalize-query unnormalizable))))
+ (is (= {:databases [], :fields [], :snippets [], :tables []}
+ (queries.metadata/batch-fetch-query-metadata [unnormalizable]))))))
+
(deftest only-models-trust-fk-semantic-types-test
(testing "FK semantic types set by user should be preserved for models but stripped for questions"
(let [target-field-id (mt/id :orders :product_id)