Update date ESLint rule to flag usage of new Date() with arguments.
#9459
Conversation
|
Size Change: 0 B Total Size: 1.86 MB ℹ️ View Unchanged
|
|
Build files for 34510c2 have been deleted. |
There was a problem hiding this comment.
Thanks @tofumatt – this looks good, just a few thoughts and small things to address.
| node.callee.property.name === 'now' && | ||
| node.arguments.length <= 2 |
There was a problem hiding this comment.
Date.now doesn't accept any parameters, so this should be triggered regardless of being used properly or not :)
| @@ -53,7 +53,7 @@ module.exports = { | |||
| NewExpression( node ) { | |||
| if ( | |||
| node.callee.name === 'Date' && | |||
| node.arguments.length === 0 | |||
| node.arguments.length <= 2 | |||
There was a problem hiding this comment.
I prefer using the simpler logical operator where possible. WDYT?
| node.arguments.length <= 2 | |
| node.arguments.length < 3 |
There was a problem hiding this comment.
I usually find the "less than or equal to" easier to scan, because I don't have to do complex arithmetic in my head.
With < 3 I need to calculate something eg. "What comes before 3 here, logically? And should it be an Integer or a Floating point number?" etc., but for <= 2 I can just go "oh, it's two or less". 😅
There was a problem hiding this comment.
but for
<= 2I can just go "oh, it's two or less".
I don't feel super strongly about it, so happy to keep what you have. Removing the "or" from that thought is what I mean by logically simpler.
| @@ -36,7 +36,7 @@ const ruleTester = new RuleTester( { | |||
| ruleTester.run( 'no-direct-date', rule, { | |||
| valid: [ | |||
| 'const date = select( CORE_USER ).getReferenceDate();', | |||
| 'const createTime = new Date( Date.now() - DAY_IN_SECONDS * 1.5 * 1000 ).toISOString();', | |||
| 'const createTime = new Date( DAY_IN_SECONDS * 1.5 * 1000, 20, 3 ).toISOString();', | |||
There was a problem hiding this comment.
This instance isn't exactly using the constructor properly. The arguments are year, monthIndex, day which don't quite align with the usage here.
There was a problem hiding this comment.
Ah, true, I was just using bogus values but I'll have them reflect real-world usage 👍🏻
assets/js/util/convert-time.js
Outdated
| ? // Valid use of `new Date()` with an argument. | ||
| // eslint-disable-next-line sitekit/no-direct-date | ||
| new Date( dateStringValue ).getTime() |
There was a problem hiding this comment.
This is valid if it uses a timestamp as shown in the docblock (complete with timezone), however this would be incorrect for one of our YYYY-MM-DD date strings as noted in the description of the issue.
There was a problem hiding this comment.
Oh, right, I missed the ternary showing that this would be a string in this case 😓 Thanks 👍🏻
There was a problem hiding this comment.
Oh, actually, this is only used in one place and is designed to accept strings:
site-kit-wp/assets/js/modules/analytics-4/datastore/base.js
Lines 78 to 82 in c7de71d
Linting isn't the right way to protect against invalid arguments here, it would need to be an invariant on the length of the datetime string.
|
Failing tests all seem to be from known unrelated instabilities. |
Summary
Addresses issue:
no-direct-dateESLint rule #9032Relevant technical choices
A difference between the IB is that it requests errors with
> 0 && < 3, but I think this was actually meant to just be< 3, because we still want errors when no arguments are used, so I made that change.It seems like all existing instances of
new Date()with arguments are valid, so I just added comments.PR Author Checklist
Do not alter or remove anything below. The following sections will be managed by moderators only.
Code Reviewer Checklist
Merge Reviewer Checklist