Skip to content

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

Make visible-columns for cards respect field visibility (#70040)

metamben7433f38a2294
diff --git a/src/metabase/lib/card.cljc b/src/metabase/lib/card.cljc
index fc4da8db354..7f307de06af 100644
--- a/src/metabase/lib/card.cljc
+++ b/src/metabase/lib/card.cljc
@@ -154,7 +154,7 @@
#{})
(defn- updated-result-metadata
- "Get `:result-metadata` from Card, but merge in updated values of `:active`."
+ "Get `:result-metadata` from Card, but merge in updated values of `:active` and `:visibility-type`."
[metadata-providerable card]
(when-let [saved-metadata-cols (not-empty (:result-metadata card))]
(let [ids (into #{} (keep :id) saved-metadata-cols)
@@ -163,7 +163,11 @@
(merge
saved-metadata-col
(when-let [metadata-provider-col (id->metadata-provider-col (:id saved-metadata-col))]
- (select-keys metadata-provider-col [:active]))))
+ (let [legacy? (contains? saved-metadata-col :base_type)]
+ (cond-> (select-keys metadata-provider-col [:active])
+ (contains? metadata-provider-col :visibility-type)
+ (assoc (if legacy? :visibility_type :visibility-type)
+ (:visibility-type metadata-provider-col)))))))
saved-metadata-cols))))
(mu/defn card->underlying-query :- ::lib.schema/query
diff --git a/src/metabase/lib/metadata.cljc b/src/metabase/lib/metadata.cljc
index c5a37177827..c8e7117cd0d 100644
--- a/src/metabase/lib/metadata.cljc
+++ b/src/metabase/lib/metadata.cljc
@@ -58,6 +58,18 @@
table-id :- ::lib.schema.id/table]
(fields* metadata-providerable table-id nil))
+(defn active-column-filter-xform
+ "A `filter` transducer that removes columns that should not be visible based on `:active` status and
+ `:visibility-type` (e.g., `:sensitive`, `:retired`). Reuses [[metabase.lib.metadata.protocols/active-column-pred]]
+ to keep the filtering logic in one place.
+
+ Options:
+ - `:include-sensitive?` - if true, does not filter out `:sensitive` columns (default false)"
+ ([]
+ (active-column-filter-xform nil))
+ ([opts]
+ (filter (lib.metadata.protocols/active-column-pred opts))))
+
(mu/defn active-fields :- [:sequential ::lib.schema.metadata/column]
"Like [[fields]], but filters out any Fields that are not `:active` or with `:visibility-type`s that mean they
should not be included in queries.
diff --git a/src/metabase/lib/metadata/protocols.cljc b/src/metabase/lib/metadata/protocols.cljc
index 1d20049576d..fe008dfad92 100644
--- a/src/metabase/lib/metadata/protocols.cljc
+++ b/src/metabase/lib/metadata/protocols.cljc
@@ -48,6 +48,19 @@
{:error/message "All metadata types except for :metadata/table and :metadata/transform must include at least one filter"}
(some-fn :id :name :table-id :card-id #(= (:lib/type %) :metadata/table) #(= (:lib/type %) :metadata/transform))]])
+(defn active-column-pred
+ "Returns a predicate that filters out columns that should not be visible based on `:active` status and
+ `:visibility-type` (e.g., `:sensitive`, `:retired`). Used by [[default-spec-filter-xform]] and by
+ [[metabase.lib.metadata/active-column-filter-xform]]."
+ ([]
+ (active-column-pred nil))
+ ([{:keys [include-sensitive?]}]
+ (let [excluded-visibility-types (cond-> #{:retired}
+ (not include-sensitive?) (conj :sensitive))]
+ #(and
+ (not (false? (:active %)))
+ (not (excluded-visibility-types (:visibility-type %)))))))
+
(mu/defn default-spec-filter-xform
"Create a `filter` transducer to a sequence of objects according to `metadata-spec`. Assumes objects are all the
correct type already (i.e., does not filter by `:lib/type`). This powers the implementation of [[metadatas]] for
@@ -79,11 +92,7 @@
(not (#{:hidden :technical :cruft} (:visibility-type %))))
:metadata/column
- (let [excluded-visibility-types (cond-> #{:retired}
- (not include-sensitive?) (conj :sensitive))]
- #(and
- (not (false? (:active %)))
- (not (excluded-visibility-types (:visibility-type %)))))
+ (active-column-pred {:include-sensitive? include-sensitive?})
(:metadata/card :metadata/measure :metadata/metric :metadata/segment)
#(not (:archived %))
diff --git a/src/metabase/lib/stage.cljc b/src/metabase/lib/stage.cljc
index ccb6eb8275c..1f4aa94c25d 100644
--- a/src/metabase/lib/stage.cljc
+++ b/src/metabase/lib/stage.cljc
@@ -234,8 +234,10 @@
(mu/defn- existing-visible-columns :- ::lib.metadata.calculation/visible-columns
[query :- ::lib.schema/query
stage-number :- :int
- {:keys [include-joined? include-expressions?], :as options} :- ::lib.metadata.calculation/visible-columns.options]
- (let [source-columns (previous-stage-or-source-visible-columns query stage-number options)]
+ {:keys [include-joined? include-expressions? include-sensitive-fields?], :as options} :- ::lib.metadata.calculation/visible-columns.options]
+ (let [source-columns (into []
+ (lib.metadata/active-column-filter-xform {:include-sensitive? include-sensitive-fields?})
+ (previous-stage-or-source-visible-columns query stage-number options))]
(concat
;; 1: columns from the previous stage, source table or query
source-columns
diff --git a/test/metabase/lib/metadata/calculation_test.cljc b/test/metabase/lib/metadata/calculation_test.cljc
index 55a131cf886..4459f88bc50 100644
--- a/test/metabase/lib/metadata/calculation_test.cljc
+++ b/test/metabase/lib/metadata/calculation_test.cljc
@@ -657,6 +657,53 @@
["PRODUCTS__via__PRODUCT_ID__RATING" :source/implicitly-joinable]
["PRODUCTS__via__PRODUCT_ID__CREATED_AT" :source/implicitly-joinable]]))))
+(deftest ^:parallel visible-columns-card-filters-sensitive-columns-test
+ (testing "visible-columns for a card-based query should filter out columns with :visibility-type :sensitive (QUE-2438)"
+ ;; Simulate: card was saved when PASSWORD was :normal (so it's in result-metadata),
+ ;; then PASSWORD was later changed to :sensitive.
+ (let [inner (-> (lib/query meta/metadata-provider (meta/table-metadata :orders))
+ (lib/join (meta/table-metadata :people)))
+ ;; Create the card using normal metadata (PASSWORD is :normal, so it's in result-metadata)
+ card-mp (lib.tu/metadata-provider-with-card-from-query meta/metadata-provider 1 inner)
+ ;; Now override PASSWORD to be :sensitive (simulating admin changing it after card was saved)
+ mp (lib.tu/merged-mock-metadata-provider
+ card-mp
+ {:fields [{:id (meta/id :people :password)
+ :visibility-type :sensitive}]})
+ query (lib/query mp (lib.metadata/card mp 1))]
+ (check-visible-columns
+ query
+ [["ID" :source/card]
+ ["SUBTOTAL" :source/card]
+ ["TOTAL" :source/card]
+ ["TAX" :source/card]
+ ["DISCOUNT" :source/card]
+ ["QUANTITY" :source/card]
+ ["CREATED_AT" :source/card]
+ ["PRODUCT_ID" :source/card]
+ ["USER_ID" :source/card]
+ ["People - User__ID" :source/card]
+ ["People - User__STATE" :source/card]
+ ["People - User__CITY" :source/card]
+ ["People - User__ADDRESS" :source/card]
+ ["People - User__NAME" :source/card]
+ ["People - User__SOURCE" :source/card]
+ ["People - User__ZIP" :source/card]
+ ["People - User__LATITUDE" :source/card]
+ ;; People - User__PASSWORD should NOT appear here because it has :visibility-type :sensitive
+ ["People - User__BIRTH_DATE" :source/card]
+ ["People - User__LONGITUDE" :source/card]
+ ["People - User__EMAIL" :source/card]
+ ["People - User__CREATED_AT" :source/card]
+ ["PRODUCTS__via__PRODUCT_ID__ID" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__EAN" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__TITLE" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__CATEGORY" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__VENDOR" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__PRICE" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__RATING" :source/implicitly-joinable]
+ ["PRODUCTS__via__PRODUCT_ID__CREATED_AT" :source/implicitly-joinable]]))))
+
(deftest ^:parallel visible-columns-checkins+users+venues-card-test
(testing "multi-card checkins+users+venues join"
;; The idea is that these are all joins between cards and nested queries.