Skip to content

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

Stop querying from importing metabot (#82401)

Fraserbe3443b07ddd
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 2cd61559af2..487f5c4731e 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -246,11 +246,7 @@ const elements = [
createElement({ type: "shared", name: "parameters" }),
createElement({ type: "shared", name: "plugins" }),
createElement({ type: "shared", name: "pulse" }),
- createElement({
- type: "shared",
- name: "querying",
- enforceSharedTiers: false,
- }),
+ createElement({ type: "shared", name: "querying" }),
createElement({ type: "shared", name: "questions" }),
createElement({ type: "shared", name: "redux", enforceSharedTiers: false }),
createElement({ type: "shared", name: "rich_text_editing" }),
diff --git a/frontend/lint/shared-tiers.mjs b/frontend/lint/shared-tiers.mjs
index 15d41c04b9b..75ae87b3e4b 100644
--- a/frontend/lint/shared-tiers.mjs
+++ b/frontend/lint/shared-tiers.mjs
@@ -56,8 +56,8 @@ const SHARED_PLATFORM_LEVELS = [
// P3 — building blocks over querying, mutually independent.
["shared/metadata", "shared/parameters", "shared/questions"],
// P4 — the metabot agent, which transforms and nav compose.
- // metabot keeps its enforceSharedTiers flag for its remaining upward edges:
- // Metabot.tsx imports MainNavbar.styled, and querying imports metabot in three places.
+ // metabot keeps its enforceSharedTiers flag for one upward edge,
+ // Metabot.tsx importing Sidebar from the main navbar.
["shared/metabot"],
];
diff --git a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
index ea896a8d9a8..408e2b7b962 100644
--- a/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
+++ b/frontend/src/metabase/documents/components/editor-extensions/CardEmbed/modals/NativeQueryModal.tsx
@@ -6,12 +6,14 @@ import EmptyCodeResult from "assets/img/empty-states/code.svg";
import { datasetApi } from "metabase/api/dataset";
import { getErrorMessage as getResponseErrorMessage } from "metabase/api/utils";
import { ErrorMessage } from "metabase/common/components/ErrorMessage";
+import { useUserMetabotPermissions } from "metabase/metabot/hooks";
+import { getMetabotVisible } from "metabase/metabot/state";
import { useQuestionFromCard } from "metabase/metadata-store";
import { defaultClickActionMode } from "metabase/querying/click-actions/lib/modes";
import { DataReference } from "metabase/querying/components/DataReference/DataReference";
import type { DataReferenceItem } from "metabase/querying/components/DataReference/types";
import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor";
-import { useDispatch } from "metabase/redux";
+import { useDispatch, useSelector } from "metabase/redux";
import { useEditorHost } from "metabase/rich_text_editing/tiptap/EditorHost";
import { Box, Button, Flex, Loader, Modal, Stack, Text } from "metabase/ui";
import { isMac } from "metabase/utils/browser";
@@ -37,7 +39,6 @@ const MODAL_SIDEBAR_FEATURES = {
dataReference: true,
variables: false,
snippets: false,
- promptInput: false,
formatQuery: false,
} as const;
@@ -119,6 +120,10 @@ export const NativeQueryModal = ({
const [isShowingTemplateTagsEditor, setIsShowingTemplateTagsEditor] =
useState(false);
const [isShowingDataReference, setIsShowingDataReference] = useState(false);
+ const isMetabotSidebarOpen = useSelector((state) =>
+ getMetabotVisible(state, "omnibot"),
+ );
+ const { hasSqlGenerationAccess } = useUserMetabotPermissions();
const [dataReferenceStack, setDataReferenceStack] = useState<
DataReferenceItem[]
>([]);
@@ -339,6 +344,8 @@ export const NativeQueryModal = ({
query={nativeQuery}
isNativeEditorOpen
isInitiallyOpen
+ canAutoOpenDataReference={!isMetabotSidebarOpen}
+ hasSqlGenerationAccess={hasSqlGenerationAccess}
availableHeight={totalHeight}
isRunnable
isRunning={isQueryRunning}
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
index a8faadf65ae..68779939d60 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.unit.spec.tsx
@@ -15,6 +15,7 @@ import { renderWithProviders, screen, waitFor } from "__support__/ui";
import { MetabotProvider } from "metabase/metabot/context";
import { getMetadata } from "metabase/metadata-store";
import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditor";
+import { NATIVE_EDITOR_ICON_SIZE } from "metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons";
import { checkNotNull } from "metabase/utils/types";
import type Question from "metabase-lib/v1/Question";
import {
@@ -24,6 +25,8 @@ import {
} from "metabase-types/api/mocks";
import { createSampleDatabase } from "metabase-types/api/mocks/presets";
+import { MetabotPromptButton } from "../MetabotPromptButton";
+
import { useInlineSQLPrompt } from "./useInlineSQLPrompt";
jest.mock(
@@ -56,11 +59,17 @@ function TestEditor({ question }: { question: Question }) {
isNativeEditorOpen
isInitiallyOpen
extensions={extensions}
- isPromptInputOpen={isPromptOpen}
- onTogglePromptInput={togglePrompt}
>
<NativeQueryEditor.TopBar>
- <NativeQueryEditor.Sidebar />
+ <NativeQueryEditor.Sidebar
+ promptButton={
+ <MetabotPromptButton
+ size={NATIVE_EDITOR_ICON_SIZE}
+ isPromptInputOpen={isPromptOpen}
+ onClick={togglePrompt}
+ />
+ }
+ />
</NativeQueryEditor.TopBar>
</NativeQueryEditor>
{portalElement}
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/MetabotPromptButton.module.css b/frontend/src/metabase/metabot/components/MetabotPromptButton/MetabotPromptButton.module.css
similarity index 100%
rename from frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/MetabotPromptButton.module.css
rename to frontend/src/metabase/metabot/components/MetabotPromptButton/MetabotPromptButton.module.css
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/MetabotPromptButton.tsx b/frontend/src/metabase/metabot/components/MetabotPromptButton/MetabotPromptButton.tsx
similarity index 100%
rename from frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/MetabotPromptButton.tsx
rename to frontend/src/metabase/metabot/components/MetabotPromptButton/MetabotPromptButton.tsx
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/index.ts b/frontend/src/metabase/metabot/components/MetabotPromptButton/index.ts
similarity index 100%
rename from frontend/src/metabase/querying/components/NativeQueryEditor/MetabotPromptButton/index.ts
rename to frontend/src/metabase/metabot/components/MetabotPromptButton/index.ts
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
index 683993aa94c..495bc3d5f7b 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditor.unit.spec.tsx
@@ -5,6 +5,7 @@ import {
setupDatabasesEndpoints,
setupNativeQuerySnippetEndpoints,
setupRecentViewsAndSelectionsEndpoints,
+ setupUserMetabotPermissionsEndpoint,
} from "__support__/server-mocks";
import { renderWithProviders, screen } from "__support__/ui";
import Question from "metabase-lib/v1/Question";
@@ -76,6 +77,7 @@ const renderDatasetEditor = async (card: Card | UnsavedCard) => {
setupCollectionsEndpoints({ collections: [ROOT_COLLECTION] });
setupNativeQuerySnippetEndpoints();
setupRecentViewsAndSelectionsEndpoints([], ["selections"]);
+ setupUserMetabotPermissionsEndpoint();
const question = new Question(card);
fetchMock.get("path:/api/search", { body: { data: [] } });
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
index 1dd2873dc6c..29a1c0c7846 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetEditorInner.tsx
@@ -21,6 +21,7 @@ import { EditBar } from "metabase/common/components/EditBar";
import { LeaveConfirmModal } from "metabase/common/components/LeaveConfirmModal";
import { getSemanticTypeIcon } from "metabase/common/utils/fields";
import CS from "metabase/css/core/index.css";
+import { FixSqlQueryButton } from "metabase/metabot/components/FixSqlQueryButton";
import { getShallowFields } from "metabase/metadata-store";
import { HasResultsAlertPrompt } from "metabase/notifications/HasResultsAlertPrompt";
import { TagEditorSidebar } from "metabase/parameters/components/TagEditor/TagEditorSidebar";
@@ -786,6 +787,7 @@ const DatasetEditorInnerView = (props: DatasetEditorInnerProps) => {
<HasResultsAlertPrompt question={question} />
)
}
+ errorAction={<FixSqlQueryButton />}
/>
)}
</DebouncedFrame>
diff --git a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx
index 824c20af637..03f1eeba145 100644
--- a/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx
+++ b/frontend/src/metabase/query_builder/components/DatasetEditor/DatasetQueryEditor.tsx
@@ -8,7 +8,10 @@ import {
} from "react";
import type { ResizableBoxProps } from "react-resizable";
+import { useUserMetabotPermissions } from "metabase/metabot/hooks";
+import { getMetabotVisible } from "metabase/metabot/state";
import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor";
+import { useSelector } from "metabase/redux";
import { Box } from "metabase/ui";
import { isReducedMotionPreferred } from "metabase/utils/dom";
import { checkNotNull } from "metabase/utils/types";
@@ -48,6 +51,10 @@ function DatasetQueryEditorInner({
...props
}: DatasetQueryEditorProps) {
const { isNative } = Lib.queryDisplayInfo(question.query());
+ const isMetabotSidebarOpen = useSelector((state) =>
+ getMetabotVisible(state, "omnibot"),
+ );
+ const { hasSqlGenerationAccess } = useUserMetabotPermissions();
const [isResizing, setResizing] = useState(false);
@@ -91,6 +98,8 @@ function DatasetQueryEditorInner({
question={question}
query={checkNotNull(question.legacyNativeQuery())} // memoized query
isInitiallyOpen
+ canAutoOpenDataReference={!isMetabotSidebarOpen}
+ hasSqlGenerationAccess={hasSqlGenerationAccess}
onSetDatabaseId={onSetDatabaseId}
>
{isActive && (
diff --git a/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx b/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
index cf0d9d1d9eb..100ab7eb6e6 100644
--- a/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/ViewMainContainer/ViewMainContainer.tsx
@@ -3,6 +3,7 @@ import cx from "classnames";
import { DebouncedFrame } from "metabase/common/components/DebouncedFrame";
import CS from "metabase/css/core/index.css";
+import { FixSqlQueryButton } from "metabase/metabot/components/FixSqlQueryButton";
import { HasResultsAlertPrompt } from "metabase/notifications/HasResultsAlertPrompt";
import { SyncedParametersList } from "metabase/parameters/components/SyncedParametersList";
import { Mode } from "metabase/querying/click-actions/Mode";
@@ -156,6 +157,7 @@ export const ViewMainContainer = (props: ViewMainContainerProps) => {
noResultsAction={
!isDirty && <HasResultsAlertPrompt question={question} />
}
+ errorAction={<FixSqlQueryButton />}
onUpdateQuestion={updateQuestion}
/>
</DebouncedFrame>
diff --git a/frontend/src/metabase/query_builder/components/view/View/ViewNativeQueryEditor/ViewNativeQueryEditor.tsx b/frontend/src/metabase/query_builder/components/view/View/ViewNativeQueryEditor/ViewNativeQueryEditor.tsx
index c2f43fdf379..ea2d2851e64 100644
--- a/frontend/src/metabase/query_builder/components/view/View/ViewNativeQueryEditor/ViewNativeQueryEditor.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/ViewNativeQueryEditor/ViewNativeQueryEditor.tsx
@@ -1,6 +1,12 @@
import { useInlineSQLPrompt } from "metabase/metabot/components/MetabotInlineSQLPrompt";
+import { MetabotPromptButton } from "metabase/metabot/components/MetabotPromptButton";
+import { useUserMetabotPermissions } from "metabase/metabot/hooks";
+import { getMetabotVisible } from "metabase/metabot/state";
import { NativeQueryParametersList } from "metabase/parameters/components/NativeQueryParametersList";
-import { NativeQueryEditor } from "metabase/querying/components/NativeQueryEditor";
+import {
+ NATIVE_EDITOR_ICON_SIZE,
+ NativeQueryEditor,
+} from "metabase/querying/components/NativeQueryEditor";
import type { QueryModalType } from "metabase/querying/constants";
import type { SelectionRange } from "metabase/querying/editor/types";
import { useSelector } from "metabase/redux";
@@ -80,6 +86,10 @@ export const ViewNativeQueryEditor = (props: ViewNativeQueryEditorProps) => {
);
const inlineSQLPrompt = useInlineSQLPrompt(question, "qb");
+ const isMetabotSidebarOpen = useSelector((state) =>
+ getMetabotVisible(state, "omnibot"),
+ );
+ const { hasSqlGenerationAccess } = useUserMetabotPermissions();
// Normally, when users open native models,
// they open an ad-hoc GUI question using the model as a data source
@@ -100,16 +110,26 @@ export const ViewNativeQueryEditor = (props: ViewNativeQueryEditorProps) => {
query={legacyNativeQuery}
highlightedLineNumbers={highlightedLineNumbers}
isInitiallyOpen={isNativeEditorOpen}
+ canAutoOpenDataReference={!isMetabotSidebarOpen}
onSetDatabaseId={onSetDatabaseId}
extensions={inlineSQLPrompt?.extensions}
proposedQuestion={inlineSQLPrompt?.proposedQuestion}
onAcceptProposed={inlineSQLPrompt?.handleAcceptProposed}
onRejectProposed={inlineSQLPrompt?.handleRejectProposed}
- isPromptInputOpen={inlineSQLPrompt?.isPromptOpen}
- onTogglePromptInput={inlineSQLPrompt?.togglePrompt}
+ hasSqlGenerationAccess={hasSqlGenerationAccess}
>
<NativeQueryEditor.TopBar leftContent={<NativeQueryParametersList />}>
- <NativeQueryEditor.Sidebar />
+ <NativeQueryEditor.Sidebar
+ promptButton={
+ inlineSQLPrompt && (
+ <MetabotPromptButton
+ size={NATIVE_EDITOR_ICON_SIZE}
+ isPromptInputOpen={inlineSQLPrompt.isPromptOpen}
+ onClick={inlineSQLPrompt.togglePrompt}
+ />
+ )
+ }
+ />
<NativeQueryEditor.VisibilityToggler />
</NativeQueryEditor.TopBar>
<NativeQueryEditor.RunButton />
diff --git a/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.tsx b/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.tsx
index f3a0570e11e..86c836ed757 100644
--- a/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.tsx
+++ b/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.tsx
@@ -14,7 +14,6 @@ import {
CodeMirror,
type CodeMirrorRef,
} from "metabase/common/components/CodeMirror";
-import { useUserMetabotPermissions } from "metabase/metabot/hooks";
import { isEventOverElement } from "metabase/utils/dom";
import * as Lib from "metabase-lib";
import type { CardId } from "metabase-types/api";
@@ -35,6 +34,7 @@ export type CodeMirrorEditorProps = {
highlightedLineNumbers?: number[];
placeholder?: string;
readOnly?: boolean;
+ hasSqlGenerationAccess?: boolean;
extensions?: Extension[];
onChange?: (queryText: string) => void;
onFormatQuery?: () => void;
@@ -60,6 +60,7 @@ export const CodeMirrorEditor = forwardRef<
highlightedLineNumbers,
placeholder: placeholderProp,
readOnly,
+ hasSqlGenerationAccess,
extensions: customExtensions,
onChange,
onRunQuery,
@@ -72,7 +73,6 @@ export const CodeMirrorEditor = forwardRef<
ref,
) {
const editorRef = useRef<CodeMirrorRef>(null);
- const { hasSqlGenerationAccess } = useUserMetabotPermissions();
const placeholder =
placeholderProp ??
getPlaceholderText(Lib.engine(query), hasSqlGenerationAccess);
diff --git a/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.unit.spec.tsx b/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.unit.spec.tsx
index ac7c9f1bc05..f9c8bacef8f 100644
--- a/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.unit.spec.tsx
+++ b/frontend/src/metabase/querying/components/CodeMirrorEditor/CodeMirrorEditor.unit.spec.tsx
@@ -1,7 +1,6 @@
import fetchMock from "fetch-mock";
import { createMockMetadata } from "__support__/metadata";
-import { setupUserMetabotPermissionsEndpoint } from "__support__/server-mocks";
import { renderWithProviders, screen } from "__support__/ui";
import * as Lib from "metabase-lib";
import { createMetadataProvider } from "metabase-lib/test-helpers";
@@ -24,7 +23,6 @@ function setup({
const onRightClickSelection = jest.fn();
const onSelectionChange = jest.fn();
- setupUserMetabotPermissionsEndpoint();
fetchMock.get("path:/api/native-query-snippet", {
body: snippets,
});
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditor.unit.spec.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditor.unit.spec.tsx
index ac99912b386..e8c7c06d159 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditor.unit.spec.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditor.unit.spec.tsx
@@ -2,7 +2,6 @@ import {
setupCollectionsEndpoints,
setupNativeQuerySnippetEndpoints,
} from "__support__/server-mocks";
-import { createMockState } from "__support__/state";
import { renderWithProviders } from "__support__/ui";
import { useNotebookScreenSize } from "metabase/querying/components/NativeQueryEditor/use-notebook-screen-size";
@@ -30,7 +29,7 @@ const mockQuestion = {
describe("NativeQueryEditor", () => {
const createEditor = (
screenSize: Exclude<UseNotebookScreenSize, undefined>,
- isMetabotSidebarOpen: boolean,
+ canAutoOpenDataReference: boolean,
) => {
const setIsNativeEditorOpen = jest.fn();
@@ -44,6 +43,7 @@ describe("NativeQueryEditor", () => {
renderWithProviders(
<NativeQueryEditor
availableHeight={700}
+ canAutoOpenDataReference={canAutoOpenDataReference}
isNativeEditorOpen={false}
question={mockQuestion}
// Unjustified type cast. FIXME
@@ -52,18 +52,6 @@ describe("NativeQueryEditor", () => {
setIsNativeEditorOpen={setIsNativeEditorOpen}
isInitiallyOpen={false}
/>,
- {
- // Unjustified type cast. FIXME
- storeInitialState: createMockState({
- metabot: {
- agents: {
- omnibot: {
- visible: isMetabotSidebarOpen,
- },
- },
- },
- } as any),
- },
);
return setIsNativeEditorOpen;
@@ -74,20 +62,20 @@ describe("NativeQueryEditor", () => {
useNotebookScreenSizeMock.mockReset();
});
- it("should not open data reference when metabot sidebar is open", () => {
- const setIsNativeEditorOpen = createEditor("large", true);
+ it("should not open data reference when canAutoOpenDataReference is false", () => {
+ const setIsNativeEditorOpen = createEditor("large", false);
expect(setIsNativeEditorOpen).toHaveBeenCalledWith(false, false);
});
it("should not open data reference on small screens", () => {
- const setIsNativeEditorOpen = createEditor("small", false);
+ const setIsNativeEditorOpen = createEditor("small", true);
expect(setIsNativeEditorOpen).toHaveBeenCalledWith(false, false);
});
- it("should open data reference when metabot is closed", () => {
- const setIsNativeEditorOpen = createEditor("large", false);
+ it("should open data reference on large screens", () => {
+ const setIsNativeEditorOpen = createEditor("large", true);
expect(setIsNativeEditorOpen).toHaveBeenCalledWith(false, true);
});
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
index 56c570dfada..4b3d91d1080 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorActionButtons/NativeQueryEditorActionButtons.tsx
@@ -1,7 +1,7 @@
+import type { ReactNode } from "react";
import { t } from "ttag";
import { DataReferenceButton } from "metabase/querying/components/NativeQueryEditor/DataReferenceButton";
-import { MetabotPromptButton } from "metabase/querying/components/NativeQueryEditor/MetabotPromptButton";
import { NativeVariablesButton } from "metabase/querying/components/NativeQueryEditor/NativeVariablesButton";
import { PreviewQueryButton } from "metabase/querying/components/NativeQueryEditor/PreviewQueryButton";
import { SnippetSidebarButton } from "metabase/querying/components/NativeQueryEditor/SnippetSidebarButton";
@@ -13,7 +13,7 @@ import type { Collection, NativeQuerySnippet } from "metabase-types/api";
import S from "./NativeQueryEditorActionButtons.module.css";
-const ICON_SIZE = 18;
+export const NATIVE_EDITOR_ICON_SIZE = 18;
interface NativeQueryEditorActionButtonsProps {
question: Question;
@@ -23,8 +23,7 @@ interface NativeQueryEditorActionButtonsProps {
isRunnable: boolean;
isRunning: boolean;
isResultDirty: boolean;
- isPromptInputOpen?: boolean;
- onTogglePromptInput?: () => void;
+ promptButton?: ReactNode;
isShowingDataReference: boolean;
isShowingTemplateTagsEditor: boolean;
isShowingSnippetSidebar: boolean;
@@ -45,8 +44,7 @@ export const NativeQueryEditorActionButtons = (
snippetCollections,
snippets,
features,
- isPromptInputOpen,
- onTogglePromptInput,
+ promptButton,
toggleDataReference,
toggleTemplateTagsEditor,
onFormatQuery,
@@ -70,30 +68,24 @@ export const NativeQueryEditorActionButtons = (
gap="xl"
align="center"
>
- {features.promptInput && onTogglePromptInput && (
- <MetabotPromptButton
- size={ICON_SIZE}
- isPromptInputOpen={isPromptInputOpen}
- onClick={onTogglePromptInput}
- />
- )}
+ {promptButton}
{PreviewQueryButton.shouldRender({ question }) && (
<PreviewQueryButton {...props} />
)}
{features.dataReference && (
<DataReferenceButton
{...props}
- size={ICON_SIZE}
+ size={NATIVE_EDITOR_ICON_SIZE}
onClick={toggleDataReference}
/>
)}
{features.snippets && showSnippetSidebarButton && (
- <SnippetSidebarButton {...props} size={ICON_SIZE} />
+ <SnippetSidebarButton {...props} size={NATIVE_EDITOR_ICON_SIZE} />
)}
{features.variables && (
<NativeVariablesButton
{...props}
- size={ICON_SIZE}
+ size={NATIVE_EDITOR_ICON_SIZE}
onClick={toggleTemplateTagsEditor}
/>
)}
@@ -104,7 +96,9 @@ export const NativeQueryEditorActionButtons = (
className={S.button}
aria-label={t`Auto-format`}
p={0}
- leftSection={<Icon name="format_code" size={ICON_SIZE} />}
+ leftSection={
+ <Icon name="format_code" size={NATIVE_EDITOR_ICON_SIZE} />
+ }
onClick={onFormatQuery}
/>
</Tooltip>
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorRoot.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorRoot.tsx
index be5f3a68788..3c4623ec0bd 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorRoot.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/NativeQueryEditorRoot.tsx
@@ -15,7 +15,6 @@ import { useMount } from "react-use";
import { t } from "ttag";
import { useListCollectionsQuery, useListSnippetsQuery } from "metabase/api";
-import { getMetabotVisible } from "metabase/metabot/state";
import { PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import {
CodeMirrorEditor,
@@ -70,6 +69,7 @@ export type NativeQueryEditorCoreProps = Omit<
"query"
> & {
availableHeight?: number;
+ canAutoOpenDataReference?: boolean;
canChangeDatabase?: boolean;
cancelQuery?: () => void;
className?: string;
@@ -85,7 +85,6 @@ export type NativeQueryEditorCoreProps = Omit<
isResultDirty?: boolean;
isRunnable?: boolean;
isRunning?: boolean;
- isPromptInputOpen?: boolean;
isShowingDataReference?: boolean;
isShowingSnippetSidebar?: boolean;
isShowingTemplateTagsEditor?: boolean;
@@ -99,7 +98,6 @@ export type NativeQueryEditorCoreProps = Omit<
onOpenModal?: (modalType: QueryModalType) => void;
onRejectProposed?: () => void;
onSetDatabaseId?: (id: DatabaseId) => void;
- onTogglePromptInput?: () => void;
openDataReferenceAtQuestion?: (id: CardId) => void;
openSnippetModalWithSelectedText?: () => void;
placeholder?: string;
@@ -132,6 +130,8 @@ export const NativeQueryEditorRoot = forwardRef<
const {
children,
availableHeight = Infinity,
+ canAutoOpenDataReference = true,
+ hasSqlGenerationAccess,
canChangeDatabase = true,
cancelQuery,
className,
@@ -145,7 +145,6 @@ export const NativeQueryEditorRoot = forwardRef<
insertSnippet,
isNativeEditorOpen,
isInitiallyOpen,
- isPromptInputOpen = false,
isResultDirty = false,
isRunnable = false,
isRunning = false,
@@ -159,7 +158,6 @@ export const NativeQueryEditorRoot = forwardRef<
onOpenModal,
onRejectProposed,
onSetDatabaseId,
- onTogglePromptInput,
openDataReferenceAtQuestion,
openSnippetModalWithSelectedText,
placeholder,
@@ -201,11 +199,8 @@ export const NativeQueryEditorRoot = forwardRef<
// do not show reference sidebar on small screens automatically
const screenSize = useNotebookScreenSize();
- const isMetabotSidebarOpen = useSelector((state) =>
- getMetabotVisible(state, "omnibot"),
- );
const shouldOpenDataReference =
- screenSize !== "small" && !isMetabotSidebarOpen;
+ screenSize !== "small" && canAutoOpenDataReference;
useMount(() => {
setIsNativeEditorOpen?.(
@@ -314,8 +309,6 @@ export const NativeQueryEditorRoot = forwardRef<
nativeEditorSelectedText,
snippets,
snippetCollections,
- isPromptInputOpen,
- onTogglePromptInput,
isShowingDataReference,
isShowingSnippetSidebar,
isShowingTemplateTagsEditor,
@@ -366,6 +359,7 @@ export const NativeQueryEditorRoot = forwardRef<
proposedQuery={proposedQuestion?.query()}
readOnly={readOnly}
placeholder={placeholder}
+ hasSqlGenerationAccess={hasSqlGenerationAccess}
highlightedLineNumbers={highlightedLineNumbers}
extensions={extensions}
onBlur={onBlur}
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/__mocks__/NativeQueryEditor.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/__mocks__/NativeQueryEditor.tsx
index 89b47dc6abc..4ac568d843b 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/__mocks__/NativeQueryEditor.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/__mocks__/NativeQueryEditor.tsx
@@ -16,6 +16,8 @@ type NativeQueryEditorProps = Pick<
| "setDatasetQuery"
>;
+export const NATIVE_EDITOR_ICON_SIZE = 18;
+
export const NativeQueryEditor = ({
canChangeDatabase = true,
editorContext = "question",
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/context/NativeQueryEditorContext.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/context/NativeQueryEditorContext.tsx
index 0f1dedf4fb5..dcac28b56b6 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/context/NativeQueryEditorContext.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/context/NativeQueryEditorContext.tsx
@@ -50,8 +50,6 @@ export interface NativeQueryEditorContextValue {
snippets: NativeQuerySnippet[];
snippetCollections: Collection[];
- isPromptInputOpen?: boolean;
- onTogglePromptInput?: () => void;
isShowingDataReference: boolean;
isShowingSnippetSidebar: boolean;
isShowingTemplateTagsEditor: boolean;
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/index.ts b/frontend/src/metabase/querying/components/NativeQueryEditor/index.ts
index 733e5488046..18f7d58ddfb 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/index.ts
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/index.ts
@@ -1,2 +1,3 @@
export { NativeQueryEditor } from "./NativeQueryEditor";
+export { NATIVE_EDITOR_ICON_SIZE } from "./NativeQueryEditorActionButtons/NativeQueryEditorActionButtons";
export { type SelectionRange } from "metabase/querying/editor/types";
diff --git a/frontend/src/metabase/querying/components/NativeQueryEditor/slots/Sidebar.tsx b/frontend/src/metabase/querying/components/NativeQueryEditor/slots/Sidebar.tsx
index 1422ff12ac9..5810f30333b 100644
--- a/frontend/src/metabase/querying/components/NativeQueryEditor/slots/Sidebar.tsx
+++ b/frontend/src/metabase/querying/components/NativeQueryEditor/slots/Sidebar.tsx
@@ -1,3 +1,5 @@
+import type { ReactNode } from "react";
+
import type { SidebarFeatures } from "metabase/querying/editor/types";
import { NativeQueryEditorActionButtons } from "../NativeQueryEditorActionButtons/NativeQueryEditorActionButtons";
@@ -5,13 +7,13 @@ import { useNativeQueryEditorContext } from "../context/NativeQueryEditorContext
interface SidebarProps {
features?: SidebarFeatures;
+ promptButton?: ReactNode;
}
const DEFAULT_FEATURES: SidebarFeatures = {
dataReference: true,
variables: true,
snippets: true,
- promptInput: true,
formatQuery: true,
};
@@ -20,7 +22,10 @@ const DEFAULT_FEATURES: SidebarFeatures = {
* auto-format, preview) shown on the right of the top bar. Renders nothing
* while the editor is collapsed or read-only.
*/
-export function Sidebar({ features = DEFAULT_FEATURES }: SidebarProps) {
+export function Sidebar({
+ features = DEFAULT_FEATURES,
+ promptButton,
+}: SidebarProps) {
const {
question,
snippets,
@@ -30,7 +35,6 @@ export function Sidebar({ features = DEFAULT_FEATURES }: SidebarProps) {
isRunnable,
isRunning,
isResultDirty,
- isPromptInputOpen,
isShowingDataReference,
isShowingTemplateTagsEditor,
isShowingSnippetSidebar,
@@ -39,7 +43,6 @@ export function Sidebar({ features = DEFAULT_FEATURES }: SidebarProps) {
toggleTemplateTagsEditor,
onOpenModal,
onFormatQuery,
- onTogglePromptInput,
} = useNativeQueryEditorContext();
if (!isNativeEditorOpen || readOnly) {
@@ -56,8 +59,7 @@ export function Sidebar({ features = DEFAULT_FEATURES }: SidebarProps) {
isRunnable={isRunnable}
isRunning={isRunning}
isResultDirty={isResultDirty}
- isPromptInputOpen={isPromptInputOpen}
- onTogglePromptInput={onTogglePromptInput}
+ promptButton={promptButton}
isShowingDataReference={isShowingDataReference}
isShowingTemplateTagsEditor={isShowingTemplateTagsEditor}
isShowingSnippetSidebar={isShowingSnippetSidebar}
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
index 027f206885a..fc35ef3ff12 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/QueryVisualization.tsx
@@ -31,6 +31,7 @@ export function QueryVisualization(props: QueryVisualizationProps) {
isNativeEditorOpen,
isDirtyStateShownForError,
result,
+ errorAction,
maxTableRows = HARD_ROW_LIMIT,
} = props;
@@ -79,6 +80,7 @@ export function QueryVisualization(props: QueryVisualizationProps) {
via={result.via ?? []}
question={question}
duration={result.duration ?? 0}
+ errorAction={errorAction}
/>
) : result?.data ? (
<VisualizationResult
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/VisualizationError.tsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/VisualizationError.tsx
index 051b6ac4dc2..e5cc7e967ca 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/VisualizationError.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/VisualizationError.tsx
@@ -1,5 +1,6 @@
import cx from "classnames";
import { getIn } from "icepick";
+import type { ReactNode } from "react";
import { t } from "ttag";
import { isNetworkError, isStreamInterruptedError } from "metabase/api/client";
@@ -10,7 +11,6 @@ import { ExternalLink } from "metabase/common/components/ExternalLink";
import CS from "metabase/css/core/index.css";
import QueryBuilderS from "metabase/css/query_builder.module.css";
import { getEngineNativeType } from "metabase/databases/utils/engine";
-import { FixSqlQueryButton } from "metabase/metabot/components/FixSqlQueryButton";
import { useSelector } from "metabase/redux";
import { getLearnUrl } from "metabase/selectors/settings";
import { getShowMetabaseLinks } from "metabase/selectors/whitelabel";
@@ -32,6 +32,7 @@ interface VisualizationErrorProps {
duration: number;
error: DatasetError;
errorType?: DatasetErrorType;
+ errorAction?: ReactNode;
}
export function VisualizationError({
@@ -41,6 +42,7 @@ export function VisualizationError({
duration,
error,
errorType,
+ errorAction,
}: VisualizationErrorProps) {
const query = question.query();
const showMetabaseLinks = useSelector(getShowMetabaseLinks);
@@ -167,7 +169,7 @@ export function VisualizationError({
{t`Learn how to debug SQL errors`}
</ExternalLink>
)}
- <FixSqlQueryButton />
+ {errorAction}
</Flex>
</Flex>
</Box>
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/common.unit.spec.ts b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/common.unit.spec.ts
index 489ef055659..f1e9b10c7f7 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/common.unit.spec.ts
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/common.unit.spec.ts
@@ -60,6 +60,21 @@ describe("VisualizationError (OSS)", () => {
screen.getByText("Learn how to debug SQL errors"),
).toBeInTheDocument();
});
+
+ it("should render the error action next to the message", () => {
+ const card = createMockCard({
+ dataset_query: {
+ database: database.id,
+ type: "native",
+ native: {
+ query: "SELECT * FROM ORDERS",
+ },
+ },
+ });
+ setup({ database, card, errorAction: "Have Metabot fix it" });
+
+ expect(screen.getByText("Have Metabot fix it")).toBeInTheDocument();
+ });
});
describe("server errors", () => {
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/premium.unit.spec.ts b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/premium.unit.spec.ts
index e9fd99b6133..de41ff97798 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/premium.unit.spec.ts
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/premium.unit.spec.ts
@@ -51,23 +51,6 @@ describe("VisualizationError (EE with token)", () => {
screen.queryByText("Learn how to debug SQL errors"),
).not.toBeInTheDocument();
});
-
- it("should show the Metabot fix button", async () => {
- const card = createMockCard({
- dataset_query: {
- database: database.id,
- type: "native",
- native: {
- query: "SELECT * FROM ORDERS",
- },
- },
- });
- setup({ database, card });
-
- expect(
- await screen.findByRole("button", { name: /Have Metabot fix it/ }),
- ).toBeInTheDocument();
- });
});
describe("NoSQL databases", () => {
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/setup.tsx b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/setup.tsx
index 4a5fab7169a..d39d27fb200 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/setup.tsx
+++ b/frontend/src/metabase/querying/components/QueryVisualization/VisualizationError/tests/setup.tsx
@@ -1,6 +1,7 @@
+import type { ReactNode } from "react";
+
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
import { createMockMetadata } from "__support__/metadata";
-import { setupUserMetabotPermissionsEndpoint } from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { createMockState } from "__support__/state";
import { createMockEntitiesState } from "__support__/store";
@@ -31,6 +32,7 @@ export interface SetupOpts {
tokenFeatures?: Partial<TokenFeatures>;
enterprisePlugins?: Parameters<typeof setupEnterpriseOnlyPlugin>[0][];
errorType?: DatasetErrorType;
+ errorAction?: ReactNode;
duration?: number;
}
@@ -42,6 +44,7 @@ export const setup = ({
tokenFeatures = {},
enterprisePlugins = [],
errorType,
+ errorAction,
duration = 0,
}: SetupOpts) => {
const state = createMockState({
@@ -55,8 +58,6 @@ export const setup = ({
}),
});
- setupUserMetabotPermissionsEndpoint();
-
enterprisePlugins.forEach((plugin) => {
setupEnterpriseOnlyPlugin(plugin);
});
@@ -74,6 +75,7 @@ export const setup = ({
// Unjustified type cast. FIXME
error={error as DatasetError}
errorType={errorType}
+ errorAction={errorAction}
via={[]}
/>,
{ storeInitialState: state },
diff --git a/frontend/src/metabase/querying/components/QueryVisualization/types.ts b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
index cca69d910cc..5da3be0162a 100644
--- a/frontend/src/metabase/querying/components/QueryVisualization/types.ts
+++ b/frontend/src/metabase/querying/components/QueryVisualization/types.ts
@@ -41,6 +41,7 @@ export type QueryVisualizationProps = VisualizationPassThroughProps & {
isShowingSummarySidebar?: boolean;
hideLegend?: boolean;
noResultsAction?: ReactNode;
+ errorAction?: ReactNode;
// query-builder-specific props injected by callers via `useVisualizationResultQBProps`
isRawTable?: boolean;
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 3a93b18ccf0..a3c427fa05a 100644
--- a/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx
+++ b/frontend/src/metabase/querying/editor/components/QueryEditor/QueryEditorBody/QueryEditorBody.tsx
@@ -34,7 +34,6 @@ const NATIVE_EDITOR_SIDEBAR_FEATURES = {
snippets: true,
formatQuery: true,
variables: true,
- promptInput: false,
};
type QueryEditorBodyProps = {
diff --git a/frontend/src/metabase/querying/editor/types.ts b/frontend/src/metabase/querying/editor/types.ts
index adadf061e95..30ae24e3fd4 100644
--- a/frontend/src/metabase/querying/editor/types.ts
+++ b/frontend/src/metabase/querying/editor/types.ts
@@ -28,7 +28,6 @@ export type SidebarFeatures = {
dataReference?: boolean;
variables?: boolean;
snippets?: boolean;
- promptInput?: boolean;
formatQuery?: boolean;
};