Validate Collection Schema #283
Conversation
Signed-off-by: Aaron Sutula <[email protected]>
Signed-off-by: Aaron Sutula <[email protected]>
| } | ||
| if !hasIDProperty(properties) { | ||
| return nil, ErrInvalidCollectionSchema | ||
| } |
There was a problem hiding this comment.
Above is the schema validation. As far as I can tell, there are two ways an ID might be defined, and we have to handle them both. First is the "expanded" schema case where a type is defined in the top level of the schema. Second is when the top level schema specifies a Ref to type nested in the schema Definitions.
There was a problem hiding this comment.
I still like the idea of validating the schema against another schema, but this was a more clear approach for now.
| @@ -12,7 +12,7 @@ message NewDBRequest { | |||
|
|
|||
| message CollectionConfig { | |||
| string name = 1; | |||
| string schema = 2; | |||
| bytes schema = 2; | |||
There was a problem hiding this comment.
Schema was always json data, so make it bytes like the rest of the json data we deal with
| if _, err := db.NewCollection(cc); err != ErrInvalidCollectionSchema { | ||
| t.Fatal("the collection should be invalid") | ||
| } | ||
| }) |
There was a problem hiding this comment.
Tests reenabled to make sure schema validation is actually working
| @@ -190,7 +197,7 @@ func (d *DB) reCreateCollections() error { | |||
| // CollectionConfig describes a new Collection. | |||
| type CollectionConfig struct { | |||
| Name string | |||
| Schema string | |||
| Schema *jsonschema.Schema | |||
There was a problem hiding this comment.
Not just a string anymore
| schema := jsonschema.Reflect(i) | ||
| JSON, err := json.MarshalIndent(schema, "", " ") | ||
| if err != nil { | ||
| func SchemaFromInstance(i interface{}, expandedStruct bool) *jsonschema.Schema { |
There was a problem hiding this comment.
Most of the noise in this PR is because of adding the expandedStruct option here. When set to true, the generated schema will use top level type definitions instead of using a ref to a nested definition. We need to be able to test both cases.
Signed-off-by: Aaron Sutula <[email protected]>
|
Ok, ready for review here. |
|
Android failure is that rate limit related to some GH action thing... Should be fine when it re-runs soon. |
This one does a couple things...
Makes
CollectionConfig.Schemaa properSchemastruct. This is nice because it provided a programatic API to the schema we can use for validation. Also makes the API nicer to work with not having to pass in a schema string.Performs validation of the provided schema when a new collection is created. Currently, that means checking that the schema defines an
IDproperty of typestring.closes #281