The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:
TypeScript analyticsbibusiness-intelligencebusinessintelligenceclojuredashboarddatadata-analysisdata-visualizationdatabasemetabasemysqlpostgrespostgresqlreportingslacksql-editorvisualization
GHY-3372 Update parameter values_source_config.card_id during source swap (#74935)
Eric Normand706edecd2b27
diff --git a/enterprise/backend/src/metabase_enterprise/replacement/source_swap.clj b/enterprise/backend/src/metabase_enterprise/replacement/source_swap.cljindex de3b9a284a5..eadfd0f7fca 100644--- a/enterprise/backend/src/metabase_enterprise/replacement/source_swap.clj+++ b/enterprise/backend/src/metabase_enterprise/replacement/source_swap.clj@@ -38,19 +38,37 @@(events/publish-event! :event/transform-update{:object (merge transform changes) :user-id api/*current-user-id*}))))))+(defn- swap-parameter-source-card-id+ "For a parameters collection, replace `values_source_config.card_id` references to `old-source-id` with+ `new-source-id`. Only applies to card-to-card swaps; returns parameters unchanged for any other swap shape+ (e.g. card-to-table)."+ [parameters [old-source-type old-source-id] [new-source-type new-source-id]]+ (letfn [(swap-card-id [card-id]+ (if (and (= :card old-source-type)+ (= :card new-source-type)+ (= old-source-id card-id))+ new-source-id+ card-id))]+ (replacement.walk/walk-parameter-source-card-ids (or parameters []) swap-card-id)))+(defn- card-swap-source)- (let [query (:dataset_query card)- query' (source-swap/swap-source-in-query query old-source new-source)- table-id (:table_id card)- table-id' (:table-id (queries.query/query->database-and-table-ids query'))- changes (cond-> {}- (not= query query')- (assoc :dataset_query query')+ (let [query (:dataset_query card)+ query' (source-swap/swap-source-in-query query old-source new-source)+ table-id (:table_id card)+ table-id' (:table-id (queries.query/query->database-and-table-ids query'))+ parameters (or (:parameters card) [])+ parameters' (swap-parameter-source-card-id parameters old-source new-source)+ changes (cond-> {}+ (not= query query')+ (assoc :dataset_query query')- (not= table-id table-id')- (assoc :table_id table-id'))+ (not= table-id table-id')+ (assoc :table_id table-id')++ (not= parameters parameters')+ (assoc :parameters parameters'));; `:result_metadata` is set to nil for native queries if not present in changes.;; `verified-result-metadata?` prevents the Card model hooks from clearing it.changes (cond-> changes@@ -144,13 +162,18 @@card-id->card (if (seq all-card-ids)(t2/select-pk->fn identity :model/Card :id [:in all-card-ids]){})- any-changed? (reduce (fn [changed? dashcard]- (or- (dashcard-swap-source! dashcard card-id->card old-source new-source)- changed?))- false- dashcards)]- (when any-changed?+ any-dashcard-changed? (reduce (fn [changed? dashcard]+ (or+ (dashcard-swap-source! dashcard card-id->card old-source new-source)+ changed?))+ false+ dashcards)+ parameters (or (:parameters dashboard) [])+ parameters' (swap-parameter-source-card-id parameters old-source new-source)+ params-changed? (not= parameters parameters')]+ (when params-changed?+ (t2/update! :model/Dashboard (:id dashboard) {:parameters parameters'}))+ (when (or any-dashcard-changed? params-changed?)(events/publish-event!:event/dashboard-update {:object (t2/select-one :model/Dashboard :id (:id dashboard)):user-id api/*current-user-id*}))))diff --git a/enterprise/backend/src/metabase_enterprise/replacement/walk.clj b/enterprise/backend/src/metabase_enterprise/replacement/walk.cljindex d16ea44622a..ec4710484c6 100644--- a/enterprise/backend/src/metabase_enterprise/replacement/walk.clj+++ b/enterprise/backend/src/metabase_enterprise/replacement/walk.clj@@ -15,6 +15,14 @@[parameters :- [:sequential :map]](into #{} (keep #(-> % :values_source_config :card_id)) parameters))+(mu/defn walk-parameter-source-card-ids :- [:sequential :map]+ "Walk the parameters and update the card IDs in `:values_source_config` using the provided function.++ `card-id-fn` will be called with a card ID and should return a new card ID."+ [parameters :- [:sequential :map]+ card-id-fn :- fn?]+ (mapv #(m/update-existing-in % [:values_source_config :card_id] card-id-fn) parameters))+(mu/defn walk-parameter-source-card-refs :- [:sequential :map]"Walk the parameters and update the refs in `:value_field` and `:label_field`in the `:values_source_config` using the provided function.diff --git a/enterprise/backend/test/metabase_enterprise/replacement/source_swap_test.clj b/enterprise/backend/test/metabase_enterprise/replacement/source_swap_test.cljindex 6ddddbb7fab..744ebeb1dc3 100644--- a/enterprise/backend/test/metabase_enterprise/replacement/source_swap_test.clj+++ b/enterprise/backend/test/metabase_enterprise/replacement/source_swap_test.clj@@ -101,6 +101,56 @@[:table (mt/id :reviews)])(is (= {} (:dataset_query (t2/select-one :model/Card card-id))))))))))+(deftest card-swap-source!-updates-parameter-values-source-config-card-id-test+ (testing "swap-source! should update card_id in card parameter values_source_config for card-to-card swaps"+ (mt/with-premium-features #{:dependencies}+ (mt/with-test-user :rasta+ (let [mp (mt/metadata-provider)]+ (mt/with-temp [:model/Card {old-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :orders)))}+ :model/Card {new-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :reviews)))}+ :model/Card {card-id :id}+ {:dataset_query (lib/native-query mp "SELECT 1")+ :parameters [{:id "cat-param"+ :name "category"+ :type :string/=+ :values_source_type "card"+ :values_source_config {:card_id old-source-id+ :value_field [:field "ID" {:base-type :type/Integer}]}}]}]+ (replacement.source-swap/swap-source! [:card card-id]+ [:card old-source-id]+ [:card new-source-id])+ (testing ":parameters JSONB on the card is updated"+ (is (= new-source-id+ (-> (t2/select-one :model/Card card-id)+ :parameters first :values_source_config :card_id))))+ (testing "parameter_card row is synced"+ (is (= new-source-id+ (t2/select-one-fn :card_id :model/ParameterCard+ :parameterized_object_type "card"+ :parameterized_object_id card-id+ :parameter_id "cat-param"))))))))))++(deftest card-swap-source!-card-to-table-leaves-parameter-untouched-test+ (testing "swap-source! should NOT update parameter values_source_config card_id on card-to-table swaps"+ (mt/with-premium-features #{:dependencies}+ (mt/with-test-user :rasta+ (let [mp (mt/metadata-provider)]+ (mt/with-temp [:model/Card {old-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :orders)))}+ :model/Card {card-id :id}+ {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :orders)))+ :parameters [{:id "cat-param"+ :name "category"+ :type :string/=+ :values_source_type "card"+ :values_source_config {:card_id old-source-id+ :value_field [:field "ID" {:base-type :type/Integer}]}}]}]+ (replacement.source-swap/swap-source! [:card card-id]+ [:table (mt/id :orders)]+ [:table (mt/id :reviews)])+ (is (= old-source-id+ (-> (t2/select-one :model/Card card-id)+ :parameters first :values_source_config :card_id)))))))))+;;; ------------------------------------------------ Transform --------------------------------------------------------(deftest transform-swap-source!-source-table-test@@ -212,6 +262,54 @@;;; ------------------------------------------------ Dashboard --------------------------------------------------------+(deftest dashboard-swap-source!-updates-parameter-values-source-config-card-id-test+ (testing "swap-source! should update card_id in dashboard parameter values_source_config for card-to-card swaps"+ (mt/with-premium-features #{:dependencies}+ (mt/with-test-user :rasta+ (let [mp (mt/metadata-provider)]+ (mt/with-temp [:model/Card {old-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :orders)))}+ :model/Card {new-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :reviews)))}+ :model/Dashboard {dashboard-id :id}+ {:parameters [{:id "cat-param"+ :name "category"+ :type :string/=+ :values_source_type "card"+ :values_source_config {:card_id old-source-id+ :value_field [:field "ID" {:base-type :type/Integer}]}}]}]+ (replacement.source-swap/swap-source! [:dashboard dashboard-id]+ [:card old-source-id]+ [:card new-source-id])+ (testing ":parameters JSONB on the dashboard is updated"+ (is (= new-source-id+ (-> (t2/select-one :model/Dashboard dashboard-id)+ :parameters first :values_source_config :card_id))))+ (testing "parameter_card row is synced"+ (is (= new-source-id+ (t2/select-one-fn :card_id :model/ParameterCard+ :parameterized_object_type "dashboard"+ :parameterized_object_id dashboard-id+ :parameter_id "cat-param"))))))))))++(deftest dashboard-swap-source!-card-to-table-leaves-parameter-untouched-test+ (testing "swap-source! should NOT update dashboard parameter values_source_config card_id on card-to-table swaps"+ (mt/with-premium-features #{:dependencies}+ (mt/with-test-user :rasta+ (let [mp (mt/metadata-provider)]+ (mt/with-temp [:model/Card {old-source-id :id} {:dataset_query (lib/query mp (lib.metadata/table mp (mt/id :orders)))}+ :model/Dashboard {dashboard-id :id}+ {:parameters [{:id "cat-param"+ :name "category"+ :type :string/=+ :values_source_type "card"+ :values_source_config {:card_id old-source-id+ :value_field [:field "ID" {:base-type :type/Integer}]}}]}]+ (replacement.source-swap/swap-source! [:dashboard dashboard-id]+ [:table (mt/id :orders)]+ [:table (mt/id :reviews)])+ (is (= old-source-id+ (-> (t2/select-one :model/Dashboard dashboard-id)+ :parameters first :values_source_config :card_id)))))))))+(deftest dashboard-swap-source!-parameter-mappings-card-to-card-test(testing "swap-source! should walk parameter mapping targets without corruption during card-to-card swap"(mt/with-premium-features #{:dependencies}