[Runtime] Design away EncodableBodyContent #30
Merged
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
czechboy0
changed the title
simonjbeaumont
approved these changes
Jul 31, 2023
czechboy0
added a commit
to apple/swift-openapi-generator
that referenced
this pull request
Jul 31, 2023
[Generator] Design away EncodableBodyContent ### Motivation See apple/swift-openapi-runtime#30 Depends on Runtime 0.1.6 ### Modifications Adapted the generator code for the runtime changes. Also, since this was factored out of the big PR (#146) adding multiple content types, you can see the code was prepared for handling multiple content types, even though still in this PR it only ever gets N=1. ### Result The generated code uses the new simplified runtime functions, and prepares us for multiple content types. ### Test Plan Adapted file-based reference tests to generate the new syntax. Reviewed by: simonjbeaumont Builds: ✔︎ pull request validation (5.8) - Build finished. ✔︎ pull request validation (5.9) - 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. #152
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
Until #12 (Choose the serialization method based on content type), we were still looking for the right way to spell the various encoding/decoding methods that take into account both the type of the underlying schema, and the desired content type. In #12, we found something decent, but we could have simplified the spelling even further, getting rid of a whole closure invocation and a specialized type.
Modifications
In this PR (in preparation for multiple content type support), we do the simplification by completely removing
EncodableBodyContentand the associated closure trampoline that we used to propoagate the content type string. We now pass the string directly, and simplified all the helper functions that have to do with encoding body content.Now, this is done in a backwards compatible way, so we really just deprecated all the existing methods, and the
EncodableBodyContenttype, but it'll all be cleaned up when we prepare for tagging the next breaking version.Result
The helper functions have a simpler spelling, which simplifies the generator and reduces the lines of code we have to generate.
(The associated generator PR will be coming in shortly.)
Test Plan
I preserved all the tests for the deprecated variants, and added new unit tests for the new variants. The deprecated tests will also be cleaned up in the next breaking version.