Skip to content

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

Correct function for fetching field values in Metabot tools (#69589)

Noah Mossaa4389bd603a
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index c611f5c7db2..f28cb655bcb 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -951,6 +951,7 @@
metabase.parameters.custom-values
metabase.parameters.dashboard
metabase.parameters.field
+ metabase.parameters.field-values
metabase.parameters.init
metabase.parameters.params
metabase.parameters.schema
@@ -2201,6 +2202,7 @@
lib-be
models
native-query-snippets
+ parameters
permissions
premium-features
pulse
@@ -2216,7 +2218,6 @@
transforms
users
util
- warehouse-schema
warehouses
enterprise/dependencies
enterprise/transforms-python}}
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/entity_details.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/entity_details.clj
index 5e50002b6d4..725f8a4feb6 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/entity_details.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/entity_details.clj
@@ -9,11 +9,11 @@
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.lib.types.isa :as lib.types.isa]
+ [metabase.parameters.field-values :as params.field-values]
[metabase.util :as u]
[metabase.util.humanization :as u.humanization]
[metabase.util.i18n :as i18n]
[metabase.util.log :as log]
- [metabase.warehouse-schema.models.field-values :as field-values]
[toucan2.core :as t2]))
(set! *warn-on-reflection* true)
@@ -80,16 +80,18 @@
:verified (verified-review? dashboard-id "dashboard")))})
{:output "dashboard not found"}))
-(defn- get-field-values [id->values id]
- (->
- (get id->values id)
- (or (field-values/get-or-create-full-field-values! (t2/select-one :model/Field :id id)))
- :values))
+(defn- get-field-values
+ "Get field values for a field, creating them if they don't exist.
+ Uses the user-aware API that respects sandboxing/impersonation."
+ [id->values id]
+ (-> (get id->values id)
+ (or (params.field-values/get-or-create-field-values! (t2/select-one :model/Field :id id)))
+ :values))
(defn- add-field-values
[cols]
(if-let [field-ids (seq (keep :id cols))]
- (let [id->values (field-values/batched-get-latest-full-field-values field-ids)]
+ (let [id->values (params.field-values/field-id->field-values-for-current-user field-ids)]
(map #(m/assoc-some % :field-values (some->> % :id (get-field-values id->values))) cols))
cols))
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/field_stats.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/field_stats.clj
index 56d6c7a598e..391ea94f26b 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/field_stats.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/field_stats.clj
@@ -3,8 +3,8 @@
[clojure.set :as set]
[metabase-enterprise.metabot-v3.tools.util :as metabot-v3.tools.u]
[metabase.lib.core :as lib]
+ [metabase.parameters.field-values :as params.field-values]
[metabase.sync.core :as sync]
- [metabase.warehouse-schema.models.field-values :as field-values]
[toucan2.core :as t2]))
(defn- build-field-statistics [fvs fp limit]
@@ -25,7 +25,7 @@
[{:keys [id fingerprint]} limit]
(if id
(let [field (t2/select-one :model/Field :id id)
- fvs (field-values/get-or-create-full-field-values! field)
+ fvs (params.field-values/get-or-create-field-values! field)
fp (or fingerprint (get-or-create-fingerprint! field))]
(build-field-statistics fvs fp limit))
(build-field-statistics nil fingerprint limit)))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/entity_details_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/entity_details_test.clj
index 072bdf48ea3..4268d21d8bf 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/entity_details_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/entity_details_test.clj
@@ -2,10 +2,12 @@
(:require
[clojure.test :refer :all]
[metabase-enterprise.metabot-v3.tools.entity-details :as entity-details]
+ [metabase-enterprise.test :as met]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.test :as mt]
- [metabase.test.fixtures :as fixtures]))
+ [metabase.test.fixtures :as fixtures]
+ [toucan2.core :as t2]))
(use-fixtures :once (fixtures/initialize :db :test-users))
@@ -274,3 +276,20 @@
(let [segment (first segments)]
(is (= segment-id (:id segment)))
(is (= "Large Orders" (:name segment)))))))))))
+
+(defn- sandboxed-query []
+ (let [mp (mt/metadata-provider)
+ table (lib.metadata/table mp (mt/id :categories))
+ id-field (lib.metadata/field mp (mt/id :categories :id))]
+ (lib/filter (lib/query mp table) (lib/< id-field 3))))
+
+(deftest sandboxed-field-values-test
+ (met/with-gtaps! {:gtaps {:categories {:query (sandboxed-query)}}}
+ (let [field-id (mt/id :categories :name)]
+ (try
+ (let [result (entity-details/get-table-details {:table-id (mt/id :categories)})
+ name-field (some #(when (= "NAME" (:name %)) %) (get-in result [:structured-output :fields]))]
+ (testing "returns sandboxed field values"
+ (is (= ["African" "American"] (:field_values name-field)))))
+ (finally
+ (t2/delete! :model/FieldValues :field_id field-id :type :advanced))))))
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/field_stats_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/field_stats_test.clj
index adcdf6aff13..4c622fdfead 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/field_stats_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/field_stats_test.clj
@@ -3,6 +3,7 @@
[clojure.test :refer :all]
[metabase-enterprise.metabot-v3.tools.field-stats :as metabot-v3.tools.field-stats]
[metabase-enterprise.metabot-v3.tools.util :as metabot-v3.tools.u]
+ [metabase-enterprise.test :as met]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.test :as mt]
@@ -152,3 +153,24 @@
:percent-null 0.0
:earliest "1958-04-26"
:latest "2000-04-03"}}))))))
+
+(defn- sandboxed-query []
+ (let [mp (mt/metadata-provider)
+ table (lib.metadata/table mp (mt/id :categories))
+ id-field (lib.metadata/field mp (mt/id :categories :id))]
+ (lib/filter (lib/query mp table) (lib/< id-field 3))))
+
+(deftest sandboxed-field-values-test
+ (met/with-gtaps! {:gtaps {:categories {:query (sandboxed-query)}}}
+ (let [field-id (mt/id :categories :name)
+ table-id (mt/id :categories)
+ mp (mt/metadata-provider)
+ tq (table-query mp table-id)
+ agent-field-id (visible-field-id tq (metabot-v3.tools.u/table-field-id-prefix table-id) "Name")]
+ (try
+ (let [result (metabot-v3.tools.field-stats/field-values
+ {:entity-type "table", :entity-id table-id, :field-id agent-field-id, :limit 10})]
+ (testing "returns sandboxed field values"
+ (is (= ["African" "American"] (get-in result [:structured-output :values])))))
+ (finally
+ (t2/delete! :model/FieldValues :field_id field-id :type :advanced))))))