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
Normalize invalid `:widget-type`s correctly (#66965)
Cam Saul26e5de8e0fdf
diff --git a/src/metabase/legacy_mbql/schema.cljc b/src/metabase/legacy_mbql/schema.cljcindex e3ac1af2f41..7883a63900e 100644--- a/src/metabase/legacy_mbql/schema.cljc+++ b/src/metabase/legacy_mbql/schema.cljc@@ -1590,7 +1590,7 @@Field filters and raw values usually have their value specified by `:parameters`."[:multi- {:dispatch (comp keyword :type)}+ {:dispatch (comp keyword (some-fn :type #(get % "type")))}[:dimension [:ref ::TemplateTag.FieldFilter]][:snippet [:ref ::TemplateTag.Snippet]][:card [:ref ::TemplateTag.SourceQuery]]@@ -2012,7 +2012,7 @@:type "An inner query must not include :type, this will cause us to mix it up with an outer query"})])(mr/def ::WidgetType- "Schema for valid values of `:widget-type` for a [[::TemplateTag.FieldFilter]]."+ "Schema for valid values of `:widget-type` for a `::TemplateTag.FieldFilter`."[:ref :metabase.lib.schema.parameter/widget-type]);; this is the reference like [:template-tag <whatever>], not the [[TemplateTag]] schema for when it's declared indiff --git a/src/metabase/lib/schema/parameter.cljc b/src/metabase/lib/schema/parameter.cljcindex 4211a93c6b3..bc832c88d9b 100644--- a/src/metabase/lib/schema/parameter.cljc+++ b/src/metabase/lib/schema/parameter.cljc@@ -161,11 +161,28 @@:else param-type)))}](keys types)))+(def ^:private valid-widget-types (set (keys types)))++(defn- normalize-widget-type [x]+ (when-let [x (lib.schema.common/normalize-keyword x)]+ (cond+ (valid-widget-types x)+ x++ ;; for invalid namespaced types like `:category/=` return closest unnamespaced match e.g. `:category`+ (and (qualified-keyword? x)+ (valid-widget-types (keyword (namespace x))))+ (keyword (namespace x))++ ;; if no close match return `:none`+ :else+ :none)))+(mr/def ::widget-type"The type of widget to display in the FE UI for the user to use to pick values for this parameter."(into [:enum{:error/message "valid parameter widget type"- :decode/normalize lib.schema.common/normalize-keyword}+ :decode/normalize normalize-widget-type}:none](keys types)))diff --git a/test/metabase/legacy_mbql/schema_test.cljc b/test/metabase/legacy_mbql/schema_test.cljcindex f28bf2546e7..975be069477 100644--- a/test/metabase/legacy_mbql/schema_test.cljc+++ b/test/metabase/legacy_mbql/schema_test.cljc@@ -331,3 +331,23 @@["aggregation-options"["concat" "$" ["round" ["sum" ["field" "cost_per_customer" {"base-type" "type/Decimal"}]]]]{"name" "Sum", "display-name" "Sum"}]))))++(deftest ^:parallel normalize-widget-type-test+ (is (= :category+ (lib/normalize ::mbql.s/WidgetType "category/=")))+ (is (= {:widget-type :category+ :id "e8b0b767-0f02-b640-5de3-128e7f7fd71e"+ :name "device_category"+ :display-name "Device category"+ :type :dimension+ :dimension [:field 298221 nil]+ :default nil}+ (lib/normalize+ ::mbql.s/TemplateTag+ {"id" "e8b0b767-0f02-b640-5de3-128e7f7fd71e"+ "name" "device_category"+ "display-name" "Device category"+ "type" "dimension"+ "dimension" ["field" 298221 nil]+ "widget-type" "category/="+ "default" nil}))))diff --git a/test/metabase/lib/schema/parameter_test.cljc b/test/metabase/lib/schema/parameter_test.cljcindex 8ab142d00f5..21a71532da7 100644--- a/test/metabase/lib/schema/parameter_test.cljc+++ b/test/metabase/lib/schema/parameter_test.cljc@@ -89,3 +89,12 @@(deftest ^:parallel default-to-type-text-test(is (= {:id "x", :type :text}(lib/normalize ::lib.schema.parameter/parameter {:id "x"}))))++(deftest ^:parallel normalize-invalid-widget-type-test+ (testing "Decode an invalid namespaced widget type like `:category/=` to the matching unnamespaced type (`:category`)"+ (is (= :category+ (lib/normalize ::lib.schema.parameter/widget-type "category/="))))+ (testing "Decode an invalid widget type with no close match to `:none`"+ (is (= :none+ (lib/normalize ::lib.schema.parameter/widget-type "broken/=")+ (lib/normalize ::lib.schema.parameter/widget-type "broken")))))diff --git a/test/metabase/lib_be/models/transforms_test.clj b/test/metabase/lib_be/models/transforms_test.cljindex 92f678afb1a..96f83a47a02 100644--- a/test/metabase/lib_be/models/transforms_test.clj+++ b/test/metabase/lib_be/models/transforms_test.clj@@ -54,3 +54,31 @@(mu/disable-enforcement(is (= {}((:out lib-be/transform-query) "WOW THIS IS A MESSED UP DATASET_QUERY!"))))))++(deftest ^:parallel normalize-invalid-widget-type-test+ (is (=? {:lib/type :mbql/query+ :stages [{:lib/type :mbql.stage/native+ :template-tags+ {"device_category"+ {:widget-type :category+ :id "e8b0b767-0f02-b640-5de3-128e7f7fd71e"+ :name "device_category"+ :display-name "Device category"+ :type :dimension+ :dimension [:field {} 298221]+ :default nil}}+ :native "<<NATIVE QUERY>>"}]+ :database 26}+ (mu/disable-enforcement+ (lib-be/normalize-query+ {"database" 26+ "type" "native"+ "native" {"template-tags"+ {"device_category" {"id" "e8b0b767-0f02-b640-5de3-128e7f7fd71e"+ "name" "device_category"+ "display-name" "Device category"+ "type" "dimension"+ "dimension" ["field" 298221 nil]+ "widget-type" "category/="+ "default" nil}}+ "query" "<<NATIVE QUERY>>"}})))))