The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
Consolidate metabot-enabled checks and add them to a number of endpoints (#71366)
Noah Mossf4b0e5946b9c
diff --git a/src/metabase/metabot/api.clj b/src/metabase/metabot/api.cljindex 1b2e56cd4fd..50bcb352253 100644--- a/src/metabase/metabot/api.clj+++ b/src/metabase/metabot/api.clj@@ -18,7 +18,6 @@[metabase.metabot.feedback :as metabot.feedback][metabase.metabot.schema :as metabot.schema][metabase.metabot.self.core :as self.core]- [metabase.metabot.settings :as metabot.settings][metabase.server.streaming-response :as sr][metabase.slackbot.api][metabase.util :as u]@@ -61,15 +60,6 @@(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.config/embedded-metabot-id)- (api/check (metabot.settings/embedded-metabot-enabled?)- [403 "Embedded Metabot is not enabled."])- (api/check (metabot.settings/metabot-enabled?)- [403 "Metabot is not enabled."])))-(defn- extract-usage"Extract usage from parts, taking the last `:usage` per model.@@ -200,7 +190,7 @@[{:keys [metabot_id profile_id message context history conversation_id state debug]}](let [message (metabot.envelope/user-message message)metabot-id (metabot.config/resolve-dynamic-metabot-id metabot_id)- _ (check-metabot-enabled! metabot-id)+ _ (metabot.config/check-metabot-enabled! metabot-id)profile-id (metabot.config/resolve-dynamic-profile-id profile_id metabot-id);; Only allow debug mode in dev — never in productiondebug? (and config/is-dev? (boolean debug))]@@ -245,6 +235,7 @@[_route-params_query-paramsfeedback :- :map]+ (metabot.config/check-metabot-enabled!)(try(api/check-400 (metabot.feedback/submit-to-harbormaster! feedback)"Cannot submit feedback. The license token and/or Store API URL are missing!")diff --git a/src/metabase/metabot/api/describe.clj b/src/metabase/metabot/api/describe.cljindex a20b423a2fc..5da49e04b5d 100644--- a/src/metabase/metabot/api/describe.clj+++ b/src/metabase/metabot/api/describe.clj@@ -3,6 +3,7 @@(:require[metabase.analyze.query-results :as qr][metabase.api.macros :as api.macros]+ [metabase.metabot.config :as metabot.config][metabase.metabot.tasks.describe-dashboard :refer [describe-dashboard]][metabase.metabot.tasks.describe-question :refer [describe-question]][metabase.parameters.schema :as parameters.schema]@@ -28,6 +29,7 @@[:collection_position {:optional true} [:maybe ms/PositiveInt]][:result_metadata {:optional true} [:maybe qr/ResultsMetadata]][:cache_ttl {:optional true} [:maybe ms/PositiveInt]]]]+ (metabot.config/check-metabot-enabled!){:summary (describe-question body)});; TODO (Cam 2025-11-25) please add a response schema to this API endpoint, it makes it easier for our customers to@@ -38,4 +40,5 @@"Provide a summary of a dashboard."[{:keys [id]} :- [:map[:id ms/PositiveInt]]]+ (metabot.config/check-metabot-enabled!){:summary (describe-dashboard id)})diff --git a/src/metabase/metabot/api/document.clj b/src/metabase/metabot/api/document.cljindex bdcc257e1f3..10c1ca75405 100644--- a/src/metabase/metabot/api/document.clj+++ b/src/metabase/metabot/api/document.clj@@ -5,6 +5,7 @@[metabase.api.macros :as api.macros][metabase.api.routes.common :refer [+auth]][metabase.metabot.agent.core :as metabot.agent]+ [metabase.metabot.config :as metabot.config][metabase.metabot.context :as metabot.context][metabase.util.malli.schema :as ms]))@@ -89,6 +90,7 @@_query-params{:keys [instructions references]} :- generate-content-body-schema]+ (metabot.config/check-metabot-enabled!)(let [context (assoc(metabot.context/create-context {:capabilities #{"permission:write_sql_queries"}}):references references)diff --git a/src/metabase/metabot/api/entity_analysis.clj b/src/metabase/metabot/api/entity_analysis.cljindex 9301955c233..cc1dc8c0bd2 100644--- a/src/metabase/metabot/api/entity_analysis.clj+++ b/src/metabase/metabot/api/entity_analysis.clj@@ -3,6 +3,7 @@(:require[metabase.api.macros :as api.macros][metabase.api.routes.common :refer [+auth]]+ [metabase.metabot.config :as metabot.config][metabase.metabot.core :as metabot]))(set! *warn-on-reflection* true)@@ -25,6 +26,7 @@[:description {:optional true} [:maybe :string]][:timestamp :string]]]]]]]+ (metabot.config/check-metabot-enabled!)(let [chart-data {:image_base64 image_base64:chart {:name name:description description}diff --git a/src/metabase/metabot/config.clj b/src/metabase/metabot/config.cljindex c0ab9a6789c..abefbd89fbb 100644--- a/src/metabase/metabot/config.clj+++ b/src/metabase/metabot/config.clj@@ -1,6 +1,7 @@(ns metabase.metabot.config(:require[medley.core :as m]+ [metabase.api.common :as api][metabase.metabot.settings :as metabot.settings][toucan2.core :as t2]))@@ -16,6 +17,24 @@"The ID of the Slack Metabot instance.""9a89fe64-54b9-4ab2-8022-eccd772e5073")+(defn any-metabot-enabled?+ "Returns true if at least one of the metabot instances (internal or embedded) is enabled."+ []+ (or (metabot.settings/metabot-enabled?) (metabot.settings/embedded-metabot-enabled?)))++(defn check-metabot-enabled!+ "Throws a 403 if metabot is not enabled. When called with no arguments, checks that at least one metabot instance is+ enabled. When called with a `metabot-id`, checks the specific instance's setting."+ ([]+ (api/check (any-metabot-enabled?)+ [403 "Metabot is not enabled."]))+ ([metabot-id]+ (if (= metabot-id embedded-metabot-id)+ (api/check (metabot.settings/embedded-metabot-enabled?)+ [403 "Embedded Metabot is not enabled."])+ (api/check (metabot.settings/metabot-enabled?)+ [403 "Metabot is not enabled."]))))+(def metabot-config"The name of the collection exposed by the answer-sources tool."{internal-metabot-id {:profile-id "internal"diff --git a/src/metabase/metabot/task/suggested_prompts_generator.clj b/src/metabase/metabot/task/suggested_prompts_generator.cljindex e9b6358577a..9a78914d76d 100644--- a/src/metabase/metabot/task/suggested_prompts_generator.clj+++ b/src/metabase/metabot/task/suggested_prompts_generator.clj@@ -21,19 +21,21 @@(defn- maybe-generate-suggested-prompts! [](try- ;; Run as admin since this is a system task generating prompts for all content in scope.- ;; Users will only see prompts for content they have access to (filtered at query time).- (request/as-admin- (let [metabot-eid (get-in metabot.config/metabot-config- [metabot.config/internal-metabot-id :entity-id])- metabot-id (t2/select-one-pk :model/Metabot :entity_id metabot-eid)- suggested-prompts-cnt (t2/count :model/MetabotPrompt :metabot_id metabot-id)]- (if (zero? suggested-prompts-cnt)- (do- (log/info "No suggested prompts found. Generating suggested prompts.")- (metabot.suggested-prompts/generate-sample-prompts metabot-id)- (log/info "Suggested prompts generated successfully."))- (log/info "Suggested prompts are present. Not generating."))))+ (if-not (metabot.config/any-metabot-enabled?)+ (log/info "Metabot is disabled. Skipping suggested prompt generation.")+ ;; Run as admin since this is a system task generating prompts for all content in scope.+ ;; Users will only see prompts for content they have access to (filtered at query time).+ (request/as-admin+ (let [metabot-eid (get-in metabot.config/metabot-config+ [metabot.config/internal-metabot-id :entity-id])+ metabot-id (t2/select-one-pk :model/Metabot :entity_id metabot-eid)+ suggested-prompts-cnt (t2/count :model/MetabotPrompt :metabot_id metabot-id)]+ (if (zero? suggested-prompts-cnt)+ (do+ (log/info "No suggested prompts found. Generating suggested prompts.")+ (metabot.suggested-prompts/generate-sample-prompts metabot-id)+ (log/info "Suggested prompts generated successfully."))+ (log/info "Suggested prompts are present. Not generating.")))))(catch Exception e(log/errorf "Suggested prompts generation failed: %s" (.getMessage e)))))diff --git a/test/metabase/metabot/api/describe_test.clj b/test/metabase/metabot/api/describe_test.cljindex e15754d0b30..e0d3ad8878c 100644--- a/test/metabase/metabot/api/describe_test.clj+++ b/test/metabase/metabot/api/describe_test.clj@@ -5,14 +5,24 @@[metabase.test :as mt][metabase.util.json :as json]))+(deftest metabot-disabled-test+ (testing "describe endpoints return 403 when all metabot instances are disabled"+ (mt/with-temporary-setting-values [metabot-enabled? false+ embedded-metabot-enabled? false]+ (mt/dataset test-data+ (mt/with-temp [:model/Card card {:name "Orders"+ :dataset_query (mt/mbql-query orders)}+ :model/Dashboard {dash-id :id} {:name "Dashboard"}]+ (is (= "Metabot is not enabled."+ (mt/user-http-request :rasta :post 403 "metabot/describe/card" card)))+ (is (= "Metabot is not enabled."+ (mt/user-http-request :rasta :post 403 (format "metabot/describe/dashboard/%d" dash-id)))))))))+(deftest summarize-card-test(testing "POST /api/metabot/describe/card"(mt/dataset test-data- (mt/with-temp [:model/Card card {:name "Orders"- :dataset_query- {:database (mt/id)- :type :query- :query {:source-table (mt/id :orders)}}}]+ (mt/with-temp [:model/Card card {:name "Orders"+ :dataset_query (mt/mbql-query orders)}](let [fake-response {:title "Title" :description "Description"}json-response (json/encode fake-response)expected {:summary fake-response}]@@ -46,11 +56,8 @@(deftest summarize-dashboard-test(testing "POST /api/metabot/describe/dashboard/:id"(mt/dataset test-data- (mt/with-temp [:model/Card {card-id :id} {:name "Orders"- :dataset_query- {:database (mt/id)- :type :query- :query {:source-table (mt/id :orders)}}}+ (mt/with-temp [:model/Card {card-id :id} {:name "Orders"+ :dataset_query (mt/mbql-query orders)}:model/Dashboard {dash-id :id} {:name "Dashboard"}:model/DashboardCard {_ :id} {:dashboard_id dash-id:card_id card-id}]diff --git a/test/metabase/metabot/config_test.clj b/test/metabase/metabot/config_test.cljindex 8efc7073a73..aae123fe65b 100644--- a/test/metabase/metabot/config_test.clj+++ b/test/metabase/metabot/config_test.clj@@ -44,6 +44,19 @@(is (= "embedding_next"(metabot.config/resolve-dynamic-profile-id nil))))))))+(deftest check-metabot-enabled-test+ (testing "0-arity throws when both are disabled, passes when either is enabled"+ (mt/with-temporary-setting-values [metabot-enabled? false embedded-metabot-enabled? false]+ (is (thrown-with-msg? clojure.lang.ExceptionInfo #"Metabot is not enabled"+ (metabot.config/check-metabot-enabled!))))+ (mt/with-temporary-setting-values [metabot-enabled? true embedded-metabot-enabled? false]+ (is (metabot.config/check-metabot-enabled!))))+ (testing "1-arity checks the specific instance's setting"+ (mt/with-temporary-setting-values [metabot-enabled? false embedded-metabot-enabled? true]+ (is (thrown-with-msg? clojure.lang.ExceptionInfo #"Metabot is not enabled"+ (metabot.config/check-metabot-enabled! metabot.config/internal-metabot-id)))+ (is (metabot.config/check-metabot-enabled! metabot.config/embedded-metabot-id)))))+(deftest integrated-resolution-test(testing "combination of metabot-id and profile-id precedence resolution"(mt/with-premium-features #{:metabot-v3}