Refactor URIDecoder/URIParser to improve handling of the deepObject style #127
Conversation
This file contains 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
|
PR is in draft as I need to add missing doc comments and a few polishing steps. |
simonjbeaumont
requested changes
Nov 18, 2024
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder+Single.swift
Outdated
Show resolved
Hide resolved
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder+Unkeyed.swift
Outdated
Show resolved
Hide resolved
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder+Unkeyed.swift
Outdated
Show resolved
Hide resolved
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder+Unkeyed.swift
Outdated
Show resolved
Hide resolved
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder.swift
Outdated
Show resolved
Hide resolved
Co-authored-by: Si Beaumont <[email protected]>
Co-authored-by: Si Beaumont <[email protected]>
…er+Single.swift Co-authored-by: Si Beaumont <[email protected]>
|
All the previous tests passed previously, we just changed the tested abstractions which forced me to refractor the tests too. The only new functionality is the deepObject support, so tests related to that style are new. |
simonjbeaumont
approved these changes
Nov 21, 2024
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder.swift
Outdated
Show resolved
Hide resolved
Sources/OpenAPIRuntime/URICoder/Decoding/URIValueFromNodeDecoder.swift
Outdated
Show resolved
Hide resolved
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
As part of apple/swift-openapi-generator#259, adding deepObject parameter style support, the initial PR wasn't complete.
And once we dug more into it, turns out the original implementation of the URIDecoder/URIParser didn't really lend themselves well for handling deepObject, and the recent additions of supporting arrays within dictionaries (#120) further confused the implementation.
Modifications
Refactored URIParser/URIDecoder with a clearer understanding of the current requirements. It's now much easier to follow and embraces the fact that each of the 7 variants of URI coding we support (form exploded, form unexploded, simple exploded, simple unexploded, form data exploded, form data unexploded, and now deepObject exploded) are similar, but still different in subtle ways.
This new implementation doesn't try as hard to share code between the implementations, so might at first sight appear to duplicate code. The original implementation had many methods with many configuration parameters and utility methods with a high cyclomatic complexity, which made it very hard to reason about. We did away with that.
While there, I also made some minor improvements to the serialization path, which allows cleaner round-tripping tests.
Result
A more maintainable and more correct URI decoder/parser implementation.
Test Plan
Added many more unit tests that test the full matrix of supported styles and inputs.