fix: format string errors no longer embed the entire format string #135
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
Problem: Format strings can be very large (e.g. when they are the 'data' element of an embedded file). The FormatStringError that we report currently embeds the entire format string into the error message. That's unnecessary since our validation errors are already pointing the user directly at the template element that is producing the error. Solution: This removes the format string data from the error message. Signed-off-by: Daniel Neilson <53624638+ddneilson@users.noreply.github.com>
|
edwards-aws
approved these changes
Aug 14, 2024
leongdl
approved these changes
Aug 14, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What was the problem/requirement? (What/Why)
Format strings can be very large (e.g. when they are the 'data' element of an embedded file). The FormatStringError that we report currently embeds the entire format string into the error message. That's unnecessary since our validation errors are already pointing the user directly at the template element that is producing the error.
What was the solution? (How)
This removes the format string data from the error message.
What is the impact of this change?
Easier to read/understand format string error messages.
How was this change tested?
Just running the unit tests.
Was this change documented?
N/A
Is this a breaking change?
No, the contents of an error string is not a contract.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.