Skip to content

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

Move Metabot QB and Sidebar into query builder (#74740)

Fraser70604b58c1b2
diff --git a/frontend/lint/module-boundaries.mjs b/frontend/lint/module-boundaries.mjs
index 9d2355e6751..50f006e51bb 100644
--- a/frontend/lint/module-boundaries.mjs
+++ b/frontend/lint/module-boundaries.mjs
@@ -93,6 +93,7 @@ const elements = [
name: "metabase-shared",
pattern: "frontend/src/metabase-shared/**",
}),
+ createElement({ type: "shared", name: "metabot" }),
createElement({ type: "shared", name: "metadata" }),
createElement({ type: "shared", name: "metrics" }),
createElement({ type: "shared", name: "metrics-viewer" }),
diff --git a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.tsx
similarity index 88%
rename from frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx
rename to frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.tsx
index 1313fc5ef7f..a90a66e803c 100644
--- a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx
+++ b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.tsx
@@ -7,8 +7,9 @@ import { useAnalyzeChartMutation } from "metabase/api";
import { CopyButton } from "metabase/common/components/CopyButton";
import { SidebarContent } from "metabase/common/components/SidebarContent";
import { useSetting } from "metabase/common/hooks";
-import { getIsLoadingComplete } from "metabase/query_builder/selectors";
-import { useSelector } from "metabase/redux";
+import { AIAnalysisContent } from "metabase/metabot/components/AIAnalysisContent/AIAnalysisContent";
+import { AIProviderConfigurationModal } from "metabase/metabot/components/AIProviderConfigurationModal";
+import { AIProviderConfigurationNotice } from "metabase/metabot/components/AIProviderConfigurationNotice";
import { Box } from "metabase/ui";
import {
getChartImagePngDataUri,
@@ -17,30 +18,28 @@ import {
import type Question from "metabase-lib/v1/Question";
import type { Timeline, TimelineEvent } from "metabase-types/api";
-import { AIAnalysisContent } from "../AIAnalysisContent/AIAnalysisContent";
-import { AIProviderConfigurationModal } from "../AIProviderConfigurationModal";
-import { AIProviderConfigurationNotice } from "../AIProviderConfigurationNotice";
-
import { getTimelineEventsForAnalysis } from "./utils";
// This is a hack to ensure visualizations have rendered after data loading, as they can render asynchronously.
const RENDER_DELAY_MS = 100;
-export interface AIQuestionAnalysisSidebarProps {
+export interface AIAnalysisSidebarProps {
question: Question;
+ isLoadingComplete: boolean;
className?: string;
onClose?: () => void;
timelines?: Timeline[];
visibleTimelineEvents?: TimelineEvent[];
}
-export function AIQuestionAnalysisSidebar({
+export function AIAnalysisSidebar({
question,
+ isLoadingComplete,
timelines,
visibleTimelineEvents,
className,
onClose,
-}: AIQuestionAnalysisSidebarProps) {
+}: AIAnalysisSidebarProps) {
const previousQuestion = usePrevious(question);
const [
isAiProviderConfigurationModalOpen,
@@ -51,7 +50,6 @@ export function AIQuestionAnalysisSidebar({
] = useDisclosure(false);
const isConfigured = !!useSetting("llm-metabot-configured?");
const [analyzeChart, { data: analysisData }] = useAnalyzeChartMutation();
- const isLoadingComplete = useSelector(getIsLoadingComplete);
const pendingAnalysisRef = useRef(false);
const analysisTimeoutRef = useRef<ReturnType<typeof setTimeout> | null>(null);
diff --git a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.unit.spec.tsx b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.unit.spec.tsx
similarity index 88%
rename from frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.unit.spec.tsx
rename to frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.unit.spec.tsx
index 4c1c1439b5f..5dfa574cc29 100644
--- a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/AIAnalysisSidebar.unit.spec.tsx
@@ -5,7 +5,6 @@ import _ from "underscore";
import { setupAnalyzeChartEndpoint } from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { renderWithProviders } from "__support__/ui";
-import { createMockQueryBuilderState } from "metabase/redux/store/mocks";
import Question from "metabase-lib/v1/Question";
import type { AIEntityAnalysisResponse } from "metabase-types/api";
import {
@@ -15,14 +14,14 @@ import {
createMockUser,
} from "metabase-types/api/mocks";
-import { AIQuestionAnalysisSidebar } from "./AIQuestionAnalysisSidebar";
+import { AIAnalysisSidebar } from "./AIAnalysisSidebar";
jest.mock("metabase/visualizations/lib/image-exports", () => ({
getChartImagePngDataUri: () => Promise.resolve("test-base64"),
getChartSelector: () => "#chart",
}));
-describe("AIQuestionAnalysisSidebar", () => {
+describe("AIAnalysisSidebar", () => {
beforeEach(() => {
jest.clearAllMocks();
});
@@ -36,13 +35,14 @@ describe("AIQuestionAnalysisSidebar", () => {
setupAnalyzeChartEndpoint(mockResponse);
renderWithProviders(
- <AIQuestionAnalysisSidebar question={question} onClose={jest.fn()} />,
+ <AIAnalysisSidebar
+ question={question}
+ isLoadingComplete
+ onClose={jest.fn()}
+ />,
{
storeInitialState: {
settings: mockSettings({ "llm-metabot-configured?": true }),
- qb: createMockQueryBuilderState({
- queryStatus: "complete",
- }),
},
},
);
@@ -118,8 +118,9 @@ describe("AIQuestionAnalysisSidebar", () => {
setupAnalyzeChartEndpoint(mockResponse);
renderWithProviders(
- <AIQuestionAnalysisSidebar
+ <AIAnalysisSidebar
question={question}
+ isLoadingComplete
visibleTimelineEvents={visibleTimelineEvents}
onClose={jest.fn()}
timelines={timelines}
@@ -127,9 +128,6 @@ describe("AIQuestionAnalysisSidebar", () => {
{
storeInitialState: {
settings: mockSettings({ "llm-metabot-configured?": true }),
- qb: createMockQueryBuilderState({
- queryStatus: "complete",
- }),
},
},
);
@@ -160,14 +158,15 @@ describe("AIQuestionAnalysisSidebar", () => {
const question = new Question(createMockCard());
renderWithProviders(
- <AIQuestionAnalysisSidebar question={question} onClose={jest.fn()} />,
+ <AIAnalysisSidebar
+ question={question}
+ isLoadingComplete
+ onClose={jest.fn()}
+ />,
{
storeInitialState: {
currentUser: createMockUser({ is_superuser: true }),
settings: mockSettings({ "llm-metabot-configured?": false }),
- qb: createMockQueryBuilderState({
- queryStatus: "complete",
- }),
},
},
);
diff --git a/frontend/src/metabase/metabot/components/AIAnalysisSidebar/index.ts b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/index.ts
new file mode 100644
index 00000000000..8a48b01e189
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/index.ts
@@ -0,0 +1,2 @@
+export { AIAnalysisSidebar } from "./AIAnalysisSidebar";
+export type { AIAnalysisSidebarProps } from "./AIAnalysisSidebar";
diff --git a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/utils.ts b/frontend/src/metabase/metabot/components/AIAnalysisSidebar/utils.ts
similarity index 100%
rename from frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/utils.ts
rename to frontend/src/metabase/metabot/components/AIAnalysisSidebar/utils.ts
diff --git a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.module.css b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.module.css
similarity index 100%
rename from frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.module.css
rename to frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.module.css
diff --git a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
similarity index 88%
rename from frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx
rename to frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
index c860b20d9b8..b18fb34a029 100644
--- a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.tsx
@@ -11,11 +11,14 @@ import { useGetSuggestedMetabotPromptsQuery } from "metabase/api";
import { MetabotLogo } from "metabase/common/components/MetabotLogo";
import { useSetting } from "metabase/common/hooks";
import { AIProviderConfigurationModal } from "metabase/metabot/components/AIProviderConfigurationModal";
+import { AIProviderConfigurationNotice } from "metabase/metabot/components/AIProviderConfigurationNotice";
import { MetabotPromptInput } from "metabase/metabot/components/MetabotPromptInput";
-import { QueryBuilder } from "metabase/query_builder/containers/QueryBuilder";
-import { useDispatch, useSelector } from "metabase/redux";
+import {
+ useMetabotAgent,
+ useUserMetabotPermissions,
+} from "metabase/metabot/hooks";
+import { useDispatch } from "metabase/redux";
import { useRouter } from "metabase/router";
-import { getSettingsLoading } from "metabase/selectors/settings";
import {
ActionIcon,
Box,
@@ -27,10 +30,7 @@ import {
} from "metabase/ui";
import * as Urls from "metabase/urls";
-import { useMetabotAgent, useUserMetabotPermissions } from "../../hooks";
-import { AIProviderConfigurationNotice } from "../AIProviderConfigurationNotice";
-
-import S from "./MetabotQueryBuilder.module.css";
+import S from "./MetabotAsk.module.css";
const defaultSuggestionModels = [
"dataset",
@@ -59,7 +59,7 @@ const responseHasNavigateTo = (action: SubmitInputResult) =>
isMatching({ type: "navigate_to" }),
);
-const MetabotQueryBuilderInner = () => {
+export const MetabotAsk = () => {
const { canUseNlq } = useUserMetabotPermissions();
const [
isAiProviderConfigurationModalOpen,
@@ -275,20 +275,3 @@ const MetabotQueryBuilderInner = () => {
</Box>
);
};
-
-export const MetabotQueryBuilder = (
- props: React.ComponentProps<typeof QueryBuilder>,
-) => {
- const { hasNlqAccess, isLoading } = useUserMetabotPermissions();
- const areSettingsLoading = useSelector(getSettingsLoading);
- // Wait until settings and metabot permissions are both resolved before
- // deciding which view to render. Otherwise QueryBuilder may mount briefly
- // and rewrite the URL away from /question/ask, racing the metabot view.
- if (areSettingsLoading || isLoading) {
- return null;
- }
- if (!hasNlqAccess) {
- return <QueryBuilder {...props} />;
- }
- return <MetabotQueryBuilderInner />;
-};
diff --git a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.unit.spec.tsx b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.unit.spec.tsx
similarity index 87%
rename from frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.unit.spec.tsx
rename to frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.unit.spec.tsx
index ccc2d6aa3a2..caac17d5d4b 100644
--- a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/MetabotQueryBuilder.unit.spec.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotAsk/MetabotAsk.unit.spec.tsx
@@ -1,4 +1,3 @@
-import type { ComponentType } from "react";
import { Route } from "react-router";
import { setupBookmarksEndpoints } from "__support__/server-mocks";
@@ -11,7 +10,7 @@ import {
} from "metabase/metabot/hooks";
import { createMockState } from "metabase/redux/store/mocks";
-import { MetabotQueryBuilder } from "./MetabotQueryBuilder";
+import { MetabotAsk } from "./MetabotAsk";
jest.mock("metabase/api", () => ({
...jest.requireActual("metabase/api"),
@@ -24,10 +23,6 @@ jest.mock("metabase/metabot/hooks", () => ({
useUserMetabotPermissions: jest.fn(),
}));
-// Hide the QueryBuilder prop type the wrapper inherits — it's irrelevant
-// since the canUseNlq path renders the inner component with no props.
-const TestSubject = MetabotQueryBuilder as ComponentType;
-
type SetupOptions = {
showIllustrations?: boolean;
prompt?: string;
@@ -65,13 +60,13 @@ function setup({
"metabot-show-illustrations": showIllustrations,
});
- return renderWithProviders(<Route path="/" component={TestSubject} />, {
+ return renderWithProviders(<Route path="/" component={MetabotAsk} />, {
withRouter: true,
storeInitialState: createMockState({ settings }),
});
}
-describe("MetabotQueryBuilder", () => {
+describe("MetabotAsk", () => {
beforeEach(() => {
jest.clearAllMocks();
});
diff --git a/frontend/src/metabase/metabot/components/MetabotAsk/index.ts b/frontend/src/metabase/metabot/components/MetabotAsk/index.ts
new file mode 100644
index 00000000000..d3040bca04b
--- /dev/null
+++ b/frontend/src/metabase/metabot/components/MetabotAsk/index.ts
@@ -0,0 +1 @@
+export { MetabotAsk } from "./MetabotAsk";
diff --git a/frontend/src/metabase/query_builder/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx b/frontend/src/metabase/query_builder/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx
new file mode 100644
index 00000000000..dd140a8317c
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/AIQuestionAnalysisSidebar/AIQuestionAnalysisSidebar.tsx
@@ -0,0 +1,18 @@
+import {
+ AIAnalysisSidebar,
+ type AIAnalysisSidebarProps,
+} from "metabase/metabot/components/AIAnalysisSidebar";
+import { getIsLoadingComplete } from "metabase/query_builder/selectors";
+import { useSelector } from "metabase/redux";
+
+export type AIQuestionAnalysisSidebarProps = Omit<
+ AIAnalysisSidebarProps,
+ "isLoadingComplete"
+>;
+
+export function AIQuestionAnalysisSidebar(
+ props: AIQuestionAnalysisSidebarProps,
+) {
+ const isLoadingComplete = useSelector(getIsLoadingComplete);
+ return <AIAnalysisSidebar {...props} isLoadingComplete={isLoadingComplete} />;
+}
diff --git a/frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/index.ts b/frontend/src/metabase/query_builder/components/AIQuestionAnalysisSidebar/index.ts
similarity index 100%
rename from frontend/src/metabase/metabot/components/AIQuestionAnalysisSidebar/index.ts
rename to frontend/src/metabase/query_builder/components/AIQuestionAnalysisSidebar/index.ts
diff --git a/frontend/src/metabase/query_builder/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx b/frontend/src/metabase/query_builder/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx
new file mode 100644
index 00000000000..a957e82f0e5
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/MetabotQueryBuilder/MetabotQueryBuilder.tsx
@@ -0,0 +1,27 @@
+import { MetabotAsk } from "metabase/metabot/components/MetabotAsk";
+import { useUserMetabotPermissions } from "metabase/metabot/hooks";
+import { QueryBuilder } from "metabase/query_builder/containers/QueryBuilder";
+import { useSelector } from "metabase/redux";
+import { getSettingsLoading } from "metabase/selectors/settings";
+
+/**
+ * Routes /question/ask to either the Metabot NLQ prompt view or the regular QueryBuilder, depending on NLQ access.
+ */
+export const MetabotQueryBuilder = (
+ props: React.ComponentProps<typeof QueryBuilder>,
+) => {
+ const { hasNlqAccess, isLoading } = useUserMetabotPermissions();
+ const areSettingsLoading = useSelector(getSettingsLoading);
+ // Wait until settings and metabot permissions are both resolved before
+ // deciding which view to render. Otherwise QueryBuilder may mount briefly
+ // and rewrite the URL away from /question/ask, racing the metabot view.
+ if (areSettingsLoading || isLoading) {
+ return null;
+ }
+
+ if (!hasNlqAccess) {
+ return <QueryBuilder {...props} />;
+ }
+
+ return <MetabotAsk />;
+};
diff --git a/frontend/src/metabase/metabot/components/MetabotQueryBuilder/index.ts b/frontend/src/metabase/query_builder/components/MetabotQueryBuilder/index.ts
similarity index 100%
rename from frontend/src/metabase/metabot/components/MetabotQueryBuilder/index.ts
rename to frontend/src/metabase/query_builder/components/MetabotQueryBuilder/index.ts
diff --git a/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx b/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
index b39bfa2e6b5..f7158adee9f 100644
--- a/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
+++ b/frontend/src/metabase/query_builder/components/view/View/NativeQueryRightSidebar/NativeQueryRightSidebar.tsx
@@ -1,7 +1,7 @@
import { match } from "ts-pattern";
-import { AIQuestionAnalysisSidebar } from "metabase/metabot/components/AIQuestionAnalysisSidebar";
import { setTemplateTagConfig } from "metabase/query_builder/actions";
+import { AIQuestionAnalysisSidebar } from "metabase/query_builder/components/AIQuestionAnalysisSidebar";
import { QuestionInfoSidebar } from "metabase/query_builder/components/view/sidebars/QuestionInfoSidebar";
import { QuestionSettingsSidebar } from "metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar";
import { TimelineSidebar } from "metabase/query_builder/components/view/sidebars/TimelineSidebar";
diff --git a/frontend/src/metabase/query_builder/components/view/View/StructuredQueryRightSidebar/StructuredQueryRightSidebar.jsx b/frontend/src/metabase/query_builder/components/view/View/StructuredQueryRightSidebar/StructuredQueryRightSidebar.jsx
index a8a920c2374..e110d3c30b6 100644
--- a/frontend/src/metabase/query_builder/components/view/View/StructuredQueryRightSidebar/StructuredQueryRightSidebar.jsx
+++ b/frontend/src/metabase/query_builder/components/view/View/StructuredQueryRightSidebar/StructuredQueryRightSidebar.jsx
@@ -1,6 +1,6 @@
import { match } from "ts-pattern";
-import { AIQuestionAnalysisSidebar } from "metabase/metabot/components/AIQuestionAnalysisSidebar";
+import { AIQuestionAnalysisSidebar } from "metabase/query_builder/components/AIQuestionAnalysisSidebar";
import { QuestionInfoSidebar } from "metabase/query_builder/components/view/sidebars/QuestionInfoSidebar";
import { QuestionSettingsSidebar } from "metabase/query_builder/components/view/sidebars/QuestionSettingsSidebar";
import { SummarizeSidebar } from "metabase/query_builder/components/view/sidebars/SummarizeSidebar";
diff --git a/frontend/src/metabase/routes.tsx b/frontend/src/metabase/routes.tsx
index 4224709f333..1fc367cec7d 100644
--- a/frontend/src/metabase/routes.tsx
+++ b/frontend/src/metabase/routes.tsx
@@ -37,7 +37,6 @@ import { DocumentPageOuter } from "metabase/documents/routes";
import { ModalRoute } from "metabase/hoc/ModalRoute";
import { HomePage } from "metabase/home/components/HomePage";
import { Onboarding } from "metabase/home/components/Onboarding";
-import { MetabotQueryBuilder } from "metabase/metabot/components/MetabotQueryBuilder";
import { getMetabotRoutes } from "metabase/metabot/routes";
import { getMetricRoutes } from "metabase/metrics/routes";
import { MetricsViewerPage } from "metabase/metrics-viewer";
@@ -49,6 +48,7 @@ import {
PLUGIN_TABLE_EDITING,
PLUGIN_TENANTS,
} from "metabase/plugins";
+import { MetabotQueryBuilder } from "metabase/query_builder/components/MetabotQueryBuilder";
import { QueryBuilder } from "metabase/query_builder/containers/QueryBuilder";
import type { State } from "metabase/redux/store";
import { loadCurrentUser } from "metabase/redux/user";