Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fallback to use result of first branch when decoding :or and :orn #946

Merged
merged 7 commits into from
Sep 5, 2023
Merged

Fallback to use result of first branch when decoding :or and :orn #946

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
46b22c4
fix #910
ikitommi Sep 3, 2023
1053cd7
deduplicate code
ikitommi Sep 3, 2023
d16f110
move code into correct place in file
ikitommi Sep 3, 2023
b751c1d
tagging requires always k & v
ikitommi Sep 3, 2023
1d0f512
remove duplicate tests
ikitommi Sep 3, 2023
85de30f
simpler loop
ikitommi Sep 4, 2023
0ab9170
allow nil as valid fallback value
ikitommi Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 23 additions & 35 deletions src/malli/core.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,27 @@
x))))
:cljs (fn [x] (into (when x empty) (map t) x))))

(defn -or-transformer [this transformer child-schemas method options]
(let [this-transformer (-value-transformer transformer this method options)]
(if (seq child-schemas)
(let [transformers (-vmap #(or (-transformer % transformer method options) identity) child-schemas)
validators (-vmap -validator child-schemas)]
(-intercepting this-transformer
(if (= :decode method)
(fn [x]
(reduce-kv
(fn [acc i transformer]
(let [x* (transformer x)]
(if ((nth validators i) x*)
(reduced x*)
(or acc x*))))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about when the first transformer returns a nil? Could that happen?

I'm thinking of something like (m/decode [:maybe :int] false false-to-nil-transformer) ==> nil

Or perhaps even just (m/decode [:or nil :int] nil trans)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought it wouldn't matter, as [:or nil :int] with nil value succeeds and doesn't use the fallback but here's a case where is fails:

(m/decode
 [:or
  [:string {:decode/remove-secrets (constantly nil)}]
  :keyword]
 "SECRET!"
 (mt/transformer {:name :remove-secrets}))
; => "SECRET!"

Fixed it so that value of the first branch is always used as fallback, regardless of value.

nil transformers))
(fn [x]
(reduce-kv
(fn [x i validator] (if (validator x) (reduced ((nth transformers i) x)) x))
x validators)))))
(-intercepting this-transformer))))

;;
;; ast
;;
Expand Down Expand Up @@ -757,23 +778,7 @@
(-parser [_] (->parser -parser))
(-unparser [_] (->parser -unparser))
(-transformer [this transformer method options]
(let [this-transformer (-value-transformer transformer this method options)]
(if (seq children)
(let [transformers (-vmap #(or (-transformer % transformer method options) identity) children)
validators (-vmap -validator children)]
(-intercepting this-transformer
(if (= :decode method)
(fn [x]
(reduce-kv
(fn [x i transformer]
(let [x* (transformer x)]
(if ((nth validators i) x*) (reduced x*) x)))
x transformers))
(fn [x]
(reduce-kv
(fn [x i validator] (if (validator x) (reduced ((nth transformers i) x)) x))
x validators)))))
(-intercepting this-transformer))))
(-or-transformer this transformer children method options))
(-walk [this walker path options] (-walk-indexed this walker path options))
(-properties [_] properties)
(-options [_] options)
Expand Down Expand Up @@ -831,24 +836,7 @@
::invalid)
::invalid))))
(-transformer [this transformer method options]
(let [this-transformer (-value-transformer transformer this method options)]
(if (seq (-children this))
(let [transformers (-vmap (fn [[_ _ c]] (or (-transformer c transformer method options) identity))
(-children this))
validators (-vmap (fn [[_ _ c]] (-validator c)) (-children this))]
(-intercepting this-transformer
(if (= :decode method)
(fn [x]
(reduce-kv
(fn [x i transformer]
(let [x* (transformer x)]
(if ((nth validators i) x*) (reduced x*) x)))
x transformers))
(fn [x]
(reduce-kv
(fn [x i validator] (if (validator x) (reduced ((nth transformers i) x)) x))
x validators)))))
(-intercepting this-transformer))))
(-or-transformer this transformer (-vmap #(nth % 2) (-children this)) method options))
(-walk [this walker path options] (-walk-entries this walker path options))
(-properties [_] properties)
(-options [_] options)
Expand Down
61 changes: 34 additions & 27 deletions test/malli/core_test.cljc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,25 +292,34 @@
(is (= [:and 'int? [:orn [:pos 'pos-int?] [:neg 'neg-int?]]] (m/form schema*))))

(testing "transforming :or"
(testing "first valid transformed branch is used"
(doseq [schema [[:or
[:map [:x keyword?]]
int?
[:map [:y keyword?]]
keyword?]
[:orn
[:äxy [:map [:x keyword?]]]
[:n int?]
[:yxy [:map [:y keyword?]]]
[:kw keyword?]]]]
(are [input result]
(= (m/decode schema input mt/string-transformer) result)

{:x "true", :y "true"} {:x :true, :y "true"}
{:x false, :y "true"} {:x false, :y :true}
{:x false, :y false} {:x false, :y false}
1 1
"kikka" :kikka)))
(let [math (mt/transformer {:name :math})
math-string [:string {:decode/math (partial str "math_")}]
math-kw-string [:and math-string [:any {:decode/math keyword}]]
bono-string [:string {:decode/math (partial str "such_")}]]

(testing "first successful branch is selected"
(is (= "math_1"
(m/decode math-string 1 math)
(m/decode [:and math-string] 1 math)
(m/decode [:or math-string] 1 math)
(m/decode [:or
math-kw-string
math-string
bono-string] 1 math)
(m/decode [:orn ["string" math-string]] 1 math)
(m/decode [:orn
["kw-math" math-kw-string]
["math" math-string]
["bono" bono-string]] 1 math))))

(testing "first branch value is selected as fallback, even if invalid"
(is (= :math_1
(m/decode [:or
math-kw-string
:string] 1 math)
(m/decode [:orn
["kw-math" math-kw-string]
["string" :string]] 1 math)))))

(testing "top-level transformations are retained"
(doseq [schema [[:or {:decode/string {:enter (fn [m] (update m :enter #(or % true)))
Expand All @@ -330,15 +339,13 @@
[:y keyword?]
[:enter boolean?]]]]]]
(are [input result]
(= (m/decode (mu/closed-schema schema) input mt/string-transformer) result)

{:x "true"} {:x :true, :enter true, :leave true}
{:x "true", :enter "invalid"} {:x "true", :enter "invalid", :leave true}

{:y "true"} {:y :true, :enter true, :leave true}
{:y "true", :leave "invalid"} {:y "true", :enter true, :leave "invalid"}
(= (m/decode (mu/closed-schema schema) input (mt/string-transformer)) result)

{:x "true", :y "true"} {:x "true", :y "true", :enter true, :leave true}))))
{:x "true"} {:x :true, :enter true, :leave true} ;; first
{:x "true", :enter "invalid"} {:x :true, :enter "invalid", :leave true} ;; first (fallback)
{:y "true"} {:y :true, :enter true, :leave true} ;; second
{:y "true", :leave "invalid"} {:y "true", :enter true, :leave "invalid"} ;; no match
{:x "true", :y "true"} {:x :true, :y "true", :enter true, :leave true})))) ;; first (fallback))

(testing "explain with branches"
(let [schema [:and pos-int? neg-int?]]
Expand Down