Skip to content

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

[MBQL lib] Move leaky column logic from models.interface into lib (#69665)

Braden Shepherdson2c04482d2730
diff --git a/.clj-kondo/config/modules/config.edn b/.clj-kondo/config/modules/config.edn
index 64db37ed7c5..54eb4f82bde 100644
--- a/.clj-kondo/config/modules/config.edn
+++ b/.clj-kondo/config/modules/config.edn
@@ -736,8 +736,7 @@
lib
{:team "Querying"
- :api #{metabase.lib.binning
- metabase.lib.core
+ :api #{metabase.lib.core
metabase.lib.equality
metabase.lib.field
metabase.lib.init
@@ -771,7 +770,6 @@
metabase.lib.schema.test-spec
metabase.lib.schema.util
metabase.lib.schema.validate
- metabase.lib.temporal-bucket
metabase.lib.types.isa
metabase.lib.util
metabase.lib.util.match
diff --git a/src/metabase/lib/core.cljc b/src/metabase/lib/core.cljc
index 2fc396d6205..0a7900ed05c 100644
--- a/src/metabase/lib/core.cljc
+++ b/src/metabase/lib/core.cljc
@@ -37,6 +37,7 @@
[metabase.lib.metadata.column]
[metabase.lib.metadata.composed-provider :as lib.metadata.composed-provider]
[metabase.lib.metadata.protocols]
+ [metabase.lib.metadata.result-metadata]
[metabase.lib.metric :as lib.metric]
[metabase.lib.native :as lib.native]
[metabase.lib.normalize :as lib.normalize]
@@ -97,6 +98,7 @@
metabase.lib.metadata.column/keep-me
lib.metadata.composed-provider/keep-me
metabase.lib.metadata.protocols/keep-me
+ metabase.lib.metadata.result-metadata/keep-me
lib.metric/keep-me
lib.native/keep-me
lib.normalize/keep-me
@@ -374,6 +376,8 @@
cached-metadata-provider-with-cache?
metadata-provider?
metadata-providerable?]
+ [metabase.lib.metadata.result-metadata
+ normalize-result-metadata-column]
[lib.native
add-parameters-for-template-tags
engine
diff --git a/src/metabase/lib/metadata/result_metadata.cljc b/src/metabase/lib/metadata/result_metadata.cljc
index d8651710de1..7a554c19e11 100644
--- a/src/metabase/lib/metadata/result_metadata.cljc
+++ b/src/metabase/lib/metadata/result_metadata.cljc
@@ -9,7 +9,9 @@
(:refer-clojure :exclude [mapv select-keys some update-keys every? empty? not-empty get-in #?(:clj for)])
(:require
#?@(:clj
- ([metabase.config.core :as config]))
+ ([metabase.config.core :as config]
+ [metabase.lib.binning :as lib.binning]
+ [metabase.lib.temporal-bucket :as lib.temporal-bucket]))
[clojure.set :as set]
[clojure.string :as str]
[medley.core :as m]
@@ -22,8 +24,8 @@
[metabase.lib.field.util :as lib.field.util]
[metabase.lib.join :as lib.join]
[metabase.lib.join.util :as lib.join.util]
-
[metabase.lib.metadata.calculation :as lib.metadata.calculation]
+ [metabase.lib.normalize :as lib.normalize]
[metabase.lib.options :as lib.options]
[metabase.lib.ref :as lib.ref]
[metabase.lib.schema :as lib.schema]
@@ -486,3 +488,18 @@
(->> initial-cols
(add-extra-metadata query)
cols->legacy-metadata)))
+
+(defn normalize-result-metadata-column
+ "Normalizes either a modern MBQL 5 `::lib.schema.metadata/column` or legacy `:result_metadata` column as it comes
+ out of AppDB. This is called by [[metabase.models.interface/result-metadata-out]]."
+ [col]
+ #?(:clj (if (:lib/type col)
+ (lib.normalize/normalize ::lib.schema.metadata/column col)
+ ;; legacy usages -- do not use these going forward
+ #_{:clj-kondo/ignore [:deprecated-var]}
+ (-> col
+ (->> (lib.normalize/normalize :metabase.query-processor.schema/result-metadata.column))
+ ;; This is necessary, because in the wild, there may be cards created prior to this change.
+ lib.temporal-bucket/ensure-temporal-unit-in-display-name
+ lib.binning/ensure-binning-in-display-name))
+ :cljs (lib.normalize/normalize ::lib.schema.metadata/column col)))
diff --git a/src/metabase/models/interface.clj b/src/metabase/models/interface.clj
index a567f4264a1..862c9cfc7cb 100644
--- a/src/metabase/models/interface.clj
+++ b/src/metabase/models/interface.clj
@@ -16,11 +16,7 @@
[medley.core :as m]
^{:clj-kondo/ignore [:discouraged-namespace]} [metabase.legacy-mbql.normalize :as mbql.normalize]
^{:clj-kondo/ignore [:discouraged-namespace]} [metabase.legacy-mbql.schema :as mbql.s]
- [metabase.lib.binning :as lib.binning]
[metabase.lib.core :as lib]
- [metabase.lib.normalize :as lib.normalize]
- [metabase.lib.schema.metadata :as lib.schema.metadata]
- [metabase.lib.temporal-bucket :as lib.temporal-bucket]
[metabase.models.dispatch :as models.dispatch]
[metabase.models.json-migration :as jm]
[metabase.models.resolution]
@@ -218,23 +214,12 @@
:out (comp (catch-normalization-exceptions #_{:clj-kondo/ignore [:deprecated-var]} mbql.normalize/normalize-field-ref)
json-out-with-keywordization)})
-(defn- normalize-result-metadata-column [col]
- (if (:lib/type col)
- (lib.normalize/normalize ::lib.schema.metadata/column col)
- ;; legacy usages -- do not use these going forward
- #_{:clj-kondo/ignore [:deprecated-var]}
- (-> col
- (->> (lib/normalize :metabase.query-processor.schema/result-metadata.column))
- ;; This is necessary, because in the wild, there may be cards created prior to this change.
- lib.temporal-bucket/ensure-temporal-unit-in-display-name
- lib.binning/ensure-binning-in-display-name)))
-
(defn- result-metadata-out
"Transform the Card result metadata as it comes out of the DB. Convert columns to keywords where appropriate."
[metadata]
;; TODO -- can we make this whole thing a lazy seq?
(when-let [metadata (not-empty (json-out-with-keywordization metadata))]
- (not-empty (mapv normalize-result-metadata-column metadata))))
+ (not-empty (mapv lib/normalize-result-metadata-column metadata))))
(def transform-result-metadata
"Transform for card.result_metadata like columns."