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 do implicit joins through sensitive FKs (#67056)

Eric Normandd7425d04f893
diff --git a/src/metabase/lib/metadata/calculation.cljc b/src/metabase/lib/metadata/calculation.cljc
index 83edea9621e..a68702127f6 100644
--- a/src/metabase/lib/metadata/calculation.cljc
+++ b/src/metabase/lib/metadata/calculation.cljc
@@ -655,10 +655,14 @@
(lib.util/first-stage? query stage-number))
(let [existing-ids (into #{} (keep :id) source-cols)]
(for [column source-cols
+ :let [fk-id (:fk-target-field-id column)]
+ :when fk-id
+ :let [fk-field (lib.metadata/field query fk-id)]
+ :when (not (contains? #{:sensitive :retired} (:visibility-type fk-field)))
:let [remapped (lib.metadata/remapped-field query column)]
:when (and remapped
(not (false? (:active remapped)))
- (not= (:visibility-type remapped) :sensitive)
+ (not (contains? #{:sensitive :retired} (:visibility-type remapped)))
(not (existing-ids (:id remapped))))]
(merge
remapped
diff --git a/src/metabase/query_processor/middleware/add_remaps.clj b/src/metabase/query_processor/middleware/add_remaps.clj
index 1aa263b4965..b804c286b88 100644
--- a/src/metabase/query_processor/middleware/add_remaps.clj
+++ b/src/metabase/query_processor/middleware/add_remaps.clj
@@ -90,14 +90,17 @@
field-id :- ::lib.schema.id/field]
(let [col (lib.metadata/field metadata-providerable field-id)]
(when-let [{remap-id :id, remap-name :name, remap-field-id :field-id} (:lib/external-remap col)]
- (when-let [remap-field (lib.metadata/field metadata-providerable remap-field-id)]
- (when (not= (:visibility-type remap-field) :sensitive)
- {:id remap-id
- :name remap-name
- :field-id (:id col)
- :field-name (:name col)
- :human-readable-field-id remap-field-id
- :human-readable-field-name (:name remap-field)})))))
+ (when-let [fk-target-field-id (:fk-target-field-id col)]
+ (when-let [fk-field (lib.metadata/field metadata-providerable fk-target-field-id)]
+ (when (not (contains? #{:sensitive :retired} (:visibility-type fk-field)))
+ (when-let [remap-field (lib.metadata/field metadata-providerable remap-field-id)]
+ (when (not (contains? #{:sensitive :retired} (:visibility-type remap-field)))
+ {:id remap-id
+ :name remap-name
+ :field-id (:id col)
+ :field-name (:name col)
+ :human-readable-field-id remap-field-id
+ :human-readable-field-name (:name remap-field)}))))))))
(mr/def ::remap-info
[:and
diff --git a/test/metabase/query_processor/middleware/add_remaps_test.clj b/test/metabase/query_processor/middleware/add_remaps_test.clj
index 13280b1aaf0..60ff3988cc7 100644
--- a/test/metabase/query_processor/middleware/add_remaps_test.clj
+++ b/test/metabase/query_processor/middleware/add_remaps_test.clj
@@ -400,10 +400,13 @@
(deftest ^:parallel multiple-fk-remaps-test
(testing "Should be able to do multiple FK remaps via different FKs from Table A to Table B (#9236)\n"
(let [mp (-> meta/metadata-provider
- (lib.tu/remap-metadata-provider (meta/field-metadata :venues :category-id)
- (meta/field-metadata :categories :name))
- (lib.tu/remap-metadata-provider (meta/field-metadata :venues :id)
- (meta/field-metadata :categories :name)))
+ (lib.tu/merged-mock-metadata-provider
+ {:fields [{:id (meta/id :venues :id)
+ :fk-target-field-id (meta/id :categories :id)}]})
+ (lib.tu/remap-metadata-provider (meta/id :venues :category-id)
+ (meta/id :categories :name))
+ (lib.tu/remap-metadata-provider (meta/id :venues :id)
+ (meta/id :categories :name)))
query (lib/query
mp
(lib.tu.macros/mbql-query venues
diff --git a/test/metabase/query_processor/remapping_test.clj b/test/metabase/query_processor/remapping_test.clj
index 1fc5fa2908f..4c8c887f3f8 100644
--- a/test/metabase/query_processor/remapping_test.clj
+++ b/test/metabase/query_processor/remapping_test.clj
@@ -560,3 +560,49 @@
(mt/formatted-rows [int str str str str str 2.0 str str str str 2.0 str
int int 2.0 2.0 2.0 2.0 str int str str]
(qp/process-query query))))))))
+
+(deftest ^:parallel fk-remapped-should-remap-test
+ (testing (format "Check that we return the title when it's remapped")
+ (let [mp (-> (mt/metadata-provider)
+ (lib.tu/remap-metadata-provider (mt/id :orders :product_id)
+ (mt/id :products :title)))
+ query (-> (lib/query mp (lib.metadata/table mp (mt/id :orders)))
+ (lib/limit 1))]
+ ;; make sure the title is returned
+ (is (string? (last (first (mt/rows (qp/process-query query)))))))))
+
+(deftest ^:parallel fk-excluded-should-not-break-test
+ (doseq [field [:id :title]
+ vis [:sensitive :retired]]
+ (testing (format "Check that we don't error when product %s is %s (#64050)" (name field) (name vis))
+ (let [mp (-> (mt/metadata-provider)
+ (lib.tu/remap-metadata-provider (mt/id :orders :product_id)
+ (mt/id :products :title))
+ (lib.tu/merged-mock-metadata-provider
+ {:fields [{:id (mt/id :products field)
+ :visibility-type vis}]}))
+ query (-> (lib/query mp (lib.metadata/table mp (mt/id :orders)))
+ (lib/limit 1))]
+ (is (seq (mt/rows (qp/process-query query))))))))
+
+(deftest ^:parallel fk-do-not-include-should-not-break-nested-test
+ (doseq [field [:id :title]
+ vis [:sensitive :retired]]
+ (testing (format "Check that we don't error when product %s is %s in nested query (#64050)" (name field) (name vis))
+ (let [mp (-> (mt/metadata-provider)
+ (lib.tu/remap-metadata-provider (mt/id :orders :product_id)
+ (mt/id :products :title))
+ (lib.tu/merged-mock-metadata-provider
+ {:fields [{:id (mt/id :products field)
+ :visibility-type vis}]}))
+ query (-> (lib/query mp (lib.metadata/table mp (mt/id :orders)))
+ (lib/limit 1))
+ mp (lib.tu/mock-metadata-provider mp {:cards
+ [{:id 1
+ :name "ORDERS"
+ :database-id (mt/id)
+ :dataset-query query
+ :type :model}]})
+ q2 (-> (lib/query mp (lib.metadata/card mp 1))
+ (lib/limit 1))]
+ (is (seq (mt/rows (qp/process-query q2))))))))