Skip to content

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

Fix native preview button in transforms (#63865)

Romeo Van Snickeeecd9a10ae9
diff --git a/e2e/support/helpers/e2e-codemirror-helpers.ts b/e2e/support/helpers/e2e-codemirror-helpers.ts
new file mode 100644
index 00000000000..088a6928a83
--- /dev/null
+++ b/e2e/support/helpers/e2e-codemirror-helpers.ts
@@ -0,0 +1,21 @@
+export function codeMirrorEditor() {
+ return cy.get(".cm-content");
+}
+export function codeMirrorValue() {
+ // Get the multiline text content of the editor
+ return codeMirrorEditor()
+ .get("[role='textbox']")
+ .get(".cm-line")
+ .then((lines) => {
+ const text: string[] = [];
+ lines.each((_, line) => {
+ text.push(line.textContent ?? "");
+ });
+ const value = text.join("\n");
+ const placeholder = "SELECT * FROM TABLE_NAME";
+ if (value === placeholder) {
+ return "";
+ }
+ return value;
+ });
+}
diff --git a/e2e/support/helpers/index.ts b/e2e/support/helpers/index.ts
index 0e2ea9d05bd..dad0c1cd59b 100644
--- a/e2e/support/helpers/index.ts
+++ b/e2e/support/helpers/index.ts
@@ -6,6 +6,7 @@ export * from "./e2e-bi-basics-helpers";
export * from "./e2e-boolean-helpers";
export * from "./e2e-browser-helpers";
export * from "./e2e-cloud-helpers";
+export * from "./e2e-codemirror-helpers";
export * from "./e2e-collection-helpers";
export * from "./e2e-command-palette-helpers";
export * from "./e2e-comment-helpers";
diff --git a/e2e/test/scenarios/admin/transforms.cy.spec.ts b/e2e/test/scenarios/admin/transforms.cy.spec.ts
index cfbf3ea414e..f98372f402e 100644
--- a/e2e/test/scenarios/admin/transforms.cy.spec.ts
+++ b/e2e/test/scenarios/admin/transforms.cy.spec.ts
@@ -127,7 +127,7 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
it("should be able to use the data reference and snippets when writing a SQL transform", () => {
H.createSnippet({
name: "snippet1",
- content: "1",
+ content: "'foo'",
});
visitTransformListPage();
@@ -175,6 +175,12 @@ H.describeWithSnowplowEE("scenarios > admin > transforms", () => {
.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();
diff --git a/e2e/test/scenarios/native/native.cy.spec.js b/e2e/test/scenarios/native/native.cy.spec.js
index 89796670251..d932d1fd175 100644
--- a/e2e/test/scenarios/native/native.cy.spec.js
+++ b/e2e/test/scenarios/native/native.cy.spec.js
@@ -578,8 +578,9 @@ describe("scenarios > question > native", () => {
cy.button("Preview the query").click();
cy.wait("@datasetNative");
- // eslint-disable-next-line no-unscoped-text-selectors -- deprecated usage
- cy.findByText(/where CATEGORY='Gadget'/).should("be.visible");
+ H.modal().within(() => {
+ H.codeMirrorValue().should("contain", "CATEGORY = 'Gadget'");
+ });
});
it("should show errors when previewing a query", () => {
diff --git a/e2e/test/scenarios/native/snippets.cy.spec.js b/e2e/test/scenarios/native/snippets.cy.spec.js
index 976f516fb04..649046df084 100644
--- a/e2e/test/scenarios/native/snippets.cy.spec.js
+++ b/e2e/test/scenarios/native/snippets.cy.spec.js
@@ -183,7 +183,9 @@ describe("scenarios > question > snippets", () => {
cy.findByTestId("native-query-top-bar")
.findByLabelText("Preview the query")
.click();
- H.modal().findByText("select 'foo'").should("be.visible");
+ H.modal().within(() => {
+ H.codeMirrorValue().should("eq", "select\n 'foo'");
+ });
});
});
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
index 1c81918c550..c4612ccc76c 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/EditorBody/EditorBody.tsx
@@ -7,6 +7,7 @@ import { useSetting } from "metabase/common/hooks";
import NativeQueryEditor, {
type SelectionRange,
} from "metabase/query_builder/components/NativeQueryEditor";
+import type { QueryModalType } from "metabase/query_builder/constants";
import { Notebook } from "metabase/querying/notebook/components/Notebook";
import { Box } from "metabase/ui";
import { doesDatabaseSupportTransforms } from "metabase-enterprise/transforms/utils";
@@ -51,6 +52,7 @@ type EditorBodyProps = {
modalSnippet?: NativeQuerySnippet | null;
onChangeModalSnippet: (snippet: NativeQuerySnippet | null) => void;
onChangeNativeEditorSelection: (range: SelectionRange[]) => void;
+ onOpenModal: (type: QueryModalType) => void;
nativeEditorSelectedText?: string | null;
databases: ApiDatabase[];
@@ -74,6 +76,7 @@ export function EditorBody({
onChangeModalSnippet,
onChangeNativeEditorSelection,
nativeEditorSelectedText,
+ onOpenModal,
}: EditorBodyProps) {
const [isResizing, setIsResizing] = useState(false);
const reportTimezone = useSetting("report-timezone-long");
@@ -136,6 +139,7 @@ export function EditorBody({
}}
setNativeEditorSelectedRange={onChangeNativeEditorSelection}
nativeEditorSelectedText={nativeEditorSelectedText}
+ onOpenModal={onOpenModal}
/>
) : (
<ResizableBox
diff --git a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
index 9016f0644d7..39ecd1f7901 100644
--- a/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/transforms/components/QueryEditor/QueryEditor.tsx
@@ -1,9 +1,12 @@
import { useDisclosure, useHotkeys, useToggle } from "@mantine/hooks";
import { useState } from "react";
+import { t } from "ttag";
import { useListDatabasesQuery } from "metabase/api";
import type { SelectionRange } from "metabase/query_builder/components/NativeQueryEditor/types";
-import { Center, Flex, Loader, Stack } from "metabase/ui";
+import type { QueryModalType } from "metabase/query_builder/constants";
+import { NativeQueryPreview } from "metabase/querying/notebook/components/NativeQueryPreview";
+import { Center, Flex, Loader, Modal, Stack } from "metabase/ui";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
import type { DatasetQuery, NativeQuerySnippet } from "metabase-types/api";
@@ -56,6 +59,7 @@ export function QueryEditor({
} = useQueryResults(question);
const { isNative } = Lib.queryDisplayInfo(question.query());
const [isShowingNativeQueryPreview, toggleNativeQueryPreview] = useToggle();
+ const [isPreviewQueryModalOpen, togglePreviewQueryModal] = useToggle();
const validationResult = getValidationResult(question.query());
const handleChange = async (newQuestion: Question) => {
@@ -95,6 +99,12 @@ export function QueryEditor({
toggleSnippetSidebar();
};
+ const handleOpenModal = (type: QueryModalType) => {
+ if (type === "preview-query") {
+ togglePreviewQueryModal(true);
+ }
+ };
+
const [selectionRange, setSelectionRange] = useState<SelectionRange[]>([]);
const selectedText = useSelectedText(question, selectionRange);
const handleInsertSnippet = useInsertSnippetHandler({
@@ -120,86 +130,98 @@ export function QueryEditor({
}
return (
- <Stack
- className={S.root}
- pos="relative"
- w="100%"
- h="100%"
- bg="bg-white"
- data-testid="transform-query-editor"
- gap={0}
- >
- <EditorHeader
- validationResult={validationResult}
- isNew={isNew}
- isSaving={isSaving}
- isQueryDirty={isQueryDirty}
- onSave={handleSave}
- onCancel={onCancel}
- />
- <Flex h="100%" w="100%" mih="0">
- <Stack flex="2 1 100%" pos="relative">
- <EditorBody
- question={question}
- isNative={isNative}
- isRunnable={isRunnable}
- isRunning={isRunning}
- isResultDirty={isResultDirty}
- isShowingDataReference={isDataReferenceOpen}
- isShowingSnippetSidebar={isSnippetSidebarOpen}
- onChange={handleChange}
- onRunQuery={runQuery}
- onCancelQuery={cancelQuery}
- databases={databases?.data ?? []}
- onToggleDataReference={handleToggleDataReference}
- onToggleSnippetSidebar={handleToggleSnippetSidebar}
- modalSnippet={modalSnippet}
- onChangeModalSnippet={setModalSnippet}
- onChangeNativeEditorSelection={setSelectionRange}
- nativeEditorSelectedText={selectedText}
- />
- <EditorVisualization
- question={question}
- result={result}
- rawSeries={rawSeries}
- isNative={isNative}
- isRunnable={isRunnable}
- isRunning={isRunning}
- isResultDirty={isResultDirty}
- onRunQuery={runQuery}
- onCancelQuery={() => undefined}
- />
+ <>
+ <Stack
+ className={S.root}
+ pos="relative"
+ w="100%"
+ h="100%"
+ bg="bg-white"
+ data-testid="transform-query-editor"
+ gap={0}
+ >
+ <EditorHeader
+ validationResult={validationResult}
+ isNew={isNew}
+ isSaving={isSaving}
+ isQueryDirty={isQueryDirty}
+ onSave={handleSave}
+ onCancel={onCancel}
+ />
+ <Flex h="100%" w="100%" mih="0">
+ <Stack flex="2 1 100%" pos="relative">
+ <EditorBody
+ question={question}
+ isNative={isNative}
+ isRunnable={isRunnable}
+ isRunning={isRunning}
+ isResultDirty={isResultDirty}
+ isShowingDataReference={isDataReferenceOpen}
+ isShowingSnippetSidebar={isSnippetSidebarOpen}
+ onChange={handleChange}
+ onRunQuery={runQuery}
+ onCancelQuery={cancelQuery}
+ databases={databases?.data ?? []}
+ onToggleDataReference={handleToggleDataReference}
+ onToggleSnippetSidebar={handleToggleSnippetSidebar}
+ onOpenModal={handleOpenModal}
+ modalSnippet={modalSnippet}
+ onChangeModalSnippet={setModalSnippet}
+ onChangeNativeEditorSelection={setSelectionRange}
+ nativeEditorSelectedText={selectedText}
+ />
+ <EditorVisualization
+ question={question}
+ result={result}
+ rawSeries={rawSeries}
+ isNative={isNative}
+ isRunnable={isRunnable}
+ isRunning={isRunning}
+ isResultDirty={isResultDirty}
+ onRunQuery={runQuery}
+ onCancelQuery={() => undefined}
+ />
- {!isNative && (
- <NativeQuerySidebarToggle
- isShowingNativeQueryPreview={isShowingNativeQueryPreview}
- onToggleNativeQueryPreview={toggleNativeQueryPreview}
+ {!isNative && (
+ <NativeQuerySidebarToggle
+ isShowingNativeQueryPreview={isShowingNativeQueryPreview}
+ onToggleNativeQueryPreview={toggleNativeQueryPreview}
+ />
+ )}
+ </Stack>
+
+ {!isNative && isShowingNativeQueryPreview && (
+ <NativeQuerySidebar
+ question={question}
+ onConvertToNativeClick={(newQuestion) => {
+ toggleNativeQueryPreview(false);
+ setQuestion(newQuestion);
+ }}
/>
)}
- </Stack>
- {!isNative && isShowingNativeQueryPreview && (
- <NativeQuerySidebar
+ <EditorSidebar
question={question}
- onConvertToNativeClick={(newQuestion) => {
- toggleNativeQueryPreview(false);
- setQuestion(newQuestion);
- }}
+ isNative={isNative}
+ isDataReferenceOpen={isDataReferenceOpen}
+ isSnippetSidebarOpen={isSnippetSidebarOpen}
+ onToggleDataReference={toggleDataReference}
+ onToggleSnippetSidebar={toggleSnippetSidebar}
+ onChangeModalSnippet={setModalSnippet}
+ onInsertSnippet={handleInsertSnippet}
/>
- )}
-
- <EditorSidebar
- question={question}
- isNative={isNative}
- isDataReferenceOpen={isDataReferenceOpen}
- isSnippetSidebarOpen={isSnippetSidebarOpen}
- onToggleDataReference={toggleDataReference}
- onToggleSnippetSidebar={toggleSnippetSidebar}
- onChangeModalSnippet={setModalSnippet}
- onInsertSnippet={handleInsertSnippet}
- />
- </Flex>
- <EditorValidationCard validationResult={validationResult} />
- </Stack>
+ </Flex>
+ <EditorValidationCard validationResult={validationResult} />
+ </Stack>
+ {isNative && (
+ <Modal
+ title={t`Query preview`}
+ opened={isPreviewQueryModalOpen}
+ onClose={togglePreviewQueryModal}
+ >
+ <NativeQueryPreview query={question.query()} />
+ </Modal>
+ )}
+ </>
);
}
diff --git a/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx b/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
index 4d7ff3e8428..fdf7f1d7d18 100644
--- a/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
+++ b/frontend/src/metabase/common/components/CodeEditor/CodeEditor.tsx
@@ -1,3 +1,4 @@
+import type { Extension } from "@uiw/react-codemirror";
import cx from "classnames";
import { CodeMirror } from "metabase/common/components/CodeMirror";
@@ -10,7 +11,7 @@ type Props = {
className?: string;
highlightRanges?: { start: number; end: number }[];
id?: string;
- language?: CodeLanguage;
+ language?: CodeLanguage | Extension;
lineNumbers?: boolean;
readOnly?: boolean;
value: string;
diff --git a/frontend/src/metabase/common/components/CodeEditor/types.ts b/frontend/src/metabase/common/components/CodeEditor/types.ts
index 2b54652b166..977a69c100c 100644
--- a/frontend/src/metabase/common/components/CodeEditor/types.ts
+++ b/frontend/src/metabase/common/components/CodeEditor/types.ts
@@ -6,4 +6,5 @@ export type CodeLanguage =
| "pug"
| "python"
| "ruby"
+ | "sql"
| "typescript";
diff --git a/frontend/src/metabase/common/components/CodeEditor/utils.ts b/frontend/src/metabase/common/components/CodeEditor/utils.ts
index a7562e30565..74a6a6b2430 100644
--- a/frontend/src/metabase/common/components/CodeEditor/utils.ts
+++ b/frontend/src/metabase/common/components/CodeEditor/utils.ts
@@ -2,6 +2,7 @@ import { html } from "@codemirror/lang-html";
import { javascript } from "@codemirror/lang-javascript";
import { json } from "@codemirror/lang-json";
import { python } from "@codemirror/lang-python";
+import { sql } from "@codemirror/lang-sql";
import { StreamLanguage } from "@codemirror/language";
import { clojure } from "@codemirror/legacy-modes/mode/clojure";
import { pug } from "@codemirror/legacy-modes/mode/pug";
@@ -12,14 +13,22 @@ import { useMemo } from "react";
import type { CodeLanguage } from "./types";
-export function useExtensions({ language }: { language?: CodeLanguage }) {
+export function useExtensions({
+ language,
+}: {
+ language?: CodeLanguage | Extension;
+}) {
return useMemo(
() => [...(language ? [getLanguageExtension(language)] : [])],
[language],
);
}
-export function getLanguageExtension(language: CodeLanguage): Extension {
+export function getLanguageExtension(language: CodeLanguage | Extension) {
+ if (typeof language !== "string") {
+ return language;
+ }
+
switch (language) {
case "clojure":
return StreamLanguage.define(clojure);
@@ -40,5 +49,7 @@ export function getLanguageExtension(language: CodeLanguage): Extension {
jsx: true,
typescript: language === "typescript",
});
+ case "sql":
+ return sql();
}
}
diff --git a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
index e3f1ccb89e1..6123a8f8bc4 100644
--- a/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
+++ b/frontend/src/metabase/query_builder/components/QueryModals/QueryModals.tsx
@@ -327,11 +327,7 @@ export function QueryModals({
</Modal>
);
case MODAL_TYPES.PREVIEW_QUERY:
- return (
- <Modal fit onClose={onCloseModal}>
- <PreviewQueryModal onClose={onCloseModal} />
- </Modal>
- );
+ return <PreviewQueryModal onClose={onCloseModal} />;
case MODAL_TYPES.QUESTION_EMBED:
return (
<QuestionEmbedWidget card={question._card} onClose={onCloseModal} />
diff --git a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.module.css b/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.module.css
deleted file mode 100644
index 9fbbebee857..00000000000
--- a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.module.css
+++ /dev/null
@@ -1,56 +0,0 @@
-.CodeContainer {
- display: flex;
- flex: 1 1 auto;
- flex-direction: column;
- box-sizing: border-box;
- margin: 0;
- padding: 1rem;
- border: 1px solid var(--mb-color-border);
- background-color: var(--mb-color-bg-light);
- border-radius: 0.5rem;
- overflow: auto;
-
- &.isHighlighted {
- background-color: var(--mb-color-brand-light);
- border: 1px solid var(--mb-color-brand);
- }
-}
-
-.CodeText {
- display: block;
- flex: 1 1 auto;
- box-sizing: border-box;
- font-size: 0.75rem;
- line-height: 1.125rem;
- white-space: pre;
- overflow-wrap: break-word;
-}
-
-.CodeRoot {
- display: flex;
- flex: 1 1 auto;
- flex-direction: column;
- min-height: 0;
- position: relative;
-
- &:hover {
- .CodeCopyButton {
- visibility: visible;
- }
- }
-}
-
-.CodeCopyButton {
- position: absolute;
- top: 1rem;
- right: 1rem;
- width: 1rem;
- height: 1rem;
- color: var(--mb-color-brand);
- visibility: hidden;
- background-color: var(--mb-color-bg-light);
-
- &.isHighlighted {
- background-color: var(--mb-color-brand-light);
- }
-}
diff --git a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.tsx b/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.tsx
deleted file mode 100644
index 8ee7b1760eb..00000000000
--- a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/NativeCodePanel.tsx
+++ /dev/null
@@ -1,64 +0,0 @@
-import cx from "classnames";
-import { useCallback, useEffect, useState } from "react";
-import { t } from "ttag";
-
-import IconButtonWrapper from "metabase/common/components/IconButtonWrapper";
-import { Flex, Icon, Tooltip } from "metabase/ui";
-
-import NativeCodePanelS from "./NativeCodePanel.module.css";
-
-interface NativeCodePanelProps {
- value: string;
- isHighlighted?: boolean;
- isCopyEnabled?: boolean;
-}
-
-export const NativeCodePanel = ({
- value,
- isHighlighted,
- isCopyEnabled,
-}: NativeCodePanelProps): JSX.Element => {
- const { isCopied, handleCopy } = useCopyButton(value);
-
- return (
- <Flex className={NativeCodePanelS.CodeRoot}>
- <pre
- className={cx(NativeCodePanelS.CodeContainer, {
- [NativeCodePanelS.isHighlighted]: isHighlighted,
- })}
- >
- <code className={NativeCodePanelS.CodeText}>{value}</code>
- </pre>
- {isCopyEnabled && (
- <Tooltip label={t`Copied!`} opened={isCopied}>
- <IconButtonWrapper
- className={cx(NativeCodePanelS.CodeCopyButton, {
- [NativeCodePanelS.isHighlighted]: isHighlighted,
- })}
- onClick={handleCopy}
- >
- <Icon name="copy" />
- </IconButtonWrapper>
- </Tooltip>
- )}
- </Flex>
- );
-};
-
-const useCopyButton = (value: string) => {
- const [isCopied, setIsCopied] = useState(false);
-
- const handleCopy = useCallback(() => {
- navigator.clipboard.writeText(value);
- setIsCopied(true);
- }, [value]);
-
- useEffect(() => {
- if (isCopied) {
- const timeout = setTimeout(() => setIsCopied(false), 2000);
- return () => clearTimeout(timeout);
- }
- }, [isCopied]);
-
- return { isCopied, handleCopy };
-};
diff --git a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/index.ts b/frontend/src/metabase/query_builder/components/view/NativeCodePanel/index.ts
deleted file mode 100644
index d326e2449f8..00000000000
--- a/frontend/src/metabase/query_builder/components/view/NativeCodePanel/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { NativeCodePanel } from "./NativeCodePanel";
diff --git a/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/NativeQueryPreview.tsx b/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/NativeQueryPreview.tsx
deleted file mode 100644
index c245c473a9c..00000000000
--- a/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/NativeQueryPreview.tsx
+++ /dev/null
@@ -1,106 +0,0 @@
-import type { ReactNode } from "react";
-import { t } from "ttag";
-
-import { color } from "metabase/lib/colors";
-import { Box, Flex, Icon, Loader, rem } from "metabase/ui";
-
-import { NativeCodePanel } from "../NativeCodePanel";
-
-interface NativeQueryPreviewProps {
- title: string;
- query?: string;
- error?: string;
- isLoading?: boolean;
- children?: ReactNode;
- onClose?: () => void;
-}
-
-const Header = ({ children }: { children: ReactNode }) => (
- <Flex align="center" mb="1.5rem">
- {children}
- </Flex>
-);
-
-const ModalWarningIcon = () => (
- <Icon
- name="warning"
- size="1rem"
- color={color("error")}
- style={{ flex: "0 0 auto", marginRight: `${rem(12)}` }}
- />
-);
-
-const Title = ({ children }: { children: string }) => (
- <Box
- c="text-dark"
- fz={rem(20)}
- lh={rem(24)}
- fw="bold"
- style={{ flex: "1 1 auto" }}
- >
- {children}
- </Box>
-);
-
-const CloseButton = ({ onClose }: Pick<NativeQueryPreviewProps, "onClose">) => (
- <Flex
- align="center"
- justify="center"
- style={{ borderRadius: `${rem(6)}`, cursor: "pointer" }}
- >
- <Icon name="close" onClick={onClose} color={color("text-light")} />
- </Flex>
-);
-
-const Divider = () => (
- <Box mb="lg" style={{ borderTop: "1px solid var(--mb-color-border)" }}></Box>
-);
-
-const Footer = ({ children }: { children: ReactNode }) => (
- <Flex justify="end" mt="lg">
- {children}
- </Flex>
-);
-
-export const NativeQueryPreview = ({
- title,
- query,
- error,
- isLoading,
- children,
- onClose,
-}: NativeQueryPreviewProps): JSX.Element => {
- return (
- <Flex
- direction="column"
- p="xl"
- miw={rem(640)}
- maw={rem(1360)}
- mih={rem(320)}
- mah={rem(1440)}
- >
- <Header>
- {error && <ModalWarningIcon />}
- <Title>{error ? t`An error occurred in your query` : title}</Title>
- {onClose && <CloseButton onClose={onClose} />}
- </Header>
- {error && <Divider />}
- <Flex
- direction="column"
- justify={isLoading ? "center" : undefined}
- align={isLoading ? "center" : undefined}
- mih={0}
- style={{ flex: "1 1 auto" }}
- >
- {isLoading ? (
- <Loader c={color("brand")} />
- ) : error ? (
- <NativeCodePanel value={error} isHighlighted />
- ) : query ? (
- <NativeCodePanel value={query} isCopyEnabled />
- ) : null}
- </Flex>
- {children && <Footer>{children}</Footer>}
- </Flex>
- );
-};
diff --git a/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/index.ts b/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/index.ts
deleted file mode 100644
index ae1d65f5aa9..00000000000
--- a/frontend/src/metabase/query_builder/components/view/NativeQueryPreview/index.ts
+++ /dev/null
@@ -1 +0,0 @@
-export { NativeQueryPreview } from "./NativeQueryPreview";
diff --git a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.module.css b/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.module.css
deleted file mode 100644
index 33a248c4e7b..00000000000
--- a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.module.css
+++ /dev/null
@@ -1,11 +0,0 @@
-.ModalExternalLink {
- color: var(--mb-color-brand);
- font-size: 0.75rem;
- line-height: 1rem;
- font-weight: bold;
- text-decoration: none;
-
- &:hover {
- text-decoration: underline;
- }
-}
diff --git a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.tsx b/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.tsx
index f60db441ef0..b119c1ef000 100644
--- a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.tsx
+++ b/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/PreviewQueryModal.tsx
@@ -1,67 +1,26 @@
import { t } from "ttag";
-import { useGetNativeDatasetQuery } from "metabase/api";
-import ExternalLink from "metabase/common/components/ExternalLink";
-import { formatNativeQuery } from "metabase/lib/engine";
-import { getResponseErrorMessage } from "metabase/lib/errors";
import { useSelector } from "metabase/lib/redux";
import { checkNotNull } from "metabase/lib/types";
import {
getNextRunParameters,
getQuestion,
} from "metabase/query_builder/selectors";
-import { getLearnUrl } from "metabase/selectors/settings";
-import { getShowMetabaseLinks } from "metabase/selectors/whitelabel";
-import * as Lib from "metabase-lib";
-
-import { NativeQueryPreview } from "../NativeQueryPreview";
-
-import PreviewQueryModalS from "./PreviewQueryModal.module.css";
-
-interface PreviewQueryModalProps {
- onClose?: () => void;
-}
+import { NativeQueryPreview } from "metabase/querying/notebook/components/NativeQueryPreview";
+import { Modal } from "metabase/ui";
+import type { UiParameter } from "metabase-lib/v1/parameters/types";
export const PreviewQueryModal = ({
- onClose,
-}: PreviewQueryModalProps): JSX.Element => {
+ onClose = () => undefined,
+}: {
+ onClose?: () => void;
+}) => {
const question = checkNotNull(useSelector(getQuestion));
- const sourceQuery = question.query();
- const parameters = useSelector(getNextRunParameters);
- const payload = {
- ...Lib.toLegacyQuery(sourceQuery),
- parameters,
- pretty: false,
- };
- const { data, error, isFetching } = useGetNativeDatasetQuery(payload);
- const learnUrl = getLearnUrl(
- "grow-your-data-skills/learn-sql/debugging-sql/sql-syntax",
- );
- const showMetabaseLinks = useSelector(getShowMetabaseLinks);
-
- const engine = question.database()?.engine;
- const formattedQuery =
- data != null && engine != null
- ? formatNativeQuery(data.query, engine)
- : undefined;
- const formattedError = error ? getResponseErrorMessage(error) : undefined;
+ const parameters: UiParameter[] = useSelector(getNextRunParameters);
return (
- <NativeQueryPreview
- title={t`Query preview`}
- query={formattedQuery}
- error={formattedError}
- isLoading={isFetching}
- onClose={onClose}
- >
- {formattedError && showMetabaseLinks && (
- <ExternalLink
- className={PreviewQueryModalS.ModalExternalLink}
- href={learnUrl}
- >
- {t`Learn how to debug SQL errors`}
- </ExternalLink>
- )}
- </NativeQueryPreview>
+ <Modal opened onClose={onClose} title={t`Query preview`}>
+ <NativeQueryPreview query={question.query()} parameters={parameters} />
+ </Modal>
);
};
diff --git a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/tests/setup.tsx b/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/tests/setup.tsx
index 128ebe484a7..f8f75d4fb39 100644
--- a/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/tests/setup.tsx
+++ b/frontend/src/metabase/query_builder/components/view/PreviewQueryModal/tests/setup.tsx
@@ -6,8 +6,8 @@ import { createMockEntitiesState } from "__support__/store";
import { renderWithProviders } from "__support__/ui";
import type { TokenFeatures } from "metabase-types/api";
import {
- createMockCard,
createMockDatabase,
+ createMockNativeCard,
createMockTokenFeatures,
} from "metabase-types/api/mocks";
import {
@@ -28,7 +28,7 @@ export const setup = ({
hasEnterprisePlugins,
tokenFeatures = {},
}: SetupOpts = {}) => {
- const card = createMockCard();
+ const card = createMockNativeCard();
const state = createMockState({
qb: createMockQueryBuilderState({ card }),
entities: createMockEntitiesState({
diff --git a/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.module.css b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.module.css
new file mode 100644
index 00000000000..5282f1c9861
--- /dev/null
+++ b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.module.css
@@ -0,0 +1,24 @@
+.ModalExternalLink {
+ color: var(--mb-color-brand);
+ font-size: 0.75rem;
+ line-height: 1rem;
+ font-weight: bold;
+ text-decoration: none;
+
+ &:hover {
+ text-decoration: underline;
+ }
+}
+
+.code {
+ background-color: var(--mb-color-bg-light);
+ border-radius: var(--mantine-radius-md);
+ overflow: hidden;
+ border: 1px solid var(--mb-color-border);
+}
+
+.copyButton {
+ position: absolute;
+ top: var(--mantine-spacing-sm);
+ right: var(--mantine-spacing-sm);
+}
diff --git a/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.tsx b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.tsx
new file mode 100644
index 00000000000..176b72c4b77
--- /dev/null
+++ b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/NativeQueryPreview.tsx
@@ -0,0 +1,108 @@
+import { t } from "ttag";
+
+import { useGetNativeDatasetQuery } from "metabase/api";
+import { getErrorMessage } from "metabase/api/utils";
+import { CodeEditor } from "metabase/common/components/CodeEditor";
+import { CopyButton } from "metabase/common/components/CopyButton";
+import ExternalLink from "metabase/common/components/ExternalLink";
+import { formatNativeQuery } from "metabase/lib/engine";
+import { useSelector } from "metabase/lib/redux";
+import { language } from "metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor/language";
+import { getLearnUrl } from "metabase/selectors/settings";
+import { getShowMetabaseLinks } from "metabase/selectors/whitelabel";
+import { Box, Flex, Icon, Loader, Stack } from "metabase/ui";
+import * as Lib from "metabase-lib";
+import type { UiParameter } from "metabase-lib/v1/parameters/types";
+import type { NativeDatasetResponse } from "metabase-types/api";
+
+import S from "./NativeQueryPreview.module.css";
+
+export function NativeQueryPreview({
+ query,
+ parameters = [],
+}: {
+ query: Lib.Query;
+ parameters?: UiParameter[];
+}) {
+ const { data, error, isFetching } = useGetNativeDatasetQuery({
+ ...Lib.toLegacyQuery(query),
+ parameters,
+ });
+
+ const showMetabaseLinks = useSelector(getShowMetabaseLinks);
+ const learnUrl = getLearnUrl(
+ "grow-your-data-skills/learn-sql/debugging-sql/sql-syntax",
+ );
+
+ const engine = Lib.engine(query);
+ const formattedQuery = getFormattedQuery(data, engine);
+ const formattedError = error ? getErrorMessage(error) : undefined;
+
+ return (
+ <Stack>
+ {formattedError && (
+ <Flex gap="sm">
+ <Icon name="warning" c="error" />
+ {t`An error occurred in your query`}
+ </Flex>
+ )}
+
+ {isFetching ? (
+ <Flex direction="column" justify="center" align="center">
+ <Loader c="brand" />
+ </Flex>
+ ) : (
+ <Flex direction="column" mih={0}>
+ <NativeCodePanel
+ value={formattedError ?? formattedQuery ?? ""}
+ engine={engine}
+ enableCopy={formattedQuery !== undefined}
+ />
+ </Flex>
+ )}
+
+ {formattedError && showMetabaseLinks && (
+ <Flex justify="end" mt="lg">
+ <ExternalLink className={S.ModalExternalLink} href={learnUrl}>
+ {t`Learn how to debug SQL errors`}
+ </ExternalLink>
+ </Flex>
+ )}
+ </Stack>
+ );
+}
+
+function getFormattedQuery(
+ data: NativeDatasetResponse | undefined,
+ engine: string | null,
+) {
+ if (data == null) {
+ return null;
+ }
+ if (engine === null) {
+ return data.query;
+ }
+ return formatNativeQuery(data.query, engine);
+}
+
+function NativeCodePanel({
+ value,
+ engine,
+ enableCopy,
+}: {
+ value: string;
+ engine?: string | null;
+ enableCopy?: boolean;
+}) {
+ return (
+ <Box pos="relative" mt="sm">
+ <CodeEditor
+ lineNumbers={false}
+ language={language({ engine })}
+ value={value}
+ className={S.code}
+ />
+ {enableCopy && <CopyButton value={value} className={S.copyButton} />}
+ </Box>
+ );
+}
diff --git a/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/index.ts b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/index.ts
new file mode 100644
index 00000000000..8c5b98e9d68
--- /dev/null
+++ b/frontend/src/metabase/querying/notebook/components/NativeQueryPreview/index.ts
@@ -0,0 +1 @@
+export * from "./NativeQueryPreview";