Skip to content

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

feat: restrict join-analysis to only table-level join analysis (#70105)

Nicola Mometto3d68aa1ac473
diff --git a/src/metabase/transforms_inspector/lens/join_analysis.clj b/src/metabase/transforms_inspector/lens/join_analysis.clj
index 3c6032b4ea3..5e39e4f4004 100644
--- a/src/metabase/transforms_inspector/lens/join_analysis.clj
+++ b/src/metabase/transforms_inspector/lens/join_analysis.clj
@@ -182,7 +182,9 @@
(defmethod lens.core/lens-applicable? :join-analysis
[_ ctx]
- (:has-joins? ctx))
+ (and (:has-joins? ctx)
+ (pos-int? (:from-table-id ctx))
+ (every? #(pos-int? (:source-table %)) (get-join-structure ctx))))
(defmethod lens.core/lens-metadata :join-analysis
[_ _ctx]
diff --git a/test/metabase/transforms_inspector/lens/core_test.clj b/test/metabase/transforms_inspector/lens/core_test.clj
index 74645d3c9ba..b08cc3e0aef 100644
--- a/test/metabase/transforms_inspector/lens/core_test.clj
+++ b/test/metabase/transforms_inspector/lens/core_test.clj
@@ -1,8 +1,11 @@
(ns metabase.transforms-inspector.lens.core-test
(:require
[clojure.test :refer :all]
+ [metabase.transforms-inspector.core :as inspector]
[metabase.transforms-inspector.lens.core :as lens.core]))
+(comment inspector/keep-me)
+
;;; -------------------------------------------------- lens-id->type --------------------------------------------------
(deftest lens-id->type-test
@@ -57,11 +60,43 @@
(is (true? (lens.core/lens-applicable? :generic-summary {:has-joins? false})))))
(deftest join-analysis-applicability-test
- (testing "join-analysis applicable when has-joins? is true"
- (is (true? (lens.core/lens-applicable? :join-analysis {:has-joins? true}))))
+ (testing "join-analysis applicable when has-joins? is true and all tables are simple"
+ (is (true? (lens.core/lens-applicable? :join-analysis
+ {:has-joins? true
+ :from-table-id 10
+ :native-context {:join-structure [{:strategy :left-join
+ :source-table 1}]}})))
+ (is (true? (lens.core/lens-applicable? :join-analysis
+ {:has-joins? true
+ :from-table-id 10
+ :mbql-context {:join-structure [{:strategy :left-join
+ :source-table 1}
+ {:strategy :inner-join
+ :source-table 2}]}}))))
(testing "join-analysis not applicable without joins"
(is (not (lens.core/lens-applicable? :join-analysis {:has-joins? false})))
- (is (not (lens.core/lens-applicable? :join-analysis {})))))
+ (is (not (lens.core/lens-applicable? :join-analysis {}))))
+ (testing "join-analysis not applicable when FROM table is a CTE/subquery (nil from-table-id)"
+ (is (not (lens.core/lens-applicable? :join-analysis
+ {:has-joins? true
+ :from-table-id nil
+ :native-context {:join-structure [{:strategy :left-join
+ :source-table 1}]}}))))
+ ;; see analyze-native-query-cte-join-source-table-is-nil-test for real SQL CTE parsing
+ (testing "join-analysis not applicable when a join target is a CTE (nil source-table)"
+ (is (not (lens.core/lens-applicable? :join-analysis
+ {:has-joins? true
+ :from-table-id 10
+ :native-context {:join-structure [{:strategy :left-join
+ :source-table nil}]}})))
+
+ (is (not (lens.core/lens-applicable? :join-analysis
+ {:has-joins? true
+ :from-table-id 10
+ :mbql-context {:join-structure [{:strategy :left-join
+ :source-table 1}
+ {:strategy :inner-join
+ :source-table nil}]}})))))
(deftest column-comparison-applicability-test
(testing "column-comparison applicable when has-column-matches? is true"
diff --git a/test/metabase/transforms_inspector/query_analysis_test.clj b/test/metabase/transforms_inspector/query_analysis_test.clj
index d9c59429710..f2428c1dcaa 100644
--- a/test/metabase/transforms_inspector/query_analysis_test.clj
+++ b/test/metabase/transforms_inspector/query_analysis_test.clj
@@ -1,10 +1,13 @@
(ns ^:mb/driver-tests metabase.transforms-inspector.query-analysis-test
(:require
[clojure.test :refer :all]
+ [metabase.driver :as driver]
+ [metabase.driver.sql.util :as sql.u]
[metabase.lib.core :as lib]
[metabase.lib.metadata :as lib.metadata]
[metabase.test :as mt]
- [metabase.transforms-inspector.query-analysis :as query-analysis]))
+ [metabase.transforms-inspector.query-analysis :as query-analysis]
+ [toucan2.core :as t2]))
(set! *warn-on-reflection* true)
@@ -36,3 +39,69 @@
(is (some? (:preprocessed-query result)))
(is (= 1 (count (:join-structure result))))
(is (some? (:visited-fields result)))))))
+
+;;; -------------------------------------------------- Helpers --------------------------------------------------
+
+(defn- qt
+ "Quote a table name for the current driver, with schema qualification."
+ [table-key]
+ (let [{:keys [name schema]} (t2/select-one [:model/Table :name :schema] :id (mt/id table-key))]
+ (sql.u/quote-name driver/*driver* :table schema name)))
+
+(defn- qf
+ "Quote a field/column name for the current driver."
+ [table-key col-key]
+ (let [col-name (t2/select-one-fn :name :model/Field :id (mt/id table-key col-key))]
+ (sql.u/quote-name driver/*driver* :field col-name)))
+
+(defn- make-native-transform
+ [query]
+ {:source {:type :query :query query}
+ :name "query-analysis-test"})
+
+(defn- make-sources
+ [& table-keys]
+ (mapv (fn [k]
+ {:table_name (t2/select-one-fn :name :model/Table :id (mt/id k))
+ :table_id (mt/id k)})
+ table-keys))
+
+;;; -------------------------------------------------- Native CTE / subquery tests --------------------------------------------------
+
+(deftest analyze-native-query-cte-join-source-table-is-nil-test
+ (mt/test-drivers (mt/normal-drivers-with-feature :left-join)
+ (testing "join against a CTE alias produces nil :source-table"
+ (let [query (lib/native-query
+ (mt/metadata-provider)
+ (str "WITH cte AS (SELECT * FROM " (qt :orders) ") "
+ "SELECT p.*, cte." (qf :orders :user_id) " "
+ "FROM " (qt :people) " p "
+ "LEFT JOIN cte ON p." (qf :people :id) " = cte." (qf :orders :user_id)))
+ sources (make-sources :orders :people)
+ transform (make-native-transform query)
+ result (query-analysis/analyze-native-query transform sources)]
+ (is (some? result))
+ (is (= 1 (count (:join-structure result))))
+ (is (nil? (:source-table (first (:join-structure result))))
+ "CTE alias should not resolve to a real table ID")))))
+
+(deftest analyze-native-query-mixed-simple-and-cte-joins-test
+ (mt/test-drivers (mt/normal-drivers-with-feature :left-join)
+ (testing "mix of simple table join and CTE join: only simple table has source-table"
+ (let [query (lib/native-query
+ (mt/metadata-provider)
+ (str "WITH cte AS (SELECT * FROM " (qt :reviews) ") "
+ "SELECT o.*, pr." (qf :products :title) ", cte." (qf :reviews :rating) " "
+ "FROM " (qt :orders) " o "
+ "JOIN " (qt :products) " pr ON o." (qf :orders :product_id) " = pr." (qf :products :id) " "
+ "LEFT JOIN cte ON o." (qf :orders :id) " = cte." (qf :reviews :id)))
+ sources (make-sources :orders :products :reviews)
+ transform (make-native-transform query)
+ result (query-analysis/analyze-native-query transform sources)]
+ (is (some? result))
+ (is (= 2 (count (:join-structure result))))
+ (let [[products-join cte-join] (:join-structure result)]
+ (is (= (mt/id :products) (:source-table products-join))
+ "simple table join should resolve to a real table ID")
+ (is (nil? (:source-table cte-join))
+ "CTE join should not resolve to a real table ID"))))))