Improve SmithyBuilder error messages #1100
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
When a SmithyBuilder implementation is missing a required property, the name of the class that was missing the property will be included in the error message. This is derived by looking at the stacktrace on error, so it's an inference. But even an inference of the builder class is better than having no idea which builder encountered an error when the stack trace of the IllegalStateException is elided for whatever reason.
adamthom-amzn
approved these changes
Feb 18, 2022
There is a specific code path in SmithyBuild that results in impossible to debug error messages. It's caused when importing a model fails and results in a Model not being created at all (for example, this can happen if something really bad happens like a trait throwing a SourceException when calling toNode). In this case, SmithyBuild tries to create a ProjectionResult with no Model, but ProjectionResult requires a model. This is now detected, an empty model is provided, and the build will fail in a way that shows a proper error message.
mtdowling
force-pushed
the
improve-builder-error-messages
branch
from
f304a97 to
7defc2f
Compare
adamthom-amzn
approved these changes
Feb 19, 2022
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.
When a SmithyBuilder implementation is missing a required property, the
name of the class that was missing the property will be included in the
error message. This is derived by looking at the stacktrace on error, so
it's an inference. But even an inference of the builder class is better
than having no idea which builder encountered an error when the stack
trace of the IllegalStateException is elided for whatever reason.
Issue #, if available:
Description of changes:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.