Skip to content

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

Don't generate join alias that matches source table name (#70876)

Riley Thompson8f9282dca17a
diff --git a/e2e/test/scenarios/joins/joins-reproductions.cy.spec.js b/e2e/test/scenarios/joins/joins-reproductions.cy.spec.js
index ed68e8cf247..0ea474b0024 100644
--- a/e2e/test/scenarios/joins/joins-reproductions.cy.spec.js
+++ b/e2e/test/scenarios/joins/joins-reproductions.cy.spec.js
@@ -1173,12 +1173,12 @@ describe("issue 27521", () => {
H.visualize();
assertTableHeader(0, "ID");
- assertTableHeader(1, "Orders → ID");
+ assertTableHeader(1, "Orders_2 → ID");
H.saveQuestion("Q1");
assertTableHeader(0, "ID");
- assertTableHeader(1, "Orders → ID");
+ assertTableHeader(1, "Orders_2 → ID");
cy.log("Create second question (Products + Q1)");
H.newButton("Question").click();
@@ -1198,7 +1198,7 @@ describe("issue 27521", () => {
});
H.popover().findByText("ID").click();
- H.popover().findByText("Orders → ID").should("be.visible").click();
+ H.popover().findByText("Orders_2 → ID").should("be.visible").click();
H.getNotebookStep("join")
.findByLabelText("Right column")
.findByText("Q1 → ID")
diff --git a/e2e/test/scenarios/models/reproductions-1.cy.spec.ts b/e2e/test/scenarios/models/reproductions-1.cy.spec.ts
index e326bc538eb..b0f009cc4c7 100644
--- a/e2e/test/scenarios/models/reproductions-1.cy.spec.ts
+++ b/e2e/test/scenarios/models/reproductions-1.cy.spec.ts
@@ -420,19 +420,19 @@ describe("issue 41785, issue 46756", () => {
H.openVizSettingsSidebar();
cy.findByTestId("chartsettings-sidebar").within(() => {
cy.findAllByText("Ean").should("have.length", 1);
- cy.findAllByText("Products → Ean").should("have.length", 1);
+ cy.findAllByText("Products_2 → Ean").should("have.length", 1);
cy.button("Add or remove columns").click();
cy.findAllByText("Ean").should("have.length", 1);
cy.findByLabelText("Ean").should("be.checked");
- cy.findByLabelText("Products → Ean").should("be.checked");
- cy.findAllByText("Products → Ean").should("have.length", 1).click();
+ cy.findByLabelText("Products_2 → Ean").should("be.checked");
+ cy.findAllByText("Products_2 → Ean").should("have.length", 1).click();
cy.wait("@dataset");
cy.log("Only the clicked column should be removed (metabase#46756)");
- cy.findByLabelText("Products → Ean").should("not.be.checked");
+ cy.findByLabelText("Products_2 → Ean").should("not.be.checked");
cy.findByLabelText("Ean").should("be.checked");
});
diff --git a/src/metabase/lib/join.cljc b/src/metabase/lib/join.cljc
index 12afd5cc5f4..6f57c86fdb1 100644
--- a/src/metabase/lib/join.cljc
+++ b/src/metabase/lib/join.cljc
@@ -222,16 +222,20 @@
;; Every stage from the input `stage-number` down to 0.
(range stage-index -1 -1))))
-(defmethod lib.metadata.calculation/display-name-method :mbql/join
- [query _stage-number {[{:keys [source-table source-card], :as _first-stage}] :stages, :as _join} _style]
+(defn- stage-source-display-name
+ [query {:keys [source-table source-card], :as _stage}]
(or
(when source-table
((some-fn :display-name :name) (lib.metadata/table query source-table)))
(when source-card
(if-let [card-metadata (lib.metadata/card query source-card)]
(lib.metadata.calculation/display-name query 0 card-metadata)
- (lib.card/fallback-display-name source-card)))
- (i18n/tru "Native Query")))
+ (lib.card/fallback-display-name source-card)))))
+
+(defmethod lib.metadata.calculation/display-name-method :mbql/join
+ [query _stage-number {[first-stage] :stages, :as _join} _style]
+ (or (stage-source-display-name query first-stage)
+ (i18n/tru "Native Query")))
(defmethod lib.metadata.calculation/display-info-method :mbql/join
[query stage-number join]
@@ -624,9 +628,12 @@
(when (and (lib.util/field-clause? lhs) (lib.util/field-clause? rhs))
[lhs rhs]))))
(:conditions a-join))
- home-col (select-home-column home-cols cond-fields)]
+ home-col (select-home-column home-cols cond-fields)
+ source-name (stage-source-display-name query stage)
+ taken-names (cond-> (into [] (keep :alias) (:joins stage))
+ source-name (conj source-name))]
(-> (calculate-join-alias query a-join home-col)
- (generate-unique-name (keep :alias (:joins stage)))))))
+ (generate-unique-name taken-names)))))
(mu/defn add-default-alias :- ::lib.schema.join/join
"Add a default generated `:alias` to a join clause that does not already have one or that specifically requests a
diff --git a/test/metabase/lib/column_group_test.cljc b/test/metabase/lib/column_group_test.cljc
index 55fc6fb1f7d..e29a8bdd3e4 100644
--- a/test/metabase/lib/column_group_test.cljc
+++ b/test/metabase/lib/column_group_test.cljc
@@ -388,12 +388,12 @@
(for [field-name ["ID" "USER_ID" "PRODUCT_ID" "SUBTOTAL" "TAX"
"TOTAL" "DISCOUNT" "CREATED_AT" "QUANTITY"]]
{:name field-name
- :lib/desired-column-alias (str "Orders__" field-name)
+ :lib/desired-column-alias (str "Orders_2__" field-name)
:lib/source :source/joins})}
(implicit product-cols "PRODUCTS__via__PRODUCT_ID__")
(implicit user-cols "PEOPLE__via__USER_ID__")
- (implicit product-cols "PRODUCTS__via__PRODUCT_ID__via__Orders__")
- (implicit user-cols "PEOPLE__via__USER_ID__via__Orders__")]
+ (implicit product-cols "PRODUCTS__via__PRODUCT_ID__via__Orders_2__")
+ (implicit user-cols "PEOPLE__via__USER_ID__via__Orders_2__")]
(lib/group-columns marked)))))
(deftest ^:parallel self-joined-cards-duplicate-implicit-columns-test
@@ -422,10 +422,10 @@
:is-from-join false,
:is-implicitly-joinable true}
;; we always use LONG display names when the column comes from a previous stage.
- {:display-name "Mock orders card → Product"
+ {:display-name "Mock orders card_2 → Product"
:is-from-join false,
:is-implicitly-joinable true}
- {:display-name "Mock orders card → User"
+ {:display-name "Mock orders card_2 → User"
:is-from-join false,
:is-implicitly-joinable true}]
(map #(lib/display-info query %) groups)))
@@ -443,19 +443,19 @@
{:lib/desired-column-alias "PEOPLE__via__USER_ID__LATITUDE"}
{:lib/desired-column-alias "PEOPLE__via__USER_ID__CREATED_AT"}]
(::lib.column-group/columns product-1)))
- (is (=? [{:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__ID", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__ADDRESS", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__EMAIL", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__PASSWORD", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__NAME", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__CITY", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__LONGITUDE", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__STATE", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__SOURCE", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__BIRTH_DATE", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__ZIP", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__LATITUDE", :fk-join-alias "Mock orders card"}
- {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card__CREATED_AT", :fk-join-alias "Mock orders card"}]
+ (is (=? [{:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__ID", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__ADDRESS", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__EMAIL", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__PASSWORD", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__NAME", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__CITY", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__LONGITUDE", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__STATE", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__SOURCE", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__BIRTH_DATE", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__ZIP", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__LATITUDE", :fk-join-alias "Mock orders card_2"}
+ {:lib/desired-column-alias "PEOPLE__via__USER_ID__via__Mock orders card_2__CREATED_AT", :fk-join-alias "Mock orders card_2"}]
(::lib.column-group/columns product-2))))))
(deftest ^:parallel column-group-order-test
@@ -473,7 +473,7 @@
(is (=? [{::lib.column-group/group-type :group-type/main}
;; Explicit joins, ordered by join alias.
{::lib.column-group/group-type :group-type/join.explicit
- :join-alias "Orders"}
+ :join-alias "Orders_2"}
{::lib.column-group/group-type :group-type/join.explicit
:join-alias "Reviews - Product"}
;; Implicit joins, ordered by the join alias and then the FK column name:
@@ -489,10 +489,10 @@
:fk-join-alias nil
:fk-field-id (meta/id :orders :user-id)}
{::lib.column-group/group-type :group-type/join.implicit
- :fk-join-alias "Orders"
+ :fk-join-alias "Orders_2"
:fk-field-id (meta/id :orders :product-id)}
{::lib.column-group/group-type :group-type/join.implicit
- :fk-join-alias "Orders"
+ :fk-join-alias "Orders_2"
:fk-field-id (meta/id :orders :user-id)}
{::lib.column-group/group-type :group-type/join.implicit
:fk-join-alias "Reviews - Product"
diff --git a/test/metabase/lib/equality_test.cljc b/test/metabase/lib/equality_test.cljc
index 58bd5e2a260..1c719839f9f 100644
--- a/test/metabase/lib/equality_test.cljc
+++ b/test/metabase/lib/equality_test.cljc
@@ -360,7 +360,7 @@
table-col #(assoc % :lib/source :source/table-defaults)
join-col #(-> %
(merge {:lib/source :source/joins
- :lib/join-alias "Orders"}))
+ :lib/join-alias "Orders_2"}))
sorted #(sort-by (juxt :position :lib/original-join-alias) %)
visible (lib/visible-columns query)]
(is (=? (->> (sorted (concat (map table-col cols)
@@ -403,12 +403,12 @@
just-3 (lib/replace-join base join (lib/with-join-fields join [(meta/field-metadata :orders :id)]))]
(is (=? [{:lib/desired-column-alias "ID"}
{:lib/desired-column-alias "TAX"}
- {:lib/desired-column-alias "Orders__ID"}
- {:lib/desired-column-alias "Orders__TAX"}]
+ {:lib/desired-column-alias "Orders_2__ID"}
+ {:lib/desired-column-alias "Orders_2__TAX"}]
(lib/returned-columns all-4)))
(is (=? [{:lib/desired-column-alias "ID"}
{:lib/desired-column-alias "TAX"}
- {:lib/desired-column-alias "Orders__ID"}]
+ {:lib/desired-column-alias "Orders_2__ID"}]
(lib/returned-columns just-3)))
(testing "matching the four fields against"
(let [hr-own-id {:lib/type :metadata/column
diff --git a/test/metabase/lib/metadata/calculation_test.cljc b/test/metabase/lib/metadata/calculation_test.cljc
index 37f464be124..56144a94060 100644
--- a/test/metabase/lib/metadata/calculation_test.cljc
+++ b/test/metabase/lib/metadata/calculation_test.cljc
@@ -254,7 +254,7 @@
:total :discount :created-at :quantity]
:let [field (meta/field-metadata :orders field-key)]]
{:name (:name field)
- :lib/join-alias "Orders"
+ :lib/join-alias "Orders_2"
:lib/source-column-alias (:name field)
:lib/source :source/joins})]
(testing "just own columns"
@@ -417,8 +417,8 @@
(m/index-by (juxt :fk-join-alias :fk-field-id)))
sr-email (get emails [nil (meta/id :gh/issues :reporter-id)])
sa-email (get emails [nil (meta/id :gh/issues :assignee-id)])
- jr-email (get emails ["GH Issues" (meta/id :gh/issues :reporter-id)])
- ja-email (get emails ["GH Issues" (meta/id :gh/issues :assignee-id)])]
+ jr-email (get emails ["GH Issues_2" (meta/id :gh/issues :reporter-id)])
+ ja-email (get emails ["GH Issues_2" (meta/id :gh/issues :assignee-id)])]
(testing "explicit self-join allows implicit joins via all duplicated FKs"
(is (= 4 (count (filter some? [sr-email sa-email jr-email ja-email]))))
(is (= 4 (count (into #{} [sr-email sa-email jr-email ja-email])))))))
diff --git a/test/metabase/lib/test_util/matrix.cljc b/test/metabase/lib/test_util/matrix.cljc
index 04692dbda2f..6e699f53bd6 100644
--- a/test/metabase/lib/test_util/matrix.cljc
+++ b/test/metabase/lib/test_util/matrix.cljc
@@ -195,7 +195,7 @@
"Matrix - Foreign__TEST_ME"]
[(-> (lib/query mp table-meta)
(lib/join (lib/join-clause table-meta [(lib/= (lib.metadata/field mp 1) (lib.metadata/field mp 1))])))
- "Matrix__TEST_ME"]
+ "Matrix_2__TEST_ME"]
[(lib/query mp (:matrix mock-cards))
"TEST_ME"]
[(lib/query mp (:matrix/native mock-cards))
diff --git a/test/metabase/query_processor/explicit_joins_test.clj b/test/metabase/query_processor/explicit_joins_test.clj
index 452ad785165..c081465880a 100644
--- a/test/metabase/query_processor/explicit_joins_test.clj
+++ b/test/metabase/query_processor/explicit_joins_test.clj
@@ -1573,6 +1573,23 @@
2 1 123 110.93 6.1 117.03 nil "2018-05-15T08:04:04.58Z" 3]]
(mt/rows (qp/process-query q2))))))))))
+(deftest ^:parallel self-join-with-capitalized-table-test
+ (mt/test-drivers (mt/normal-driver-select {:+features [:left-join]})
+ (mt/dataset (mt/dataset-definition "self-join-db"
+ [["TableA"
+ [{:field-name "foo" :base-type :type/Integer}]
+ [[1] [2]]]])
+ (let [mp (mt/metadata-provider)
+ table-kw (try (mt/id :TableA) :TableA (catch Exception _ :tablea))
+ table-a (lib.metadata/table mp (mt/id table-kw))
+ id (lib.metadata/field mp (mt/id table-kw :id))
+ query (-> (lib/query mp table-a)
+ (lib/join (lib/join-clause table-a [(lib/= id id)]))
+ (lib/order-by id :asc))]
+ (is (= [[1 1 1 1] [2 2 2 2]]
+ (mt/formatted-rows [int int int int]
+ (qp/process-query query))))))))
+
(deftest ^:parallel dangling-join-condition-lhs-errors-if-fuzzy-matched-to-rhs-test
(testing (str "When upstream changes leave a dangling ref in a join condition LHS, QP throws if it is fuzzy-matched"
"to a column from the RHS of the same join (#67667)")