Skip to content

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

Add toggle to enable/disable the Metabot (#70111)

Oleksandr Solovyov94309cd070cd
diff --git a/.clj-kondo/src/hooks/metabase/settings/models/setting.clj b/.clj-kondo/src/hooks/metabase/settings/models/setting.clj
index e99ef5bada7..d31472af446 100644
--- a/.clj-kondo/src/hooks/metabase/settings/models/setting.clj
+++ b/.clj-kondo/src/hooks/metabase/settings/models/setting.clj
@@ -55,7 +55,6 @@
help-link-custom-destination
instance-creation
is-hosted?
- is-metabot-enabled
jdbc-data-warehouse-max-connection-pool-size
jdbc-data-warehouse-unreturned-connection-timeout-seconds
jwt-attribute-email
diff --git a/e2e/support/helpers/api/updateSetting.ts b/e2e/support/helpers/api/updateSetting.ts
index 706418e7156..92a1f20e596 100644
--- a/e2e/support/helpers/api/updateSetting.ts
+++ b/e2e/support/helpers/api/updateSetting.ts
@@ -7,7 +7,11 @@ export const updateSetting = <
setting: TKey,
value: TValue,
): Cypress.Chainable<Cypress.Response<never>> => {
- return cy.request<never>("PUT", `/api/setting/${setting}`, { value });
+ return cy.request<never>(
+ "PUT",
+ `/api/setting/${encodeURIComponent(setting)}`,
+ { value },
+ );
};
export const updateEnterpriseSetting = <
diff --git a/e2e/support/helpers/e2e-embedding-helpers.js b/e2e/support/helpers/e2e-embedding-helpers.js
index cd70fb4b84a..bd82586d197 100644
--- a/e2e/support/helpers/e2e-embedding-helpers.js
+++ b/e2e/support/helpers/e2e-embedding-helpers.js
@@ -359,7 +359,7 @@ export function createPublicDocumentLink(documentId) {
/**
* @param {Object} options
* @param {string} options.url
- * @param {import("metabase-types/store").InteractiveEmbeddingOptions} options.qs
+ * @param {Partial<import("metabase-types/store").InteractiveEmbeddingOptions>} options.qs
* @param {Function} [options.onBeforeLoad]
*/
export const visitFullAppEmbeddingUrl = ({ url, qs, onBeforeLoad }) => {
diff --git a/e2e/test-component/scenarios/embedding-sdk/metabot-question.cy.spec.tsx b/e2e/test-component/scenarios/embedding-sdk/metabot-question.cy.spec.tsx
index 0079611800c..f0ee539bfcb 100644
--- a/e2e/test-component/scenarios/embedding-sdk/metabot-question.cy.spec.tsx
+++ b/e2e/test-component/scenarios/embedding-sdk/metabot-question.cy.spec.tsx
@@ -313,6 +313,27 @@ describe("scenarios > embedding-sdk > metabot-question", () => {
});
});
+describe("scenarios > embedding-sdk > metabot-question > enablement", () => {
+ it("should show an error when embedded-metabot-enabled? is false", () => {
+ signInAsAdminAndEnableEmbeddingSdk();
+
+ cy.log("Disable embedded metabot");
+ H.updateEnterpriseSettings({ "embedded-metabot-enabled?": false });
+
+ cy.signOut();
+ mockAuthProviderAndJwtSignIn();
+
+ mountSdkContent(<MetabotQuestion />);
+
+ getSdkRoot().within(() => {
+ cy.findByText("Metabot is not enabled for embedded analytics.").should(
+ "be.visible",
+ );
+ cy.findByTestId("metabot-question-container").should("not.exist");
+ });
+ });
+});
+
const mockSuggestedPrompts = () => {
cy.intercept(
"GET",
diff --git a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
index cf5bee1804c..a6b723864fe 100644
--- a/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
+++ b/e2e/test/scenarios/embedding/sdk-iframe-embedding/custom-elements-api.cy.spec.ts
@@ -549,6 +549,22 @@ describe("scenarios > embedding > sdk iframe embedding > custom elements api", (
});
});
});
+
+ it("should not render metabot when embedded-metabot-enabled? is false", () => {
+ H.updateSetting("embedded-metabot-enabled?", false);
+
+ H.visitCustomHtmlPage(`
+ ${H.getNewEmbedScriptTag()}
+ ${H.getNewEmbedConfigurationScript()}
+ <metabase-metabot />
+ `);
+
+ H.getSimpleEmbedIframeContent().within(() => {
+ // When embedded metabot is disabled, the component should not render the chat interface
+ cy.findByText("Ask questions to AI.").should("not.exist");
+ cy.findByPlaceholderText("Ask AI a question...").should("not.exist");
+ });
+ });
});
describe("common checks", () => {
diff --git a/e2e/test/scenarios/metabot/metabot-query-builder.cy.spec.ts b/e2e/test/scenarios/metabot/metabot-query-builder.cy.spec.ts
index e6a85980ddd..575d381e115 100644
--- a/e2e/test/scenarios/metabot/metabot-query-builder.cy.spec.ts
+++ b/e2e/test/scenarios/metabot/metabot-query-builder.cy.spec.ts
@@ -45,6 +45,26 @@ describe("Metabot Query Builder", () => {
cy.intercept("POST", "/api/ee/metabot-v3/agent-streaming").as("agentReq");
});
+ it("should redirect to notebook when metabot-enabled? is false", () => {
+ H.updateSetting("metabot-enabled?", false);
+
+ cy.log(
+ "visiting '/question/ask' should redirect to notebook when metabot is disabled",
+ );
+ cy.visit("/question/ask");
+ cy.url().should("include", "/question#");
+ cy.findByTestId("metabot-send-message").should("not.exist");
+ });
+
+ it("should not show AI exploration in new button when metabot is disabled", () => {
+ H.updateSetting("metabot-enabled?", false);
+ cy.visit("/");
+
+ cy.log("'AI exploration' option should not appear in new button");
+ H.newButton().click();
+ H.popover().findByText("AI exploration").should("not.exist");
+ });
+
it("should be able to successfully generate a notebook query", () => {
// visit home page
cy.visit("/");
diff --git a/e2e/test/scenarios/metabot/metabot.cy.spec.ts b/e2e/test/scenarios/metabot/metabot.cy.spec.ts
index c336cb13ee5..3351c6dcd8e 100644
--- a/e2e/test/scenarios/metabot/metabot.cy.spec.ts
+++ b/e2e/test/scenarios/metabot/metabot.cy.spec.ts
@@ -223,7 +223,51 @@ d:{"finishReason":"stop","usage":{"promptTokens":4916,"completionTokens":8}}`,
H.assertChatVisibility("visible");
H.lastChatMessage().should("have.text", "You, but don't tell anyone.");
});
+
+ it("should not submit a prompt via /metabot/new when metabot is disabled", () => {
+ H.updateSetting("metabot-enabled?", false);
+ cy.visit("/metabot/new?q=Who%20is%20your%20favorite%3F");
+ cy.url().should("eq", Cypress.config().baseUrl + "/");
+ H.assertChatVisibility("not.visible");
+ cy.get("@agentReq.all").should("have.length", 0);
+ });
+ });
+ });
+});
+
+describe("Metabot in full-app embedding", () => {
+ beforeEach(() => {
+ H.restore();
+ cy.signInAsAdmin();
+ H.activateToken("bleeding-edge");
+ });
+
+ it("should show the metabot button when embedded-metabot-enabled? is true", () => {
+ H.updateEnterpriseSettings({ "embedded-metabot-enabled?": true });
+
+ H.visitFullAppEmbeddingUrl({
+ url: `/question/${ORDERS_BY_YEAR_QUESTION_ID}`,
+ qs: {},
+ });
+
+ H.appBar().icon("metabot").should("be.visible");
+ cy.findByLabelText("Explain this chart").should("not.exist");
+ });
+
+ it("should not show the metabot button when embedded-metabot-enabled? is false", () => {
+ H.updateEnterpriseSettings({ "embedded-metabot-enabled?": false });
+
+ H.visitFullAppEmbeddingUrl({
+ url: `/question/${ORDERS_BY_YEAR_QUESTION_ID}`,
+ qs: {},
});
+
+ cy.log("Wait for the question to render");
+ H.main().findByText("Filter").should("be.visible");
+
+ cy.log("Assert metabot buttons are not rendered");
+ H.appBar().icon("metabot").should("not.exist");
+ cy.findByLabelText("Explain this chart").should("not.exist");
});
});
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
index d0c13a6b1f8..f719e2ff99e 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/api.clj
@@ -10,6 +10,7 @@
[metabase-enterprise.metabot-v3.config :as metabot-v3.config]
[metabase-enterprise.metabot-v3.context :as metabot-v3.context]
[metabase-enterprise.metabot-v3.envelope :as metabot-v3.envelope]
+ [metabase-enterprise.metabot-v3.settings :as metabot-v3.settings]
[metabase-enterprise.metabot-v3.util :as metabot-v3.u]
[metabase.api.common :as api]
[metabase.api.macros :as api.macros]
@@ -50,11 +51,21 @@
(map #(+ (:prompt %) (:completion %)))
(apply +))})))
+(defn- check-metabot-enabled!
+ "Checks that the Metabot instance identified by `metabot-id` is enabled. Throws a 403 if it's not."
+ [metabot-id]
+ (if (= metabot-id metabot-v3.config/embedded-metabot-id)
+ (api/check (metabot-v3.settings/embedded-metabot-enabled?)
+ [403 "Embedded Metabot is not enabled."])
+ (api/check (metabot-v3.settings/metabot-enabled?)
+ [403 "Metabot is not enabled."])))
+
(defn streaming-request
"Handles an incoming request, making all required tool invocation, LLM call loops, etc."
[{:keys [metabot_id profile_id message context history conversation_id state]}]
(let [message (metabot-v3.envelope/user-message message)
metabot-id (metabot-v3.config/resolve-dynamic-metabot-id metabot_id)
+ _ (check-metabot-enabled! metabot-id)
profile-id (metabot-v3.config/resolve-dynamic-profile-id profile_id metabot-id)
session-id (metabot-v3.client/get-ai-service-token api/*current-user-id* metabot-id)]
(store-message! conversation_id profile-id [message])
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
index f965c44de86..dc80b6028b6 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/settings.clj
@@ -49,3 +49,21 @@
:encryption :no
:export? false
:doc false)
+
+(defsetting metabot-enabled?
+ (deferred-tru "Whether Metabot is enabled for regular usage.")
+ :type :boolean
+ :visibility :public
+ :default true
+ :feature :metabot-v3
+ :export? true
+ :doc false)
+
+(defsetting embedded-metabot-enabled?
+ (deferred-tru "Whether Metabot is enabled for embedding.")
+ :type :boolean
+ :visibility :public
+ :default true
+ :feature :metabot-v3
+ :export? true
+ :doc false)
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
index bf673620035..00554794ebf 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/api_test.clj
@@ -9,6 +9,7 @@
[metabase-enterprise.metabot-v3.api :as api]
[metabase-enterprise.metabot-v3.client :as client]
[metabase-enterprise.metabot-v3.client-test :as client-test]
+ [metabase-enterprise.metabot-v3.config :as metabot-v3.config]
[metabase-enterprise.metabot-v3.util :as metabot.u]
[metabase.search.test-util :as search.tu]
[metabase.server.instance :as server.instance]
@@ -166,3 +167,65 @@
(testing "Throws when premium token is missing"
(mt/with-temporary-setting-values [premium-embedding-token nil]
(mt/user-http-request :rasta :post 400 "ee/metabot-v3/feedback" {:foo "bar"})))))))
+
+(deftest metabot-enabled-setting-test
+ (mt/with-premium-features #{:metabot-v3}
+ (let [mock-response (client-test/make-mock-text-stream-response
+ ["Hello"] {"m" {:prompt 1 :completion 1}})
+ conversation-id (str (random-uuid))
+ base-request {:message "Test"
+ :context {}
+ :conversation_id conversation-id
+ :history []
+ :state {}}]
+ (mt/with-dynamic-fn-redefs [client/post! (fn [url opts]
+ ((client-test/mock-post! mock-response) url opts))]
+ (testing "Regular metabot is blocked when metabot-enabled is false"
+ (mt/with-temporary-setting-values [metabot-enabled? false]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 403 "ee/metabot-v3/agent-streaming"
+ base-request))))
+
+ (testing "Regular metabot works when metabot-enabled is true"
+ (mt/with-temporary-setting-values [metabot-enabled? true]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 202 "ee/metabot-v3/agent-streaming"
+ (assoc base-request :conversation_id (str (random-uuid)))))))
+
+ (testing "Embedded metabot is blocked when embedded-metabot-enabled? is false"
+ (mt/with-temporary-setting-values [embedded-metabot-enabled? false]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 403 "ee/metabot-v3/agent-streaming"
+ (assoc base-request
+ :metabot_id metabot-v3.config/embedded-metabot-id
+ :conversation_id (str (random-uuid)))))))
+
+ (testing "Embedded metabot works when embedded-metabot-enabled? is true"
+ (mt/with-temporary-setting-values [embedded-metabot-enabled? true]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 202 "ee/metabot-v3/agent-streaming"
+ (assoc base-request
+ :metabot_id metabot-v3.config/embedded-metabot-id
+ :conversation_id (str (random-uuid)))))))
+
+ (testing "Regular metabot still works when only embedded is disabled"
+ (mt/with-temporary-setting-values [metabot-enabled? true
+ embedded-metabot-enabled? false]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 202 "ee/metabot-v3/agent-streaming"
+ (assoc base-request :conversation_id (str (random-uuid)))))))
+
+ (testing "Embedded metabot still works when only regular is disabled"
+ (mt/with-temporary-setting-values [metabot-enabled? false
+ embedded-metabot-enabled? true]
+ (mt/with-model-cleanup [:model/MetabotMessage
+ [:model/MetabotConversation :created_at]]
+ (mt/user-http-request :rasta :post 202 "ee/metabot-v3/agent-streaming"
+ (assoc base-request
+ :metabot_id metabot-v3.config/embedded-metabot-id
+ :conversation_id (str (random-uuid)))))))))))
diff --git a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.tsx b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.tsx
index fed87506f3e..a5692361bb8 100644
--- a/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.tsx
+++ b/enterprise/frontend/src/embedding-sdk-ee/metabot/MetabotQuestion.tsx
@@ -1,13 +1,18 @@
import { useElementSize } from "@mantine/hooks";
import { useId, useMemo } from "react";
import { P, match } from "ts-pattern";
+import { t } from "ttag";
-import { withPublicComponentWrapper } from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
+import {
+ SdkError,
+ withPublicComponentWrapper,
+} from "embedding-sdk-bundle/components/private/PublicComponentWrapper";
import { ResizeWrapper } from "embedding-sdk-bundle/components/private/ResizeWrapper";
import { SdkAdHocQuestion } from "embedding-sdk-bundle/components/private/SdkAdHocQuestion";
import { SdkQuestionDefaultView } from "embedding-sdk-bundle/components/private/SdkQuestionDefaultView";
import { METABOT_SDK_EE_PLUGIN } from "embedding-sdk-bundle/components/public/MetabotQuestion/MetabotQuestion";
import { EnsureSingleInstance } from "embedding-sdk-shared/components/EnsureSingleInstance/EnsureSingleInstance";
+import { useSetting } from "metabase/common/hooks";
import { useLocale } from "metabase/common/hooks/use-locale";
import { Stack } from "metabase/ui";
import { useMetabotReactions } from "metabase-enterprise/metabot/hooks/use-metabot-reactions";
@@ -39,6 +44,7 @@ const MetabotQuestionInner = ({
isSaveEnabled = false,
targetCollection,
}: MetabotQuestionProps) => {
+ const isEmbeddedMetabotEnabled = useSetting("embedded-metabot-enabled?");
const { isLocaleLoading } = useLocale();
const { navigateToPath } = useMetabotReactions();
const { ref: containerRef, width: containerWidth } = useElementSize();
@@ -61,6 +67,12 @@ const MetabotQuestionInner = ({
});
}, [layout, containerWidth]);
+ if (isEmbeddedMetabotEnabled === false) {
+ return (
+ <SdkError message={t`Metabot is not enabled for embedded analytics.`} />
+ );
+ }
+
function renderQuestion() {
if (!hasQuestion || isLocaleLoading) {
return <MetabotQuestionEmptyState />;
diff --git a/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.tsx b/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.tsx
index fd8f5e72a4e..a294c378e14 100644
--- a/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.tsx
@@ -1,13 +1,19 @@
import { t } from "ttag";
import { ToolbarButton } from "metabase/common/components/ToolbarButton";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { useMetabotAgent } from "metabase-enterprise/metabot/hooks";
import { trackExplainChartClicked } from "../analytics";
export const AIQuestionAnalysisButton = () => {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const { submitInput } = useMetabotAgent("omnibot");
+ if (!isMetabotEnabled) {
+ return null;
+ }
+
const handleClick = () => {
trackExplainChartClicked();
submitInput("Analyze this chart");
diff --git a/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.unit.spec.tsx
new file mode 100644
index 00000000000..42ad164f12c
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/ai-entity-analysis/components/AIQuestionAnalysisButton.unit.spec.tsx
@@ -0,0 +1,86 @@
+import { combineReducers } from "@reduxjs/toolkit";
+import userEvent from "@testing-library/user-event";
+
+import { setupEnterprisePlugins } from "__support__/enterprise";
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen, waitFor } from "__support__/ui";
+import { mockStreamedEndpoint } from "metabase-enterprise/api/ai-streaming/test-utils";
+import { MetabotProvider } from "metabase-enterprise/metabot/context";
+import { metabotReducer } from "metabase-enterprise/metabot/state";
+import { getMetabotInitialState } from "metabase-enterprise/metabot/state/reducer-utils";
+import { createMockTokenFeatures } from "metabase-types/api/mocks";
+import { createMockState } from "metabase-types/store/mocks";
+
+import { AIQuestionAnalysisButton } from "./AIQuestionAnalysisButton";
+
+const mockAgentEndpoint = () =>
+ mockStreamedEndpoint("/api/ee/metabot-v3/agent-streaming", {
+ textChunks: [
+ `0:"Here is an analysis of the chart."`,
+ `d:{"finishReason":"stop","usage":{"promptTokens":100,"completionTokens":10}}`,
+ ],
+ });
+
+function setup({
+ isMetabotEnabled = true,
+}: { isMetabotEnabled?: boolean } = {}) {
+ setupEnterprisePlugins();
+
+ const settings = mockSettings({
+ "metabot-enabled?": isMetabotEnabled,
+ "token-features": createMockTokenFeatures({
+ metabot_v3: true,
+ }),
+ });
+
+ const metabotState = getMetabotInitialState();
+
+ renderWithProviders(
+ <MetabotProvider>
+ <AIQuestionAnalysisButton />
+ </MetabotProvider>,
+ {
+ storeInitialState: createMockState({
+ settings,
+ plugins: {
+ metabotPlugin: metabotState,
+ },
+ } as any),
+ customReducers: {
+ plugins: combineReducers({
+ metabotPlugin: metabotReducer,
+ }),
+ },
+ },
+ );
+}
+
+describe("AIQuestionAnalysisButton", () => {
+ it("should render the button when metabot is enabled", () => {
+ setup({ isMetabotEnabled: true });
+ expect(
+ screen.getByRole("button", { name: "Explain this chart" }),
+ ).toBeInTheDocument();
+ });
+
+ it("should not render the button when metabot is disabled", () => {
+ setup({ isMetabotEnabled: false });
+ expect(
+ screen.queryByRole("button", { name: "Explain this chart" }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should submit analyze prompt when clicked", async () => {
+ const agentSpy = mockAgentEndpoint();
+ setup({ isMetabotEnabled: true });
+
+ await userEvent.click(
+ screen.getByRole("button", { name: "Explain this chart" }),
+ );
+
+ await waitFor(() => expect(agentSpy).toHaveBeenCalled());
+ const lastCall = agentSpy.mock.lastCall;
+ const body = JSON.parse(lastCall?.[1]?.body as string);
+ expect(body.message).toBe("Analyze this chart");
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.tsx b/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.tsx
index e2c340492b7..c0542d73887 100644
--- a/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.tsx
@@ -1,5 +1,6 @@
import { t } from "ttag";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { Button } from "metabase/ui";
import { useMetabotAgent } from "metabase-enterprise/metabot/hooks";
@@ -14,8 +15,13 @@ export function FixSqlQueryButton({
rawSql,
errorMessage,
}: FixSqlQueryButtonProps) {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const { submitInput } = useMetabotAgent("omnibot");
+ if (!isMetabotEnabled) {
+ return null;
+ }
+
const handleClick = () => {
trackQueryFixClicked();
const promptParts = ["Fix this SQL query"];
diff --git a/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.unit.spec.tsx
index 11a09a6df76..b38ac93cc6a 100644
--- a/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/ai-sql-fixer/components/FixSqlQueryButton/FixSqlQueryButton.unit.spec.tsx
@@ -1,6 +1,9 @@
import userEvent from "@testing-library/user-event";
+import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen } from "__support__/ui";
+import { createMockTokenFeatures } from "metabase-types/api/mocks";
+import { createMockState } from "metabase-types/store/mocks";
import { FixSqlQueryButton } from "./FixSqlQueryButton";
@@ -12,8 +15,19 @@ jest.mock("metabase-enterprise/metabot/hooks", () => ({
}),
}));
-function setup() {
- renderWithProviders(<FixSqlQueryButton />);
+function setup({
+ isMetabotEnabled = true,
+}: { isMetabotEnabled?: boolean } = {}) {
+ const settings = mockSettings({
+ "metabot-enabled?": isMetabotEnabled,
+ "token-features": createMockTokenFeatures({
+ metabot_v3: true,
+ }),
+ });
+
+ renderWithProviders(<FixSqlQueryButton />, {
+ storeInitialState: createMockState({ settings }),
+ });
}
describe("FixSqlQueryButton", () => {
@@ -21,15 +35,22 @@ describe("FixSqlQueryButton", () => {
jest.clearAllMocks();
});
- it("should render the button with correct text", () => {
- setup();
+ it("should render the button with correct text when metabot is enabled", () => {
+ setup({ isMetabotEnabled: true });
expect(
screen.getByRole("button", { name: /Have Metabot fix it/ }),
).toBeInTheDocument();
});
+ it("should not render the button when metabot is disabled", () => {
+ setup({ isMetabotEnabled: false });
+ expect(
+ screen.queryByRole("button", { name: /Have Metabot fix it/ }),
+ ).not.toBeInTheDocument();
+ });
+
it("should submit a prompt to the metabot agent when clicked", async () => {
- setup();
+ setup({ isMetabotEnabled: true });
await userEvent.click(
screen.getByRole("button", { name: /Have Metabot fix it/ }),
diff --git a/enterprise/frontend/src/metabase-enterprise/data-studio/workspaces/pages/WorkspacePage/useWorkspaceMetabot.ts b/enterprise/frontend/src/metabase-enterprise/data-studio/workspaces/pages/WorkspacePage/useWorkspaceMetabot.ts
index 1a18da06dcb..b5eb890fdfd 100644
--- a/enterprise/frontend/src/metabase-enterprise/data-studio/workspaces/pages/WorkspacePage/useWorkspaceMetabot.ts
+++ b/enterprise/frontend/src/metabase-enterprise/data-studio/workspaces/pages/WorkspacePage/useWorkspaceMetabot.ts
@@ -6,7 +6,7 @@ import { useLazyGetTransformQuery } from "metabase/api";
import { useDispatch } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
import { useRegisterMetabotContextProvider } from "metabase/metabot";
-import { PLUGIN_METABOT } from "metabase/plugins";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { getIsWorkspace } from "metabase/selectors/routing";
import { METABOT_PROFILE_OVERRIDES } from "metabase-enterprise/metabot/constants";
import type {
@@ -98,7 +98,7 @@ export function useWorkspaceMetabot({
patchEditedTransform,
} = useWorkspace();
- const isMetabotAvailable = PLUGIN_METABOT.isEnabled();
+ const isMetabotAvailable = useMetabotEnabledEmbeddingAware();
const { navigateToPath, setNavigateToPath } = useMetabotReactions();
const {
resetConversation: resetMetabotConversation,
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/Metabot.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/Metabot.tsx
index 4d10a734f1a..23d946952ba 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/Metabot.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/Metabot.tsx
@@ -5,6 +5,7 @@ import { t } from "ttag";
import MetabotFailure from "assets/img/metabot-failure.svg?component";
import ErrorBoundary from "metabase/ErrorBoundary";
import { useSelector } from "metabase/lib/redux";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { Sidebar } from "metabase/nav/containers/MainNavbar/MainNavbar.styled";
import type { SuggestionModel } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import { getUser } from "metabase/selectors/user";
@@ -108,11 +109,12 @@ export const MetabotAuthenticated = ({ hide, config }: MetabotProps) => {
export const Metabot = (props: MetabotProps) => {
const currentUser = useSelector(getUser);
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
// NOTE: do not render Metabot if the user is not authenticated.
// doing so will cause a redirect for unauthenticated requests
// which will break interactive embedding. See (metabase#58687).
- if (!currentUser) {
+ if (!currentUser || !isMetabotEnabled) {
return null;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.tsx
index 7ae606d5820..4f02cd7a11f 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.tsx
@@ -1,4 +1,5 @@
import { useDisclosure } from "@mantine/hooks";
+import type { ReactNode } from "react";
import { useEffect, useMemo } from "react";
import { IndexRoute, Route } from "react-router";
import { push } from "react-router-redux";
@@ -14,6 +15,7 @@ import {
import { SettingsSection } from "metabase/admin/components/SettingsSection";
import { SettingHeader } from "metabase/admin/settings/components/SettingHeader";
import { skipToken, useGetCollectionQuery } from "metabase/api";
+import { useAdminSetting } from "metabase/api/utils/settings";
import { canonicalCollectionId } from "metabase/collections/utils";
import { AdminSettingsLayout } from "metabase/common/components/AdminLayout/AdminSettingsLayout";
import { LoadingAndErrorWrapper } from "metabase/common/components/LoadingAndErrorWrapper";
@@ -43,6 +45,7 @@ import { hasPremiumFeature } from "metabase-enterprise/settings";
import type {
Collection,
CollectionEssentials,
+ EnterpriseSettingKey,
MetabotInfo,
} from "metabase-types/api";
@@ -80,6 +83,10 @@ export function MetabotAdminPage() {
const isEmbedMetabot =
metabot.entity_id === FIXED_METABOT_ENTITY_IDS.EMBEDDED;
+ const enabledSettingKey: EnterpriseSettingKey = isEmbedMetabot
+ ? "embedded-metabot-enabled?"
+ : "metabot-enabled?";
+
return (
<AdminSettingsLayout sidebar={<MetabotNavPane />}>
<ErrorBoundary>
@@ -97,20 +104,26 @@ export function MetabotAdminPage() {
{t`If you're embedding the Metabot component in an app, you can specify a different collection that embedded Metabot is allowed to use for creating queries.`}
</Text>
)}
+ <MetabotEnabledToggle
+ settingKey={enabledSettingKey}
+ isEmbedMetabot={isEmbedMetabot}
+ />
</Box>
- <MetabotVerifiedContentConfigurationPane metabot={metabot} />
+ <MetabotSettingsBody settingKey={enabledSettingKey}>
+ <MetabotVerifiedContentConfigurationPane metabot={metabot} />
- <MetabotCollectionConfigurationPane
- metabot={metabot}
- title={
- isEmbedMetabot
- ? undefined
- : t`Collection for natural language querying`
- }
- />
+ <MetabotCollectionConfigurationPane
+ metabot={metabot}
+ title={
+ isEmbedMetabot
+ ? undefined
+ : t`Collection for natural language querying`
+ }
+ />
- <MetabotPromptSuggestionPane metabot={metabot} />
+ <MetabotPromptSuggestionPane metabot={metabot} />
+ </MetabotSettingsBody>
</SettingsSection>
</ErrorBoundary>
</AdminSettingsLayout>
@@ -152,6 +165,78 @@ function MetabotNavPane() {
);
}
+function MetabotEnabledToggle({
+ settingKey,
+ isEmbedMetabot = false,
+}: {
+ settingKey: EnterpriseSettingKey;
+ isEmbedMetabot?: boolean;
+}) {
+ const { value, updateSetting, isLoading } = useAdminSetting(settingKey);
+
+ const handleToggle = async (checked: boolean) => {
+ await updateSetting({ key: settingKey, value: checked });
+ };
+
+ return (
+ <Box mt="lg">
+ <SettingHeader
+ id="enable-metabot"
+ title={isEmbedMetabot ? t`Enable Embedded Metabot` : t`Enable Metabot`}
+ description={
+ isEmbedMetabot
+ ? undefined
+ : t`Metabot is Metabase's AI assistant. When enabled, Metabot will be available to help users create queries, analyze data, and answer questions about your data.` // eslint-disable-line metabase/no-literal-metabase-strings -- admin UI
+ }
+ />
+ <Flex align="center" gap="md" mt="md">
+ <Switch
+ data-testid="metabot-enabled-toggle"
+ checked={!!value}
+ onChange={(e) => handleToggle(e.target.checked)}
+ disabled={isLoading}
+ w="auto"
+ size="sm"
+ />
+ <Text c={value ? "text-primary" : "text-secondary"} fw="500">
+ {isEmbedMetabot
+ ? value
+ ? t`Embedded Metabot is enabled`
+ : t`Embedded Metabot is disabled`
+ : value
+ ? t`Metabot is enabled`
+ : t`Metabot is disabled`}
+ </Text>
+ </Flex>
+ </Box>
+ );
+}
+
+function MetabotSettingsBody({
+ settingKey,
+ children,
+}: {
+ settingKey: EnterpriseSettingKey;
+ children: ReactNode;
+}) {
+ const { value } = useAdminSetting(settingKey);
+ const isDisabled = value === false;
+
+ return (
+ <Stack
+ gap="lg"
+ opacity={isDisabled ? 0.4 : 1}
+ aria-disabled={isDisabled || undefined}
+ style={{
+ pointerEvents: isDisabled ? "none" : "auto",
+ transition: "opacity 150ms ease",
+ }}
+ >
+ {children}
+ </Stack>
+ );
+}
+
function MetabotVerifiedContentConfigurationPane({
metabot,
}: {
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.unit.spec.tsx
index 3c434fe301b..bf66812ee4c 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.unit.spec.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAdmin/MetabotAdminPage.unit.spec.tsx
@@ -6,8 +6,11 @@ import {
findRequests,
setupCollectionByIdEndpoint,
setupCollectionsEndpoints,
+ setupPropertiesEndpoints,
setupRecentViewsAndSelectionsEndpoints,
setupRootCollectionItemsEndpoint,
+ setupSettingsEndpoints,
+ setupUpdateSettingEndpoint,
} from "__support__/server-mocks";
import {
setupMetabotPromptSuggestionsEndpoint,
@@ -20,6 +23,7 @@ import {
waitFor,
waitForLoaderToBeRemoved,
} from "__support__/ui";
+import { waitForRequest } from "__support__/utils";
import {
FIXED_METABOT_ENTITY_IDS,
FIXED_METABOT_IDS,
@@ -29,6 +33,7 @@ import type { MetabotId, RecentItem } from "metabase-types/api";
import {
createMockCollection,
createMockMetabotInfo,
+ createMockSettings,
} from "metabase-types/api/mocks";
import { MetabotAdminPage } from "./MetabotAdminPage";
@@ -95,9 +100,12 @@ const setup = async (
metabots = defaultMetabots,
seedCollections = defaultSeedCollections,
error = false,
+ settings = createMockSettings(),
) => {
mockGetBoundingClientRect();
mockPathParam(initialPathParam);
+ setupPropertiesEndpoints(settings);
+ setupSettingsEndpoints([]);
setupMetabotsEndpoints(metabots, error ? 500 : undefined);
setupCollectionByIdEndpoint({
collections: seedCollections.map((c: any) => ({ id: c.model_id, ...c })),
@@ -106,6 +114,7 @@ const setup = async (
setupCollectionsEndpoints({ collections: [] });
setupRecentViewsAndSelectionsEndpoints(seedCollections as RecentItem[]);
+ setupUpdateSettingEndpoint();
metabots.forEach((mb) =>
setupMetabotPromptSuggestionsEndpoint({
@@ -132,12 +141,34 @@ const setup = async (
}
};
+const enabledToggle = () => screen.findByTestId("metabot-enabled-toggle");
+
+const getLastSettingUpdateCall = (settingKey: string) =>
+ fetchMock.callHistory.lastCall(
+ `path:/api/setting/${encodeURIComponent(settingKey)}`,
+ );
+
describe("MetabotAdminPage", () => {
it("should render the page", async () => {
await setup();
expect(screen.getByText(/Configure Metabot/)).toBeInTheDocument();
});
+ it("should toggle default metabot enabled state", async () => {
+ await setup();
+
+ expect(await screen.findByText("Enable Metabot")).toBeInTheDocument();
+ expect(
+ await screen.findByText(/Metabot is Metabase's AI assistant/),
+ ).toBeInTheDocument();
+ expect(await screen.findByText("Metabot is enabled")).toBeInTheDocument();
+
+ await userEvent.click(await enabledToggle());
+ await waitForRequest(() => getLastSettingUpdateCall("metabot-enabled?"));
+ const call = getLastSettingUpdateCall("metabot-enabled?");
+ expect(call?.options?.body).toBe(JSON.stringify({ value: false }));
+ });
+
it("should render the metabots list", async () => {
await setup();
expect(await screen.findByText("Metabot")).toBeInTheDocument();
@@ -222,6 +253,26 @@ describe("MetabotAdminPage", () => {
).toBeInTheDocument();
});
+ it("should toggle embedded metabot enabled state", async () => {
+ await setup(FIXED_METABOT_IDS.EMBEDDED);
+
+ // Shows title but NOT description for embedded
+ expect(
+ await screen.findByText("Enable Embedded Metabot"),
+ ).toBeInTheDocument();
+ expect(
+ screen.queryByText(/Metabot is Metabase's AI assistant/),
+ ).not.toBeInTheDocument();
+
+ // Toggle calls correct setting
+ await userEvent.click(await enabledToggle());
+ await waitForRequest(() =>
+ getLastSettingUpdateCall("embedded-metabot-enabled?"),
+ );
+ const call = getLastSettingUpdateCall("embedded-metabot-enabled?");
+ expect(call?.options?.body).toBe(JSON.stringify({ value: false }));
+ });
+
it("should show an error message when a request fails", async () => {
await setup(404, defaultMetabots, defaultSeedCollections, true);
@@ -230,69 +281,67 @@ describe("MetabotAdminPage", () => {
).toBeInTheDocument();
});
- describe("MetabotVerifiedContentConfigurationPane", () => {
- const mockContentVerificationEnabled = (enabled: boolean) => {
- mockHasPremiumFeature.mockImplementation((feature) => {
- if (feature === "content_verification") {
- return enabled;
- }
- return true; // Mock other features as enabled by default
- });
- };
-
- it("should not show verification switch without content_verification feature", async () => {
- mockContentVerificationEnabled(false);
+ const mockContentVerificationEnabled = (enabled: boolean) => {
+ mockHasPremiumFeature.mockImplementation((feature) => {
+ if (feature === "content_verification") {
+ return enabled;
+ }
+ return true; // Mock other features as enabled by default
+ });
+ };
- await setup();
+ it("should not show verification switch without content_verification feature", async () => {
+ mockContentVerificationEnabled(false);
- // First ensure the page has loaded
- await screen.findByText(/Configure Metabot/);
+ await setup();
- expect(screen.queryByText("Verified content")).not.toBeInTheDocument();
- expect(
- screen.queryByText("Only use Verified content"),
- ).not.toBeInTheDocument();
- });
+ // First ensure the page has loaded
+ await screen.findByText(/Configure Metabot/);
- it("should show verification switch with content_verification feature", async () => {
- mockContentVerificationEnabled(true);
+ expect(screen.queryByText("Verified content")).not.toBeInTheDocument();
+ expect(
+ screen.queryByText("Only use Verified content"),
+ ).not.toBeInTheDocument();
+ });
- await setup();
+ it("should show verification switch with content_verification feature", async () => {
+ mockContentVerificationEnabled(true);
- expect(await screen.findByText("Verified content")).toBeInTheDocument();
- expect(
- await screen.findByText("Only use Verified content"),
- ).toBeInTheDocument();
- expect(
- await screen.findByRole("switch", {
- name: "Only use Verified content",
- }),
- ).toBeInTheDocument();
- });
+ await setup();
- it("should allow enabling/disabling verified switch affecting use_verified_content", async () => {
- mockContentVerificationEnabled(true);
+ expect(await screen.findByText("Verified content")).toBeInTheDocument();
+ expect(
+ await screen.findByText("Only use Verified content"),
+ ).toBeInTheDocument();
+ expect(
+ await screen.findByRole("switch", {
+ name: "Only use Verified content",
+ }),
+ ).toBeInTheDocument();
+ });
- await setup();
+ it("should allow enabling/disabling verified switch affecting use_verified_content", async () => {
+ mockContentVerificationEnabled(true);
- const verifiedSwitch = await screen.findByRole("switch", {
- name: "Only use Verified content",
- });
+ await setup();
- // Verify switch is initially unchecked (default metabot has use_verified_content: false)
- expect(verifiedSwitch).not.toBeChecked();
+ const verifiedSwitch = await screen.findByRole("switch", {
+ name: "Only use Verified content",
+ });
- // Click to enable
- await userEvent.click(verifiedSwitch);
+ // Verify switch is initially unchecked (default metabot has use_verified_content: false)
+ expect(verifiedSwitch).not.toBeChecked();
- // Verify API call was made with correct payload
- await waitFor(async () => {
- const putRequests = await findRequests("PUT");
- expect(putRequests.length).toBe(1);
- });
+ // Click to enable
+ await userEvent.click(verifiedSwitch);
+ // Verify API call was made with correct payload
+ await waitFor(async () => {
const putRequests = await findRequests("PUT");
- expect(putRequests[0].body).toEqual({ use_verified_content: true });
+ expect(putRequests.length).toBe(1);
});
+
+ const putRequests = await findRequests("PUT");
+ expect(putRequests[0].body).toEqual({ use_verified_content: true });
});
});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.tsx
index ab1a83c316f..863911187e4 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.tsx
@@ -1,6 +1,7 @@
import { t } from "ttag";
import { METAKEY } from "metabase/lib/browser";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { ActionIcon, type ActionIconProps, Icon, Tooltip } from "metabase/ui";
import { useMetabotAgent } from "metabase-enterprise/metabot/hooks";
@@ -14,8 +15,13 @@ export function MetabotAppBarButton({
className,
...rest
}: MetabotAppBarButtonProps) {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const metabot = useMetabotAgent("omnibot");
+ if (!isMetabotEnabled) {
+ return null;
+ }
+
const handleClick = () => {
if (!metabot.visible) {
trackMetabotChatOpened("header");
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.unit.spec.tsx
new file mode 100644
index 00000000000..11608ff9978
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotAppBarButton.unit.spec.tsx
@@ -0,0 +1,84 @@
+import { combineReducers } from "@reduxjs/toolkit";
+import userEvent from "@testing-library/user-event";
+
+import { setupEnterprisePlugins } from "__support__/enterprise";
+import { mockSettings } from "__support__/settings";
+import { renderWithProviders, screen } from "__support__/ui";
+import { createMockTokenFeatures } from "metabase-types/api/mocks";
+import { createMockState } from "metabase-types/store/mocks";
+
+import { MetabotProvider } from "../context";
+import { metabotReducer } from "../state";
+import { getMetabotInitialState } from "../state/reducer-utils";
+
+import { MetabotAppBarButton } from "./MetabotAppBarButton";
+
+function setup({
+ isMetabotEnabled = true,
+}: { isMetabotEnabled?: boolean } = {}) {
+ setupEnterprisePlugins();
+
+ const settings = mockSettings({
+ "metabot-enabled?": isMetabotEnabled,
+ "token-features": createMockTokenFeatures({
+ metabot_v3: true,
+ }),
+ });
+
+ const metabotState = getMetabotInitialState();
+
+ const { store } = renderWithProviders(
+ <MetabotProvider>
+ <MetabotAppBarButton />
+ </MetabotProvider>,
+ {
+ storeInitialState: createMockState({
+ settings,
+ plugins: {
+ metabotPlugin: metabotState,
+ },
+ } as any),
+ customReducers: {
+ plugins: combineReducers({
+ metabotPlugin: metabotReducer,
+ }),
+ },
+ },
+ );
+
+ return { store };
+}
+
+describe("MetabotAppBarButton", () => {
+ it("should render the button when metabot is enabled", () => {
+ setup({ isMetabotEnabled: true });
+ expect(
+ screen.getByRole("button", { name: /Chat with Metabot/ }),
+ ).toBeInTheDocument();
+ });
+
+ it("should not render the button when metabot is disabled", () => {
+ setup({ isMetabotEnabled: false });
+ expect(
+ screen.queryByRole("button", { name: /Chat with Metabot/ }),
+ ).not.toBeInTheDocument();
+ });
+
+ it("should toggle metabot visibility when clicked", async () => {
+ const { store } = setup({ isMetabotEnabled: true });
+
+ const initialState = store.getState() as any;
+ expect(
+ initialState.plugins.metabotPlugin.conversations.omnibot.visible,
+ ).toBe(false);
+
+ await userEvent.click(
+ screen.getByRole("button", { name: /Chat with Metabot/ }),
+ );
+
+ const newState = store.getState() as any;
+ expect(newState.plugins.metabotPlugin.conversations.omnibot.visible).toBe(
+ true,
+ );
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotDataStudioButton.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotDataStudioButton.tsx
index 48180065214..0a1381685db 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotDataStudioButton.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotDataStudioButton.tsx
@@ -3,6 +3,7 @@ import { t } from "ttag";
import { METAKEY } from "metabase/lib/browser";
import { useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { getLocation } from "metabase/selectors/routing";
import { ActionIcon, Icon, Tooltip } from "metabase/ui";
@@ -10,8 +11,14 @@ import { trackMetabotChatOpened } from "../analytics";
import { useMetabotAgent } from "../hooks";
export const MetabotDataStudioButton = () => {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const metabot = useMetabotAgent("omnibot");
const location = useSelector(getLocation);
+
+ if (!isMetabotEnabled) {
+ return null;
+ }
+
const disabled = !location.pathname?.startsWith(Urls.transformList());
const handleClick = () => {
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotQuickLinks.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotQuickLinks.tsx
index 7545e32906d..863b8d704d0 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotQuickLinks.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/MetabotQuickLinks.tsx
@@ -3,6 +3,7 @@ import { replace } from "react-router-redux";
import { useMount } from "react-use";
import { useDispatch } from "metabase/lib/redux";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { useMetabotAgent } from "metabase-enterprise/metabot/hooks";
export const getMetabotQuickLinks = () => {
@@ -11,6 +12,7 @@ export const getMetabotQuickLinks = () => {
key="metabot"
path="metabot/new"
component={(props) => {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const { submitInput } = useMetabotAgent("omnibot");
const prompt = String(props.location.query?.q ?? "");
const dispatch = useDispatch();
@@ -18,7 +20,7 @@ export const getMetabotQuickLinks = () => {
useMount(() => {
dispatch(replace("/"));
- if (prompt) {
+ if (prompt && isMetabotEnabled) {
submitInput(prompt, { focusInput: true });
}
});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.tsx
index 7cf2cab9620..276ffe87c6d 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.tsx
@@ -8,8 +8,9 @@ import type { CollectionId } from "metabase-types/api";
export function getNewMenuItemAIExploration(
hasDataAccess: boolean,
collectionId?: CollectionId,
+ isMetabotEnabled?: boolean,
) {
- if (!hasDataAccess) {
+ if (!hasDataAccess || !isMetabotEnabled) {
return undefined;
}
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.unit.spec.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.unit.spec.tsx
new file mode 100644
index 00000000000..5f7fb742f87
--- /dev/null
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/components/NewMenuItemAIExploration.unit.spec.tsx
@@ -0,0 +1,30 @@
+import { getNewMenuItemAIExploration } from "./NewMenuItemAIExploration";
+
+describe("getNewMenuItemAIExploration", () => {
+ it("should return undefined when hasDataAccess is false", () => {
+ const result = getNewMenuItemAIExploration(false, undefined, true);
+ expect(result).toBeUndefined();
+ });
+
+ it("should return undefined when isMetabotEnabled is false", () => {
+ const result = getNewMenuItemAIExploration(true, undefined, false);
+ expect(result).toBeUndefined();
+ });
+
+ it("should return undefined when isMetabotEnabled is undefined", () => {
+ const result = getNewMenuItemAIExploration(true, undefined, undefined);
+ expect(result).toBeUndefined();
+ });
+
+ it("should return a Menu.Item when hasDataAccess and isMetabotEnabled are true", () => {
+ const result = getNewMenuItemAIExploration(true, undefined, true);
+ expect(result).not.toBeUndefined();
+ expect(result?.key).toBe("nlq");
+ });
+
+ it("should link to the ask mode question page", () => {
+ const result = getNewMenuItemAIExploration(true, 123, true);
+ expect(result).not.toBeUndefined();
+ expect(result?.props?.to).toBe("/question/ask");
+ });
+});
diff --git a/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx b/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
index 36d5b2faee5..6cbf1ce0896 100644
--- a/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
+++ b/enterprise/frontend/src/metabase-enterprise/metabot/index.tsx
@@ -1,7 +1,9 @@
import { Route } from "react-router";
import type { MetabotContext as MetabotContextType } from "metabase/metabot";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { PLUGIN_METABOT, PLUGIN_REDUCERS } from "metabase/plugins";
+import { QueryBuilder } from "metabase/query_builder/containers/QueryBuilder";
import { useLazyMetabotGenerateContentQuery } from "metabase-enterprise/api";
import { hasPremiumFeature } from "metabase-enterprise/settings";
@@ -25,6 +27,19 @@ import {
metabotReducer,
} from "./state";
+/**
+ * A wrapper component that renders MetabotQueryBuilder if metabot is enabled,
+ * otherwise falls back to the regular QueryBuilder.
+ */
+function MetabotQueryBuilderOrFallback(props: any) {
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
+ return isMetabotEnabled ? (
+ <MetabotQueryBuilder {...props} />
+ ) : (
+ <QueryBuilder {...props} />
+ );
+}
+
/**
* This is for Metabot in embedding
*
@@ -46,14 +61,13 @@ export function initializePlugin() {
if (hasPremiumFeature("metabot_v3")) {
Object.assign(PLUGIN_METABOT, {
// helpers
- isEnabled: () => true,
getNewMenuItemAIExploration,
getMetabotVisible,
// routes
getAdminRoutes,
getMetabotRoutes: getMetabotQuickLinks,
getMetabotQueryBuilderRoute: () => (
- <Route path="ask" component={MetabotQueryBuilder} />
+ <Route path="ask" component={MetabotQueryBuilderOrFallback} />
),
// components
Metabot,
diff --git a/frontend/src/metabase-types/api/mocks/settings.ts b/frontend/src/metabase-types/api/mocks/settings.ts
index dfe502fd378..0b56952765e 100644
--- a/frontend/src/metabase-types/api/mocks/settings.ts
+++ b/frontend/src/metabase-types/api/mocks/settings.ts
@@ -311,7 +311,7 @@ export const createMockSettings = (
"ldap-group-mappings": null,
"ldap-group-membership-filter": "(member={dn})",
"loading-message": "doing-science",
- "llm-sql-generation-enabled": false,
+ "llm-anthropic-api-key-configured?": false,
"map-tile-server-url": "https://{s}.tile.openstreetmap.org/{z}/{x}/{y}.png",
"native-query-autocomplete-match-style": "substring",
"openai-api-key": null,
@@ -366,6 +366,8 @@ export const createMockSettings = (
"show-homepage-data": false,
"show-homepage-pin-message": false,
"show-homepage-xrays": false,
+ "metabot-enabled?": true,
+ "embedded-metabot-enabled?": true,
"show-metabase-links": true,
"show-metabot": true,
"show-updated-permission-modal": false,
diff --git a/frontend/src/metabase-types/api/settings.ts b/frontend/src/metabase-types/api/settings.ts
index 4256e7fa372..3a791ff644e 100644
--- a/frontend/src/metabase-types/api/settings.ts
+++ b/frontend/src/metabase-types/api/settings.ts
@@ -449,7 +449,7 @@ interface InstanceSettings {
"example-dashboard-id": number | null;
"has-sample-database?"?: boolean; // Careful! This can be undefined during setup!
"instance-creation": string;
- "llm-sql-generation-enabled": boolean;
+ "llm-anthropic-api-key-configured?": boolean;
"read-only-mode": boolean;
"search-typeahead-enabled": boolean;
"show-homepage-data": boolean;
@@ -586,6 +586,8 @@ interface PublicSettings {
"report-timezone-short": string;
"session-cookies": boolean | null;
"setup-token": string | null;
+ "metabot-enabled?": boolean;
+ "embedded-metabot-enabled?": boolean;
"show-metabase-links": boolean;
"show-metabot": boolean;
"show-google-sheets-integration": boolean;
diff --git a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx
index 63c9c98f44e..cbc991fc937 100644
--- a/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx
+++ b/frontend/src/metabase/common/components/NewItemMenu/NewItemMenuView.tsx
@@ -5,6 +5,7 @@ import { t } from "ttag";
import { ForwardRefLink } from "metabase/common/components/Link";
import { useDispatch, useSelector } from "metabase/lib/redux";
import * as Urls from "metabase/lib/urls";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { PLUGIN_METABOT } from "metabase/plugins";
import { setOpenModal } from "metabase/redux/ui";
import { getSetting } from "metabase/selectors/settings";
@@ -41,12 +42,15 @@ export const NewItemMenuView = ({
const canWriteToCollections = useSelector(getUserCanWriteToCollections);
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
+
const menuItems = useMemo(() => {
const items = [];
const aiExplorationItem = PLUGIN_METABOT.getNewMenuItemAIExploration(
hasDataAccess,
collectionId,
+ isMetabotEnabled,
);
if (aiExplorationItem) {
items.push(aiExplorationItem);
@@ -124,6 +128,7 @@ export const NewItemMenuView = ({
hasDatabaseWithJsonEngine,
dispatch,
canWriteToCollections,
+ isMetabotEnabled,
]);
if (menuItems.length === 0) {
diff --git a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedExperienceStep.tsx b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedExperienceStep.tsx
index 7e377a5c6e4..675702f1faf 100644
--- a/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedExperienceStep.tsx
+++ b/frontend/src/metabase/embedding/embedding-iframe-sdk-setup/components/SelectEmbedExperienceStep.tsx
@@ -1,6 +1,6 @@
import { t } from "ttag";
-import { PLUGIN_METABOT } from "metabase/plugins";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { Card, Flex, Radio, Stack, Text } from "metabase/ui";
import { UPSELL_CAMPAIGN_EXPERIENCE } from "../analytics";
@@ -16,7 +16,7 @@ export const SelectEmbedExperienceStep = () => {
useSdkIframeEmbedSetupContext();
const isGuestEmbed = !!settings.isGuest;
- const isMetabotAvailable = PLUGIN_METABOT.isEnabled();
+ const isMetabotAvailable = useMetabotEnabledEmbeddingAware();
const handleEmbedExperienceChange = useHandleExperienceChange();
diff --git a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.tsx b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.tsx
index 6160da96f89..8b9bcce6751 100644
--- a/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.tsx
+++ b/frontend/src/metabase/metabot/components/MetabotInlineSQLPrompt/useInlineSQLPrompt.tsx
@@ -12,9 +12,10 @@ import {
import { createPortal } from "react-dom";
import { skipToken, useExtractTablesQuery } from "metabase/api";
-import { useHasTokenFeature, useSetting } from "metabase/common/hooks";
+import { useHasTokenFeature } from "metabase/common/hooks";
import { useDebouncedValue } from "metabase/common/hooks/use-debounced-value";
import { useRegisterMetabotContextProvider } from "metabase/metabot/context";
+import { useLlmSqlGenerationEnabled } from "metabase/metabot/hooks";
import { PLUGIN_METABOT } from "metabase/plugins";
import * as Lib from "metabase-lib";
import type Question from "metabase-lib/v1/Question";
@@ -66,7 +67,7 @@ export function useInlineSQLPrompt(
bufferId: string,
): UseInlineSqlEditResult {
const isTableBarEnabled = !useHasTokenFeature("metabot_v3");
- const llmSqlGenerationEnabled = useSetting("llm-sql-generation-enabled");
+ const isEnabled = useLlmSqlGenerationEnabled();
const databaseId = question.databaseId();
@@ -224,7 +225,7 @@ export function useInlineSQLPrompt(
const extensions = useMemo(
() =>
- llmSqlGenerationEnabled
+ isEnabled
? [
createPromptInputExtension(setPortalTarget),
keymap.of([
@@ -263,13 +264,13 @@ export function useInlineSQLPrompt(
}),
]
: [],
- [llmSqlGenerationEnabled],
+ [isEnabled],
);
return {
extensions,
portalElement:
- llmSqlGenerationEnabled && portalTarget
+ isEnabled && portalTarget
? createPortal(
<MetabotInlineSQLPrompt
databaseId={databaseId}
@@ -289,12 +290,8 @@ export function useInlineSQLPrompt(
portalTarget.container,
)
: null,
- proposedQuestion: llmSqlGenerationEnabled ? proposedQuestion : undefined,
- handleRejectProposed: llmSqlGenerationEnabled
- ? handleRejectProposed
- : undefined,
- handleAcceptProposed: llmSqlGenerationEnabled
- ? handleAcceptProposed
- : undefined,
+ proposedQuestion: isEnabled ? proposedQuestion : undefined,
+ handleRejectProposed: isEnabled ? handleRejectProposed : undefined,
+ handleAcceptProposed: isEnabled ? handleAcceptProposed : undefined,
};
}
diff --git a/frontend/src/metabase/metabot/hooks/index.ts b/frontend/src/metabase/metabot/hooks/index.ts
index 225eafde175..e050d270f36 100644
--- a/frontend/src/metabase/metabot/hooks/index.ts
+++ b/frontend/src/metabase/metabot/hooks/index.ts
@@ -1 +1,3 @@
export { useMetabotSQLSuggestion } from "./use-metabot-sql-suggestion";
+export { useMetabotEnabledEmbeddingAware } from "./use-metabot-embedding-aware-enabled";
+export { useLlmSqlGenerationEnabled } from "./use-llm-sql-generation-enabled";
diff --git a/frontend/src/metabase/metabot/hooks/use-llm-sql-generation-enabled.ts b/frontend/src/metabase/metabot/hooks/use-llm-sql-generation-enabled.ts
new file mode 100644
index 00000000000..68d3a34cc27
--- /dev/null
+++ b/frontend/src/metabase/metabot/hooks/use-llm-sql-generation-enabled.ts
@@ -0,0 +1,24 @@
+import { useHasTokenFeature, useSetting } from "metabase/common/hooks";
+
+import { useMetabotEnabledEmbeddingAware } from "./use-metabot-embedding-aware-enabled";
+
+/**
+ * Returns whether LLM SQL generation is available and enabled.
+ *
+ * Enterprise path: metabot_v3 feature is enabled AND metabot is enabled (embedding-aware)
+ * OSS path: not hosted AND Anthropic API key is configured
+ */
+export const useLlmSqlGenerationEnabled = (): boolean => {
+ const hasMetabotV3 = useHasTokenFeature("metabot_v3");
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
+ const isHosted = useSetting("is-hosted?");
+ const isAnthropicConfigured = useSetting("llm-anthropic-api-key-configured?");
+
+ // Enterprise: metabot_v3 feature + metabot enabled
+ if (hasMetabotV3) {
+ return isMetabotEnabled;
+ }
+
+ // OSS: not hosted + Anthropic API key configured
+ return !isHosted && !!isAnthropicConfigured;
+};
diff --git a/frontend/src/metabase/metabot/hooks/use-metabot-embedding-aware-enabled.ts b/frontend/src/metabase/metabot/hooks/use-metabot-embedding-aware-enabled.ts
new file mode 100644
index 00000000000..ea2b01db88f
--- /dev/null
+++ b/frontend/src/metabase/metabot/hooks/use-metabot-embedding-aware-enabled.ts
@@ -0,0 +1,14 @@
+import { useHasTokenFeature, useSetting } from "metabase/common/hooks";
+import { isEmbeddingSdk } from "metabase/embedding-sdk/config";
+import { isWithinIframe } from "metabase/lib/dom";
+
+/** Returns the value for `metabot-enabled?` or `embedded-metabot-enabled?` depending on the context
+ * only if the metabot token feature is enabled. */
+export const useMetabotEnabledEmbeddingAware = (): boolean => {
+ const hasMetabotV3 = useHasTokenFeature("metabot_v3");
+ const isEmbeddingIframe = isWithinIframe() || isEmbeddingSdk();
+ const isEnabled = useSetting(
+ isEmbeddingIframe ? "embedded-metabot-enabled?" : "metabot-enabled?",
+ );
+ return hasMetabotV3 && isEnabled;
+};
diff --git a/frontend/src/metabase/nav/components/AppBar/AppBarLarge.tsx b/frontend/src/metabase/nav/components/AppBar/AppBarLarge.tsx
index e8bc13ff709..068c9c906b3 100644
--- a/frontend/src/metabase/nav/components/AppBar/AppBarLarge.tsx
+++ b/frontend/src/metabase/nav/components/AppBar/AppBarLarge.tsx
@@ -2,6 +2,7 @@ import { t } from "ttag";
import { Nav as DetailViewNav } from "metabase/detail-view/components";
import { DETAIL_VIEW_PADDING_LEFT } from "metabase/detail-view/constants";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { PLUGIN_METABOT, PLUGIN_REMOTE_SYNC } from "metabase/plugins";
import { Box, Flex } from "metabase/ui";
import type { CollectionId } from "metabase-types/api";
@@ -57,6 +58,8 @@ const AppBarLarge = ({
const { isVisible: isGitSyncVisible } =
PLUGIN_REMOTE_SYNC.useGitSyncVisible();
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
+
return (
<AppBarRoot
hasSidebarOpen={
@@ -94,7 +97,10 @@ const AppBarLarge = ({
) : null}
</AppBarInfoContainer>
</Flex>
- {(isSearchVisible || isNewButtonVisible || isAppSwitcherVisible) && (
+ {(isSearchVisible ||
+ isNewButtonVisible ||
+ isAppSwitcherVisible ||
+ isMetabotEnabled) && (
<Flex
align="center"
gap="sm"
@@ -105,7 +111,7 @@ const AppBarLarge = ({
{isSearchVisible &&
(isEmbeddingIframe ? <SearchBar /> : <SearchButton mr="md" />)}
{isNewButtonVisible && <NewItemButton collectionId={collectionId} />}
- {!isEmbeddingIframe && <PLUGIN_METABOT.MetabotAppBarButton />}
+ {<PLUGIN_METABOT.MetabotAppBarButton />}
{isAppSwitcherVisible && (
<Box c="text-primary" aria-label={t`Settings menu`}>
<AppSwitcher />
diff --git a/frontend/src/metabase/plugins/oss/ai.ts b/frontend/src/metabase/plugins/oss/ai.ts
index 29098852ac0..c5b3896f8be 100644
--- a/frontend/src/metabase/plugins/oss/ai.ts
+++ b/frontend/src/metabase/plugins/oss/ai.ts
@@ -65,7 +65,6 @@ type PluginMetabotConfig = {
};
type PluginMetabotType = {
- isEnabled: () => boolean;
Metabot: (props: {
hide?: boolean;
config?: PluginMetabotConfig;
@@ -82,6 +81,7 @@ type PluginMetabotType = {
getNewMenuItemAIExploration: (
hasDataAccess: boolean,
collectionId?: CollectionId,
+ isMetabotEnabled?: boolean,
) => React.ReactElement | undefined;
getMetabotVisible: (state: State, conversation_id: string) => boolean;
MetabotAppBarButton: ComponentType;
@@ -151,7 +151,6 @@ const defaultMetabotContextValue: MetabotContext =
getDefaultMetabotContextValue();
const getDefaultPluginMetabot = (): PluginMetabotType => ({
- isEnabled: () => false,
Metabot: (_props: { hide?: boolean; config?: PluginMetabotConfig }) =>
null as React.ReactElement | null,
MetabotChat: (_props: { config?: PluginMetabotConfig }) =>
diff --git a/frontend/src/metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor/CodeMirrorEditor.tsx b/frontend/src/metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor/CodeMirrorEditor.tsx
index 7576b1b4707..273ba0322ba 100644
--- a/frontend/src/metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor/CodeMirrorEditor.tsx
+++ b/frontend/src/metabase/query_builder/components/NativeQueryEditor/CodeMirrorEditor/CodeMirrorEditor.tsx
@@ -14,8 +14,8 @@ import {
CodeMirror,
type CodeMirrorRef,
} from "metabase/common/components/CodeMirror";
-import { useSetting } from "metabase/common/hooks";
import { isEventOverElement } from "metabase/lib/dom";
+import { useLlmSqlGenerationEnabled } from "metabase/metabot/hooks";
import * as Lib from "metabase-lib";
import type { CardId } from "metabase-types/api";
@@ -72,10 +72,9 @@ export const CodeMirrorEditor = forwardRef<
ref,
) {
const editorRef = useRef<CodeMirrorRef>(null);
- const llmSqlGenerationEnabled = useSetting("llm-sql-generation-enabled");
+ const isLlmEnabled = useLlmSqlGenerationEnabled();
const placeholder =
- placeholderProp ??
- getPlaceholderText(Lib.engine(query), llmSqlGenerationEnabled);
+ placeholderProp ?? getPlaceholderText(Lib.engine(query), isLlmEnabled);
const baseExtensions = useExtensions({
query,
diff: !!proposedQuery,
diff --git a/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.tsx b/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.tsx
index f5db6885e63..f88c7a27b96 100644
--- a/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.tsx
+++ b/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.tsx
@@ -2,7 +2,8 @@ import dayjs from "dayjs";
import { match } from "ts-pattern";
import { useRegisterMetabotContextProvider } from "metabase/metabot";
-import { PLUGIN_AI_ENTITY_ANALYSIS, PLUGIN_METABOT } from "metabase/plugins";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
+import { PLUGIN_AI_ENTITY_ANALYSIS } from "metabase/plugins";
import {
getChartImagePngDataUri,
getChartSelector,
@@ -207,14 +208,16 @@ export const registerQueryBuilderMetabotContextFn = async ({
visualizationSettings,
timelineEvents,
queryResult,
+ isMetabotEnabled,
}: {
question: Question | undefined;
series: RawSeries;
visualizationSettings: ComputedVisualizationSettings | undefined;
timelineEvents: TimelineEvent[];
queryResult: any;
+ isMetabotEnabled: boolean;
}) => {
- if (!PLUGIN_METABOT.isEnabled()) {
+ if (!isMetabotEnabled) {
return {};
}
if (!question) {
@@ -252,19 +255,25 @@ export const registerQueryBuilderMetabotContextFn = async ({
};
export const useRegisterQueryBuilderMetabotContext = () => {
- useRegisterMetabotContextProvider(async (state) => {
- const question = getQuestion(state);
- const series = getTransformedSeries(state);
- const visualizationSettings = getVisualizationSettings(state);
- const timelineEvents = getVisibleTimelineEvents(state);
- const queryResult = getFirstQueryResult(state);
-
- return registerQueryBuilderMetabotContextFn({
- question,
- series,
- visualizationSettings,
- timelineEvents,
- queryResult,
- });
- }, []);
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
+
+ useRegisterMetabotContextProvider(
+ async (state) => {
+ const question = getQuestion(state);
+ const series = getTransformedSeries(state);
+ const visualizationSettings = getVisualizationSettings(state);
+ const timelineEvents = getVisibleTimelineEvents(state);
+ const queryResult = getFirstQueryResult(state);
+
+ return registerQueryBuilderMetabotContextFn({
+ question,
+ series,
+ visualizationSettings,
+ timelineEvents,
+ queryResult,
+ isMetabotEnabled,
+ });
+ },
+ [isMetabotEnabled],
+ );
};
diff --git a/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.unit.spec.tsx b/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.unit.spec.tsx
index 2923df7858f..9ae34a48d14 100644
--- a/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.unit.spec.tsx
+++ b/frontend/src/metabase/query_builder/containers/use-register-query-builder-metabot-context.unit.spec.tsx
@@ -2,8 +2,7 @@ import _ from "underscore";
import { setupEnterpriseOnlyPlugin } from "__support__/enterprise";
import { mockSettings } from "__support__/settings";
-import { renderHook } from "__support__/ui";
-import { PLUGIN_METABOT } from "metabase/plugins";
+import { renderHookWithProviders } from "__support__/ui";
import type { ComputedVisualizationSettings } from "metabase/visualizations/types";
import Question from "metabase-lib/v1/Question";
import type {
@@ -54,6 +53,7 @@ function createMockData(opts: {
series?: RawSeries | TransformedSeries;
visualizationSettings?: ComputedVisualizationSettings;
timelineEvents?: TimelineEvent[];
+ isMetabotEnabled?: boolean;
}) {
const question = opts.question;
const card = question?.card();
@@ -87,6 +87,7 @@ function createMockData(opts: {
visualizationSettings: question?.settings() ?? {},
timelineEvents: [],
queryResult: undefined,
+ isMetabotEnabled: opts.isMetabotEnabled ?? true,
...opts,
};
}
@@ -254,8 +255,6 @@ describe("registerQueryBuilderMetabotContextFn", () => {
});
it("should return empty result when metabot is disabled", async () => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => false);
-
const card = createMockCard({
name: "Count by name",
display: "table",
@@ -264,15 +263,16 @@ it("should return empty result when metabot is disabled", async () => {
"graph.metrics": ["count"],
}),
});
- const data = createMockData({ question: new Question(card) });
+ const data = createMockData({
+ question: new Question(card),
+ isMetabotEnabled: false,
+ });
const result = await registerQueryBuilderMetabotContextFn(data);
expect(getUserIsViewing(result)).toBeUndefined();
});
it("should return populated context when metabot is enabled", async () => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => true);
-
const card = createMockCard({
name: "Count by name",
display: "table",
@@ -281,16 +281,19 @@ it("should return populated context when metabot is enabled", async () => {
"graph.metrics": ["count"],
}),
});
- const data = createMockData({ question: new Question(card) });
+ const data = createMockData({
+ question: new Question(card),
+ isMetabotEnabled: true,
+ });
const result = await registerQueryBuilderMetabotContextFn(data);
const viewing = getUserIsViewing(result);
expect(viewing).toBeDefined();
});
it("should register without throwing", () => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => true);
+ mockSettings(createMockSettings({ "metabot-enabled?": true }));
expect(() => {
- renderHook(() => useRegisterQueryBuilderMetabotContext());
+ renderHookWithProviders(() => useRegisterQueryBuilderMetabotContext(), {});
}).not.toThrow();
});
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
index 6136500d71f..8125a13aca1 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.tsx
@@ -22,6 +22,7 @@ import {
} from "metabase/documents/components/Editor/shared/SuggestionPaper";
import { getCurrentDocument } from "metabase/documents/selectors";
import { useSelector } from "metabase/lib/redux";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { getBrowseAllItemIndex } from "metabase/rich_text_editing/tiptap/extensions/shared/suggestionUtils";
import type { SuggestionPickerViewMode } from "metabase/rich_text_editing/tiptap/extensions/shared/types";
import {
@@ -101,6 +102,7 @@ export const CommandSuggestion = forwardRef<
CommandSuggestionProps
>(function CommandSuggestionComponent({ command, editor, query }, ref) {
const document = useSelector(getCurrentDocument);
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const [selectedIndex, setSelectedIndex] = useState(0);
const [viewMode, setViewMode] = useState<SuggestionPickerViewMode>(null);
@@ -111,8 +113,8 @@ export const CommandSuggestion = forwardRef<
const itemRefs = useRef<(HTMLButtonElement | null)[]>([]);
const allCommandSections: CommandSection[] = useMemo(
- getAllCommandSections,
- [],
+ () => getAllCommandSections(isMetabotEnabled),
+ [isMetabotEnabled],
);
const allCommandOptions = useMemo(
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
index dbae74f09cf..fee1b466167 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/CommandSuggestion.unit.spec.tsx
@@ -11,7 +11,6 @@ import {
} from "__support__/server-mocks";
import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen, within } from "__support__/ui";
-import { PLUGIN_METABOT } from "metabase/plugins";
import { Input } from "metabase/ui";
import registerVisualizations from "metabase/visualizations/register";
import { type RecentItem, isRecentTableItem } from "metabase-types/api";
@@ -439,12 +438,9 @@ describe("CommandSuggestion", () => {
});
describe("when metabot is disabled", () => {
- beforeEach(() => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => false);
- });
-
it("should show all available commands except Metabot", async () => {
const settings = mockSettings({
+ "metabot-enabled?": false,
"token-features": createMockTokenFeatures({
metabot_v3: false,
}),
@@ -458,12 +454,9 @@ describe("CommandSuggestion", () => {
});
describe("when metabot is enabled", () => {
- beforeEach(() => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => true);
- });
-
it("should show all available commands including Metabot", async () => {
const settings = mockSettings({
+ "metabot-enabled?": true,
"token-features": createMockTokenFeatures({
metabot_v3: true,
}),
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
index 484f8961a74..b552c7fe315 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/Command/utils.ts
@@ -1,14 +1,14 @@
import { t } from "ttag";
-import { PLUGIN_METABOT } from "metabase/plugins";
-
import type { CommandSection } from "./types";
-export const getAllCommandSections = (): CommandSection[] => {
+export const getAllCommandSections = (
+ isMetabotEnabled: boolean,
+): CommandSection[] => {
return [
{
items: [
- ...(PLUGIN_METABOT.isEnabled()
+ ...(isMetabotEnabled
? ([
{
icon: "metabot" as const,
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx
index 1f0fe1f1305..b3e76da6a9b 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.tsx
@@ -20,6 +20,7 @@ import {
} from "metabase/documents/documents.slice";
import { getCurrentDocument } from "metabase/documents/selectors";
import { useDispatch, useSelector } from "metabase/lib/redux";
+import { useMetabotEnabledEmbeddingAware } from "metabase/metabot/hooks";
import { PLUGIN_METABOT } from "metabase/plugins";
import { Box, Button, Flex, Icon, Text, Tooltip } from "metabase/ui";
import type { Card, MetabotGenerateContentRequest } from "metabase-types/api";
@@ -152,7 +153,7 @@ export const MetabotComponent = memo(
const [isLoading, setIsLoading] = useState(false);
const [errorText, setErrorText] = useState("");
const [queryMetabot] = PLUGIN_METABOT.useLazyMetabotGenerateContentQuery();
- const isMetabotEnabled = PLUGIN_METABOT.isEnabled();
+ const isMetabotEnabled = useMetabotEnabledEmbeddingAware();
const handleRunMetabot = async () => {
const serializePrompt =
diff --git a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx b/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
index 9892a828cbf..7706675b05c 100644
--- a/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
+++ b/frontend/src/metabase/rich_text_editing/tiptap/extensions/MetabotEmbed/MetabotEmbed.unit.spec.tsx
@@ -2,7 +2,6 @@ import userEvent from "@testing-library/user-event";
import { mockSettings } from "__support__/settings";
import { renderWithProviders, screen, within } from "__support__/ui";
-import { PLUGIN_METABOT } from "metabase/plugins";
import { createMockTokenFeatures } from "metabase-types/api/mocks";
import { createMockState } from "metabase-types/store/mocks";
@@ -31,12 +30,9 @@ describe("MetabotEmbed", () => {
});
describe("when metabot is disabled", () => {
- beforeEach(() => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => false);
- });
-
it("should show disabled button with tooltip", async () => {
const settings = mockSettings({
+ "metabot-enabled?": false,
"token-features": createMockTokenFeatures({
metabot_v3: false,
}),
@@ -60,12 +56,9 @@ describe("MetabotEmbed", () => {
});
describe("when metabot is enabled", () => {
- beforeEach(() => {
- PLUGIN_METABOT.isEnabled = jest.fn(() => true);
- });
-
it("should show enabled button without tooltip", async () => {
const settings = mockSettings({
+ "metabot-enabled?": true,
"token-features": createMockTokenFeatures({
metabot_v3: true,
}),
diff --git a/resources/python-sources/.lock b/resources/python-sources/.lock
new file mode 100644
index 00000000000..e69de29bb2d
diff --git a/src/metabase/llm/settings.clj b/src/metabase/llm/settings.clj
index a260a5714e2..d8d7006abc5 100644
--- a/src/metabase/llm/settings.clj
+++ b/src/metabase/llm/settings.clj
@@ -2,7 +2,6 @@
"Settings for OSS LLM integration."
(:require
[clojure.string :as str]
- [metabase.premium-features.core :as premium-features]
[metabase.settings.core :as setting :refer [defsetting]]
[metabase.util.i18n :refer [deferred-tru tru]]))
@@ -20,6 +19,15 @@
(setting/set-value-of-type! :string :llm-anthropic-api-key trimmed)))
:doc false)
+(defsetting llm-anthropic-api-key-configured?
+ "Whether an Anthropic API key has been configured for AI-assisted SQL generation."
+ :type :boolean
+ :visibility :public
+ :setter :none
+ :export? false
+ :getter #(boolean (some? (llm-anthropic-api-key)))
+ :doc false)
+
(defsetting llm-anthropic-model
(deferred-tru "Anthropic model for AI-assisted SQL generation.")
:encryption :no
@@ -83,15 +91,3 @@
:visibility :settings-manager
:export? false
:doc false)
-
-(defsetting llm-sql-generation-enabled
- (deferred-tru "Whether AI-assisted SQL generation is enabled.")
- :visibility :public
- :type :boolean
- :setter :none
- :export? false
- :getter (fn [] (or
- (premium-features/enable-metabot-v3?)
- (and
- (not (premium-features/is-hosted?))
- (some? (llm-anthropic-api-key))))))
diff --git a/test/metabase/llm/settings_test.clj b/test/metabase/llm/settings_test.clj
index cc84678b9ab..4e443b7b244 100644
--- a/test/metabase/llm/settings_test.clj
+++ b/test/metabase/llm/settings_test.clj
@@ -2,7 +2,6 @@
(:require
[clojure.test :refer :all]
[metabase.llm.settings :as llm.settings]
- [metabase.premium-features.core :as premium-features]
[metabase.test :as mt]))
(set! *warn-on-reflection* true)
@@ -27,24 +26,16 @@
(llm.settings/llm-anthropic-api-key! "")
(is (nil? (llm.settings/llm-anthropic-api-key))))))
-;;; ------------------------------------------- llm-sql-generation-enabled Tests -------------------------------------------
+;;; ------------------------------------------- llm-anthropic-api-key-configured? Tests -------------------------------------------
-(deftest llm-sql-generation-enabled-test
- (testing "returns true when Anthropic API key is set (self-hosted)"
- (with-redefs [premium-features/is-hosted? (constantly false)]
- (mt/with-temporary-setting-values [llm-anthropic-api-key "sk-ant-test"]
- (is (true? (llm.settings/llm-sql-generation-enabled))))))
+(deftest llm-anthropic-api-key-configured?-test
+ (testing "returns false when no API key is set"
+ (mt/with-temporary-setting-values [llm-anthropic-api-key nil]
+ (is (false? (llm.settings/llm-anthropic-api-key-configured?)))))
- (testing "returns false when no API key and metabot not enabled"
- (mt/with-premium-features #{}
- (mt/with-temporary-setting-values [llm-anthropic-api-key nil]
- (is (false? (llm.settings/llm-sql-generation-enabled))))))
-
- (testing "returns false when hosted without metabot enabled, even with API key"
- (with-redefs [premium-features/is-hosted? (constantly true)]
- (mt/with-premium-features #{}
- (mt/with-temporary-setting-values [llm-anthropic-api-key "sk-ant-test"]
- (is (false? (llm.settings/llm-sql-generation-enabled))))))))
+ (testing "returns true when API key is set"
+ (mt/with-temporary-setting-values [llm-anthropic-api-key "sk-ant-test"]
+ (is (true? (llm.settings/llm-anthropic-api-key-configured?))))))
;;; ------------------------------------------- Settings Defaults Tests -------------------------------------------
diff --git a/test_resources/serialization_baseline/settings.yaml b/test_resources/serialization_baseline/settings.yaml
index 26c4c4cd92e..427752f1205 100644
--- a/test_resources/serialization_baseline/settings.yaml
+++ b/test_resources/serialization_baseline/settings.yaml
@@ -30,6 +30,8 @@ enable-xrays: null
gsheets: null
hide-embed-branding?: null
humanization-strategy: null
+embedded-metabot-enabled?: null
+metabot-enabled?: null
landing-page: null
landing-page-illustration: null
landing-page-illustration-custom: null