Skip to content
Snippets Groups Projects
Unverified Commit 26f671e5 authored by Cam Saul's avatar Cam Saul Committed by GitHub
Browse files

Handle legacy Field filter template tags that did not specify `:widget-type` (#20751) 

* Handle legacy Field filter parameters that did not specify `:widget-type`

* Fix indentation

* Test fix
parent 422f12b2
Branches jest-role-hidden
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
shared/src/metabase/mbql/normalize.cljc
+ 15
− 7
View file @ 26f671e5
......@@ -222,13 +222,21 @@
(defn- normalize-template-tag-definition
"For a template tag definition, normalize all the keys appropriately."
[tag-definition]
(into
{}
(map (fn [[k v]]
(let [k (maybe-normalize-token k)
transform-fn (template-tag-definition-key->transform-fn k)]
[k (transform-fn v)])))
tag-definition))
(let [tag-def (into
{}
(map (fn [[k v]]
(let [k (maybe-normalize-token k)
transform-fn (template-tag-definition-key->transform-fn k)]
[k (transform-fn v)])))
tag-definition)]
;; `:widget-type` is a required key for Field Filter (dimension) template tags -- see
;; [[metabase.mbql.schema/TemplateTag:FieldFilter]] -- but prior to v42 it wasn't usually included by the
;; frontend. See #20643. If it's not present, just add in `:category` which will make things work they way they
;; did in the past.
(cond-> tag-def
(and (= (:type tag-def) :dimension)
(not (:widget-type tag-def)))
(assoc :widget-type :category))))
(defn- normalize-template-tags
"Normalize native-query template tags. Like `expressions` we want to preserve the original name rather than normalize
......
shared/test/metabase/mbql/normalize_test.cljc
+ 46
− 8
View file @ 26f671e5
......@@ -262,7 +262,8 @@
:template-tags {"checkin_date" {:name "checkin_date"
:display-name "Checkin Date"
:type :dimension
:dimension [:field 14 nil]}}}}}
:dimension [:field 14 nil]
:widget-type :category}}}}}
"Don't try to normalize template-tag name/display name. Names should get converted to strings."
{(query-with-template-tags
......@@ -274,7 +275,8 @@
{"checkin_date" {:name "checkin_date"
:display-name "looks/like-a-keyword"
:type :dimension
:dimension [:field 14 nil]}})
:dimension [:field 14 nil]
:widget-type :category}})
(query-with-template-tags
{:checkin_date {:name :checkin_date
......@@ -285,7 +287,8 @@
{"checkin_date" {:name "checkin_date"
:display-name "Checkin Date"
:type :dimension
:dimension [:field 14 nil]}})}
:dimension [:field 14 nil]
:widget-type :category}})}
"Actually, `:name` should just get copied over from the map key if it's missing or different"
{(query-with-template-tags
......@@ -296,7 +299,8 @@
{"checkin_date" {:name "checkin_date"
:display-name "Checkin Date"
:type :dimension
:dimension [:field 14 nil]}})
:dimension [:field 14 nil]
:widget-type :category}})
(query-with-template-tags
{"checkin_date" {:name "something_else"
......@@ -307,7 +311,8 @@
{"checkin_date" {:name "checkin_date"
:display-name "Checkin Date"
:type :dimension
:dimension [:field 14 nil]}})}
:dimension [:field 14 nil]
:widget-type :category}})}
"`:type` should get normalized"
{(query-with-template-tags
......@@ -319,7 +324,8 @@
{"names_list" {:name "names_list"
:display-name "Names List"
:type :dimension
:dimension [:field-id 49]}})}
:dimension [:field-id 49]
:widget-type :category}})}
"`:widget-type` should get normalized"
{(query-with-template-tags
......@@ -346,7 +352,8 @@
{"checkin_date" {:name "checkin_date"
:display-name "Checkin Date"
:type :dimension
:dimension [:field-id 14]}})}
:dimension [:field-id 14]
:widget-type :category}})}
"Don't normalize `:default` values"
{(query-with-template-tags
......@@ -372,7 +379,37 @@
;; `:name` still gets copied over from the map key.
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"}}}}})))
:native {:template-tags {"x" {:name "x"}}}}}
":dimension (Field filter) template tags with no :widget-type should get :category as a default type (#20643)"
{{:database 1
:type :native
:native {:template-tags {"x" {:name "x", :type :dimension}}}}
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"
:type :dimension
:widget-type :category}}}}
;; don't add if there's already an existing `:widget-type`
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"
:type :dimension
:widget-type :string/=}}}}
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"
:type :dimension
:widget-type :string/=}}}}
;; don't add if this isn't a Field filter (`:type` is not `:dimension`)
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"
:type :nonsense}}}}
{:database 1
:type :native
:native {:template-tags {"x" {:name "x"
:type :nonsense}}}}})))
;;; ------------------------------------------------- source queries -------------------------------------------------
......@@ -1048,6 +1085,7 @@
:template-tags {"names_list" {:name "names_list"
:display-name "Names List"
:type :dimension
:widget-type :category
:dimension [:field 49 nil]}}}
:parameters [{:type :text
:target [:dimension [:template-tag "names_list"]]
......
test/metabase/query_processor_test/parameters_test.clj
+ 13
− 0
View file @ 26f671e5
......@@ -219,3 +219,16 @@
{:source-field (mt/id :venues :category_id)}]]}]))
(m/dissoc-in [:data :native_form :params])
(m/dissoc-in [:data :results_metadata :checksum])))))))
(deftest legacy-parameters-with-no-widget-type-test
(testing "Legacy queries with parameters that don't specify `:widget-type` should still work (#20643)"
(mt/dataset sample-dataset
(let [query (mt/native-query
{:query "SELECT count(*) FROM products WHERE {{cat}};"
:template-tags {"cat" {:id "__MY_CAT__"
:name "cat"
:display-name "Cat"
:type :dimension
:dimension [:field (mt/id :products :category) nil]}}})]
(is (= [200]
(mt/first-row (qp/process-query query))))))))
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment