[spec] Better explain reporting on a failed zero or one match with an embedded spec.
Description
Environment
OSX, Java 8, Clojure 1.9.0-alpha10
Activity
nick.jones July 20, 2016 at 2:15 AM
Thanks Alex. I've updated the description and removed the project attachments. I've also added a REPL session to the description to reproduce the problem in a standalone Clojure 1.9.0-alpha10 REPL.
Alex Miller July 19, 2016 at 2:27 PM
Nick, I've given you edit rights here. Generally, we don't like to have external projects for repro - if you can boil it down to a few line example in the description, that would be ideal.
nick.jones July 19, 2016 at 9:45 AM
Added simplified version of project archive matching comment at 2016-07-19.
nick.jones July 19, 2016 at 9:30 AM
Hi,
Sorry I don't seem to have access to edit the description of the ticket after creation. Here is a simplified sample that I hope will help illustrate the case better.
When the optional nested map below fails validation because :nested-element-b is a string instead of an int the explain report says the spec fails at the parent predicate: :user/vector-schema at: [:element-value] predicate: string?.
As it is an optional map I could see how this would be the case. When no match is found it moves onto the next predicate in the parent.
That said I think it could be helpful (especially in a large optional nested data structure) that if a partial match is achieved that that could be reported to the user as a potential spot for the spec failing.
user=> (require '[clojure.spec :as s])
nil
user=> (s/def ::nested-element-a string?)
:user/nested-element-a
user=> (s/def ::nested-element-b int?)
:user/nested-element-b
user=> (s/def ::nested-element-schema
(s/keys :opt-un [::nested-element-a ::nested-element-b]))
:user/nested-element-schema
user=> (s/def ::vector-schema
(s/cat :tag-kw #{:tag}
:optional-nested-map (s/? (s/spec ::nested-element-schema))
:element-value string?))
:user/vector-schema
user=> (s/valid? ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b 10} "Element"])
true
user=> (s/valid? ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b ""} "Element"])
false
user=> (s/explain ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b ""} "Element"])
In: [1] val: {:nested-element-a "bla", :nested-element-b ""} fails spec: :user/vector-schema at: [:element-value] predicate: string?
nil
user=>
Alex Miller July 18, 2016 at 1:43 PM
Can you update this description with a self-contained example that demonstrates the problem? It's too hard to repro and understand this larger example.
Details
Assignee
UnassignedUnassignedReporter
nick.jonesnick.jonesLabels
Approval
TriagedPriority
MinorAffects versions
Details
Details
Assignee
Reporter
Labels
Approval
Priority
Minor
Problem:
When attempting to validate a vector containing an optional map, the spec will validate correctly if the vector contains a valid map. If however the optional map does not satisfy the spec misleading error messages are produced. It would be nice if on a partial match of an optional map that some indication of this would be given to the user.
Example REPL session to illustrate problem:
The optional nested map (:optional-nested-map) below fails validation because :nested-element-b is a string instead of an int however the explain report says the spec fails at the parent predicate: :user/vector-schema at: [:element-value] predicate: string?.
It would be more helpful for the user in this case if spec reported that the optional nested map at :optional-nested-map had failed due to ::nested-element-b failing the int? predicate.
user=> (require '[clojure.spec :as s]) nil user=> (s/def ::nested-element-a string?) :user/nested-element-a user=> (s/def ::nested-element-b int?) :user/nested-element-b user=> (s/def ::nested-element-schema (s/keys :opt-un [::nested-element-a ::nested-element-b])) :user/nested-element-schema user=> (s/def ::vector-schema (s/cat :tag-kw #{:tag} :optional-nested-map (s/? (s/spec ::nested-element-schema)) :element-value string?)) :user/vector-schema user=> (s/valid? ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b 10} "Element"]) true user=> (s/valid? ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b ""} "Element"]) false user=> (s/explain ::vector-schema [:tag {:nested-element-a "bla" :nested-element-b ""} "Element"]) In: [1] val: {:nested-element-a "bla", :nested-element-b ""} fails spec: :user/vector-schema at: [:element-value] predicate: string? nil user=>