[feature] Durations gain validity #3611

marwahaha · 2016-11-19T07:32:34Z

This was hoping to resolve #3225

Creates an _isValid property for durations, and an accessor isValid()
If not valid, create a duration of time 0 and set ._isValid to false
.humanize() will return the translated version of Invalid Date if not valid
duration(null), duration(undefined), duration() will all be valid
duration(NaN) is invalid

jsf-clabot · 2016-11-19T07:32:35Z

All committers have signed the CLA.

icambron · 2016-11-25T08:33:25Z

src/test/moment/duration.js

@@ -53,10 +53,17 @@ test('milliseconds instantiation', function (assert) {

 test('undefined instantiation', function (assert) {
    assert.equal(moment.duration(undefined).milliseconds(), 0, 'milliseconds');
+    assert.equal(moment.duration(undefined)._isValid, true, '_isValid');


This needs an isValid() accessor function. We don't want people checking underscored properties.

icambron · 2016-11-25T08:36:27Z

src/test/moment/duration.js

@@ -53,10 +53,17 @@ test('milliseconds instantiation', function (assert) {

 test('undefined instantiation', function (assert) {
    assert.equal(moment.duration(undefined).milliseconds(), 0, 'milliseconds');
+    assert.equal(moment.duration(undefined)._isValid, true, '_isValid');
 });

 test('null instantiation', function (assert) {
    assert.equal(moment.duration(null).milliseconds(), 0, 'milliseconds');


This doesn't really fix the #3225 because humanize will still output "in a few seconds".

marwahaha · 2016-11-29T07:08:54Z

@icambron let me know what you think! I've fixed as per your review.

ichernev · 2016-12-04T02:33:20Z

@marwahaha this is a good starting point. But to make it really work isValid needs to be viral. What I mean is that if a duration is invalid most operations should return invalid durations/values/whatever. Here's a list of all the prototype functions and what they should return. This should be implemented and tested (check src/test/moment/invalid.js).

abs -> invalid
add -> invalid
subtract -> invalid
as -> NaN
asMilliseconds -> NaN
asSeconds -> NaN
asMinutes -> NaN
asHours -> NaN
asDays -> NaN
asWeeks -> NaN
asMonths -> NaN
asYears -> NaN
valueOf -> NaN
get -> NaN
milliseconds -> NaN
seconds -> NaN
minutes -> NaN
hours -> NaN
days -> NaN
weeks -> NaN
months -> NaN
years -> NaN
humanize -> invalid duration localized string
toISOString -> invalid duration localized string
toString -> invalid duration localized string
toJSON -> null
locale -> no change in behavior
localeData -> no change in behavior

marwahaha · 2016-12-05T07:38:45Z

src/lib/duration/iso-string.js

@@ -50,3 +54,8 @@ export function toISOString() {
        (m ? m + 'M' : '') +
        (s ? s + 'S' : '');
 }
+
+export function toJSON() {
+    // this may not be fully implemented


For some reason, .toJSON was previously mapped to .toISOString. I've created a separate function, at least, to handle the difference when the duration is invalid.

@maggiepint answered your question -- just patch toISOString and leave toJSON an alias to it.

marwahaha · 2016-12-05T07:54:01Z

Ok, I've done this @ichernev

Two nits:
❓ the toJSON method does not look implemented. The scope of that deserves a different PR.
❓ So far, this isValid checker is quite lax about actually creating invalid durations. One of the only "invalid" durations I could make was just moment.duration(NaN). Should durations be invalid in other cases?

marwahaha · 2016-12-20T20:08:12Z

How does this look?

maggiepint · 2017-01-08T04:56:42Z

Okay, circling back to this. This is good work, thank you.

What other cases do you expect to handle with toJSON()? I'm not sure what you mean by not implemented. When you pass a duration inside of a JSON object, ISO format works just fine, which is why it delegates to .toIsoString. I agree that passing null if it is invalid makes sense, but I'm not sure what else there would need to be.

As for what constitutes an invalid duration - that one might best be handled by @mj1856 who is probably the most interested in standards, though I'm pretty sure @butterflyhug is pretty darn good at durations too from his old gig. Based on the Wikipedia interpretation of the standard though, I believe that any duration with a decimal on a unit other than the smallest unit is technically invalid.

marwahaha · 2017-01-09T02:32:50Z

Ok @maggiepint !

I'm fine with leaving the toJSON() as is. Your explanation makes sense.
How should I move forward here? I suppose I could check whether numbers other than the smallest are integers, but it might be too restrictive. (Should we allow 5.1 days and 2 milliseconds?)

marwahaha · 2017-01-10T15:35:58Z

Let me know how I can help here @mj1856 @butterflyhug

marwahaha · 2017-01-18T04:07:22Z

Pinging this thread again @mj1856 @maggiepint @butterflyhug

maggiepint · 2017-01-18T11:53:13Z

What you are saying is correct. Numbers other than the smallest should be integers according to the spec.

marwahaha · 2017-01-21T02:27:18Z

Ok this is updated! @maggiepint I did change two tests because they used an invalid duration (-0.5 years, 1 month).

Let me know if I can help further.

marwahaha · 2017-01-31T05:36:18Z

Bumping this thread.

ichernev

The code and tests look good, just a few small tweaks and its ready to go.

As I said in one of the comments, we can't go too harsh on bad input, because we were happily accepting it in the previous release, and its not really obvious what is right anymore: duration({d: null}) -- so is this invalid, or should it be treated as 0? I'd say keep it rolling for now and rething in v3.

ichernev · 2017-02-04T08:12:30Z

src/lib/duration/constructor.js

+    var normalizedInput = normalizeObjectUnits(duration);
+
+    this._isValid = isDurationValid(normalizedInput);
+    this.isValid = function () {


isValid should be a regular prototype function, not something attached to this on every object creation.

ichernev · 2017-02-04T08:14:25Z

src/lib/duration/iso-string.js

@@ -50,3 +54,8 @@ export function toISOString() {
        (m ? m + 'M' : '') +
        (s ? s + 'S' : '');
 }
+
+export function toJSON() {
+    // this may not be fully implemented


@maggiepint answered your question -- just patch toISOString and leave toJSON an alias to it.

ichernev · 2017-02-04T08:14:48Z

src/lib/duration/prototype.js

@@ -8,7 +8,7 @@ import { as, asMilliseconds, asSeconds, asMinutes, asHours, asDays, asWeeks, asM
 import { bubble } from './bubble';
 import { get, milliseconds, seconds, minutes, hours, days, months, years, weeks } from './get';
 import { humanize } from './humanize';
-import { toISOString } from './iso-string';
+import { toISOString, toJSON } from './iso-string';


So no changes in this file whatsoever.

ichernev · 2017-02-04T08:15:33Z

src/lib/duration/valid.js

+export default function isDurationValid(m) {
+    for (var key in m) {
+        if (ordering.indexOf(key) === -1 ||
+        m[key] !== undefined && isNaN(parseInt(m[key]))) {


I'm amazed jscs doesn't catch this but this line needs to be indented 8 more spaces (continuation indent).

Rewrite to:
if (!(ordering.indexOf(key) !== -1 && (m[key] == null || !isNaN(m[key]))))
The tricky part is -- I want to explicitly allow both null and undefined (they'll be treated as 0 because of the || 0 code later). Also you don't need parseInt when doing isNaN (its built in).

I hope we can have some stricter rules in a future major release, but right now even this is getting dangerous (as it will break someone's code).

ichernev · 2017-02-04T08:24:27Z

src/lib/duration/constructor.js

+        return this._isValid;
+    };
+
+    var years = this._isValid && normalizedInput.year || 0,


We have a one var policy in jshint, so this won't fly. Just don't change the code (leave it as it was) -- if its invalid its safe to exit this function. All other functions check for isValid, so its fine if the internals are messed up.

ichernev · 2017-02-04T08:28:11Z

src/lib/duration/valid.js

+            if (unitHasDecimal) {
+                return false; // only allow non-integers for smallest unit
+            }
+            if (parseFloat(m[ordering[i]]) !== parseInt(m[ordering[i]])) {


Use toInt functions from the src/lib/utils/to-int.js instead of parseInt.

ichernev · 2017-02-04T08:46:15Z

src/test/moment/duration.js

+});
+
+test('NaN instantiation', function (assert) {
+    assert.ok(isNaN(moment.duration(NaN).milliseconds()), 'milliseconds should be NaN');


That is good. For tests it makes sense to add a helper method moment.duration.invalid(), the same way we have for moment, so you can properly construct an invalid duration.

ichernev · 2017-02-04T08:48:20Z

src/test/moment/duration_invalid.js

+    for (i = 0; i < invalids.length; ++i) {
+        invalid = invalids[i];
+
+        assert.ok(!invalid.add(5, 'hours').isValid(), 'invalid.add is invalid');


For loops like this -- include the i into the string description (so when it fails you can debug it), or scrap the loop altogether -- this is unit test, you check first what is invalid, and then you check what invalid means, you don't have to test end-to-end.

marwahaha · 2017-02-06T08:05:21Z

Ok @ichernev !

I added a test for moment.duration({d: null}).
Should I add a helper method moment.duration.invalid()? I couldn't find where moment.invalid() was implemented.
this.isValid() does not re-compute the value of this._isValid. If it's not ok, I can change it.
All other requests are completed.

ichernev · 2017-02-19T20:47:55Z

src/test/moment/duration_invalid.js

+    assert.ok(isNaN(m.valueOf()));
+});
+
+test('valid duration - as per @ichernev', function (assert) {


Well, no need for that mention, I'm famous enough already ;-)

ichernev · 2017-02-19T20:48:40Z

@marwahaha thank you!

Should I add a helper method moment.duration.invalid()? I couldn't find where moment.invalid() was implemented.

Follow the chain from src/moment.js to src/lib/moment/moment.js to src/lib/create/valid.js.

this.isValid() does not re-compute the value of this._isValid. If it's not ok, I can change it.

Well, the _isValid is an optimization. Also you should make sure that an invalid duration stays invalid (you can not perform an op and make it magically valid) -- you have tests for that. So its fine.

marwahaha · 2017-02-21T08:02:59Z

Ok @ichernev I think I am done making revisions. Do let me know.

ichernev · 2017-03-02T08:45:41Z

@marwahaha thank you, looks great.

ichernev · 2017-03-02T08:47:56Z

Merged in a05fbb2

[feature] Durations gain validity

ichernev · 2017-05-22T14:41:42Z

@marwahaha lets PR the v3 change agains the immutability branch.

In version 2.18.0, durations gained validity: https://gist.github.com/ichernev/78920c5a1e419fb28c6e4546d1b7235c More info: moment/moment#3611

Create _isValid property for durations

5076d1f

marwahaha mentioned this pull request Nov 24, 2016

moment.duration(NaN).humanize() returns "a few seconds" #3225

Closed

icambron reviewed Nov 25, 2016

View reviewed changes

marwahaha added 2 commits November 28, 2016 22:57

Add accessor function to isValid

f60a3f4

Return invalid date for humanize if duration is invalid

81aa62d

Replace arrow function

35ee5a5

marwahaha added 2 commits December 5, 2016 02:15

Write duration-invalid tests

0e71c08

Fix duration functions to follow tests

d6afd97

marwahaha commented Dec 5, 2016

View reviewed changes

Add second invalid duration test case

b3604b7

Add validity check for decimal values on non-smallest duration unit

f95841e

ichernev reviewed Feb 4, 2017

View reviewed changes

ichernev added Needs Revision Pending Next Release labels Feb 4, 2017

marwahaha added 2 commits February 6, 2017 02:31

Make easy changes as per code review

058e741

Make rest of code review changes

a78014d

ichernev added this to the 2.18.0 milestone Feb 19, 2017

ichernev reviewed Feb 19, 2017

View reviewed changes

ichernev mentioned this pull request Feb 19, 2017

v3 changes #3775

Closed

10 tasks

Create moment.duration.invalid()

4020a7d

ichernev removed the Needs Revision label Mar 2, 2017

ichernev changed the title ~~Create _isValid property for durations~~ [feature] Durations gain validity Mar 2, 2017

ichernev closed this Mar 2, 2017

ichernev added a commit that referenced this pull request Mar 2, 2017

Merge pull request #3611 from marwahaha:patch-3225

a05fbb2

[feature] Durations gain validity

ichernev mentioned this pull request Mar 14, 2017

Document duration invalidity moment/momentjs.com#405

Merged

mjomble added a commit to mjomble/flow-typed that referenced this pull request Aug 14, 2017

Added isValid() method to moment.js duration class

bd6ca16

In version 2.18.0, durations gained validity: https://gist.github.com/ichernev/78920c5a1e419fb28c6e4546d1b7235c More info: moment/moment#3611

mjomble mentioned this pull request Aug 14, 2017

Added isValid() method to moment.js duration class flow-typed/flow-typed#1142

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feature] Durations gain validity #3611

[feature] Durations gain validity #3611

marwahaha commented Nov 19, 2016 •

edited

Loading

jsf-clabot commented Nov 19, 2016 •

edited

Loading

icambron Nov 25, 2016

icambron Nov 25, 2016

marwahaha commented Nov 29, 2016 •

edited

Loading

ichernev commented Dec 4, 2016

marwahaha Dec 5, 2016

ichernev Feb 4, 2017

marwahaha commented Dec 5, 2016

marwahaha commented Dec 20, 2016

maggiepint commented Jan 8, 2017

marwahaha commented Jan 9, 2017

marwahaha commented Jan 10, 2017

marwahaha commented Jan 18, 2017

maggiepint commented Jan 18, 2017

marwahaha commented Jan 21, 2017

marwahaha commented Jan 31, 2017

ichernev left a comment

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

ichernev Feb 4, 2017

marwahaha commented Feb 6, 2017

ichernev Feb 19, 2017

ichernev commented Feb 19, 2017

marwahaha commented Feb 21, 2017

ichernev commented Mar 2, 2017

ichernev commented Mar 2, 2017

ichernev commented May 22, 2017

[feature] Durations gain validity #3611

[feature] Durations gain validity #3611

Conversation

marwahaha commented Nov 19, 2016 • edited Loading

jsf-clabot commented Nov 19, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marwahaha commented Nov 29, 2016 • edited Loading

ichernev commented Dec 4, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marwahaha commented Dec 5, 2016

marwahaha commented Dec 20, 2016

maggiepint commented Jan 8, 2017

marwahaha commented Jan 9, 2017

marwahaha commented Jan 10, 2017

marwahaha commented Jan 18, 2017

maggiepint commented Jan 18, 2017

marwahaha commented Jan 21, 2017

marwahaha commented Jan 31, 2017

ichernev left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marwahaha commented Feb 6, 2017

Choose a reason for hiding this comment

ichernev commented Feb 19, 2017

marwahaha commented Feb 21, 2017

ichernev commented Mar 2, 2017

ichernev commented Mar 2, 2017

ichernev commented May 22, 2017

marwahaha commented Nov 19, 2016 •

edited

Loading

jsf-clabot commented Nov 19, 2016 •

edited

Loading

marwahaha commented Nov 29, 2016 •

edited

Loading