(GH-96) Replace jsonschema crate with boon
#154
Conversation
Prior to this change, the DSC library, CLI, and the Registry resource all relied on the `jsonschema` crate for schema compilation and validation. As raised in PowerShell#96, the `jsonschema` crate does not support newer versions of JSON Schema like drafts 2019-09 and 2020-12. Further, the implementation fails several of the tests designed by the JSON Schema organization to validate implementations for the newest dialect it _does_ support (Draft 7). This change prototypes the replacement of the `jsonschema` crate with the `boon` crate, which has full support for every released draft of JSON Schema and currently passes every test for implementation validation. In this initial prototype change, the code includes duplicated behaviors that can be cleaned up or abstracted into helper functions. Another benefit and possible avenue going forward is to turn the decomposed schemas in the repository into the source of truth for validating the incoming data. With Boon, DSC could pre-load the schemas and only have to compile schemas for resources on-demand thereafter. In that model, the JSON schemas in the repository could be embedded in the binary or shipped alongside it. This change also updates the use of Schemars to output Draft 2019-09 schemas for DSC and the Registry resource, to make them closer to the definitions for the schemas in the repository. This commit adds documentation to the structs in the Registry resource, showing how they can be used to provide improved documentation for the schema at author-time.
michaeltlombardi
force-pushed
the
gh-96/main/schema-validation-and-docs
branch
from
5eb83ee to
cde9eb5
Compare
|
It looks like |
|
The jsonschema maintainers are tracking progress for draft 2019 and 2020 support in these issues: The following keywords aren't implemented:
Regarding repository activity, I do generally prefer projects that are more active. But in this case, the recent activity I see for jsonschema is around making the library 2019+ compliant, whereas boon is quieter but fully compliant with the test suite maintained by the JSON schema maintainers. I'll investigate using the crate feature flags to see if that is sufficient for our current use case, but it's worth noting that we can't support any resource instance schemas that use unsupported keywords. Of the not-implemented keywords, I think the only ones I expect to see in instance schemas are Neither implementation seems to have full support for (non-annotation) custom keywords, which is okay, I think. Most of the keywords I've been able to think of as useful for DSC are annotation-type keywords. |
|
Closing for now, we can revisit later |
|
Folks, FYI, in UPDATE 2024-10-24: |
PR Summary
Prior to this change, the DSC library, CLI, and the Registry resource all relied on the
jsonschemacrate for schema compilation and validation.As raised in #96, the
jsonschemacrate does not support newer versions of JSON Schema like drafts 2019-09 and 2020-12. Further, the implementation fails several of the tests designed by the JSON Schema organization to validate implementations for the newest dialect it does support (Draft 7).This change prototypes the replacement of the
jsonschemacrate with thebooncrate, which has full support for every released draft of JSON Schema and currently passes every test for implementation validation.PR Context
In this initial prototype change, the code includes duplicated behaviors that can be cleaned up or abstracted into helper functions.
Another benefit and possible avenue going forward is to turn the decomposed schemas in the repository into the source of truth for validating the incoming data. With Boon, DSC could pre-load the schemas and only have to compile schemas for resources on-demand thereafter.
In that model, the JSON schemas in the repository could be embedded in the binary or shipped alongside it.
This change also updates the use of Schemars to output Draft 2019-09 schemas for DSC and the Registry resource, to make them closer to the definitions for the schemas in the repository.
This change adds documentation to the structs in the Registry resource, showing how they can be used to provide improved documentation for the schema at author-time.