Fix: Make rule-tester strictly check messageId. (ref #9890) #9908
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
lib/testers/rule-tester.js
Outdated
| assert.strictEqual( | ||
| error.messageId, | ||
| message.messageId, | ||
| `messageId mismatch saw '${message.messageId}' and expected '${error.messageId}'.` |
There was a problem hiding this comment.
This message feels like a run-on sentence. I would suggest something like:
messageId '${message.messageId}' does not match expected messageId '${error.messageId}'.
aladdin-add
added
bug
betaorbust
changed the title
betaorbust
force-pushed
the
make-message-id-direct-compare--jf
branch
from
9ca36d8
to
fa2ca54
Compare
betaorbust
changed the title
|
@platinumazure The code now aligns with what we discussed in #9890 (comment) and I think it's ready for the fix to go in. |
betaorbust
force-pushed
the
make-message-id-direct-compare--jf
branch
from
fa2ca54
to
59437bf
Compare
|
Looks like there’s some issues with older versions of node and assert.fail 😓 |
This change makes rule-tester check messageId directly by value provided instead of the current behavior, which is to check the messageId's message value against the message returned from the rule at runtime.
betaorbust
force-pushed
the
make-message-id-direct-compare--jf
branch
from
59437bf
to
ff35ff8
Compare
|
Ok, all fixed up and ready for review. |
platinumazure
approved these changes
Feb 26, 2018
ilyavolodin
approved these changes
Mar 22, 2018
|
Closing and reopening to make sure Travis/AppVeyor still pass with this change against latest master. Then I'll merge this in if all goes well. |
eslint-deprecated
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 is the purpose of this pull request? (put an "X" next to item)
[ ] Documentation update
[x] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
This PR:
RuleTestercomparemessageIdin the test tomessageIdin the runtime error.tests/lib/rules/no-fallthrough.jswhere the wrong message and type data was being passed through.What changes did you make? (Give an overview)
Currently, when
RuleTesteris used with amessageIdproperty in the error section, the underlying implementation looks up the raw message string fromrule.meta.messages[messageId]and compares it with the runtime error string produced by the rule.All other properties checked in
RuleTester's error section (message,type,line,column,endLine,endColumn) are direct comparisons to the resulting data, which makes the behavior ofmessageIdan unexpected and confusing developer experience.This PR addresses this by changing
messageIdchecks inRuleTesterto be direct comparisons.Is there anything you'd like reviewers to focus on?
This partially addresses #9890, fixing the DX of
messageIdwithout dealing with the more contentious issue of surfacingdatain the public API.