Inline values in error messages #257
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
|
Deploy preview for redux-starter-kit-docs ready! Built with commit 4cdaf35 https://deploy-preview-257--redux-starter-kit-docs.netlify.com |
markerikson
reviewed
Nov 16, 2019
| expect(value).toBe(type) | ||
| expect(action).toBe(dispatchedAction) | ||
| expect(log).toMatchInlineSnapshot(` | ||
| "A non-serializable value was detected in an action, in the path: \`type\`. Value: Symbol(SOME_CONSTANT) |
There was a problem hiding this comment.
Are the backslashes actually needed here? They should be escape characters and thus not appear in the actual output string, I would think.
There was a problem hiding this comment.
It’s auto generated by Jest via toMatchInlineSnapshot. Also, there is a backslash in the line above, so I think it’s needed.
markerikson
approved these changes
Dec 1, 2019
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.
Fix #253.
Inline the values in the error messages to fix that some environment won't properly display string substitutions. By using
,to separate each value, we can remain native formatter in each environment (node.js or all major browsers devtool). Since the value we want to log here might be non-serializable, converting them to strings often loose context and make the developer confused.I also rewrite the tests to better represent how it's actually seen in the logs, so that we can guard it when something like this issue ever occurred in the future. A caveat here is that by doing so, our tests might only be able to run in node v10+.