Support for framework exceptions #295
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
JordonPhillips
requested changes
Mar 25, 2021
...ipt-codegen/src/main/java/software/amazon/smithy/typescript/codegen/FrameworkErrorModel.java
Show resolved
Hide resolved
...escript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/ServerGenerator.java
Outdated
Show resolved
Hide resolved
| * | ||
| * @param serverContext Serialization context. | ||
| */ | ||
| void generateFrameworkExceptionSerializer(GenerationContext serverContext); |
There was a problem hiding this comment.
We use the term "Error" in other interfaces so we should here as well for consistency
There was a problem hiding this comment.
I was actually halfway to changing Exception to Error globally in my review yesterday before submitting it but then I saw how often I was handling SmithyException and SerializationException and UnknownOperationException and I left it. I can change the method names in the generator for sure.
adamthom-amzn
force-pushed
the
ssdk
branch
2 times, most recently
from
daf42da to
55860c4
Compare
Framework exceptions are ones that are not modeled by the service owner and will never be expected to have specific types generated by any client. They are not framework errors simply because they are ubiquitous, but because we have to be able to throw them regardless of the service model. They should represent the inability for the framework to process the request, as opposed to the framework refusing to process the request.
JordonPhillips
approved these changes
Mar 29, 2021
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.
Description of changes:
The most controversial part of this, I expect, will be the hand-built static model for these that I use to reuse the code generators. I wonder if I should replace the context's
SymbolProvideras well, in the event one of the error serialization implementations tries to do a symbol lookup. I didn't go to those lengths in this review because I'm unsure framework errors will ever be much more than a name, a status code and a message.In the future, if we allow customization of the namespace of the framework exceptions for backwards compatibility with existing services, the static model will have to turn into a model factory of some sort.
You can take a look at the generation changes here: https://github.com/adamthom-amzn/smithy-typescript-ssdk-demo/commit/503b7ae1be16113be2fbcc1cf8af3d1ded01cbb9 and the TS definitions of the framework exceptions here: https://github.com/adamthom-amzn/smithy-typescript-ssdk-demo/commit/64ec3c51f7e0583eed61770d15c8479d4b1949ce
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.