feat: omit 'undefined' when generating SSDK and @required trait is used #537
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
Currently when the client SDK is generated, @required shapes have their types rendered with ' | undefined'. This allows removing @required as a non-breaking change for client SDK users. However, the server SDK (SSDK) has no need for backwards compatibility, it can be updated as the service evolves. When generating SSDK types the project does not need to include ' | undefined' for required types. This update changes the structure member writer to only include ' | undefined" when it is a required member and a non-server sdk is generated. Server SDK does not appear to have any tests. Test frameworks do not seem to support SSDK generation at this moment. only implementation code is included.
|
This causes type issues inside the deserialise functions. Its not feasible to make these changes without a lot of internal plumbing. |
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.
Issue #, if available:
Addresses issues raised in #503 for SSDK code
Description of changes:
Currently when the client SDK is generated, @required shapes have their
types rendered with ' | undefined'. This allows removing @required as
a non-breaking change for client SDK users.
However, the server SDK (SSDK) has no need for backwards compatibility,
it can be updated as the service evolves. When generating SSDK types
the project does not need to include ' | undefined' for required types.
This update changes the structure member writer when the SSDK is
generated to not include ' | undefined" when it is a required member.
Client SDK remains unaffected.
Server SDK does not appear to have any tests. Test frameworks do
not seem to support SSDK generation at this moment. only implementation
code is included.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.