Add custom Decodable conformance #80
Merged
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
0xTim
approved these changes
Dec 3, 2024
|
@sebsto this PR is a breaking change (changing optionals to non-optional). (It was just pointed out to me). It has broken hummingbird-lambda |
|
@adam-fowler I know and we discussed this with @FranzBusch This change is on Would you recommend to tag a v1.0.0 now and start to follow server rules to avoid future breaking change to impact downstream projects? |
|
It would be good to have a stable version. Although we are reliant on AWS keeping the structs stable. |
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.
Add custom Decodable conformance.
Closes #73
Duplicate of #76 created by @twistinside
Motivation:
Absent collections would fail to decode, when in reality it is possible to have empty headers, for example. This allows processing to continue in the context of the Lambda runtime where users can handle the collections as dictated by their code.
Modifications:
Custom Decodable conformance has been added to both API Gateway request objects to optionally decode absent collections to empty collections.
Unit testa have been added for the same.
Result:
This will make the swift lambda runtime more accepting of input, allowing processing to proceed in the rare cases where collection fields would be absent in the JSON received by the runtime. This will unlock certain functionality in edge cases such as testing lambda code from API Gateway console with empty headers (the use case that prompted this change).
This change will require users to update their code to remove optional handling for the collections involved, potentially also requiring extra logic to validate that the collections they've received aren't empty.