Skip to content

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

Reject implicit-join field refs in tile endpoints (#80480)

Alexander Polyankin0ea74a39ff98
diff --git a/src/metabase/tiles/api.clj b/src/metabase/tiles/api.clj
index 9805e80f3ea..4df0bdbf18d 100644
--- a/src/metabase/tiles/api.clj
+++ b/src/metabase/tiles/api.clj
@@ -137,7 +137,10 @@
(mu/defn- resolve-field :- ::lib.schema.metadata/column
[query :- ::lib.schema/query
legacy-ref :- ::legacy-ref]
- (lib/metadata query (lib/->mbql5 legacy-ref)))
+ (let [field (lib/metadata query (lib/->mbql5 legacy-ref))]
+ (api/check-400 (not (:fk-field-id field))
+ (tru "Fields referenced via implicit joins are not supported."))
+ field))
(mu/defn- tiles-query :- ::lib.schema/query
"Transform a card's query into a query finding coordinates in a particular region.
diff --git a/test/metabase/embedding_rest/api/embed_test.clj b/test/metabase/embedding_rest/api/embed_test.clj
index ce3583f9a75..0896866b00a 100644
--- a/test/metabase/embedding_rest/api/embed_test.clj
+++ b/test/metabase/embedding_rest/api/embed_test.clj
@@ -1903,6 +1903,35 @@
:latField (tiles.api-test/encoded-lat-field-ref)
:lonField (tiles.api-test/encoded-lon-field-ref)))))))))
+(deftest card-tile-query-implicit-join-ref-test
+ (testing "GET api/embed/tiles/card/:uuid/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Card {card-id :id} {:dataset_query (tiles.api-test/implicit-join-query)
+ :enable_embedding true}]
+ (let [token (card-token card-id)]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "embed/tiles/card/%s/1/1/1" token)
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
+
+(deftest dashcard-tile-query-implicit-join-ref-test
+ (testing "GET api/embed/tiles/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Dashboard {dashboard-id :id} {:enable_embedding true}
+ :model/Card {card-id :id} {:dataset_query (tiles.api-test/implicit-join-query)}
+ :model/DashboardCard {dashcard-id :id} {:card_id card-id
+ :dashboard_id dashboard-id}]
+ (let [token (dash-token dashboard-id)]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "embed/tiles/dashboard/%s/dashcard/%d/card/%d/1/1/1"
+ token
+ dashcard-id
+ card-id)
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
+
(deftest embedded-string-parameter-case-sensitivity-regression-test
"Regression test for metabase#29371 - Case-sensitive field filters in embedded dashboards.
Embedded dashboards should apply case-insensitive default options for string operators."
diff --git a/test/metabase/embedding_rest/api/preview_embed_test.clj b/test/metabase/embedding_rest/api/preview_embed_test.clj
index 9e93579cfc2..1b7c52990c2 100644
--- a/test/metabase/embedding_rest/api/preview_embed_test.clj
+++ b/test/metabase/embedding_rest/api/preview_embed_test.clj
@@ -731,3 +731,32 @@
card-id)
:latField (tiles.api-test/encoded-lat-field-ref)
:lonField (tiles.api-test/encoded-lon-field-ref)))))))))
+
+(deftest card-tile-query-implicit-join-ref-test
+ (testing "GET api/preview_embed/tiles/card/:uuid/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (embed-test/with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Card {card-id :id} {:dataset_query (tiles.api-test/implicit-join-query)
+ :enable_embedding true}]
+ (let [token (embed-test/card-token card-id)]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "preview_embed/tiles/card/%s/1/1/1" token)
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
+
+(deftest dashcard-tile-query-implicit-join-ref-test
+ (testing "GET api/preview_embed/tiles/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (embed-test/with-embedding-enabled-and-new-secret-key!
+ (mt/with-temp [:model/Dashboard {dashboard-id :id} {:enable_embedding true}
+ :model/Card {card-id :id} {:dataset_query (tiles.api-test/implicit-join-query)}
+ :model/DashboardCard {dashcard-id :id} {:card_id card-id
+ :dashboard_id dashboard-id}]
+ (let [token (embed-test/dash-token dashboard-id)]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "preview_embed/tiles/dashboard/%s/dashcard/%d/card/%d/1/1/1"
+ token
+ dashcard-id
+ card-id)
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
diff --git a/test/metabase/public_sharing_rest/api_test.clj b/test/metabase/public_sharing_rest/api_test.clj
index 1506fd8a13b..348cc9ce09d 100644
--- a/test/metabase/public_sharing_rest/api_test.clj
+++ b/test/metabase/public_sharing_rest/api_test.clj
@@ -1890,6 +1890,30 @@
:latField lat-field
:lonField lon-field)))))))))
+(deftest card-tile-query-implicit-join-ref-test
+ (testing "GET api/public/tiles/card/:uuid/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (let [uuid (str (random-uuid))]
+ (mt/with-temporary-setting-values [enable-public-sharing true]
+ (mt/with-temp [:model/Card _card {:dataset_query (tiles.api-test/implicit-join-query)
+ :public_uuid uuid}]
+ (is (= "An error occurred."
+ (client/client :get 400 (str "public/tiles/card/" uuid "/1/1/1")
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
+
+(deftest dashcard-tile-query-implicit-join-ref-test
+ (testing "GET api/public/tiles/dashboard/:uuid/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join"
+ (let [uuid (str (random-uuid))]
+ (mt/with-temporary-setting-values [enable-public-sharing true]
+ (mt/with-temp [:model/Dashboard {dashboard-id :id} {:public_uuid uuid}
+ :model/Card {card-id :id} {:dataset_query (tiles.api-test/implicit-join-query)}
+ :model/DashboardCard {dashcard-id :id} {:card_id card-id
+ :dashboard_id dashboard-id}]
+ (is (= "An error occurred."
+ (client/client :get 400 (str "public/tiles/dashboard/" uuid "/dashcard/" dashcard-id "/card/" card-id "/1/1/1")
+ :latField (tiles.api-test/encoded-implicit-join-field-ref :latitude)
+ :lonField (tiles.api-test/encoded-implicit-join-field-ref :longitude)))))))))
+
;;; --------------------------------- POST /oembed ----------------------------------
(deftest oembed-test
diff --git a/test/metabase/tiles/api_test.clj b/test/metabase/tiles/api_test.clj
index fc663da2ae7..4f8b71b083e 100644
--- a/test/metabase/tiles/api_test.clj
+++ b/test/metabase/tiles/api_test.clj
@@ -3,8 +3,10 @@
{:clj-kondo/config '{:linters {:deprecated-var {:exclude {metabase.test.data/mbql-query {:namespaces [metabase.tiles.api-test]}}}}}}
(:require
[clojure.test :refer :all]
+ [medley.core :as m]
[metabase.api.macros :as api.macros]
[metabase.lib.core :as lib]
+ [metabase.lib.metadata :as lib.metadata]
[metabase.lib.test-metadata :as meta]
[metabase.test :as mt]
[metabase.tiles.api :as api.tiles]
@@ -64,6 +66,19 @@
:mbql (mt/$ids $people.longitude)
:native [:field "LONGITUDE" {:base-type :type/Float}]))))
+(defn implicit-join-query
+ "Query on Orders; the People lat/lon columns are only reachable via an implicit join through USER_ID."
+ []
+ (let [mp (mt/metadata-provider)]
+ (lib/query mp (lib.metadata/table mp (mt/id :orders)))))
+
+(defn encoded-implicit-join-field-ref
+ "JSON-encoded legacy ref with `:source-field` for a People column reached from Orders via an implicit join."
+ [field-name]
+ (let [col (m/find-first #(= (:id %) (mt/id :people field-name))
+ (lib/visible-columns (implicit-join-query)))]
+ (json/encode (lib/->legacy-MBQL (lib/ref col)))))
+
(deftest ^:parallel ad-hoc-query-test
(testing "GET /api/tiles/:zoom/:x/:y with latField and lonField query params"
(is (png? (mt/user-http-request
@@ -264,6 +279,39 @@
:lonField (encoded-lon-field-ref :mbql)
:query (json/encode (mt/mbql-query people {:filter [:= $people.id "X"]})))))))
+(deftest ^:parallel ad-hoc-implicit-join-ref-test
+ (testing "GET /api/tiles/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join (:source-field)"
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 "tiles/1/1/1"
+ :query (json/encode (implicit-join-query))
+ :latField (encoded-implicit-join-field-ref :latitude)
+ :lonField (encoded-implicit-join-field-ref :longitude))))))
+
+(deftest ^:parallel saved-card-implicit-join-ref-test
+ (testing "GET /api/tiles/:card-id/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join (:source-field)"
+ (mt/with-temp [:model/Card card {:dataset_query (implicit-join-query)}]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "tiles/%d/1/1/1" (u/id card))
+ :latField (encoded-implicit-join-field-ref :latitude)
+ :lonField (encoded-implicit-join-field-ref :longitude)))))))
+
+(deftest ^:parallel dashcard-implicit-join-ref-test
+ (testing "GET /api/tiles/:dashboard-id/dashcard/:dashcard-id/card/:card-id/:zoom/:x/:y returns a 400 when the lat/lon refs use an implicit join (:source-field)"
+ (mt/with-temp [:model/Dashboard {dashboard-id :id} {}
+ :model/Card {card-id :id} {:dataset_query (implicit-join-query)}
+ :model/DashboardCard {dashcard-id :id} {:card_id card-id
+ :dashboard_id dashboard-id}]
+ (is (= "Fields referenced via implicit joins are not supported."
+ (mt/user-http-request
+ :crowberto :get 400 (format "tiles/%d/dashcard/%d/card/%d/1/1/1"
+ dashboard-id
+ dashcard-id
+ card-id)
+ :latField (encoded-implicit-join-field-ref :latitude)
+ :lonField (encoded-implicit-join-field-ref :longitude)))))))
+
(deftest ^:parallel legacy-ref-schema-strips-extra-keys-test
(testing "the tile latField/lonField schema decodes a JSON field ref, validates it, and strips undeclared properties"
(let [decoded (api.macros/decode-and-validate-params