[Runtime] Include partial errors in oneOf/anyOf decoding errors #66
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
simonjbeaumont
approved these changes
Oct 30, 2023
|
API breakage is red with:
This method was never meant to be API, it was (by mistake) missing the SPI annotation, so adding that here. While it's technically an API-break, nobody should have been using this method. |
czechboy0
added a commit
to apple/swift-openapi-generator
that referenced
this pull request
Oct 30, 2023
[Generator] Include partial errors in oneOf/anyOf decoding errors ### Motivation Fixes #275. Depends on apple/swift-openapi-runtime#66. ### Modifications Adapt the generator to emit code that collects individual errors during oneOf/anyOf decoding and includes them in the final error. ### Result Easier debugging of oneOf/anyOf decoding issues. ### Test Plan Adapted tests and verified that the errors look better now and include the partial errors. Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.10) - Build finished. ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - Build finished. ✔︎ pull request validation (compatibility test) - Build finished. ✔︎ pull request validation (docc test) - Build finished. ✔︎ pull request validation (integration test) - Build finished. ✔︎ pull request validation (nightly) - Build finished. ✔︎ pull request validation (soundness) - Build finished. #350
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
The runtime changes to address apple/swift-openapi-generator#275.
This makes debugging of decoding of oneOf/anyOf much easier, as the individual errors aren't dropped on the floor anymore.
Modifications
Added SPI that allows the generated code to collect and report partial errors when a oneOf/anyOf fails to decode (that includes trying multiple subschemas, which themselves emit errors when they're not the right match).
Result
Easier debugging of oneOf/anyOf decoding issues.
Test Plan
Tested manually as part of the generator changes, we don't generally test exact error strings.