Skip to content

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

Revised approach to related_tables and consistent field IDs for implicitly-joined fields (#66271)

Noah Mossb561b5c8b941
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 45c251ad19d..f3350118939 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/dummy_tools.clj
@@ -173,13 +173,13 @@
table-query (when query-needed?
(lib/query mp (lib.metadata/table mp id)))
cols (when with-fields?
- (->> (lib/visible-columns table-query)
+ (->> (lib/visible-columns table-query -1 {:include-implicitly-joinable? false})
field-values-fn
(map #(metabot-v3.tools.u/add-table-reference table-query %))))
- field-id-prefix (when with-fields?
+ field-id-prefix (when (or with-fields? with-related-tables?)
(metabot-v3.tools.u/table-field-id-prefix id))
related-tables (when with-related-tables?
- (related-tables table-query with-fields? field-values-fn))]
+ (related-tables table-query field-id-prefix with-fields? field-values-fn))]
(-> {:id id
:type :table
:fields (into [] (map-indexed #(metabot-v3.tools.u/->result-column table-query %2 %1 field-id-prefix)) cols)
@@ -196,21 +196,42 @@
(not-empty (mapv #(convert-metric % mp options)
(lib/available-metrics table-query))))))))))
-(defn- related-tables
- "Constructs a list of tables, optionally including their fields, that are related to the given query via foreign key."
- [query with-fields? field-values-fn]
- (let [fk-fields (->> (lib/visible-columns query)
- (filter :fk-field-id))
- related-table-ids (->> fk-fields
- (map :table-id)
- (into #{}))]
- (when (seq related-table-ids)
- (map #(table-details % {:with-fields? with-fields?
- :field-values-fn field-values-fn
- ;; Important! Only recurse one level
- :with-related-tables? false
- :with-metrics? false})
- related-table-ids))))
+(defn related-tables
+ "Constructs a list of tables, optionally including their fields, that are related to the given query via foreign key.
+ Creates separate entries for each FK path when the same table is reachable through multiple foreign keys."
+ [query main-field-id-prefix with-fields? field-values-fn]
+ (let [all-main-cols (lib/visible-columns query)
+ ;; Map [table-id fk-field-id field-name] -> index in the main query
+ contextual-index (into {}
+ (keep-indexed
+ (fn [idx {:keys [fk-field-id table-id name]}]
+ (when fk-field-id
+ {[table-id fk-field-id name] idx})))
+ all-main-cols)
+ fk-cols (filter :fk-field-id all-main-cols)
+ ;; { [table-id fk-field-id] [fk-col ...] }
+ grouped-fks (group-by (juxt :table-id :fk-field-id) fk-cols)]
+ (when (seq grouped-fks)
+ (mapv
+ (fn [[[table-id fk-field-id] _]]
+ (let [base-details (table-details table-id
+ {:with-fields? with-fields?
+ :field-values-fn field-values-fn
+ :with-related-tables? false
+ :with-metrics? false})
+ base-table-col (lib.metadata/field query fk-field-id)
+ fk-field-name (:name base-table-col)
+ updated-fields
+ (when with-fields?
+ (->> (:fields base-details)
+ (keep
+ (fn [{:keys [name] :as field}]
+ (when-let [idx (get contextual-index [table-id fk-field-id name])]
+ (assoc field :field_id (str main-field-id-prefix idx)))))))]
+ (-> (cond-> base-details
+ updated-fields (assoc :fields updated-fields))
+ (assoc :related_by fk-field-name))))
+ grouped-fks))))
(defn- card-details
"Get details for a card."
@@ -241,9 +262,9 @@
returned-fields (when with-fields?
(->> (lib/returned-columns card-query)
field-values-fn))
+ field-id-prefix (metabot-v3.tools.u/card-field-id-prefix id)
related-tables (when with-related-tables?
- (related-tables card-query with-fields? field-values-fn))
- field-id-prefix (metabot-v3.tools.u/card-field-id-prefix id)]
+ (related-tables card-query field-id-prefix with-fields? field-values-fn))]
(-> {:id id
:type card-type
:fields (into [] (map-indexed #(metabot-v3.tools.u/->result-column card-query %2 %1 field-id-prefix)) returned-fields)
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
index c03e26936cc..2081b95295b 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/api.clj
@@ -180,7 +180,7 @@
[:field_id :string]
[:field_granularity {:optional true}
[:maybe [:enum {:encode/tool-api-request keyword}
- "day" "week" "month" "quarter" "year"]]]]
+ "minute", "hour" "day" "week" "month" "quarter" "year" "day-of-week"]]]]
[:map {:encode/tool-api-request #(update-keys % metabot-v3.u/safe->kebab-case-en)}]])
(mr/def ::query-metric-arguments
@@ -613,6 +613,7 @@
[:database_schema {:optional true} [:maybe :string]] ; Schema name, if applicable
[:fields ::columns]
[:related_tables {:optional true} [:sequential [:ref ::table-result]]]
+ [:related_by {:optional true} [:maybe :string]]
[:description {:optional true} [:maybe :string]]
[:metrics {:optional true} [:sequential ::basic-metric]]])
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 18caa79f7fa..335c52b4d6c 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
@@ -34,13 +34,12 @@
(defn- table-field-stats
[table-id agent-field-id limit]
(try
- (let [field-id-prefix (metabot-v3.tools.u/table-field-id-prefix table-id)
- index (metabot-v3.tools.u/resolve-column-index agent-field-id field-id-prefix)
- query (metabot-v3.tools.u/table-query table-id)]
+ (let [query (metabot-v3.tools.u/table-query table-id)]
(if query
- (if-let [col (nth (lib/visible-columns query) index nil)]
- {:structured-output (field-statistics col limit)}
- {:output (str "No field found with ID " agent-field-id)})
+ (let [field-id-prefix (metabot-v3.tools.u/table-field-id-prefix table-id)
+ visible-cols (lib/visible-columns query)
+ col (:column (metabot-v3.tools.u/resolve-column {:field-id agent-field-id} field-id-prefix visible-cols))]
+ {:structured-output (field-statistics col limit)})
{:output (str "No table found with ID " table-id)}))
(catch Exception ex
(metabot-v3.tools.u/handle-agent-error ex))))
@@ -48,13 +47,12 @@
(defn- card-field-stats
[card-id agent-field-id limit card-type]
(try
- (let [field-id-prefix (metabot-v3.tools.u/card-field-id-prefix card-id)
- index (metabot-v3.tools.u/resolve-column-index agent-field-id field-id-prefix)
- query (metabot-v3.tools.u/card-query card-id)]
+ (let [query (metabot-v3.tools.u/card-query card-id)]
(if query
- (if-let [col (nth (lib/visible-columns query) index nil)]
- {:structured-output (field-statistics col limit)}
- {:output (str "No field found with ID " agent-field-id)})
+ (let [field-id-prefix (metabot-v3.tools.u/card-field-id-prefix card-id)
+ visible-cols (lib/visible-columns query)
+ col (:column (metabot-v3.tools.u/resolve-column {:field-id agent-field-id} field-id-prefix visible-cols))]
+ {:structured-output (field-statistics col limit)})
{:output (str "No " card-type " found with ID " card-id)}))
(catch Exception ex
(metabot-v3.tools.u/handle-agent-error ex))))
@@ -62,13 +60,12 @@
(defn- metric-field-stats
[metric-id agent-field-id limit]
(try
- (let [field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
- index (metabot-v3.tools.u/resolve-column-index agent-field-id field-id-prefix)
- query (metabot-v3.tools.u/metric-query metric-id)]
+ (let [query (metabot-v3.tools.u/metric-query metric-id)]
(if query
- (if-let [col (nth (lib/filterable-columns query) index nil)]
- {:structured-output (field-statistics col limit)}
- {:output (str "No field found with ID " agent-field-id)})
+ (let [field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
+ filterable-cols (lib/filterable-columns query)
+ col (:column (metabot-v3.tools.u/resolve-column {:field-id agent-field-id} field-id-prefix filterable-cols))]
+ {:structured-output (field-statistics col limit)})
{:output (str "No metric found with ID " metric-id)}))
(catch Exception ex
(metabot-v3.tools.u/handle-agent-error ex))))
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 20053a2959f..f3652ef59fc 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/filters.clj
@@ -151,15 +151,15 @@
mp (lib-be/application-database-metadata-provider (:database_id card))
base-query (->> (lib/query mp (lib.metadata/card mp metric-id))
lib/remove-all-breakouts)
+ field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
visible-cols (lib/visible-columns base-query)
- filter-field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
query (as-> base-query $q
(reduce add-filter
$q
- (map #(metabot-v3.tools.u/resolve-column % filter-field-id-prefix visible-cols) filters))
+ (map #(metabot-v3.tools.u/resolve-column % field-id-prefix visible-cols) filters))
(reduce add-breakout
$q
- (map #(metabot-v3.tools.u/resolve-column % filter-field-id-prefix visible-cols) group-by)))
+ (map #(metabot-v3.tools.u/resolve-column % field-id-prefix visible-cols) group-by)))
query-id (u/generate-nano-id)
query-field-id-prefix (metabot-v3.tools.u/query-field-id-prefix query-id)
returned-cols (lib/returned-columns query)]
@@ -234,9 +234,9 @@
(let [card (metabot-v3.tools.u/get-card model-id)
mp (lib-be/application-database-metadata-provider (:database_id card))
base-query (lib/query mp (lib.metadata/card mp model-id))
+ field-id-prefix (metabot-v3.tools.u/card-field-id-prefix model-id)
visible-cols (lib/visible-columns base-query)
- filter-field-id-prefix (metabot-v3.tools.u/card-field-id-prefix model-id)
- resolve-visible-column #(metabot-v3.tools.u/resolve-column % filter-field-id-prefix visible-cols)
+ resolve-visible-column #(metabot-v3.tools.u/resolve-column % field-id-prefix visible-cols)
resolve-order-by-column (fn [{:keys [field direction]}] {:field (resolve-visible-column field) :direction direction})
projection (map (comp (juxt filter-bucketed-column (fn [{:keys [column bucket]}]
(let [column (cond-> column
@@ -415,12 +415,12 @@
api/*is-superuser?* true]
(-> (filter-records #_{:data-source {:tabl-id 3}
:filters [{:operation "number-greater-than"
- :field-id "t3/6"
+ :field-id "t3-6"
:value 50}]}
{:data-source {:table-id 1}
:filters [{:operation "greater-than"
:bucket "month-of-year"
- :field-id "t1/3"
+ :field-id "t1-3"
:value #_"2020-01-01" 1}]})
:structured-output :query qp/process-query :data :native_form :query))
-)
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/find_outliers.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/find_outliers.clj
index f2061b343ac..054365126cc 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/find_outliers.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/find_outliers.clj
@@ -16,34 +16,27 @@
:dataset_query))
(defn- find-dataset-query
- [{:keys [query query-id report-id metric-id] :as data-source}]
- (letfn [(handle-query [query query-id]
- (api/read-check :model/Database (:database query))
- [(if query-id
- (metabot-v3.tools.u/query-field-id-prefix query-id)
- metabot-v3.tools.u/any-prefix-pattern)
- query])]
- (cond
- metric-id (if (int? metric-id)
- [(metabot-v3.tools.u/card-field-id-prefix metric-id)
- (checked-card-dataset-query metric-id)]
- (throw (ex-info "Invalid metric_id as data_source" {:agent-error? true
- :data-source data-source})))
- report-id (if (int? report-id)
- [(metabot-v3.tools.u/card-field-id-prefix report-id)
- (checked-card-dataset-query report-id)]
- (throw (ex-info "Invalid report_id as data_source" {:agent-error? true
- :data-source data-source})))
- query (handle-query query query-id)
- :else (throw (ex-info "Invalid data_source" {:agent-error? true
- :data-source data-source})))))
+ [{:keys [query report-id metric-id] :as data-source}]
+ (cond
+ metric-id (if (int? metric-id)
+ (checked-card-dataset-query metric-id)
+ (throw (ex-info "Invalid metric_id as data_source" {:agent-error? true
+ :data-source data-source})))
+ report-id (if (int? report-id)
+ (checked-card-dataset-query report-id)
+ (throw (ex-info "Invalid report_id as data_source" {:agent-error? true
+ :data-source data-source})))
+ query (do (api/read-check :model/Database (:database query))
+ query)
+ :else (throw (ex-info "Invalid data_source" {:agent-error? true
+ :data-source data-source}))))
(defn find-outliers
"Find outliers in the values provided by `data-source` for a given column."
[{:keys [data-source]}]
(let [{:keys [metric-id result-field-id]} data-source]
(try
- (let [[field-id-prefix dataset-query] (find-dataset-query data-source)
+ (let [dataset-query (find-dataset-query data-source)
{:keys [data]} (u/prog1 (-> dataset-query
(qp/userland-query-with-default-constraints {:context :ad-hoc})
qp/process-query)
@@ -67,7 +60,12 @@
first)
(throw (ex-info "Could not determine result field."
{:agent-error? true})))
- (metabot-v3.tools.u/resolve-column-index result-field-id field-id-prefix))]
+ ;; Parse field-id and extract the numeric index
+ (if-let [{:keys [field-index]} (metabot-v3.tools.u/parse-field-id result-field-id)]
+ field-index
+ (throw (ex-info (str "Invalid result_field_id format: " result-field-id)
+ {:agent-error? true
+ :result-field-id result-field-id}))))]
(when-not (< -1 value-col-idx (-> data :rows first count))
(throw (ex-info (str "Invalid result_field_id " result-field-id)
{:agent-error? true})))
diff --git a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/util.clj b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/util.clj
index ef6a9c2da0a..b252d93872f 100644
--- a/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/util.clj
+++ b/enterprise/backend/src/metabase_enterprise/metabot_v3/tools/util.clj
@@ -45,21 +45,21 @@
(defn table-field-id-prefix
"Return the field ID prefix for `table-id`."
[table-id]
- (str "t" table-id "/"))
+ (str "t" table-id "-"))
(defn card-field-id-prefix
"Return the field ID prefix for a model or a metric with ID `card-id`."
[card-id]
- (str "c" card-id "/"))
+ (str "c" card-id "-"))
(defn query-field-id-prefix
"Return the field ID prefix for `query-id`."
[query-id]
- (str "q" query-id "/"))
+ (str "q" query-id "-"))
(def any-prefix-pattern
"A prefix pattern accepting columns from any entity."
- #"^.*/(\d+)")
+ #"^.*-(\d+)")
(defn ->result-column
"Return tool result columns for `column` of `query`. The position of `column` is determined by `index`.
@@ -77,29 +77,65 @@
:field_values (:field-values column)
:table_reference (:table-reference column)))))
-(defn resolve-column-index
- "Resolve the reference `field_id` to the index of the result columns in the entity with `field-id-prefix`."
- [field-id field-id-prefix]
- (if (string? field-id-prefix)
- (if (str/starts-with? field-id field-id-prefix)
- (-> field-id (subs (count field-id-prefix)) parse-long)
- (throw (ex-info (str "field " field-id " not found") {:agent-error? true
- :expected-prefix field-id-prefix})))
- (if-let [id-str (when (instance? java.util.regex.Pattern field-id-prefix)
- (-> (re-matches field-id-prefix field-id)
- second))]
- (parse-long id-str)
- (throw (ex-info (str "invalid field_id " field-id " for prefix " field-id-prefix)
- {:agent-error? true
- :expected-prefix (str field-id-prefix)
- :field-id field-id})))))
+(defn parse-field-id
+ "Parse a field-id string into its components.
+
+ The field-id format is '<model-tag><model-id>-<field-index>' where:
+ - model-tag is 't' for tables, 'c' for cards/models/metrics, or 'q' for ad-hoc queries
+ - model-id is the numeric ID (for tables/cards) or nano-id (for queries)
+ - field-index is the index within that model's visible columns
+
+ Returns a map with :model-tag, :model-id, and :field-index keys, or nil if the format is invalid.
+
+ Examples:
+ (parse-field-id \"t154-1\") => {:model-tag \"t\", :model-id 154, :field-index 1}
+ (parse-field-id \"qpuL95JSvym3k23W1UUuog-0\") => {:model-tag \"q\", :model-id \"puL95JSvym3k23W1UUuog\", :field-index 0}"
+ [field-id]
+ (when-let [[_ model-tag model-id field-index] (re-matches #"^([tcq])(.+)-(\d+)$" field-id)]
+ {:model-tag model-tag
+ ;; For tables and cards, model-id should be numeric; for queries it's a nano-id string
+ :model-id (if (= model-tag "q")
+ model-id
+ (parse-long model-id))
+ :field-index (parse-long field-index)}))
(defn resolve-column
"Resolve the reference `field-id` in filter `item` by finding the column in `columns` specified by `field-id`.
- `field-id-prefix` is used to check if the filter refers to a column from the right entity."
- [{:keys [field-id] :as item} field-id-prefix columns]
- (let [index (resolve-column-index field-id field-id-prefix)]
- (assoc item :column (nth columns index))))
+
+ The field-id format is '<model-tag><model-id>-<field-index>' where:
+ - model-tag is 't' for tables, 'c' for cards/models/metrics, or 'q' for ad-hoc queries
+ - model-id is the numeric ID (for tables/cards) or nano-id (for queries)
+ - field-index is the index within the columns array (using wide field IDs across all visible columns)
+
+ The `expected-prefix` parameter validates that the field-id starts with the expected prefix (e.g., 't154-' for table 154).
+ This prevents accidentally using a field-id from a different entity.
+
+ For example, 't154-1' refers to the column at index 1 in the columns array,
+ and 'qpuL95JSvym3k23W1UUuog-0' refers to the column at index 0."
+ [{:keys [field-id] :as item} expected-prefix columns]
+ (if-let [{:keys [model-tag model-id field-index]} (parse-field-id field-id)]
+ (do
+ ;; Validate that the field-id matches the expected prefix
+ ;; Supports both string prefixes (e.g., "t154-") and regex patterns (e.g., #"^.*-(\d+)")
+ (when-not (if (string? expected-prefix)
+ (str/starts-with? field-id expected-prefix)
+ (re-matches expected-prefix field-id))
+ (throw (ex-info (str "field " field-id " does not match expected prefix " expected-prefix)
+ {:agent-error? true
+ :field-id field-id
+ :expected-prefix expected-prefix})))
+ (if-let [column (get columns field-index)]
+ (assoc item :column column)
+ (throw (ex-info (str "field " field-id " not found - no column at index " field-index)
+ {:agent-error? true
+ :field-id field-id
+ :model-tag model-tag
+ :model-id model-id
+ :field-index field-index
+ :available-columns-count (count columns)}))))
+ (throw (ex-info (str "invalid field_id format: " field-id)
+ {:agent-error? true
+ :field-id field-id}))))
(defn get-database
"Get the `fields` of the database with ID `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 3c2a6c24bb2..a1eb9141269 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
@@ -133,3 +133,27 @@
(is (map? (:query output)))
(is (= (mt/id) (get-in output [:query :database])))
(is (sequential? (:result-columns output)))))))))
+
+(deftest related-tables-exclude-implicitly-joinable-fields-test
+ (testing "Related tables should only include fields from the table itself, not implicitly joinable fields"
+ (mt/test-driver :h2
+ (mt/with-current-user (mt/user->id :crowberto)
+ (let [orders-id (mt/id :orders)
+ products-id (mt/id :products)
+ ;; Get expected field count for Products table (without implicitly joinable fields)
+ products-query (lib/query (mt/metadata-provider) (mt/mbql-query products))
+ expected-products-field-count (count (lib/visible-columns products-query -1 {:include-implicitly-joinable? false}))
+ ;; Get Orders table details with related tables
+ result (dummy-tools/get-table-details {:table-id orders-id})
+ output (:structured-output result)
+ related-tables (:related_tables output)
+ products-related (first (filter #(= products-id (:id %)) related-tables))]
+
+ (testing "Orders table has Products as a related table"
+ (is (some? products-related)))
+
+ (testing "Related Products table has correct number of fields (excluding implicitly joinable fields)"
+ (is (= expected-products-field-count
+ (count (:fields products-related)))
+ (str "Products related table should have " expected-products-field-count
+ " fields (only its own fields, not implicitly joinable fields)"))))))))
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 d4a6823db30..87af52b67ba 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
@@ -113,13 +113,13 @@
:query-id query-id
:query {}
:result-columns []}})]
- (let [filters [{:field_id "q2a/1", :operation "is-not-null"}
- {:field_id "q2a/2", :operation "equals", :value "3"}
- {:field_id "q2a/3", :operation "equals", :values ["3" "4"]}
- {:field_id "q2a/5", :operation "not-equals", :values [3 4]}
- {:field_id "q2a/6", :operation "month-equals", :values [4 5 9]}
- {:field_id "c2a/6", :bucket "week-of-year" :operation "not-equals", :values [14 15 19]}
- {:field_id "q2a/6", :operation "year-equals", :value 2008}]
+ (let [filters [{:field_id "q2a-1", :operation "is-not-null"}
+ {:field_id "q2a-2", :operation "equals", :value "3"}
+ {:field_id "q2a-3", :operation "equals", :values ["3" "4"]}
+ {:field_id "q2a-5", :operation "not-equals", :values [3 4]}
+ {:field_id "q2a-6", :operation "month-equals", :values [4 5 9]}
+ {:field_id "c2a-6", :bucket "week-of-year" :operation "not-equals", :values [14 15 19]}
+ {:field_id "q2a-6", :operation "year-equals", :value 2008}]
response (mt/user-http-request :rasta :post 200 "ee/metabot-tools/filter-records"
{:request-options {:headers {"x-metabase-session" ai-token}}}
{:arguments {:data_source data-source
@@ -135,11 +135,11 @@
response))))))))
(deftest find-outliers-test
- (doseq [data-source [{:query {:database 1}, :query_id "query ID", :result_field_id "q1233/2"}
- {:query {:database 1}, :result_field_id "q1233/2"}
+ (doseq [data-source [{:query {:database 1}, :query_id "query ID", :result_field_id "q1233-2"}
+ {:query {:database 1}, :result_field_id "q1233-2"}
{:metric_id 1}
- {:report_id 1, :result_field_id "c131/3"}
- {:table_id "card__1", :result_field_id "t42/7"}]]
+ {:report_id 1, :result_field_id "c131-3"}
+ {:table_id "card__1", :result_field_id "t42-7"}]]
(mt/with-premium-features #{:metabot-v3}
(let [tool-requests (atom [])
conversation-id (str (random-uuid))
@@ -197,15 +197,15 @@
:query-id output
:query {}
:result-columns []}})]
- (let [filters [{:field_id "c2/7", :operation "number-greater-than", :value 50}
- {:field_id "c2/3", :operation "equals", :values ["3" "4"]}
- {:field_id "c2/5", :operation "not-equals", :values [3 4]}
- {:field_id "c2/6", :operation "month-equals", :values [4 5 9]}
- {:field_id "c2/6", :bucket "day-of-month" :operation "not-equals", :values [14 15 19]}
- {:field_id "c2/6", :bucket "day-of-week" :operation "equals", :values [1 7]}
- {:field_id "c2/6", :operation "year-equals", :value 2008}]
- breakouts [{:field_id "c2/4", :field_granularity "week"}
- {:field_id "c2/6", :field_granularity "day"}]
+ (let [filters [{:field_id "c2-7", :operation "number-greater-than", :value 50}
+ {:field_id "c2-3", :operation "equals", :values ["3" "4"]}
+ {:field_id "c2-5", :operation "not-equals", :values [3 4]}
+ {:field_id "c2-6", :operation "month-equals", :values [4 5 9]}
+ {:field_id "c2-6", :bucket "day-of-month" :operation "not-equals", :values [14 15 19]}
+ {:field_id "c2-6", :bucket "day-of-week" :operation "equals", :values [1 7]}
+ {:field_id "c2-6", :operation "year-equals", :value 2008}]
+ breakouts [{:field_id "c2-4", :field_granularity "week"}
+ {:field_id "c2-6", :field_granularity "day"}]
response (mt/user-http-request :rasta :post 200 "ee/metabot-tools/query-metric"
{:request-options {:headers {"x-metabase-session" ai-token}}}
{:arguments {:metric_id 1
@@ -233,7 +233,7 @@
:dataset_query (lib/->legacy-MBQL source-query)
:type :metric}]
(mt/with-temp [:model/Card {metric-id :id} metric-data]
- (let [fid #(format "c%d/%d" metric-id %)
+ (let [fid #(format "c%d-%d" metric-id %)
filters [{:field_id (fid 0), :operation "number-greater-than", :value 50} ; ID
{:field_id (fid 2), :operation "equals", :values ["3" "4"]} ; Title
{:field_id (fid 6), :operation "not-equals", :values [3 4]} ; Rating
@@ -265,17 +265,17 @@
[:= [:get-day-of-week [:field %created_at {}] :iso] 1 7]
[:= [:get-year [:field %created_at {}]] 2008]]})
:result_columns
- [{:field_id (str "q" query-id "/0")
+ [{:field_id (str "q" query-id "-0")
:name "CREATED_AT"
:display_name "Created At: Week"
:type "datetime"
:semantic_type "creation_timestamp"}
- {:field_id (str "q" query-id "/1")
+ {:field_id (str "q" query-id "-1")
:name "CREATED_AT_2"
:display_name "Created At: Day"
:type "datetime"
:semantic_type "creation_timestamp"}
- {:field_id (str "q" query-id "/2")
+ {:field_id (str "q" query-id "-2")
:name "avg"
:display_name "Metrica"
:type "number"
@@ -297,19 +297,19 @@
:query-id output
:query {}
:result-columns []}})]
- (let [fields [{:field_id "c2/8", :bucket "year-of-era"}
- {:field_id "c2/9"}]
- filters [{:field_id "c2/7", :operation "number-greater-than", :value 50}
- {:field_id "c2/3", :operation "equals", :values ["3" "4"]}
- {:field_id "c2/5", :operation "not-equals", :values [3 4]}
- {:field_id "c2/6", :operation "month-equals", :values [4 5 9]}
- {:field_id "c2/6", :bucket "day-of-month" :operation "not-equals", :values [14 15 19]}
- {:field_id "c2/6", :bucket "day-of-week" :operation "equals", :values [1 7]}
- {:field_id "c2/6", :operation "year-equals", :value 2008}]
- aggregations [{:field_id "c2/10", :bucket "week", :function "count-distinct"}
- {:field_id "c2/11", :function "sum"}]
- breakouts [{:field_id "c2/4", :field_granularity "week"}
- {:field_id "c2/6", :field_granularity "day"}]
+ (let [fields [{:field_id "c2-8", :bucket "year-of-era"}
+ {:field_id "c2-9"}]
+ filters [{:field_id "c2-7", :operation "number-greater-than", :value 50}
+ {:field_id "c2-3", :operation "equals", :values ["3" "4"]}
+ {:field_id "c2-5", :operation "not-equals", :values [3 4]}
+ {:field_id "c2-6", :operation "month-equals", :values [4 5 9]}
+ {:field_id "c2-6", :bucket "day-of-month" :operation "not-equals", :values [14 15 19]}
+ {:field_id "c2-6", :bucket "day-of-week" :operation "equals", :values [1 7]}
+ {:field_id "c2-6", :operation "year-equals", :value 2008}]
+ aggregations [{:field_id "c2-10", :bucket "week", :function "count-distinct"}
+ {:field_id "c2-11", :function "sum"}]
+ breakouts [{:field_id "c2-4", :field_granularity "week"}
+ {:field_id "c2-6", :field_granularity "day"}]
response (mt/user-http-request :rasta :post 200 "ee/metabot-tools/query-model"
{:request-options {:headers {"x-metabase-session" ai-token}}}
{:arguments {:model_id 1
@@ -341,7 +341,7 @@
(swap! tool-requests conj arguments)
{:structured-output output})]
(let [fields []
- filters [{:field_id "c2/7", :operation "number-greater-than", :value 50}]
+ filters [{:field_id "c2-7", :operation "number-greater-than", :value 50}]
response (mt/user-http-request :rasta :post 200 "ee/metabot-tools/query-model"
{:request-options {:headers {"x-metabase-session" ai-token}}}
{:arguments {:model_id 1
@@ -430,17 +430,17 @@
(assoc :id metric-id
:type "metric"
:verified true
- :default_time_dimension_field_id (format "c%d/%d" metric-id 7)
+ :default_time_dimension_field_id (format "c%d-%d" metric-id 7)
:queryable_dimensions
- (map-indexed #(assoc %2 :field_id (format "c%d/%d" metric-id %1))
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" metric-id %1))
expected-fields)))
(-> model-metric-data
(select-keys [:name :description])
(assoc :id model-metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/%d" model-metric-id 7)
+ :default_time_dimension_field_id (format "c%d-%d" model-metric-id 7)
:queryable_dimensions
- (map-indexed #(assoc %2 :field_id (format "c%d/%d" model-metric-id %1))
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" model-metric-id %1))
expected-fields)))]
:models [(-> model-data
(select-keys [:name :description :database_id])
@@ -449,13 +449,13 @@
:verified true
:database_engine (db-engine-name)
:display_name "Model Model"
- :fields (map-indexed #(assoc %2 :field_id (format "c%d/%d" model-id %1))
+ :fields (map-indexed #(assoc %2 :field_id (format "c%d-%d" model-id %1))
expected-fields)
:metrics
[{:id model-metric-id
:name "Model metric"
:description "Model metric desc"
- :default_time_dimension_field_id (format "c%d/%d" model-metric-id 7)}]))]}
+ :default_time_dimension_field_id (format "c%d-%d" model-metric-id 7)}]))]}
:conversation_id conversation-id}
response))))
(testing "Minimal call"
@@ -594,9 +594,9 @@
(assoc :id metric-id
:type "metric"
:verified true
- :default_time_dimension_field_id (format "c%d/%d" metric-id 7)
+ :default_time_dimension_field_id (format "c%d-%d" metric-id 7)
:queryable_dimensions
- (map-indexed #(assoc %2 :field_id (format "c%d/%d" metric-id %1))
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" metric-id %1))
expected-fields)))
:conversation_id conversation-id}
(request {:metric_id metric-id}))))
@@ -606,10 +606,10 @@
(assoc :id metric-id
:type "metric"
:verified true
- :default_time_dimension_field_id (format "c%d/%d" metric-id 7)
+ :default_time_dimension_field_id (format "c%d-%d" metric-id 7)
:queryable_dimensions
(map-indexed #(assoc %2
- :field_id (format "c%d/%d" metric-id %1)
+ :field_id (format "c%d-%d" metric-id %1)
:field_values missing-value)
expected-fields)))
:conversation_id conversation-id}
@@ -621,7 +621,7 @@
(assoc :id metric-id
:type "metric"
:verified true
- :default_time_dimension_field_id (format "c%d/%d" metric-id 7)
+ :default_time_dimension_field_id (format "c%d-%d" metric-id 7)
:queryable_dimensions missing-value))
:conversation_id conversation-id}
(request {:metric_id metric-id
@@ -658,8 +658,8 @@
:query_id string?
: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"}]}
+ [{: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}
response))
;; Verify the query is normalized (supports both MBQL v4 and v5)
@@ -698,7 +698,7 @@
:type "question"
:verified true
:result_columns
- (map-indexed #(assoc %2 :field_id (format "c%d/%d" question-id %1))
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" question-id %1))
expected-fields)))
:conversation_id conversation-id}
(request arguments))))
@@ -709,7 +709,7 @@
:type "question"
:result_columns
(map-indexed #(assoc %2
- :field_id (format "c%d/%d" question-id %1)
+ :field_id (format "c%d-%d" question-id %1)
:field_values missing-value)
expected-fields)))
:conversation_id conversation-id}
@@ -750,26 +750,12 @@
;; Related tables via FK (order matches what related-tables function returns)
expected-related-tables
[{:type "table"
- :id (mt/id :products)
- :name "PRODUCTS"
- :display_name "Products"
- :database_id (mt/id)
- :database_schema "PUBLIC"
- :fields
- [{:name "ID", :display_name "ID", :type "number", :semantic_type "pk"}
- {:name "EAN", :display_name "Ean", :type "string", :field_values string-sequence?}
- {:name "TITLE", :display_name "Title", :type "string", :semantic_type "title", :field_values string-sequence?}
- {:name "CATEGORY", :display_name "Category", :type "string", :semantic_type "category", :field_values string-sequence?}
- {:name "VENDOR", :display_name "Vendor", :type "string", :semantic_type "company", :field_values string-sequence?}
- {:name "PRICE", :display_name "Price", :type "number"}
- {:name "RATING", :display_name "Rating", :type "number", :semantic_type "score"}
- {:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp"}]}
- {:type "table"
:id (mt/id :people)
:name "PEOPLE"
:display_name "People"
:database_id (mt/id)
:database_schema "PUBLIC"
+ :related_by "USER_ID"
:fields
[{:name "ID", :display_name "ID", :type "number", :semantic_type "pk"}
{:name "ADDRESS", :display_name "Address", :type "string"}
@@ -783,6 +769,22 @@
{:name "BIRTH_DATE", :display_name "Birth Date", :type "date"}
{:name "ZIP", :display_name "Zip", :type "string"}
{:name "LATITUDE", :display_name "Latitude", :type "number", :semantic_type "latitude"}
+ {:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp"}]}
+ {:type "table"
+ :id (mt/id :products)
+ :name "PRODUCTS"
+ :display_name "Products"
+ :database_id (mt/id)
+ :database_schema "PUBLIC"
+ :related_by "PRODUCT_ID"
+ :fields
+ [{:name "ID", :display_name "ID", :type "number", :semantic_type "pk"}
+ {:name "EAN", :display_name "Ean", :type "string", :field_values string-sequence?}
+ {:name "TITLE", :display_name "Title", :type "string", :semantic_type "title", :field_values string-sequence?}
+ {:name "CATEGORY", :display_name "Category", :type "string", :semantic_type "category", :field_values string-sequence?}
+ {:name "VENDOR", :display_name "Vendor", :type "string", :semantic_type "company", :field_values string-sequence?}
+ {:name "PRICE", :display_name "Price", :type "number"}
+ {:name "RATING", :display_name "Rating", :type "number", :semantic_type "score"}
{:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp"}]}]]
{:model-data model-data
:metric-data metric-data
@@ -823,15 +825,20 @@
:database_engine (db-engine-name)
:display_name "Model Model"
:verified true
- :fields (add-field-ids (format "c%d/%%d" model-id) expected-core-fields)
+ :fields (add-field-ids (format "c%d-%%d" model-id) expected-core-fields)
:related_tables
- (map #(update % :fields
- (partial add-field-ids (format "t%d/%%d" (:id %))))
- expected-related-tables)
+ [(-> (first expected-related-tables)
+ (update :fields (fn [fields]
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" model-id (+ 9 %1)))
+ fields))))
+ (-> (second expected-related-tables)
+ (update :fields (fn [fields]
+ (map-indexed #(assoc %2 :field_id (format "c%d-%d" model-id (+ 22 %1)))
+ fields))))]
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]))
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]))
:conversation_id conversation-id}
(request arguments)))))))))))
@@ -862,18 +869,25 @@
:display_name "Model Model"
:verified true
:fields
- (add-field-ids (format "c%d/%%d" model-id) expected-core-fields
+ (add-field-ids (format "c%d-%%d" model-id) expected-core-fields
#(assoc % :field_values missing-value))
:related_tables
- (map (fn [table]
- (update table :fields
- #(add-field-ids (format "t%d/%%d" (:id table)) %
- (fn [f] (assoc f :field_values missing-value)))))
- expected-related-tables)
+ [(-> (first expected-related-tables)
+ (update :fields (fn [fields]
+ (map-indexed #(assoc %2
+ :field_id (format "c%d-%d" model-id (+ 9 %1))
+ :field_values missing-value)
+ fields))))
+ (-> (second expected-related-tables)
+ (update :fields (fn [fields]
+ (map-indexed #(assoc %2
+ :field_id (format "c%d-%d" model-id (+ 22 %1))
+ :field_values missing-value)
+ fields))))]
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]))
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]))
:conversation_id conversation-id}
(request (assoc arguments :with_field_values false)))))))))))
@@ -909,7 +923,7 @@
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]))
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]))
:conversation_id conversation-id}
(request (assoc arguments :with_fields false)))))))))))
@@ -1057,40 +1071,7 @@
{:name "TOTAL", :display_name "Total", :type "number"}
{:name "DISCOUNT", :display_name "Discount", :type "number", :semantic_type "discount"}
{:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp"}
- {:name "QUANTITY", :display_name "Quantity", :type "number", :semantic_type "quantity", :field_values int-sequence?}
- {:name "ID", :display_name "ID", :type "number", :semantic_type "pk", :table_reference "User"}
- {:name "ADDRESS", :display_name "Address", :type "string", :table_reference "User"}
- {:name "EMAIL", :display_name "Email", :type "string", :semantic_type "email", :table_reference "User"}
- {:name "PASSWORD", :display_name "Password", :type "string", :table_reference "User"}
- {:name "NAME", :display_name "Name", :type "string", :semantic_type "name", :table_reference "User"}
- {:name "CITY", :display_name "City", :type "string", :semantic_type "city", :table_reference "User"}
- {:name "LONGITUDE", :display_name "Longitude", :type "number", :semantic_type "longitude", :table_reference "User"}
- {:name "STATE", :display_name "State", :type "string", :semantic_type "state", :table_reference "User"}
- {:name "SOURCE", :display_name "Source", :type "string", :semantic_type "source", :table_reference "User"}
- {:name "BIRTH_DATE", :display_name "Birth Date", :type "date", :table_reference "User"}
- {:name "ZIP", :display_name "Zip", :type "string", :table_reference "User"}
- {:name "LATITUDE", :display_name "Latitude", :type "number", :semantic_type "latitude", :table_reference "User"}
- {:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp", :table_reference "User"}
- {:name "ID", :display_name "ID", :type "number", :semantic_type "pk", :table_reference "Product"}
- {:name "EAN", :display_name "Ean", :type "string", :field_values string-sequence?, :table_reference "Product"}
- {:name "TITLE", :display_name "Title"
- :type "string"
- :semantic_type "title"
- :field_values string-sequence?
- :table_reference "Product"}
- {:name "CATEGORY", :display_name "Category"
- :type "string"
- :semantic_type "category"
- :field_values string-sequence?
- :table_reference "Product"}
- {:name "VENDOR", :display_name "Vendor"
- :type "string"
- :semantic_type "company"
- :field_values string-sequence?
- :table_reference "Product"}
- {:name "PRICE", :display_name "Price", :type "number", :table_reference "Product"}
- {:name "RATING", :display_name "Rating", :type "number", :semantic_type "score", :table_reference "Product"}
- {:name "CREATED_AT", :display_name "Created At", :type "datetime", :semantic_type "creation_timestamp", :table_reference "Product"}]
+ {:name "QUANTITY", :display_name "Quantity", :type "number", :semantic_type "quantity", :field_values int-sequence?}]
request (fn [arguments]
(mt/user-http-request :rasta :post 200 "ee/metabot-tools/get-table-details"
{:request-options {:headers {"x-metabase-session" ai-token}}}
@@ -1110,12 +1091,12 @@
:database_schema "PUBLIC"
:id table-id
:type "table"
- :fields (map-indexed #(assoc %2 :field_id (format "t%d/%d" table-id %1))
+ :fields (map-indexed #(assoc %2 :field_id (format "t%d-%d" table-id %1))
expected-fields)
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]}
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]}
:conversation_id conversation-id}
(request {:table_id arg-id})))))
(let [arguments {:table_id table-id}]
@@ -1128,13 +1109,13 @@
:id table-id
:type "table"
:fields (map-indexed #(assoc %2
- :field_id (format "t%d/%d" table-id %1)
+ :field_id (format "t%d-%d" table-id %1)
:field_values missing-value)
expected-fields)
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]}
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]}
:conversation_id conversation-id}
(request (assoc arguments :with_field_values false)))))
(testing "Without fields"
@@ -1149,7 +1130,7 @@
:metrics [(assoc metric-data
:id metric-id
:type "metric"
- :default_time_dimension_field_id (format "c%d/7" metric-id))]}
+ :default_time_dimension_field_id (format "c%d-7" metric-id))]}
:conversation_id conversation-id}
(request (assoc arguments :with_fields false)))))
(testing "Without fields and metric default time dimension"
@@ -1206,6 +1187,23 @@
:with_related_tables false})
(get-in [:structured_output :related_tables]))))))))
+(deftest get-table-details-related-by-test
+ (mt/with-premium-features #{:metabot-v3}
+ (testing "Related tables include related_by field indicating the FK field name"
+ (let [conversation-id (str (random-uuid))
+ ai-token (ai-session-token)
+ response (mt/user-http-request :rasta :post 200 "ee/metabot-tools/get-table-details"
+ {:request-options {:headers {"x-metabase-session" ai-token}}}
+ {:arguments {:table_id (mt/id :orders)}
+ :conversation_id conversation-id})
+ related-tables (get-in response [:structured_output :related_tables])
+ people-table (first (filter #(= (:id %) (mt/id :people)) related-tables))
+ products-table (first (filter #(= (:id %) (mt/id :products)) related-tables))]
+ (testing "People table is related by USER_ID FK"
+ (is (= "USER_ID" (:related_by people-table))))
+ (testing "Products table is related by PRODUCT_ID FK"
+ (is (= "PRODUCT_ID" (:related_by products-table))))))))
+
(deftest get-transforms-test
(mt/with-premium-features #{:metabot-v3 :transforms}
(let [conversation-id (str (random-uuid))
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 a9c2d6dd18c..adcdf6aff13 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
@@ -43,9 +43,9 @@
people-query (table-query mp people-id)
birth-date-id (visible-field-id people-query (metabot-v3.tools.u/table-field-id-prefix people-id) "Birth Date")
state-id (visible-field-id people-query (metabot-v3.tools.u/table-field-id-prefix people-id) "State")
- orders-id (mt/id :orders)
- orders-query (table-query mp orders-id)
- category-id (visible-field-id orders-query (metabot-v3.tools.u/table-field-id-prefix orders-id) "Category")]
+ products-id (mt/id :products)
+ products-query (table-query mp products-id)
+ category-id (visible-field-id products-query (metabot-v3.tools.u/table-field-id-prefix products-id) "Category")]
(testing "No read permission results in an error."
(is (thrown-with-msg? clojure.lang.ExceptionInfo #"You don't have permissions to do that."
(metabot-v3.tools.field-stats/field-values
@@ -69,7 +69,7 @@
:percent-state 1.0
:average-length 2.0}
:values ["AK" "AL" "AR" "AZ" "CA"]}
- orders-id category-id {:statistics {:distinct-count 4
+ products-id category-id {:statistics {:distinct-count 4
:percent-null 0.0
:percent-json 0.0
:percent-url 0.0
@@ -79,16 +79,18 @@
:values ["Doohickey" "Gadget" "Gizmo" "Widget"]})))))
(deftest field-values-model-test
+ (ensure-fresh-field-values! (mt/id :orders :quantity))
(ensure-fresh-field-values! (mt/id :people :state))
(ensure-fresh-field-values! (mt/id :products :category))
(mt/with-temp [:model/Card {model-id :id} {:dataset_query (mt/mbql-query orders)
:type :model}]
(let [mp (mt/metadata-provider)
model-query (lib/query mp (lib.metadata/card mp model-id))
- field-id-prefix (metabot-v3.tools.u/card-field-id-prefix model-id)
- birth-date-id (visible-field-id model-query field-id-prefix "Birth Date")
- state-id (visible-field-id model-query field-id-prefix "State")
- category-id (visible-field-id model-query field-id-prefix "Category")]
+ card-field-id-prefix (metabot-v3.tools.u/card-field-id-prefix model-id)
+ ;; All fields use c<card-id> syntax with indices from model's visible-columns
+ quantity-id (visible-field-id model-query card-field-id-prefix "Quantity")
+ state-id (visible-field-id model-query card-field-id-prefix "State")
+ category-id (visible-field-id model-query card-field-id-prefix "Category")]
(testing "No read permission results in an error."
(is (thrown-with-msg? clojure.lang.ExceptionInfo #"You don't have permissions to do that."
(metabot-v3.tools.field-stats/field-values
@@ -96,40 +98,42 @@
(testing "Getting statistics and values for model fields works."
(mt/as-admin
(are [field-id output]
- (= {:structured-output output}
- (metabot-v3.tools.field-stats/field-values
- {:entity-type "model", :entity-id model-id, :field-id field-id, :limit 5}))
- birth-date-id {:statistics
- {:distinct-count 2308
- :percent-null 0.0
- :earliest "1958-04-26"
- :latest "2000-04-03"}}
- state-id {:statistics {:distinct-count 49
- :percent-null 0.0
- :percent-json 0.0
- :percent-url 0.0
- :percent-email 0.0
- :percent-state 1.0
- :average-length 2.0}
- :values ["AK" "AL" "AR" "AZ" "CA"]}
- category-id {:statistics {:distinct-count 4
- :percent-null 0.0
- :percent-json 0.0
- :percent-url 0.0
- :percent-email 0.0
- :percent-state 0.0
- :average-length 6.375}
- :values ["Doohickey" "Gadget" "Gizmo" "Widget"]}))))))
+ (=? {:structured-output output}
+ (metabot-v3.tools.field-stats/field-values
+ {:entity-type "model", :entity-id model-id, :field-id field-id, :limit 5}))
+ quantity-id {:statistics {:distinct-count 62
+ :percent-null 0.0}
+ :values [0 1 2 3 4]}
+ state-id {:statistics {:distinct-count 49
+ :percent-null 0.0
+ :percent-json 0.0
+ :percent-url 0.0
+ :percent-email 0.0
+ :percent-state 1.0
+ :average-length 2.0}
+ :values ["AK" "AL" "AR" "AZ" "CA"]}
+ category-id {:statistics {:distinct-count 4
+ :percent-null 0.0
+ :percent-json 0.0
+ :percent-url 0.0
+ :percent-email 0.0
+ :percent-state 0.0
+ :average-length 6.375}
+ :values ["Doohickey" "Gadget" "Gizmo" "Widget"]}))))))
-(deftest ^:parallel field-values-metric-test
+(deftest field-values-metric-test
+ (ensure-fresh-field-values! (mt/id :orders :quantity))
(mt/with-temp [:model/Card {metric-id :id} {:dataset_query (mt/mbql-query orders
{:aggregation [[:count]]
- :breakout [!year.user_id->people.birth_date]})
+ :breakout [$quantity
+ !year.user_id->people.birth_date]})
:type :metric}]
(let [mp (mt/metadata-provider)
metric-query (lib/query mp (lib.metadata/metric mp metric-id))
- field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
- birth-date-id (filterable-field-id metric-query field-id-prefix "Birth Date")]
+ card-field-id-prefix (metabot-v3.tools.u/card-field-id-prefix metric-id)
+ ;; All fields use c<card-id> syntax with indices from metric's filterable-columns
+ quantity-id (filterable-field-id metric-query card-field-id-prefix "Quantity")
+ birth-date-id (filterable-field-id metric-query card-field-id-prefix "Birth Date")]
(testing "No read permission results in an error."
(is (thrown-with-msg? clojure.lang.ExceptionInfo #"You don't have permissions to do that."
(metabot-v3.tools.field-stats/field-values
@@ -137,9 +141,12 @@
(testing "Getting statistics and values for metric fields works."
(mt/as-admin
(are [field-id output]
- (= {:structured-output output}
- (metabot-v3.tools.field-stats/field-values
- {:entity-type "metric", :entity-id metric-id, :field-id field-id, :limit 5}))
+ (=? {:structured-output output}
+ (metabot-v3.tools.field-stats/field-values
+ {:entity-type "metric", :entity-id metric-id, :field-id field-id, :limit 5}))
+ quantity-id {:statistics {:distinct-count 62
+ :percent-null 0.0}
+ :values [0 1 2 3 4]}
birth-date-id {:statistics
{:distinct-count 2308
:percent-null 0.0
diff --git a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/util_test.clj b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/util_test.clj
index 4c0457a4a17..462cab79c9d 100644
--- a/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/util_test.clj
+++ b/enterprise/backend/test/metabase_enterprise/metabot_v3/tools/util_test.clj
@@ -171,3 +171,87 @@
unverified-ids #{(:id unverified-model) (:id unverified-metric)}]
(is (every? verified-ids (take 2 ordered-ids)))
(is (every? unverified-ids (drop 2 ordered-ids))))))))))))
+
+(deftest parse-field-id-test
+ (testing "parse-field-id parses valid field IDs correctly"
+ (testing "table field IDs with numeric table ID"
+ (is (= {:model-tag "t", :model-id 154, :field-index 1}
+ (metabot-v3.tools.util/parse-field-id "t154-1")))
+ (is (= {:model-tag "t", :model-id 1, :field-index 0}
+ (metabot-v3.tools.util/parse-field-id "t1-0")))
+ (is (= {:model-tag "t", :model-id 999, :field-index 42}
+ (metabot-v3.tools.util/parse-field-id "t999-42"))))
+
+ (testing "card/model/metric field IDs with numeric card ID"
+ (is (= {:model-tag "c", :model-id 125, :field-index 7}
+ (metabot-v3.tools.util/parse-field-id "c125-7")))
+ (is (= {:model-tag "c", :model-id 2, :field-index 0}
+ (metabot-v3.tools.util/parse-field-id "c2-0"))))
+
+ (testing "query field IDs with nano-id string"
+ (is (= {:model-tag "q", :model-id "puL95JSvym3k23W1UUuog", :field-index 0}
+ (metabot-v3.tools.util/parse-field-id "qpuL95JSvym3k23W1UUuog-0")))
+ (is (= {:model-tag "q", :model-id "abc123XYZ", :field-index 5}
+ (metabot-v3.tools.util/parse-field-id "qabc123XYZ-5"))))
+
+ (testing "query field IDs with nano-id containing dashes"
+ (is (= {:model-tag "q", :model-id "wG9GfYTcE-wKTg3wlZyuc", :field-index 6}
+ (metabot-v3.tools.util/parse-field-id "qwG9GfYTcE-wKTg3wlZyuc-6")))
+ (is (= {:model-tag "q", :model-id "a-b-c", :field-index 0}
+ (metabot-v3.tools.util/parse-field-id "qa-b-c-0"))))))
+
+(deftest resolve-column-test
+ (testing "resolve-column resolves field IDs to columns"
+ (let [columns [{:name "ID" :table-id 1 :type :number} ; index 0
+ {:name "NAME" :table-id 1 :type :string} ; index 1
+ {:name "EMAIL" :table-id 1 :type :string} ; index 2
+ {:name "USER_ID" :table-id 2 :type :number} ; index 0 for table 2
+ {:name "TOTAL" :table-id 2 :type :number}]] ; index 1 for table 2
+ (testing "resolves table field IDs correctly"
+ (let [item {:field-id "t1-0" :operation "equals"}
+ result (metabot-v3.tools.util/resolve-column item "t1-" columns)]
+ (is (= "ID" (get-in result [:column :name])))
+ (is (= 1 (get-in result [:column :table-id])))
+ (is (= :number (get-in result [:column :type])))))
+
+ (testing "resolves field IDs using flat index into columns vector"
+ (let [item {:field-id "t1-3" :operation "equals"}
+ result (metabot-v3.tools.util/resolve-column item "t1-" columns)]
+ (is (= "USER_ID" (get-in result [:column :name])))
+ (is (= 2 (get-in result [:column :table-id])))))
+
+ (testing "resolves card field IDs using flat index"
+ (let [item {:field-id "c125-1" :operation "equals"}
+ result (metabot-v3.tools.util/resolve-column item "c125-" columns)]
+ (is (= "NAME" (get-in result [:column :name])))
+ (is (= 1 (get-in result [:column :table-id])))))
+
+ (testing "resolves query field IDs using flat index"
+ (let [item {:field-id "qabc123-2" :operation "equals"}
+ result (metabot-v3.tools.util/resolve-column item "qabc123-" columns)]
+ (is (= "EMAIL" (get-in result [:column :name])))))))
+
+ (testing "resolve-column throws for invalid field IDs"
+ (let [columns [{:name "ID" :table-id 1 :type :number}
+ {:name "NAME" :table-id 1 :type :string}]]
+ (testing "throws for invalid field ID format"
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"invalid field_id format"
+ (metabot-v3.tools.util/resolve-column {:field-id "invalid"} "t1-" columns)))
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"invalid field_id format"
+ (metabot-v3.tools.util/resolve-column {:field-id "t154/1"} "t154-" columns))))
+
+ (testing "throws when field index is out of bounds"
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"field t1-10 not found"
+ (metabot-v3.tools.util/resolve-column {:field-id "t1-10"} "t1-" columns))))
+
+ (testing "throws when field ID prefix doesn't match expected prefix"
+ (is (thrown-with-msg?
+ clojure.lang.ExceptionInfo
+ #"does not match expected prefix"
+ (metabot-v3.tools.util/resolve-column {:field-id "t999-0"} "t1-" columns)))))))