Skip to content

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

[Lib] remove deprecated/confusing `:source-alias` key from col metadata (#69314)

Cam Saul570952497a6d
diff --git a/src/metabase/lib/drill_thru/common.cljc b/src/metabase/lib/drill_thru/common.cljc
index 48f140757f1..1134b8ebc60 100644
--- a/src/metabase/lib/drill_thru/common.cljc
+++ b/src/metabase/lib/drill_thru/common.cljc
@@ -7,6 +7,8 @@
[metabase.lib.expression :as lib.expression]
[metabase.lib.filter :as lib.filter]
[metabase.lib.hierarchy :as lib.hierarchy]
+ [metabase.lib.join :as lib.join]
+ [metabase.lib.join.util :as lib.join.util]
[metabase.lib.metadata.calculation :as lib.metadata.calculation]
[metabase.lib.ref :as lib.ref]
[metabase.lib.schema :as lib.schema]
@@ -16,7 +18,7 @@
[metabase.lib.underlying :as lib.underlying]
[metabase.lib.util :as lib.util]
[metabase.util.malli :as mu]
- [metabase.util.performance :refer [select-keys not-empty]]))
+ [metabase.util.performance :refer [not-empty select-keys]]))
(defn mbql-stage?
"Is this query stage an MBQL stage?"
@@ -140,6 +142,22 @@
column :- ::lib.schema.metadata/column]
(let [columns (lib.filter/filterable-columns query stage-number)]
(or (lib.equality/find-matching-column query stage-number column-ref columns)
+ ;; TODO (Cam 2026-02-11) HACK if we have a column ref that for some reason is missing the
+ ;; `:join-alias` (likely from broken metadata converted from legacy metadata where `:source-alias` was renamed
+ ;; to `:lib/original-join-alias` but not `:metabase.lib.join/join-alias`) we still want find a match, so try
+ ;; using that if we failed without using it. This hack is needed to
+ ;; make [[metabase.lib.drill-thru.column-filter-test/column-filter-join-alias-test]] pass.
+ ;;
+ ;; Ideally I think we'd just update this code to use [[metabase.lib.metadata.calculation/metadata]] (which
+ ;; uses things like [[metabase.lib.field.resolution]] under the hood) but then we'd have to fix a lot of bugs
+ ;; where this is called with the wrong stage number (several callers append a stage to the query and then call
+ ;; with a different `stage-number` than the original even tho `column` is relative to a different stage). I
+ ;; tried doing this fix but it broke a few other things. Investigate further.
+ (when (and (lib.util/clause-of-type? column-ref :field)
+ (not (lib.join.util/current-join-alias column-ref)))
+ (when-let [original-join-alias (:lib/original-join-alias column)]
+ (let [ref-with-alias (lib.join/with-join-alias column-ref original-join-alias)]
+ (lib.equality/find-matching-column query stage-number ref-with-alias columns))))
(and (:lib/source-uuid column)
(m/find-first #(= (:lib/source-uuid %) (:lib/source-uuid column))
columns)))))
diff --git a/src/metabase/lib/equality.cljc b/src/metabase/lib/equality.cljc
index 74327dad330..4a305ad4def 100644
--- a/src/metabase/lib/equality.cljc
+++ b/src/metabase/lib/equality.cljc
@@ -204,7 +204,7 @@ are known to be the same."
;; TODO (Cam 6/19/25) -- seems busted to be using joins that happened at ANY LEVEL previously for equality purposes
;; so lightly but removing this breaks stuff. We should just remove this and do smarter matching like we do
;; in [[plausible-matches-for-name-with-join-alias]] below.
- ((some-fn :metabase.lib.join/join-alias :lib/original-join-alias :source-alias) column))
+ ((some-fn :metabase.lib.join/join-alias :lib/original-join-alias) column))
(mu/defn- matching-join? :- :boolean
[[_ref-kind {:keys [join-alias source-field source-field-name
@@ -277,10 +277,7 @@ are known to be the same."
(when-let [columns-from-join (some (fn [k]
(not-empty (filter #(= (k %) join-alias) columns)))
[:metabase.lib.join/join-alias
- :lib/original-join-alias
- ;; use the `:source-alias` key which was traditionally set by QP result
- ;; metadata sometimes if neither one of the other keys had match(es)
- :source-alias])]
+ :lib/original-join-alias])]
(plausible-matches columns-from-join))))
(mu/defn- plausible-matches-for-name :- [:maybe [:sequential ::lib.schema.metadata/column]]
diff --git a/src/metabase/lib/field.cljc b/src/metabase/lib/field.cljc
index 2553fae7e50..2729441116e 100644
--- a/src/metabase/lib/field.cljc
+++ b/src/metabase/lib/field.cljc
@@ -160,9 +160,6 @@
stage-number
{join-alias :metabase.lib.join/join-alias
original-join-alias :lib/original-join-alias
- ;; TODO (Cam 6/19/25) -- `:source-alias` is deprecated, see description for column metadata
- ;; schema. Still getting set/used in a few places tho. Work on removing it altogether.
- source-alias :source-alias
fk-field-id :fk-field-id
original-fk-field-id :lib/original-fk-field-id
table-id :table-id
@@ -170,8 +167,7 @@
style
display-name]
(let [join-alias (or join-alias
- original-join-alias
- source-alias)
+ original-join-alias)
fk-field-id (or fk-field-id original-fk-field-id)
join-display-name (when (and (= style :long)
;; don't prepend a join display name if `:display-name` already contains one! Legacy
@@ -447,19 +443,6 @@
options (merge {:lib/uuid (str (random-uuid))
:effective-type (column-metadata-effective-type metadata)}
(select-renamed-keys metadata field-ref-propagated-keys)
- ;; MEGA HACK! QP result metadata includes `:source-alias` (which is basically any
- ;; join alias that was ever used for the column); if that is present then we need to
- ;; generate field refs that use as a join alias because even tho that sounds
- ;; completely broken that is traditionally what we've done. Taking this out
- ;; breakouts [[metabase.lib.drill-thru.column-filter-test/column-filter-join-alias-test]].
- ;;
- ;; TODO (Cam 6/26/25) -- figure out if we can actually take this out or not.
- (when-let [source-alias (and (not inherited-column?)
- (not (:fk-field-id metadata))
- (not= :source/implicitly-joinable
- (:lib/source metadata))
- (:source-alias metadata))]
- {:join-alias source-alias})
(when-not inherited-column?
(select-renamed-keys metadata field-ref-propagated-keys-for-non-inherited-columns)))
id-or-name (or (lib.field.util/inherited-column-name metadata)
diff --git a/src/metabase/lib/join.cljc b/src/metabase/lib/join.cljc
index a50f2ddb8ec..b2df2151424 100644
--- a/src/metabase/lib/join.cljc
+++ b/src/metabase/lib/join.cljc
@@ -254,15 +254,12 @@
join-alias :- ::lib.schema.join/alias]
(-> col
(assoc
- ;; TODO (Cam 6/19/25) -- we need to get rid of `:source-alias` it's just causing confusion; don't need two
- ;; keys for join aliases.
- :source-alias join-alias
:lib/original-join-alias join-alias
:lib/source :source/joins
::join-alias join-alias
:lib/original-name ((some-fn :lib/original-name :name) col)
:lib/original-display-name (or (:lib/original-display-name col)
- (lib.metadata.calculation/display-name query stage-number (dissoc col ::join-alias :lib/original-join-alias :source-alias))))
+ (lib.metadata.calculation/display-name query stage-number (dissoc col ::join-alias :lib/original-join-alias))))
(set/rename-keys {:lib/expression-name :lib/original-expression-name})
(as-> $col (assoc $col :display-name (lib.metadata.calculation/display-name query stage-number $col)))))
@@ -1035,11 +1032,7 @@
(defn- xform-add-join-alias [a-join]
(let [join-alias (lib.join.util/current-join-alias a-join)]
- (map (fn [col]
- (-> col
- (with-join-alias join-alias)
- ;; TODO (Cam 6/25/25) -- remove `:source-alias` since it is busted
- (assoc :source-alias join-alias))))))
+ (map #(with-join-alias % join-alias))))
(defn- xform-mark-selected-joinable-columns
"Mark the column metadatas in `cols` as `:selected` if they appear in `a-join`'s `:fields`."
diff --git a/src/metabase/lib/metadata/result_metadata.cljc b/src/metabase/lib/metadata/result_metadata.cljc
index 3cbe0a3728e..803bddfc48b 100644
--- a/src/metabase/lib/metadata/result_metadata.cljc
+++ b/src/metabase/lib/metadata/result_metadata.cljc
@@ -40,7 +40,7 @@
;; TODO (Cam 6/19/25) -- I think we should actually namespace all the keys added here (to make it clear where they
;; came from) and then have the `annotate` middleware convert them to something else for QP results purposes. Then
;; we can 'ban' stuff like `:source-alias` and `:source` within Lib itself. See #59772 for some experimental work
- ;; there.
+ ;; there. (See QUE2-361)
[:map
[:source {:optional true} ::lib.schema.metadata/column.legacy-source]
[:field-ref {:optional true} ::mbql.s/Reference]])
@@ -173,22 +173,7 @@
cols))
(defn- any-join-alias [col]
- ((some-fn lib.join.util/current-join-alias :source-alias :lib/original-join-alias) col))
-
-(mu/defn- add-source-alias :- [:sequential ::kebab-cased-map]
- "`:source-alias` (`:source_alias`) is still needed
- for [[metabase.query-processor.middleware.remove-inactive-field-refs]]
- and [[metabase.lib.equality/column-join-alias]] to work correctly. Why? Not 100% sure -- we should theoretically be
- able to use `:metabase.lib.join/join-alias` for this purpose -- but that doesn't seem to work. Until I figure that
- out, include the `:source-alias` key.
-
- Note that this is no longer used on the FE -- see QUE-1355"
- [cols :- [:sequential ::kebab-cased-map]]
- (for [col cols]
- (merge
- (when-let [join-alias (any-join-alias col)]
- {:source-alias join-alias})
- col)))
+ ((some-fn lib.join.util/current-join-alias :lib/original-join-alias) col))
(defn- implicit-join-aliases [query stage-number]
(let [aliases (into #{}
@@ -211,7 +196,7 @@
(= (:lib/source col) :source/joins)
(assoc :lib/source :source/implicitly-joinable)))
remove-aliases (fn [col]
- (dissoc col :metabase.lib.join/join-alias :lib/original-join-alias :source-alias))
+ (dissoc col :metabase.lib.join/join-alias :lib/original-join-alias))
implicitly-joined? (fn [col]
(when-let [join-alias (any-join-alias col)]
(contains? implicit-aliases join-alias)))
@@ -419,7 +404,6 @@
(seq lib-cols) (merge-cols lib-cols))))
(add-converted-timezone query)
(remove-implicit-join-aliases query)
- add-source-alias
add-legacy-source
deduplicate-names
(add-legacy-field-refs query)
diff --git a/src/metabase/lib/schema/metadata.cljc b/src/metabase/lib/schema/metadata.cljc
index 616c440e61c..5da116c74f4 100644
--- a/src/metabase/lib/schema/metadata.cljc
+++ b/src/metabase/lib/schema/metadata.cljc
@@ -3,6 +3,7 @@
(:require
#?@(:clj
([metabase.util.regex :as u.regex]))
+ [clojure.set :as set]
[medley.core :as m]
[metabase.lib.schema.binning :as lib.schema.binning]
[metabase.lib.schema.common :as lib.schema.common]
@@ -186,8 +187,13 @@
(as-> m (cond-> m
(and (:id m) (not (pos-int? (:id m))))
(dissoc :id)))
- ;; remove deprecated `:ident` and `:model/inner_ident` keys (normalized to `:model/inner-ident`)
- (dissoc :ident :model/inner-ident))))
+ ;; If the column has a legacy `:source-alias` key but doesn't have `:lib/original-join-alias` then rename it
+ ;; to that. `:source-alias` had a kind of ambiguous meaning before we removed it, but
+ ;; `:lib/original-join-alias` was a subset of its purpose
+ (as-> m (cond-> m
+ (and (:source-alias m)
+ (not (:lib/original-join-alias m)))
+ (set/rename-keys {:source-alias :lib/original-join-alias}))))))
(def ^:private column-validate-for-source-specs
"Schemas to use to validate columns with a given `:lib/source`. Since a lot of these schemas are applicable to
@@ -353,18 +359,6 @@
;; an foreign key, and points to this Field ID. This is mostly used to determine how to add implicit joins by
;; the [[metabase.query-processor.middleware.add-implicit-joins]] middleware.
[:fk-target-field-id {:optional true} [:maybe ::lib.schema.id/field]]
- ;;
- ;; Join alias of the table we're joining against, if any. Not really 100% clear why we would need this on top
- ;; of [[metabase.lib.join/current-join-alias]], which stores the same info under a namespaced key. I think we can
- ;; remove it.
- ;;
- ;; TODO (Cam 6/19/25) -- yes, we should remove this key, I've tried to do so but a few places are still
- ;; setting (AND USING!) it. It actually appears that this gets propagated beyond the current stage where the join
- ;; has happened and has thus taken on a purposes as a 'previous stage join alias' column. We should use
- ;; `:lib/original-join-alias` instead to serve this purpose since `:source-alias` is not set or used correctly.
- ;; Check out experimental https://github.com/metabase/metabase/pull/59772 where I updated this schema to 'ban'
- ;; this key so we can root out anywhere trying to use it. (QUE-1403)
- [:source-alias {:optional true} [:maybe ::lib.schema.common/non-blank-string]]
;; Join alias of the table we're joining against, if any. SHOULD ONLY BE SET IF THE JOIN HAPPENED AT THIS STAGE OF
;; THE QUERY! (Also ok within a join's conditions for previous joins within the parent stage, because a join is
;; allowed to join on the results of something else)
@@ -514,8 +508,12 @@
;;
;; Additional constraints
;;
- ::lib.schema.common/kebab-cased-map
- [:ref ::column.validate-for-source]])
+ [:ref ::lib.schema.common/kebab-cased-map]
+ [:ref ::column.validate-for-source]
+ (lib.schema.common/disallowed-keys
+ {:source-alias ":source-alias is deprecated; use :metabase.lib.join/join-alias or :lib/original-join-alias instead"
+ :ident ":ident is deprecated and should not be included in column metadata"
+ :model/inner-ident ":model/inner_ident (normalized to :model/inner-ident) is deprecated and should not be included in column metadata"})])
(mr/def ::persisted-info.definition
"Definition spec for a cached table."
diff --git a/src/metabase/query_processor/util/add_alias_info.clj b/src/metabase/query_processor/util/add_alias_info.clj
index db8e6bf2c73..37d1135e845 100644
--- a/src/metabase/query_processor/util/add_alias_info.clj
+++ b/src/metabase/query_processor/util/add_alias_info.clj
@@ -418,7 +418,7 @@
;; Sanity check - reject an "other" ref resolved to also come from this join!
;; That creates a broken condition and a Cartesian join.
(when (and (= (:lib/source col) :source/joins)
- (= (:source-alias col) (:alias join)))
+ (= (lib/current-join-alias col) (:alias join)))
(throw (cartesian-join-condition-exception field-ref)))
(add-source-to-field-ref query parent-stage-path field-ref col)))
update-conditions (fn [conditions]
diff --git a/test/metabase/lib/breakout_test.cljc b/test/metabase/lib/breakout_test.cljc
index a5498e08d3f..2682d4ca24c 100644
--- a/test/metabase/lib/breakout_test.cljc
+++ b/test/metabase/lib/breakout_test.cljc
@@ -266,20 +266,20 @@
{:id (meta/id :venues :latitude) :name "LATITUDE"}
{:id (meta/id :venues :longitude) :name "LONGITUDE"}
{:id (meta/id :venues :price) :name "PRICE"}
- {:lib/type :metadata/column
- :name "ID"
- :display-name "ID"
- :source-alias "Cat"
- :id (meta/id :categories :id)
- :table-id (meta/id :categories)
- :base-type :type/BigInteger}
- {:lib/type :metadata/column
- :name "NAME"
- :display-name "Name"
- :source-alias "Cat"
- :id (meta/id :categories :name)
- :table-id (meta/id :categories)
- :base-type :type/Text}]
+ {:lib/type :metadata/column
+ :name "ID"
+ :display-name "ID"
+ :metabase.lib.join/join-alias "Cat"
+ :id (meta/id :categories :id)
+ :table-id (meta/id :categories)
+ :base-type :type/BigInteger}
+ {:lib/type :metadata/column
+ :name "NAME"
+ :display-name "Name"
+ :metabase.lib.join/join-alias "Cat"
+ :id (meta/id :categories :name)
+ :table-id (meta/id :categories)
+ :base-type :type/Text}]
(lib/breakoutable-columns query))))))))
(deftest ^:parallel breakoutable-columns-source-card-test
diff --git a/test/metabase/lib/card_test.cljc b/test/metabase/lib/card_test.cljc
index b94de8c264b..9261ca90e13 100644
--- a/test/metabase/lib/card_test.cljc
+++ b/test/metabase/lib/card_test.cljc
@@ -107,7 +107,7 @@
(meta/field-metadata table col)))
(defn- sort-cols [cols]
- (sort-by (juxt :id :name :source-alias :lib/desired-column-alias) cols))
+ (sort-by (juxt :id :name :metabase.lib.join/join-alias :lib/desired-column-alias) cols))
(deftest ^:parallel visible-columns-use-result-metadata-test
(testing "visible-columns should use the Card's `:result-metadata` (regardless of what's actually in the Card)"
diff --git a/test/metabase/lib/convert_test.cljc b/test/metabase/lib/convert_test.cljc
index 50c4d33bdfb..151f72baee4 100644
--- a/test/metabase/lib/convert_test.cljc
+++ b/test/metabase/lib/convert_test.cljc
@@ -831,24 +831,24 @@
:base_type :type/Integer}]}
:metabase-enterprise.sandbox.query-processor.middleware.sandboxing/original-metadata
- [{:base-type :type/Text
- :semantic-type :type/Category
- :table-id 32600
- :name "category"
- :source :breakout
- :effective-type :type/Text
- :id 134551
- :source-alias "products__via__product_id"
- :visibility-type :normal
- :display-name "Product → Category"
- :field-ref [:field 134551 {:source-field 134534}]
- :fk-field-id 134534
- :fingerprint {:global {:distinct-count 4, :nil% 0.0}
- :type {:type/Text {:percent-json 0.0
- :percent-url 0.0
- :percent-email 0.0
- :percent-state 0.0
- :average-length 6.375}}}}]}]
+ [{:base-type :type/Text
+ :semantic-type :type/Category
+ :table-id 32600
+ :name "category"
+ :source :breakout
+ :effective-type :type/Text
+ :id 134551
+ :metabase.lib.join/join-alias "products__via__product_id"
+ :visibility-type :normal
+ :display-name "Product → Category"
+ :field-ref [:field 134551 {:source-field 134534}]
+ :fk-field-id 134534
+ :fingerprint {:global {:distinct-count 4, :nil% 0.0}
+ :type {:type/Text {:percent-json 0.0
+ :percent-url 0.0
+ :percent-email 0.0
+ :percent-state 0.0
+ :average-length 6.375}}}}]}]
(is (= query
(-> query lib.convert/->pMBQL lib.convert/->legacy-MBQL))))))
diff --git a/test/metabase/lib/drill_thru/column_filter_test.cljc b/test/metabase/lib/drill_thru/column_filter_test.cljc
index fc2d42577fd..0a8f6e410a6 100644
--- a/test/metabase/lib/drill_thru/column_filter_test.cljc
+++ b/test/metabase/lib/drill_thru/column_filter_test.cljc
@@ -1,12 +1,14 @@
(ns metabase.lib.drill-thru.column-filter-test
(:require
#?@(:cljs ([metabase.test-runner.assert-exprs.approximately-equal]))
+ [clojure.set :as set]
[clojure.test :refer [deftest is testing use-fixtures]]
[medley.core :as m]
[metabase.lib.core :as lib]
[metabase.lib.drill-thru.test-util :as lib.drill-thru.tu]
[metabase.lib.drill-thru.test-util.canned :as canned]
[metabase.lib.metadata :as lib.metadata]
+ [metabase.lib.schema.metadata :as lib.schema.metadata]
[metabase.lib.test-metadata :as meta]
[metabase.lib.test-util :as lib.tu]))
@@ -265,22 +267,28 @@
(lib/drill-thru query -1 nil drill "=" (lib/relative-datetime :current :day))))))))
(deftest ^:parallel column-filter-join-alias-test
- (testing "an input column with `:source-alias` and no `:join-alias` should work properly (#36861)"
+ (testing "an input column with `:source-alias` and no `:metabase.lib.join/join-alias` should work properly (#36861)"
(let [query (-> (lib/query meta/metadata-provider (meta/table-metadata :orders))
(lib/join (lib/join-clause (meta/table-metadata :products)
[(lib/= (meta/field-metadata :orders :product-id)
(meta/field-metadata :products :id))])))
columns (lib/returned-columns query)
category (-> (m/find-first #(= (:name %) "CATEGORY") columns)
- (dissoc :join-alias :metabase.lib.join/join-alias :lib/source))
+ (set/rename-keys {:metabase.lib.join/join-alias :source-alias})
+ (dissoc :join-alias :metabase.lib.join/join-alias :lib/original-join-alias :lib/source)
+ (->> (lib/normalize ::lib.schema.metadata/column)))
context {:column category
:column-ref (lib/ref category)
:value nil}
drills (lib/available-drill-thrus query -1 context)
colfilter (m/find-first #(= (:type %) :drill-thru/column-filter) drills)]
- (is (= "Products" (:source-alias category)))
- (is (= "Products" (-> context :column-ref second :join-alias)))
- (is (some? (:column colfilter))))))
+ (is (= "Products" (:lib/original-join-alias category))
+ "legacy :source-alias should have been renamed to :lib/original-join-alias")
+ (is (nil? (-> context :column-ref second :join-alias))
+ "Should NOT be propagated to generated field ref")
+ (is (=? {:column some?}
+ colfilter)
+ "Should still suggest column filter drill"))))
(deftest ^:parallel string-pk-filters-test
(testing "string PKs and FKs should be returned as filterable columns (#40665)"
diff --git a/test/metabase/lib/drill_thru/zoom_in_bins_test.cljc b/test/metabase/lib/drill_thru/zoom_in_bins_test.cljc
index b48463309f7..822408cb9f9 100644
--- a/test/metabase/lib/drill_thru/zoom_in_bins_test.cljc
+++ b/test/metabase/lib/drill_thru/zoom_in_bins_test.cljc
@@ -7,6 +7,7 @@
[metabase.lib.drill-thru.test-util :as lib.drill-thru.tu]
[metabase.lib.drill-thru.test-util.canned :as canned]
[metabase.lib.drill-thru.zoom-in-bins :as zoom-in]
+ [metabase.lib.schema.metadata :as lib.schema.metadata]
[metabase.lib.test-metadata :as meta]))
#?(:cljs (comment metabase.test-runner.assert-exprs.approximately-equal/keep-me))
@@ -382,7 +383,8 @@
(lib/with-binning {:strategy :num-bins, :min-value 0, :max-value 160, :num-bins 8, :bin-width 20})
;; I have to construct this weird column because I cannot find a way to reproduce
;; the columns that lib/existing-breakouts is being passed
- (assoc :source-alias "Orders"))
+ (assoc :source-alias "Orders")
+ (->> (lib/normalize ::lib.schema.metadata/column)))
people-orders-ref
(first (lib/breakouts people-orders-query-breakout))
@@ -396,14 +398,14 @@
;; make sure we're testing the right thing
(assert (get-in people-orders-ref [1 :join-alias]))
(assert (nil? (:metabase.lib.join/join-alias people-orders-clicked-column)))
- ;; somehow the column (as printed out in console.log) has :source-alias but not :metabase.lib.join/join-alias
- (assert (:source-alias people-orders-clicked-column))
+ ;; the column (as printed out in console.log) was from legacy metadata, and had `:source-alias`, renamed to
+ ;; `:lib/original-join-alias`; but should be missing `:metabase.lib.join/join-alias`
+ (assert (:lib/original-join-alias people-orders-clicked-column))
(assert (nil? (get-in orders-people-ref [1 :join-alias])))
(assert (nil? (:metabase.lib.join/join-alias orders-people-clicked-column)))
(assert (nil? (:source-alias orders-people-clicked-column)))
(testing "zoom-in binning should not depend on join order"
- (is (= orders-people-zoom
- (some-> people-orders-zoom
- (update :column dissoc :source-alias)))))))
+ (is (= (assoc-in orders-people-zoom [:column :lib/original-join-alias] "Orders")
+ people-orders-zoom)))))
diff --git a/test/metabase/lib/equality_test.cljc b/test/metabase/lib/equality_test.cljc
index 6b982be614d..7e222045a08 100644
--- a/test/metabase/lib/equality_test.cljc
+++ b/test/metabase/lib/equality_test.cljc
@@ -361,7 +361,7 @@
join-col #(-> %
(merge {:lib/source :source/joins
:metabase.lib.join/join-alias "Orders"}))
- sorted #(sort-by (juxt :position :source-alias) %)
+ sorted #(sort-by (juxt :position :lib/original-join-alias) %)
visible (lib/visible-columns query)]
(is (=? (->> (sorted (concat (map table-col cols)
(map join-col cols)))
@@ -601,7 +601,7 @@
query (-> base
(lib/breakout base-user-source)
(lib/breakout base-category))
- returned (map #(assoc %1 :source-alias %2)
+ returned (map #(assoc %1 :lib/original-join-alias %2)
(lib/returned-columns query)
[nil "PEOPLE__via__USER_ID" "PRODUCTS__via__PRODUCT_ID" nil])]
(is (= :source/implicitly-joinable (:lib/source base-user-source)))
@@ -1011,7 +1011,6 @@
:metabase.lib.join/join-alias "Orders"
:name "ID_2"
:semantic-type :type/PK
- :source-alias "Orders"
:table-id 55060}
refs [[:field
{:lib/uuid "1c2a0643-f25c-4099-a2d5-7c7e790b632f"
diff --git a/test/metabase/lib/field/resolution_test.cljc b/test/metabase/lib/field/resolution_test.cljc
index e5e8ae4c14d..24048af790a 100644
--- a/test/metabase/lib/field/resolution_test.cljc
+++ b/test/metabase/lib/field/resolution_test.cljc
@@ -421,9 +421,6 @@
:lib/original-display-name "Category"
:lib/original-name "CATEGORY"
:lib/original-join-alias "Products"
- ;; this key is DEPRECATED (see description in column metadata schema) but still used (FOR
- ;; NOW) (QUE-1403)
- :source-alias "Products"
:lib/source :source/card ; or is it supposed to be `:source/table-defaults`
:lib/source-uuid (lib.options/uuid breakout-ref)
:lib/type :metadata/column
@@ -1509,7 +1506,6 @@
(is (=? {:display-name "ID → Name"
:id (meta/id :categories :name)
:semantic-type :type/Name
- :source-alias "J"
:lib/deduplicated-name "NAME_2"
:lib/original-fk-field-id (meta/id :venues :id)
:lib/original-join-alias "J"
@@ -1523,7 +1519,6 @@
(is (=? {:display-name "Category → Name"
:id (meta/id :categories :name)
:semantic-type :type/Name
- :source-alias "J"
:lib/deduplicated-name "NAME"
:lib/original-fk-field-id (meta/id :venues :category-id)
:lib/original-join-alias "J"
diff --git a/test/metabase/lib/field_test.cljc b/test/metabase/lib/field_test.cljc
index 6d2c64a102d..355b570ef92 100644
--- a/test/metabase/lib/field_test.cljc
+++ b/test/metabase/lib/field_test.cljc
@@ -1490,8 +1490,8 @@
(assoc :lib/source :source/card)
(dissoc :id :table-id)))
join-cols [(-> (meta/field-metadata :products :category)
- (assoc :lib/source :source/card
- :source-alias "Products")
+ (assoc :lib/source :source/card
+ :lib/original-join-alias "Products")
(dissoc :id :table-id))]
implicit-cols (for [col (meta/fields :people)]
(-> (meta/field-metadata :people col)
diff --git a/test/metabase/lib/join_test.cljc b/test/metabase/lib/join_test.cljc
index 5bca9c01bca..9c7cfd117dc 100644
--- a/test/metabase/lib/join_test.cljc
+++ b/test/metabase/lib/join_test.cljc
@@ -1273,13 +1273,11 @@
cols (lib/joinable-columns query -1 join)]
(is (=? [{:name "ID"
:metabase.lib.join/join-alias "Cat"
- :source-alias "Cat"
:lib/source :source/joins
:lib/source-column-alias "ID"
:selected? id-selected?}
{:name "NAME"
:metabase.lib.join/join-alias "Cat"
- :source-alias "Cat"
:lib/source :source/joins
:lib/source-column-alias "NAME"
:selected? name-selected?}]
diff --git a/test/metabase/lib/order_by_test.cljc b/test/metabase/lib/order_by_test.cljc
index d0ada2160e4..b5f9ed7c5a4 100644
--- a/test/metabase/lib/order_by_test.cljc
+++ b/test/metabase/lib/order_by_test.cljc
@@ -344,20 +344,20 @@
{:id (meta/id :venues :latitude) :name "LATITUDE"}
{:id (meta/id :venues :longitude) :name "LONGITUDE"}
{:id (meta/id :venues :price) :name "PRICE"}
- {:lib/type :metadata/column
- :name "ID"
- :display-name "ID"
- :source-alias "Cat"
- :id (meta/id :categories :id)
- :table-id (meta/id :categories)
- :base-type :type/BigInteger}
- {:lib/type :metadata/column
- :name "NAME"
- :display-name "Name"
- :source-alias "Cat"
- :id (meta/id :categories :name)
- :table-id (meta/id :categories)
- :base-type :type/Text}]
+ {:lib/type :metadata/column
+ :name "ID"
+ :display-name "ID"
+ :metabase.lib.join/join-alias "Cat"
+ :id (meta/id :categories :id)
+ :table-id (meta/id :categories)
+ :base-type :type/BigInteger}
+ {:lib/type :metadata/column
+ :name "NAME"
+ :display-name "Name"
+ :metabase.lib.join/join-alias "Cat"
+ :id (meta/id :categories :name)
+ :table-id (meta/id :categories)
+ :base-type :type/Text}]
(lib/orderable-columns query)))))))
(deftest ^:parallel orderable-columns-source-card-test
@@ -645,7 +645,7 @@
{:display-name "ID", :lib/source :source/joins}
{:display-name "Name", :lib/source :source/joins}]
(lib/orderable-columns query)))
- (let [query' (lib/order-by query (m/find-first #(and (= (:source-alias %) "Cat")
+ (let [query' (lib/order-by query (m/find-first #(and (= (:metabase.lib.join/join-alias %) "Cat")
(= (:display-name %) "Name"))
(lib/orderable-columns query)))]
(is (=? [{:display-name "ID", :lib/source :source/table-defaults}
diff --git a/test/metabase/lib/schema/metadata_test.cljc b/test/metabase/lib/schema/metadata_test.cljc
index 5d7f5cef0a5..7ffad94f1ec 100644
--- a/test/metabase/lib/schema/metadata_test.cljc
+++ b/test/metabase/lib/schema/metadata_test.cljc
@@ -126,3 +126,13 @@
(testing "Remove deprecated keys like :model/inner_ident automatically (GIT-8399)"
(is (= {:lib/type :metadata/column, :base-type :type/*, :name "X"}
(lib/normalize ::lib.schema.metadata/column {:name "X", :model/inner_ident "wow"})))))
+
+(deftest ^:parallel rename-source-alias-to-lib-original-join-alias-test
+ (testing "Rename deprecated :source-alias to :lib/original-join-alias if it is not present (QUE2-278, QUE2-280)"
+ (are [col expected] (= expected
+ (lib/normalize ::lib.schema.metadata/column col))
+ {:name "X", :source-alias "alias"}
+ {:name "X", :lib/type :metadata/column, :base-type :type/*, :lib/original-join-alias "alias"}
+
+ {:name "X", :source-alias "alias", :lib/original-join-alias "existing alias"}
+ {:name "X", :lib/type :metadata/column, :base-type :type/*, :lib/original-join-alias "existing alias"})))
diff --git a/test/metabase/lib/stage_test.cljc b/test/metabase/lib/stage_test.cljc
index 41f370c23be..d866290efc9 100644
--- a/test/metabase/lib/stage_test.cljc
+++ b/test/metabase/lib/stage_test.cljc
@@ -169,20 +169,20 @@
{:id (meta/id :venues :price), :name "PRICE", :lib/source :source/table-defaults}
{:name "ID + 1", :lib/source :source/expressions}
{:name "ID + 2", :lib/source :source/expressions}
- {:id (meta/id :categories :id)
- :name "ID_2"
- :lib/source :source/joins
- :source-alias "Cat"
- :display-name "ID"
- :lib/source-column-alias "ID"
- :lib/desired-column-alias "Cat__ID"}
- {:id (meta/id :categories :name)
- :name "NAME_2"
- :lib/source :source/joins
- :source-alias "Cat"
- :display-name "Name"
- :lib/source-column-alias "NAME"
- :lib/desired-column-alias "Cat__NAME"}]
+ {:id (meta/id :categories :id)
+ :name "ID_2"
+ :lib/source :source/joins
+ :metabase.lib.join/join-alias "Cat"
+ :display-name "ID"
+ :lib/source-column-alias "ID"
+ :lib/desired-column-alias "Cat__ID"}
+ {:id (meta/id :categories :name)
+ :name "NAME_2"
+ :lib/source :source/joins
+ :metabase.lib.join/join-alias "Cat"
+ :display-name "Name"
+ :lib/source-column-alias "NAME"
+ :lib/desired-column-alias "Cat__NAME"}]
metadata))
(testing ":long display names"
(is (= ["ID"
@@ -892,8 +892,7 @@
:lib/type :metadata/column
:metabase.lib.join/join-alias "Orders"
:name "sum"
- :semantic-type :type/Quantity
- :source-alias "Orders"}
+ :semantic-type :type/Quantity}
{:base-type :type/Integer
:display-name "Sum"
:effective-type :type/Integer
@@ -929,7 +928,6 @@
:preview-display true
:semantic-type :type/Title
:settings nil
- :source-alias "Orders"
:table-id 24050
:visibility-type :normal
:lib/breakout? false
diff --git a/test/metabase/lib/test_util/mocks_31368.cljc b/test/metabase/lib/test_util/mocks_31368.cljc
index c5c1a04f68b..9ddb1684a67 100644
--- a/test/metabase/lib/test_util/mocks_31368.cljc
+++ b/test/metabase/lib/test_util/mocks_31368.cljc
@@ -23,9 +23,9 @@
(for [col (lib/returned-columns
(lib/query meta/metadata-provider legacy-card-query))]
(cond-> col
- (:source-alias col)
+ (:lib/original-join-alias col)
(update :display-name (fn [display-name]
- (str (:source-alias col) " → " display-name))))))
+ (str (:lib/original-join-alias col) " → " display-name))))))
(defn query-with-legacy-source-card
"An MLv2 query that has a `:source-card` that has a legacy query, and legacy metadata."
diff --git a/test/metabase/lib_be/metadata/jvm_test.clj b/test/metabase/lib_be/metadata/jvm_test.clj
index 92ba49b17f7..cb33023c1f7 100644
--- a/test/metabase/lib_be/metadata/jvm_test.clj
+++ b/test/metabase/lib_be/metadata/jvm_test.clj
@@ -76,7 +76,7 @@
:id (mt/id :orders :product_id)
:lib/desired-column-alias "Orders__PRODUCT_ID"
:display-name "Orders → Product ID"
- :source-alias "Orders"}
+ :lib/original-join-alias "Orders"}
{:metabase.lib.join/join-alias "Orders"
:lib/type :metadata/column
:base-type :type/Integer
@@ -86,7 +86,7 @@
:effective-type :type/Integer
:lib/desired-column-alias "Orders__sum"
:display-name "Orders → Sum of Quantity"
- :source-alias "Orders"}]
+ :lib/original-join-alias "Orders"}]
(binding [lib.metadata.calculation/*display-name-style* :long]
(lib.metadata.calculation/returned-columns mlv2-query))))))
diff --git a/test/metabase/query_processor/nested_queries_test.clj b/test/metabase/query_processor/nested_queries_test.clj
index c69251da8de..fb1e4c667b0 100644
--- a/test/metabase/query_processor/nested_queries_test.clj
+++ b/test/metabase/query_processor/nested_queries_test.clj
@@ -1697,7 +1697,7 @@
(lib/with-join-alias (lib.metadata/field mp (mt/id "space table" "space column"))
"Space Table Alias"))])))
- (lib/breakout $q (m/find-first (every-pred (comp #{"Space Column"} :display-name) :source-alias)
+ (lib/breakout $q (m/find-first (every-pred (comp #{"Space Column"} :display-name) :lib/original-join-alias)
(lib/breakoutable-columns $q)))
(lib/append-stage $q)
(lib/breakout $q (first (lib/breakoutable-columns $q)))
diff --git a/test/metabase/query_processor/preprocess_test.clj b/test/metabase/query_processor/preprocess_test.clj
index 1b206f0ff10..ed530a1dbd9 100644
--- a/test/metabase/query_processor/preprocess_test.clj
+++ b/test/metabase/query_processor/preprocess_test.clj
@@ -301,6 +301,8 @@
[:field %products.category {:source-field %product-id}]]}))]
;; actually, ok just to not return `:source-alias`, which is used for mysterious FE legacy historical purposes. We
;; can go ahead and return various Lib keys for Lib purposes.
+ ;;
+ ;; NOTE: As of 2025-02-09 `:source-alias` is removed completely so we ESPECIALLY should not be returning it now.
(doseq [col (qp.preprocess/query->expected-cols query)]
(testing (pr-str (:name col))
(is (not (contains? col :source-alias)))))