Skip to content

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

Fixes ordering issue in parameters (#72083)

Sébastiene21a007fbc0d
diff --git a/src/metabase/query_processor/card.clj b/src/metabase/query_processor/card.clj
index 7616fb389a5..0654a43e5c7 100644
--- a/src/metabase/query_processor/card.clj
+++ b/src/metabase/query_processor/card.clj
@@ -256,12 +256,18 @@
[{:keys [parameters] :as card} :- ::queries.schema/card]
(let [template-tag-parameters (queries/card-template-tag-parameters card)
id->template-tags-parameter (m/index-by :id template-tag-parameters)
- id->parameter (m/index-by :id parameters)]
- (vals (reduce-kv (fn [acc id parameter]
- ;; order importance: we want the info from `template-tag` to be merged last
- (update acc id #(merge % parameter)))
- id->parameter
- id->template-tags-parameter))))
+ parameter-ids (into #{} (map :id) parameters)
+ ;; Preserve the order of card.parameters, merging in template-tag info
+ merged-parameters (mapv (fn [param]
+ (if-let [tt-param (get id->template-tags-parameter (:id param))]
+ ;; order importance: we want the info from `template-tag` to be merged last
+ (merge param tt-param)
+ param))
+ parameters)]
+ ;; Append any template-tag parameters not already present in card.parameters
+ (into merged-parameters
+ (remove #(contains? parameter-ids (:id %)))
+ template-tag-parameters)))
(mu/defn- enrich-parameters-from-card :- ::parameters.schema/parameters
"Allow the FE to omit type and target for parameters by adding them from the card."
diff --git a/test/metabase/query_processor/card_test.clj b/test/metabase/query_processor/card_test.clj
index ac08468e16b..9cc0ce35b3c 100644
--- a/test/metabase/query_processor/card_test.clj
+++ b/test/metabase/query_processor/card_test.clj
@@ -391,3 +391,34 @@
(get-in response [:headers "Content-Disposition"])
(str expected-slug "_"))
(str "Expected filename to contain: " expected-slug))))))))))
+
+(deftest combined-parameters-and-template-tags-preserves-parameter-order-test
+ (testing "combined-parameters-and-template-tags should preserve the order of card.parameters (#62079)"
+ ;; Use enough parameters (9) so that Clojure switches to PersistentHashMap.
+ ;; PersistentArrayMap (used for <= 8 entries) preserves insertion order, but PersistentHashMap (>= 9) does not.
+ (let [tag-names ["zeta" "alpha" "mu" "beta" "omega" "gamma" "theta" "delta" "epsilon"]
+ name->id #(str "_" (u/upper-case-en %) "_")
+ tags (into {} (map (fn [n]
+ [n {:id (name->id n)
+ :name n
+ :display-name (str n " param")
+ :type :text}]))
+ tag-names)
+ params (mapv (fn [n]
+ {:id (name->id n)
+ :type :string/=
+ :slug n
+ :name (str n " param")
+ :target [:variable [:template-tag n]]})
+ tag-names)
+ placeholders (str/join " AND " (map #(str % " = {{" % "}}") tag-names))
+ query (str "SELECT * FROM t WHERE " placeholders)]
+ (mt/with-temp [:model/Card card {:dataset_query {:database (mt/id)
+ :type :native
+ :native {:template-tags tags
+ :query query}}
+ :parameters params}]
+ (let [result (qp.card/combined-parameters-and-template-tags card)]
+ (is (= (mapv name->id tag-names)
+ (mapv :id result))
+ "Parameters should be returned in the same order as card.parameters"))))))