Skip to content

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

Ghy 3975 fix dependency analysis on upgrade (#76442)

Ben Grabow0c81b6fc9515
diff --git a/src/metabase/dashboards/models/dashboard_card.clj b/src/metabase/dashboards/models/dashboard_card.clj
index 40ede158121..9735e667a84 100644
--- a/src/metabase/dashboards/models/dashboard_card.clj
+++ b/src/metabase/dashboards/models/dashboard_card.clj
@@ -40,7 +40,7 @@
(t2/define-after-select :model/DashboardCard
[dashcard]
(if (contains? dashcard :visualization_settings)
- (update dashcard :visualization_settings serdes/import-visualizer-settings)
+ (update dashcard :visualization_settings serdes/import-visualizer-settings-lenient)
dashcard))
(declare series)
diff --git a/src/metabase/models/serialization.clj b/src/metabase/models/serialization.clj
index 01db076aed0..ebb93b04ea6 100644
--- a/src/metabase/models/serialization.clj
+++ b/src/metabase/models/serialization.clj
@@ -1789,16 +1789,18 @@
(defn- import-card-dimension-ref
[s]
- (if-let [[_ card-id] (and (string? s) (re-matches #"^\$_card:([A-Za-z0-9_\-]{21})_name$" s))]
- (str "$_card:" (*import-fk* card-id :model/Card) "_name")
- s))
+ (or (when-let [[_ card-id] (and (string? s) (re-matches #"^\$_card:([A-Za-z0-9_\-]{21})_name$" s))]
+ (when-let [resolved (*import-fk* card-id :model/Card)]
+ (str "$_card:" resolved "_name")))
+ s))
(defn- import-visualizer-source-id
[source-id]
(when (string? source-id)
- (if-let [card-entity-id (second (re-matches #"^card:([A-Za-z0-9_\-]{21})$" source-id))]
- (str "card:" (*import-fk* card-entity-id :model/Card))
- source-id)))
+ (or (when-let [card-entity-id (second (re-matches #"^card:([A-Za-z0-9_\-]{21})$" source-id))]
+ (when-let [card-id (*import-fk* card-entity-id :model/Card)]
+ (str "card:" card-id)))
+ source-id)))
(defn import-visualizer-settings
"Update embedded entity ids to card ids in visualizer dashcard settings"
@@ -1806,20 +1808,26 @@
(m/update-existing-in
settings
[:visualization :columnValuesMapping]
- (fn [mapping]
- (into {}
- (for [[k cols] mapping]
- (let [updated-cols (cond
- ;; e.g. [{:sourceId "card:..."} ...]
- (and (coll? cols) (map? (first cols)))
- (mapv #(update % :sourceId import-visualizer-source-id) cols)
-
- ;; e.g. ["$_card:<id>_name"] for funnel dimensions
- (and (coll? cols) (string? (first cols)))
- (mapv import-card-dimension-ref cols)
-
- :else cols)]
- [k updated-cols]))))))
+ update-vals
+ (fn [cols]
+ (cond
+ ;; e.g. [{:sourceId "card:..."} ...]
+ (and (coll? cols) (map? (first cols)))
+ (mapv #(update % :sourceId import-visualizer-source-id) cols)
+
+ ;; e.g. ["$_card:<id>_name"] for funnel dimensions
+ (and (coll? cols) (string? (first cols)))
+ (mapv import-card-dimension-ref cols)
+
+ :else cols))))
+
+(defn import-visualizer-settings-lenient
+ "Like [[import-visualizer-settings]], but resolves card references leniently: a dangling reference is
+ left in its portable entity-id form, instead of throwing. Use for paths where a deleted source Card
+ should be treated as a broken section rather than break the whole read."
+ [settings]
+ (binding [resolve/*import-resolver* @(requiring-resolve 'metabase.models.serialization.resolve.db/lenient-import-resolver)]
+ (import-visualizer-settings settings)))
(defn import-visualization-settings
"Given an EDN value as exported by [[export-visualization-settings]], convert its portable `[db schema table field]`
diff --git a/src/metabase/models/serialization/resolve/db.clj b/src/metabase/models/serialization/resolve/db.clj
index 32fcf09d57c..d8ab17369c8 100644
--- a/src/metabase/models/serialization/resolve/db.clj
+++ b/src/metabase/models/serialization/resolve/db.clj
@@ -6,7 +6,9 @@
(:require
[metabase.models.serialization :as serdes]
[metabase.models.serialization.resolve :as resolve]
- [toucan2.core :as t2]))
+ [metabase.util.log :as log]
+ [toucan2.core :as t2])
+ (:import (clojure.lang ExceptionInfo)))
(set! *warn-on-reflection* true)
@@ -145,20 +147,32 @@
(def default-export-resolver
"A stateless database-backed export resolver."
(reify resolve/SerdesExportResolver
- (export-fk [_ id model] (export-fk id model))
- (export-fk-keyed [_ id model field] (export-fk-keyed id model field))
- (export-user [this id] (export-user this id))
- (export-table-fk [_ table-id] (export-table-fk table-id))
- (export-field-fk [this field-id] (export-field-fk this field-id))))
+ (resolve/export-fk [_ id model] (export-fk id model))
+ (resolve/export-fk-keyed [_ id model field] (export-fk-keyed id model field))
+ (resolve/export-user [this id] (export-user this id))
+ (resolve/export-table-fk [_ table-id] (export-table-fk table-id))
+ (resolve/export-field-fk [this field-id] (export-field-fk this field-id))))
(def default-import-resolver
"A stateless database-backed import resolver."
(reify resolve/SerdesImportResolver
- (import-fk [_ eid model] (import-fk eid model))
- (import-fk-keyed [_ portable model field] (import-fk-keyed portable model field))
- (import-user [this email] (import-user this email))
- (import-table-fk [_ path] (import-table-fk path))
- (import-field-fk [this path] (import-field-fk this path))))
+ (resolve/import-fk [_ eid model] (import-fk eid model))
+ (resolve/import-fk-keyed [_ portable model field] (import-fk-keyed portable model field))
+ (resolve/import-user [this email] (import-user this email))
+ (resolve/import-table-fk [_ path] (import-table-fk path))
+ (resolve/import-field-fk [this path] (import-field-fk this path))))
+
+(def lenient-import-resolver
+ "A stateless database-backed import resolver that returns nil for an unresolvable FK instead of throwing."
+ (reify resolve/SerdesImportResolver
+ (resolve/import-fk [_ eid model] (try (resolve/import-fk default-import-resolver eid model)
+ (catch ExceptionInfo e
+ (log/warn e "Failed to import FK")
+ nil)))
+ (resolve/import-fk-keyed [_ portable model field] (resolve/import-fk-keyed default-import-resolver portable model field))
+ (resolve/import-user [_ email] (resolve/import-user default-import-resolver email))
+ (resolve/import-table-fk [_ path] (resolve/import-table-fk default-import-resolver path))
+ (resolve/import-field-fk [_ path] (resolve/import-field-fk default-import-resolver path))))
(defn cached-export-resolver
"Returns a database-backed export resolver with memoized lookups."
@@ -169,11 +183,11 @@
export-table-fk* (memoize export-table-fk)
export-field-fk* (memoize export-field-fk)]
(reify resolve/SerdesExportResolver
- (export-fk [_ id model] (export-fk* id model))
- (export-fk-keyed [_ id model field] (export-fk-keyed* id model field))
- (export-user [this id] (export-user* this id))
- (export-table-fk [_ table-id] (export-table-fk* table-id))
- (export-field-fk [this field-id] (export-field-fk* this field-id)))))
+ (resolve/export-fk [_ id model] (export-fk* id model))
+ (resolve/export-fk-keyed [_ id model field] (export-fk-keyed* id model field))
+ (resolve/export-user [this id] (export-user* this id))
+ (resolve/export-table-fk [_ table-id] (export-table-fk* table-id))
+ (resolve/export-field-fk [this field-id] (export-field-fk* this field-id)))))
(defn cached-import-resolver
"Returns a database-backed import resolver with memoized lookups."
@@ -184,8 +198,8 @@
import-table-fk* (memoize import-table-fk)
import-field-fk* (memoize import-field-fk)]
(reify resolve/SerdesImportResolver
- (import-fk [_ eid model] (import-fk* eid model))
- (import-fk-keyed [_ portable model field] (import-fk-keyed* portable model field))
- (import-user [this email] (import-user* this email))
- (import-table-fk [_ path] (import-table-fk* path))
- (import-field-fk [this path] (import-field-fk* this path)))))
+ (resolve/import-fk [_ eid model] (import-fk* eid model))
+ (resolve/import-fk-keyed [_ portable model field] (import-fk-keyed* portable model field))
+ (resolve/import-user [this email] (import-user* this email))
+ (resolve/import-table-fk [_ path] (import-table-fk* path))
+ (resolve/import-field-fk [this path] (import-field-fk* this path)))))
diff --git a/src/metabase/sample_data/impl.clj b/src/metabase/sample_data/impl.clj
index e4bb0ed4417..a0d12a65380 100644
--- a/src/metabase/sample_data/impl.clj
+++ b/src/metabase/sample_data/impl.clj
@@ -115,7 +115,7 @@
"IDs of Dashboards holding at least one card backed by `database-id`. Captured before the sample
database is deleted so the dashboards it empties out can be pruned afterward."
[database-id]
- (t2/select-fn-set :dashboard_id :model/DashboardCard
+ (t2/select-fn-set :dashboard_id [:model/DashboardCard :dashboard_id]
:card_id [:in {:select [:id]
:from [(t2/table-name :model/Card)]
:where [:= :database_id database-id]}]))
@@ -126,7 +126,7 @@
in cards from another database) is left alone."
[dashboard-ids]
(when (seq dashboard-ids)
- (let [non-empty (t2/select-fn-set :dashboard_id :model/DashboardCard :dashboard_id [:in dashboard-ids])
+ (let [non-empty (t2/select-fn-set :dashboard_id [:model/DashboardCard :dashboard_id] :dashboard_id [:in dashboard-ids])
empty-ids (remove (or non-empty #{}) dashboard-ids)]
(when (seq empty-ids)
(t2/delete! :model/Dashboard :id [:in empty-ids])))))
diff --git a/test/metabase/dashboards/models/dashboard_card_test.clj b/test/metabase/dashboards/models/dashboard_card_test.clj
index b2347caee91..95a324cb06b 100644
--- a/test/metabase/dashboards/models/dashboard_card_test.clj
+++ b/test/metabase/dashboards/models/dashboard_card_test.clj
@@ -324,3 +324,33 @@
transformed (dashboard-card/from-parsed-json deserialized)]
(is (= dashcard
transformed))))))
+
+(deftest ^:parallel after-select-tolerates-dangling-visualizer-ref-test
+ (testing "A DashboardCard whose visualizer settings reference a deleted Card is returned unmodified on read,
+ rather than throwing and making the dashcard unloadable."
+ (mt/with-temp [:model/Dashboard dash {}
+ :model/Card card {}
+ :model/DashboardCard dc {:dashboard_id (:id dash), :card_id (:id card)}]
+ (let [dangling {:visualization {:columnValuesMapping {:COLUMN_1 [{:sourceId "card:gEnfWx10SmfjiccZpcGrj"}]}}}]
+ ;; Inject the dangling ref via raw SQL so model hooks don't rewrite it on write.
+ (t2/query-one {:update (t2/table-name :model/DashboardCard)
+ :set {:visualization_settings (json/encode dangling)}
+ :where [:= :id (:id dc)]})
+ (testing "the read does not throw and the unresolved ref is left untouched"
+ (let [loaded (t2/select-one :model/DashboardCard :id (:id dc))]
+ (is (= [{:sourceId "card:gEnfWx10SmfjiccZpcGrj"}]
+ (get-in loaded [:visualization_settings :visualization :columnValuesMapping :COLUMN_1])))))))))
+
+(deftest ^:parallel after-select-resolves-valid-visualizer-ref-test
+ (testing "A valid visualizer entity-id reference is resolved to a numeric card id on read."
+ (mt/with-temp [:model/Dashboard dash {}
+ :model/Card card {}
+ :model/Card src {}
+ :model/DashboardCard dc {:dashboard_id (:id dash), :card_id (:id card)}]
+ (let [viz {:visualization {:columnValuesMapping {:COLUMN_1 [{:sourceId (str "card:" (:entity_id src))}]}}}]
+ (t2/query-one {:update (t2/table-name :model/DashboardCard)
+ :set {:visualization_settings (json/encode viz)}
+ :where [:= :id (:id dc)]})
+ (let [loaded (t2/select-one :model/DashboardCard :id (:id dc))]
+ (is (= [{:sourceId (str "card:" (:id src))}]
+ (get-in loaded [:visualization_settings :visualization :columnValuesMapping :COLUMN_1]))))))))
diff --git a/test/metabase/sample_data/impl_test.clj b/test/metabase/sample_data/impl_test.clj
index 1c7b0008bfe..a4884c52718 100644
--- a/test/metabase/sample_data/impl_test.clj
+++ b/test/metabase/sample_data/impl_test.clj
@@ -14,6 +14,7 @@
[metabase.sync.task.sync-databases-test :as task.sync-databases-test]
[metabase.test :as mt]
[metabase.util :as u]
+ [metabase.util.json :as json]
[metabase.warehouse-schema.models.field-values :as field-values]
[metabase.warehouses-rest.api-test :as api.database-test]
[toucan2.core :as t2])
@@ -204,6 +205,28 @@
(testing "the Example collection is preserved (the engine swap no longer deletes it)"
(is (t2/exists? :model/Collection :id (:id examples)))))))
+(deftest replace-sample-database-survives-dangling-visualizer-ref-test
+ (testing "The engine swap completes when a sample dashcard has a dangling visualizer ref"
+ (mt/with-temp
+ [:model/Database old-sample {:engine :h2, :is_sample true, :details {:db "mem:old-sample"}}
+ :model/Card sample-card {:database_id (:id old-sample)}
+ :model/Dashboard sample-dash {}
+ :model/DashboardCard dc {:dashboard_id (:id sample-dash), :card_id (:id sample-card)}]
+ ;; Inject a dangling visualizer ref via raw SQL so the model's hooks don't reject/rewrite it.
+ (t2/query-one {:update (t2/table-name :model/DashboardCard)
+ :set {:visualization_settings
+ (json/encode {:visualization
+ {:columnValuesMapping
+ {:COLUMN_1 [{:sourceId "card:gEnfWx10SmfjiccZpcGrj"}]}}})}
+ :where [:= :id (:id dc)]})
+ (with-redefs [config/load-sample-content? (constantly false)]
+ (testing "the replacement completes instead of throwing on the dangling ref"
+ (is (nil? (#'sample-data/update-sample-database-if-needed! old-sample)))))
+ (testing "the old sample DB and the dashboard emptied by its removal are deleted"
+ (is (not (t2/exists? :model/Database :id (:id old-sample))))
+ (is (not (t2/exists? :model/Card :id (:id sample-card))))
+ (is (not (t2/exists? :model/Dashboard :id (:id sample-dash))))))))
+
(def ^:private edn-example-collection-entity-id
"Stable entity id of the bundled Examples collection in sample-content.edn."
"HyB3nRtqb7pBPhFG26evI")