Skip to content

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

Adjust format-native-query to accept legacy mbql (#72217)

lbrdnk50e9fe7a7a82
diff --git a/src/metabase/metabot/agent/user_context.clj b/src/metabase/metabot/agent/user_context.clj
index 62be458152b..38cea4512e9 100644
--- a/src/metabase/metabot/agent/user_context.clj
+++ b/src/metabase/metabot/agent/user_context.clj
@@ -10,6 +10,7 @@
[metabase.metabot.tmpl :as te]
[metabase.metabot.tools.entity-details :as entity-details]
[metabase.metabot.tools.shared.llm-representations :as llm-rep]
+ [metabase.metabot.util :as metabot.u]
[metabase.util :as u]
[metabase.util.log :as log])
(:import
@@ -166,26 +167,30 @@
(str id)
(str/join ", " (map-indexed (fn [idx _] (str id "-" idx)) chart_configs)))))
+(defn- native-query-details
+ "Extract query details from legacy or modern native query."
+ [query]
+ {:database-id (:database query)
+ :query-str (metabot.u/extract-sql-content query)})
+
(defn- format-native-query
"Format viewing `item`"
[item]
- (assert (lib/native-only-query? (:query item))
- "Native MBQL5 query expected.")
- (te/lines
- "The user is currently in the SQL editor."
- (when (:id item)
- (te/field "Query ID" (:id item)))
- (te/field "Current SQL query"
- (te/code (lib/raw-native-query (:query item)) "sql"))
- (te/field "Database ID" (get-in item [:query :database]))
- (te/field "Database SQL engine" (:sql_engine item))
- (when-some [error (:error item)]
- (te/field "Query error" (te/code error)))
- (when-let [config-ids (format-chart-config-ids item)]
- (te/field "Chart Config IDs (for analyze_chart tool)" config-ids))
- (te/field "Tables used" (some->> (:used_tables item)
- (map format-entity)
- te/lines))))
+ (let [{:keys [database-id query-str]} (native-query-details (:query item))]
+ (te/lines
+ "The user is currently in the SQL editor."
+ (when (:id item)
+ (te/field "Query ID" (:id item)))
+ (te/field "Current SQL query" (te/code query-str "sql"))
+ (te/field "Database ID" database-id)
+ (te/field "Database SQL engine" (:sql_engine item))
+ (when-some [error (:error item)]
+ (te/field "Query error" (te/code error)))
+ (when-let [config-ids (format-chart-config-ids item)]
+ (te/field "Chart Config IDs (for analyze_chart tool)" config-ids))
+ (te/field "Tables used" (some->> (:used_tables item)
+ (map format-entity)
+ te/lines)))))
(defmethod format-entity "question"
[entity]
diff --git a/src/metabase/metabot/tools/sql/edit.clj b/src/metabase/metabot/tools/sql/edit.clj
index 740f5252da3..d87b79bb243 100644
--- a/src/metabase/metabot/tools/sql/edit.clj
+++ b/src/metabase/metabot/tools/sql/edit.clj
@@ -4,22 +4,13 @@
[clojure.string :as str]
[metabase.metabot.tools.sql.common :as metabot.tools.sql.common]
[metabase.metabot.tools.sql.validation :as metabot.tools.sql.validation]
+ [metabase.metabot.util :as metabot.u]
[metabase.util.i18n :refer [tru]]
[metabase.util.log :as log]
[metabase.util.malli :as mu]))
(set! *warn-on-reflection* true)
-(defn- extract-sql-content
- "Extract SQL content from a dataset_query map.
- Handles both legacy format and lib/query format."
- [query]
- (or
- ;; Try lib/query format (with stages)
- (get-in query [:stages 0 :native])
- ;; Try legacy format
- (get-in query [:native :query])))
-
(defn- apply-sql-edit
"Apply a targeted string replacement to SQL content."
[sql {:keys [old_string new_string replace_all]}]
@@ -68,7 +59,7 @@
:query-id query-id
:available-queries (keys queries-state)})))
- (let [current-sql (extract-sql-content query)]
+ (let [current-sql (metabot.u/extract-sql-content query)]
(when-not current-sql
(throw (ex-info (tru "Query {0} is not a SQL query" query-id)
{:agent-error? true
diff --git a/src/metabase/metabot/util.clj b/src/metabase/metabot/util.clj
index 7e9e1db7a37..bb366beb49c 100644
--- a/src/metabase/metabot/util.clj
+++ b/src/metabase/metabot/util.clj
@@ -99,3 +99,18 @@
(str/starts-with? res "<?xml") (subs (inc (.indexOf res "\n"))))))]
(->> (map fmt bits)
(str/join "\n"))))
+
+;;; MBQL utils (needed until we erradicate legacy from Metabot module)
+
+(defn extract-sql-content
+ "Extract SQL content from a dataset_query map.
+ Handles both legacy format and lib/query format."
+ [query]
+ (or
+ ;; Following should be ideally handled by lib functions. However we have test in place that checks this piece
+ ;; is able to handle not-normalized mblq5 with e.g. string value for type. Lib functions throw on such input.
+ ;;
+ ;; Try lib/query format (with stages)
+ (get-in query [:stages 0 :native])
+ ;; Try legacy format
+ (get-in query [:native :query])))
diff --git a/test/metabase/metabot/agent/user_context_test.clj b/test/metabase/metabot/agent/user_context_test.clj
index c5e6fb96b83..9c546e261fb 100644
--- a/test/metabase/metabot/agent/user_context_test.clj
+++ b/test/metabase/metabot/agent/user_context_test.clj
@@ -1,5 +1,6 @@
(ns metabase.metabot.agent.user-context-test
(:require
+ [clojure.string :as str]
[clojure.test :refer :all]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
@@ -435,3 +436,21 @@
{:user_is_viewing [{:type "table" :id (mt/id :orders)}]})]
(is (re-find #"(?i)orders" result))
(is (re-find #"(?i)field" result))))))
+
+(deftest ^:parallel format-user-context-with-legacy-query-test
+ (let [lq {:database 1111
+ :type :native
+ :native {:query "select 1"}}
+ {:keys [result error]}
+ (try {:result (user-context/format-viewing-context
+ {:user_is_viewing [{:type "adhoc" :query lq}]})}
+ (catch Throwable t
+ {:error t}))]
+ (is (nil? error)
+ "Formatting of context with legacy query should yield no error.")
+ (is (string? result)
+ "Formatting result should be a string.")
+ (is (str/includes? result "select 1")
+ "Formatting result should contain the native query string")
+ (is (str/includes? result "1111")
+ "Formatting result should contain database id")))