jsonschema: represent integer keywords as ints
Some JSON Schema keywords, like minLength, are logically integers.
The JSON Schema spec allows them to be written as floating-point
values with zero fractional part, which is a reasonable choice, since
JSON doesn't distinguish the two.
We could simply validate these fields as integers in the normal course
of events (namely, validating the schema against its meta-schema),
but this CL does a little better: it uses *int struct fields for
these keywords, preventing them from ever being non-integers.
The UnmarshalJSON method still accepts integral floating-point values.
Marshaling is unaffected, and the results don't change: encoding/json
has always marshaled integral floats without the decimal part.
Other choices:
- Leave them as float64: you could then get away with
Schema{MinLength: Ptr(1.5)}
and though you couldn't get far with that, it's still irksome.
- json.Number: same problem as float64, plus it's even harder to write
as a literal.
- int64: now `Ptr(1)` doesn't work (it's a *int, not a *int64).
Anyway, these keywords all compare against len(x) in Go, which
is of type int.
Change-Id: Ie3f08bd8a5deaf2a21344d6ab873551c011b12d5
Reviewed-on: https://go-review.googlesource.com/c/tools/+/668315
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Robert Findley <rfindley@google.com>
This commit is contained in:
parent
0def4e0327
commit
40185dd013
1 changed files with 132 additions and 25 deletions
|
|
@ -8,6 +8,7 @@ package jsonschema
|
|||
|
||||
import (
|
||||
"bytes"
|
||||
"cmp"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
|
|
@ -67,25 +68,25 @@ type Schema struct {
|
|||
Maximum *float64 `json:"maximum,omitempty"`
|
||||
ExclusiveMinimum *float64 `json:"exclusiveMinimum,omitempty"`
|
||||
ExclusiveMaximum *float64 `json:"exclusiveMaximum,omitempty"`
|
||||
MinLength *float64 `json:"minLength,omitempty"`
|
||||
MaxLength *float64 `json:"maxLength,omitempty"`
|
||||
MinLength *int `json:"minLength,omitempty"`
|
||||
MaxLength *int `json:"maxLength,omitempty"`
|
||||
Pattern string `json:"pattern,omitempty"`
|
||||
|
||||
// arrays
|
||||
PrefixItems []*Schema `json:"prefixItems,omitempty"`
|
||||
Items *Schema `json:"items,omitempty"`
|
||||
MinItems *float64 `json:"minItems,omitempty"`
|
||||
MaxItems *float64 `json:"maxItems,omitempty"`
|
||||
MinItems *int `json:"minItems,omitempty"`
|
||||
MaxItems *int `json:"maxItems,omitempty"`
|
||||
AdditionalItems *Schema `json:"additionalItems,omitempty"`
|
||||
UniqueItems bool `json:"uniqueItems,omitempty"`
|
||||
Contains *Schema `json:"contains,omitempty"`
|
||||
MinContains *float64 `json:"minContains,omitempty"`
|
||||
MaxContains *float64 `json:"maxContains,omitempty"`
|
||||
MinContains *int `json:"minContains,omitempty"` // *int, not int: default is 1, not 0
|
||||
MaxContains *int `json:"maxContains,omitempty"`
|
||||
UnevaluatedItems *Schema `json:"unevaluatedItems,omitempty"`
|
||||
|
||||
// objects
|
||||
MinProperties *float64 `json:"minProperties,omitempty"`
|
||||
MaxProperties *float64 `json:"maxProperties,omitempty"`
|
||||
MinProperties *int `json:"minProperties,omitempty"`
|
||||
MaxProperties *int `json:"maxProperties,omitempty"`
|
||||
Required []string `json:"required,omitempty"`
|
||||
DependentRequired map[string][]string `json:"dependentRequired,omitempty"`
|
||||
Properties map[string]*Schema `json:"properties,omitempty"`
|
||||
|
|
@ -174,8 +175,17 @@ func (s *Schema) UnmarshalJSON(data []byte) error {
|
|||
}
|
||||
|
||||
ms := struct {
|
||||
Type json.RawMessage `json:"type,omitempty"`
|
||||
Const json.RawMessage `json:"const,omitempty"`
|
||||
Type json.RawMessage `json:"type,omitempty"`
|
||||
Const json.RawMessage `json:"const,omitempty"`
|
||||
MinLength *float64 `json:"minLength,omitempty"`
|
||||
MaxLength *float64 `json:"maxLength,omitempty"`
|
||||
MinItems *float64 `json:"minItems,omitempty"`
|
||||
MaxItems *float64 `json:"maxItems,omitempty"`
|
||||
MinProperties *float64 `json:"minProperties,omitempty"`
|
||||
MaxProperties *float64 `json:"maxProperties,omitempty"`
|
||||
MinContains *float64 `json:"minContains,omitempty"`
|
||||
MaxContains *float64 `json:"maxContains,omitempty"`
|
||||
|
||||
*schemaWithoutMethods
|
||||
}{
|
||||
schemaWithoutMethods: (*schemaWithoutMethods)(s),
|
||||
|
|
@ -192,12 +202,13 @@ func (s *Schema) UnmarshalJSON(data []byte) error {
|
|||
case '[':
|
||||
err = json.Unmarshal(ms.Type, &s.Types)
|
||||
default:
|
||||
err = fmt.Errorf("invalid type: %q", ms.Type)
|
||||
err = fmt.Errorf(`invalid value for "type": %q`, ms.Type)
|
||||
}
|
||||
}
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
// Setting Const to a pointer to null will marshal properly, but won't unmarshal:
|
||||
// the *any is set to nil, not a pointer to nil.
|
||||
if len(ms.Const) > 0 {
|
||||
|
|
@ -207,6 +218,34 @@ func (s *Schema) UnmarshalJSON(data []byte) error {
|
|||
return err
|
||||
}
|
||||
}
|
||||
|
||||
// Store integer properties as ints.
|
||||
setInt := func(name string, dst **int, src *float64) error {
|
||||
if src == nil {
|
||||
return nil
|
||||
}
|
||||
i := int(*src)
|
||||
if float64(i) != *src {
|
||||
return fmt.Errorf("%s: %f is not an int", name, *src)
|
||||
}
|
||||
*dst = &i
|
||||
return nil
|
||||
}
|
||||
|
||||
err = cmp.Or(
|
||||
setInt("minLength", &s.MinLength, ms.MinLength),
|
||||
setInt("maxLength", &s.MaxLength, ms.MaxLength),
|
||||
setInt("minItems", &s.MinItems, ms.MinItems),
|
||||
setInt("maxItems", &s.MaxItems, ms.MaxItems),
|
||||
setInt("minProperties", &s.MinProperties, ms.MinProperties),
|
||||
setInt("maxProperties", &s.MaxProperties, ms.MaxProperties),
|
||||
setInt("minContains", &s.MinContains, ms.MinContains),
|
||||
setInt("maxContains", &s.MaxContains, ms.MaxContains),
|
||||
)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue