Skip to content

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

Metabot tool endpoitns should support MBQL5 (#65844)

Thomas Schmidt0a3a8265376b
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj
index 06341951582..ea05407fc08 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj
@@ -4,8 +4,6 @@
[metabase-enterprise.documents.core :as documents]
[metabase-enterprise.metabot-v3.tools.util :as metabot-v3.tools.u]
[metabase.api.common :as api]
- ;; TODO (Cam 10/10/25) -- update MetaBot to use Lib + MBQL 5
- ^{:clj-kondo/ignore [:discouraged-namespace]} [metabase.legacy-mbql.normalize :as mbql.normalize]
[metabase.lib-be.core :as lib-be]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
@@ -378,23 +376,23 @@
{:output "invalid document_id"}))
(defn- execute-query
- [query-id legacy-query]
- (let [legacy-query (mbql.normalize/normalize legacy-query)
+ [query-id query-input]
+ (let [normalized-query (lib-be/normalize-query query-input)
field-id-prefix (metabot-v3.tools.u/query-field-id-prefix query-id)
- database-id (:database legacy-query)
+ database-id (:database normalized-query)
_ (api/read-check :model/Database database-id)
mp (lib-be/application-database-metadata-provider database-id)
- query (lib/query mp legacy-query)
+ query (lib/query mp normalized-query)
returned-cols (lib/returned-columns query)]
{:type :query
:query-id query-id
- :query legacy-query
+ :query normalized-query
:result-columns (into []
(map-indexed #(metabot-v3.tools.u/->result-column query %2 %1 field-id-prefix))
returned-cols)}))
(defn get-query-details
- "Get the details of a (legacy) query."
+ "Get the details of a query (supports both MBQL v4 and v5)."
[{:keys [query]}]
(lib-be/with-metadata-provider-cache
{:structured-output (execute-query (u/generate-nano-id) query)}))
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj
index fb8d29a5f1b..20053a2959f 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj
@@ -350,13 +350,14 @@
(let [{:keys [table-id query query-id report-id]} data-source
model-id (lib.util/legacy-string-table-id->card-id table-id)
handle-query (fn [query query-id]
- (let [database-id (:database query)
+ (let [normalized-query (lib-be/normalize-query query)
+ database-id (:database normalized-query)
_ (api/read-check :model/Database database-id)
mp (lib-be/application-database-metadata-provider database-id)]
[(if query-id
(metabot-v3.tools.u/query-field-id-prefix query-id)
metabot-v3.tools.u/any-prefix-pattern)
- (-> (lib/query mp query) lib/append-stage)]))]
+ (-> (lib/query mp normalized-query) lib/append-stage)]))]
(cond
model-id
(if-let [model-query (metabot-v3.tools.u/card-query model-id)]
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/dummy_tools_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/dummy_tools_test.clj
index dc238ea75bf..3c2a6c24bb2 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/dummy_tools_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/dummy_tools_test.clj
@@ -2,6 +2,7 @@
(:require
[clojure.test :refer :all]
[metabase-enterprise.metabot-v3.dummy-tools :as dummy-tools]
+ [metabase.lib.core :as lib]
[metabase.test :as mt]
[metabase.test.fixtures :as fixtures]))
@@ -76,7 +77,7 @@
(is (= "Empty Document" (:name doc-info)))
(is (= nil (:document doc-info)))))))))
-(deftest get-document-no-user-access
+(deftest get-document-no-user-access-test
(testing "does not return details if the user can't access the document"
(mt/with-non-admin-groups-no-root-collection-perms
(mt/with-temp [:model/Document {doc-id :id} {:name "Empty Document"
@@ -85,3 +86,50 @@
(mt/with-current-user (mt/user->id :rasta)
(is (= {:output "error fetching document: You don't have permissions to do that."}
(dummy-tools/get-document-details {:document-id doc-id}))))))))
+
+(deftest get-query-details-mbql-v4-test
+ (testing "get-query-details works with MBQL v4 (legacy) queries"
+ (mt/test-driver :h2
+ (mt/with-current-user (mt/user->id :crowberto)
+ (let [legacy-query {:database (mt/id)
+ :type :query
+ :query {:source-table (mt/id :venues)
+ :limit 10}}
+ result (dummy-tools/get-query-details {:query legacy-query})]
+ (is (contains? result :structured-output))
+ (let [output (:structured-output result)]
+ (is (= :query (:type output)))
+ (is (string? (:query-id output)))
+ (is (map? (:query output)))
+ (is (= (mt/id) (get-in output [:query :database])))
+ (is (sequential? (:result-columns output)))
+ (is (pos? (count (:result-columns output))))))))))
+
+(deftest get-query-details-mbql-v5-test
+ (testing "get-query-details works with MBQL v5 queries"
+ (mt/test-driver :h2
+ (mt/with-current-user (mt/user->id :crowberto)
+ (let [mbql-v5-query (lib/query (mt/metadata-provider) (mt/mbql-query venues {:limit 10}))
+ result (dummy-tools/get-query-details {:query mbql-v5-query})]
+ (is (contains? result :structured-output))
+ (let [output (:structured-output result)]
+ (is (= :query (:type output)))
+ (is (string? (:query-id output)))
+ (is (map? (:query output)))
+ (is (= (mt/id) (get-in output [:query :database])))
+ (is (sequential? (:result-columns output)))
+ (is (pos? (count (:result-columns output))))))))))
+
+(deftest get-query-details-native-query-test
+ (testing "get-query-details works with native queries"
+ (mt/test-driver :h2
+ (mt/with-current-user (mt/user->id :crowberto)
+ (let [native-query (lib/native-query (mt/metadata-provider) "SELECT * FROM VENUES LIMIT 10")
+ result (dummy-tools/get-query-details {:query native-query})]
+ (is (contains? result :structured-output))
+ (let [output (:structured-output result)]
+ (is (= :query (:type output)))
+ (is (string? (:query-id output)))
+ (is (map? (:query output)))
+ (is (= (mt/id) (get-in output [:query :database])))
+ (is (sequential? (:result-columns output)))))))))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/api_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/api_test.clj
index 81644f637bc..0b8365e235a 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/api_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/api_test.clj
@@ -651,13 +651,14 @@
generated-id (-> response :structured_output :query_id)]
(is (=? {:structured_output {:type "query"
:query_id string?
- :query query
+ :query map?
:result_columns
[{:field_id (str "q" generated-id "/0"), :name "CREATED_AT", :display_name "Created At: Week", :type "datetime"}
{:field_id (str "q" generated-id "/1"), :name "avg", :display_name "Average of Rating", :type "number"}]}
:conversation_id conversation-id}
- ;; normalize query to convert strings like "field" to keywords
- (update-in response [:structured_output :query] mbql.normalize/normalize))))))
+ response))
+ ;; Verify the query is normalized (supports both MBQL v4 and v5)
+ (is (= (mt/id) (get-in response [:structured_output :query :database]))))))
(deftest get-report-details-test
(mt/with-premium-features #{:metabot-v3}
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/filters_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/filters_test.clj
index dd660d62a58..ad12a2cd6dc 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/filters_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/filters_test.clj
@@ -488,7 +488,11 @@
(testing "new tool call with just query"
(is (=? expected
(metabot-v3.tools.filters/filter-records
- (assoc input :data-source (select-keys query-details [:query]))))))))))
+ (assoc input :data-source (select-keys query-details [:query]))))))
+ (testing "MBQL v5 query works"
+ (is (=? expected
+ (metabot-v3.tools.filters/filter-records
+ (assoc input :data-source {:query query})))))))))
(deftest ^:parallel query-datasource-table-test
(mt/with-current-user (mt/user->id :crowberto)
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/find_outliers_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/find_outliers_test.clj
index 599f972e9c4..bd7e720027b 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/find_outliers_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/find_outliers_test.clj
@@ -128,10 +128,11 @@
{:data-source {:query (:query details)
:result-field-id result-field-id}}))
- (assoc-in query-details [:query :query :source-table] Integer/MAX_VALUE)
+ (update query-details :query (fn [query]
+ (lib/update-query-stage query 0 #(assoc % :source-table Integer/MAX_VALUE))))
"Unexpected error running query"
- (m/dissoc-in query-details [:query :query :breakout])
+ (update query-details :query lib/remove-all-breakouts)
"No temporal dimension found. Outliers can only be detected when a temporal dimension is available.")
(let [wrong-result-field-id (str result-field-id "99999")]
(is (= {:output (str "Invalid result_field_id " wrong-result-field-id)}