chore: add UX tests around @jsii/kernel serializer errors #3632
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
Bring attention to error messages as part of the contract of the `@jsii/kernel` serialization component, as such messages are currently a known pain point (not specific enough, confusing, overloaded, ...). Intoriducing snapshot tests, and quick win improvements to the existing error messages where possible.
MrArnoldPalmer
approved these changes
Jul 5, 2022
Comment on lines
+1162
to
+1193
| ...(renderValue | ||
| ? [ | ||
| `${ | ||
| causes.length > 0 ? '\u{251C}' : '\u{2570}' | ||
| }\u{2500}\u{2500} \u{1F6D1} Failing value is ${describeTypeOf( | ||
| value, | ||
| )}`, | ||
| ...(value == null | ||
| ? [] | ||
| : inspect(value, false, 0) | ||
| .split('\n') | ||
| .map( | ||
| (l) => | ||
| `${causes.length > 0 ? '\u{2502}' : ' '} ${l}`, | ||
| )), | ||
| ] | ||
| : []), | ||
| ...(causes.length > 0 | ||
| ? [ | ||
| '\u{2570}\u{2500}\u{2500} \u{1F50D} Failure reason(s):', | ||
| ...causes.map( | ||
| (cause, idx) => | ||
| ` ${ | ||
| idx < causes.length - 1 ? '\u{251C}' : '\u{2570}' | ||
| }\u{2500}${ | ||
| causes.length > 1 | ||
| ? ` [${cause.context ?? inspect(idx)}]` | ||
| : '' | ||
| } ${cause.message.split('\n').join('\n ')}`, | ||
| ), | ||
| ] | ||
| : []), |
There was a problem hiding this comment.
probably could extract into a function? Feels tough to read here. Not blocking.
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
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.
Bring attention to error messages as part of the contract of the
@jsii/kernelserialization component, as such messages are currently aknown pain point (not specific enough, confusing, overloaded, ...).
Introducing snapshot tests, and quick win improvements to the existing
error messages where possible.
Fixes #3636
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.