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
Add position field to dashboard parameters for stable serialization (#70107)
Nicola Mometto11a73d8621bd
diff --git a/.gitignore b/.gitignoreindex 3a5d3a011a6..21ff2419812 100644--- a/.gitignore+++ b/.gitignore@@ -170,5 +170,5 @@ CLAUDE.local.md# Python dependencies (pip-installed, not committed)/resources/python-sources/sqlglot//resources/python-sources/sqlglot-*.dist-info/+/resources/python-sources/.lock__pycache__/-diff --git a/enterprise/backend/test/metabase_enterprise/serialization/v2/e2e_test.clj b/enterprise/backend/test/metabase_enterprise/serialization/v2/e2e_test.cljindex bc953263bb9..009e6970582 100644--- a/enterprise/backend/test/metabase_enterprise/serialization/v2/e2e_test.clj+++ b/enterprise/backend/test/metabase_enterprise/serialization/v2/e2e_test.clj@@ -430,6 +430,7 @@(is (= [{:id "abc",:name "CATEGORY",:type :category,+ :position 0,:values_source_config {:card_id (:entity_id card1s),:value_field [:field["my-db" nil "CUSTOMERS" (:name field1s)]@@ -442,6 +443,7 @@[{:id "abc",:name "CATEGORY",:type :category,+ :position 0,:values_source_config {:card_id (:entity_id card1s),:value_field [:field["my-db" nil "CUSTOMERS" (:name field1s)]diff --git a/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj b/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.cljindex b52241763ed..b3bd10d2955 100644--- a/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj+++ b/enterprise/backend/test/metabase_enterprise/serialization/v2/extract_test.clj@@ -1296,6 +1296,7 @@(is (= [{:id "abc",:type :category,:name "CATEGORY",+ :position 0,:values_source_type :card:values_source_config {:card_id card-eid-1,:value_field [:field ["My Database" nil "Schemaless Table" "A Field"] nil]}}]@@ -2555,8 +2556,12 @@{:id "alpha" :name "A param" :type :category}{:id "middle" :name "M param" :type :category}]result (serdes/export-parameters params)]- (is (= ["alpha" "middle" "zebra"]- (map :id result)))))+ (testing "export sorts parameters by :id for stable diffs"+ (is (= ["alpha" "middle" "zebra"]+ (map :id result))))+ (testing "export stamps :position from original array index"+ (is (= [1 2 0]+ (map :position result))))))(deftest ^:parallel export-parameters-empty-input-test(is (= [] (serdes/export-parameters []))))@@ -2567,14 +2572,16 @@(deftest ^:parallel export-parameters-single-element-test(let [params [{:id "only" :name "Only param"}]result (serdes/export-parameters params)]- (is (= ["only"] (map :id result)))))+ (is (= ["only"] (map :id result)))+ (is (= [0] (map :position result)))))(deftest ^:parallel export-parameters-nil-id-sorts-first-test(let [params [{:id "beta" :name "B"}{:id nil :name "Nil"}{:id "alpha" :name "A"}]result (serdes/export-parameters params)]- (is (= [nil "alpha" "beta"] (map :id result)))))+ (is (= [nil "alpha" "beta"] (map :id result)))+ (is (= [1 2 0] (map :position result)))))(deftest ^:parallel export-parameter-mappings-sorts-by-parameter-id-test(let [mappings [{:parameter_id "z-param" :target [:dimension [:field 1 nil]]}@@ -2614,7 +2621,32 @@:card_id card-id:target [:dimension [:field 2 nil]]}]}](let [ser (ts/extract-one "Dashboard" dash-id)]- (is (= ["alpha" "beta" "zebra"]- (map :id (:parameters ser))))+ (testing "parameters are sorted by :id"+ (is (= ["alpha" "beta" "zebra"]+ (map :id (:parameters ser)))))+ (testing "positions preserve original display order"+ (is (= [1 2 0]+ (map :position (:parameters ser)))))(is (= ["alpha" "zebra"](map :parameter_id (-> ser :dashcards first :parameter_mappings))))))))++(deftest ^:parallel import-parameters-round-trip-test+ (testing "export stamps position, import restores original display order"+ (let [params [{:id "zebra" :name "Z param" :type :category}+ {:id "alpha" :name "A param" :type :category}+ {:id "middle" :name "M param" :type :category}]+ exported (serdes/export-parameters params)+ imported (serdes/import-parameters exported)]+ (is (= ["alpha" "middle" "zebra"] (map :id exported))+ "export sorts by id")+ (is (= [1 2 0] (map :position exported))+ "export stamps position from original array index")+ (is (= ["zebra" "alpha" "middle"] (map :id imported))+ "import restores original display order via position"))))++(deftest ^:parallel import-parameters-without-position-preserves-order-test+ (testing "importing legacy params without :position preserves existing order"+ (let [params [{:id "zebra" :name "Z param" :type :category}+ {:id "alpha" :name "A param" :type :category}]+ imported (serdes/import-parameters params)]+ (is (= ["zebra" "alpha"] (map :id imported))))))diff --git a/src/metabase/models/serialization.clj b/src/metabase/models/serialization.cljindex 5b94654db34..338dd6c5b32 100644--- a/src/metabase/models/serialization.clj+++ b/src/metabase/models/serialization.clj@@ -1354,20 +1354,26 @@(defn export-parameters"Given the :parameter field of a `Card` or `Dashboard`, as a vector of maps, convertsit to a portable form with the CardIds/FieldIds replaced with `[db schema table field]` references.- Parameters are sorted by :id for stable serialization output."+ Parameters are sorted by `:id` for stable serialization output. A `:position` field is added+ to preserve display order through the sort."[parameters](->> parameters+ (map-indexed (fn [i p] (assoc p :position i)))(sort-by :id)(mapv ids->fully-qualified-names)))(defn import-parameters"Given the :parameter field as exported by serialization convert its field references- (`[db schema table field]`) back into raw IDs."+ (`[db schema table field]`) back into raw IDs. If every parameter has `:position`, sorts by it+ to restore display order; otherwise preserves the existing order."[parameters]- (for [param parameters]- (-> param- mbql-fully-qualified-names->ids- (m/update-existing-in [:values_source_config :card_id] *import-fk* 'Card))))+ (let [params (for [param parameters]+ (-> param+ mbql-fully-qualified-names->ids+ (m/update-existing-in [:values_source_config :card_id] *import-fk* 'Card)))]+ (if (every? :position params)+ (sort-by :position params)+ params)))(defn parameters-deps"Given the :parameters (possibly nil) for an entity, return any embedded serdes-deps as a set.