return date object from date/datetime widgets if no format set #1296

erquhart · 2018-04-20T17:00:07Z

BREAKING CHANGE

As of 1.0, the documented behavior for the date and datetime widgets was
to always return a string value, but they were instead returning a date
object if the default date was not manually changed by the user. This
was addressed in #1143, but it became clear afterward that static site
generators were depending on the raw date objects that Netlify CMS was
unintentionally producing. Remaining as is or addressing the bug were
both "breaking" states, so this commit reverts to producing raw date
objects when no format is explicitly set.

It is now considered an edge case to require string dates, as most
static site generators expect to parse a raw date against formatting in
a site's templates.

Also note that this commit improves the original behavior by always
providing a date object when no format is provided, even if the user
manually changes the value.

Fixes #1271.

- Description for the changelog

return date object from date/datetime widgets if no format set

erquhart · 2018-04-20T17:01:14Z

@siliconchild please test and confirm this works for you.

verythorough · 2018-04-20T17:03:22Z

Deploy preview for cms-demo ready!

Built with commit 21cfa71

https://deploy-preview-1296--cms-demo.netlify.com

verythorough · 2018-04-20T17:03:35Z

Deploy preview for netlify-cms-www ready!

Built with commit 21cfa71

https://deploy-preview-1296--netlify-cms-www.netlify.com

tech4him1 · 2018-04-20T17:16:20Z

CHANGELOG.md

@@ -4,6 +4,8 @@
    Changes that have landed in master but are not yet released.
    Click to see more.
  </summary>
+
+  * BREAKING: return date object from date/datetime widgets if no format set ([@erquhart](https://github.com/erquhart) in [#1296](https://github.com/netlify/netlify-cms/pull/1296))


Maybe it would be better to say "Possibly Breaking", since we're not doing a major release.

Yeah, agreed

tech4him1 · 2018-04-20T17:27:51Z

src/components/EditorWidgets/Date/DateControl.js

      onChange(formattedValue);
+    } else {
+      onChange(datetime);


Is it better to call datetime.toDate() here so that the formatters have a JS date object to work with instead of a Moment object?

Nevermind, this may not work well for JSON: https://momentjs.com/docs/#/displaying/as-json/

Yeah it matches previous behavior.

tech4him1 · 2018-04-20T17:37:01Z

src/components/EditorWidgets/Date/DateControl.js

@@ -67,7 +79,7 @@ export default class DateControl extends React.Component {

  render() {
    const { includeTime, value, classNameWrapper, setActiveStyle, setInactiveStyle } = this.props;
-    const format = this.format;
+    const format = this.formatDisplay;


Not sure if we need this since it doesn't actually affect the display, just the parsing. I haven't tested, though.

Agreed, updated.

erquhart · 2018-04-24T15:14:46Z

Reworked to consistently return a raw date rather than a moment object when no format is configured - the difference was manifesting in the preview pane, raw date stringifies with the timezone code in parens, moment does not.

erquhart · 2018-05-15T21:55:06Z

This is ready for review.

erquhart · 2018-05-25T15:43:58Z

We'll leave this in 2.0 since we're getting close anyway.

BREAKING CHANGE As of 1.0, the documented behavior for the date and datetime widgets was to always return a string value, but they were instead returning a date object if the default date was not manually changed by the user. This was addressed in #1143, but it became clear afterward that static site generators were depending on the raw date objects that Netlify CMS was unintentionally producing. Remaining as is or addressing the bug were both "breaking" states, so this commit reverts to producing raw date objects when no format is explicitly set. It is now considered an edge case to require string dates, as most static site generators expect to parse a raw date against formatting in a site's templates. Also note that this commit improves the original behavior by always providing a date object when no format is provided, even if the user manually changes the value.

ghost · 2018-05-25T19:06:33Z

Hi, I'm currently looking at this page and I'm seeing that this PR is included, I tried re-adding the CMS to my site to confirm this but the date still has quotes when creating new items.

Am I misunderstanding/misreading the details in the page I linked?

erquhart · 2018-05-25T19:17:37Z

Right, the page shows what's on master that is not in 1.8.4. Because that PR is a breaking change, we're saving it for 2.0. Pre-releases of 2.0 will begin in the coming weeks.

Also note that comparisons between 1.x releases and master won't work because 1.x releases are coming from the v1 branch, which receives cherry picked commits from master, so every commit in master moving forward will seem to be missing from future 1.x releases. Instead, you can check at the bottom of a PR for a commit occurring after merge - those happen when the merged pull request is backported (cherry picked) to v1.

Or you can just check release notes, we keep them accurate.

ghost · 2018-05-25T20:02:16Z

@erquhart Thanks

…org#1296) * return date object from date/datetime widgets if no format set BREAKING CHANGE As of 1.0, the documented behavior for the date and datetime widgets was to always return a string value, but they were instead returning a date object if the default date was not manually changed by the user. This was addressed in decaporg#1143, but it became clear afterward that static site generators were depending on the raw date objects that Netlify CMS was unintentionally producing. Remaining as is or addressing the bug were both "breaking" states, so this commit reverts to producing raw date objects when no format is explicitly set. It is now considered an edge case to require string dates, as most static site generators expect to parse a raw date against formatting in a site's templates. Also note that this commit improves the original behavior by always providing a date object when no format is provided, even if the user manually changes the value. * produce raw date when no format is provided

erquhart added kind: bug area: extensions/widgets labels Apr 20, 2018

erquhart force-pushed the date-object branch 2 times, most recently from 081c595 to 84abbc0 Compare April 20, 2018 17:05

tech4him1 reviewed Apr 20, 2018

View reviewed changes

erquhart force-pushed the date-object branch from 84abbc0 to f61081a Compare April 20, 2018 17:40

erquhart mentioned this pull request Apr 24, 2018

UTC Timezone for Date Widget (without being a string) #1307

Closed

erquhart added the status: 2-code-review label May 15, 2018

erquhart added 2 commits May 25, 2018 11:49

produce raw date when no format is provided

21cfa71

erquhart force-pushed the date-object branch from 5a6e4e0 to 21cfa71 Compare May 25, 2018 15:49

erquhart merged commit 9fd0ff4 into master May 25, 2018

erquhart deleted the date-object branch May 25, 2018 16:03

erquhart added the release: 2.0 label May 25, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

return date object from date/datetime widgets if no format set #1296

return date object from date/datetime widgets if no format set #1296

erquhart commented Apr 20, 2018 •

edited

Loading

erquhart commented Apr 20, 2018

verythorough commented Apr 20, 2018 •

edited

Loading

verythorough commented Apr 20, 2018 •

edited

Loading

tech4him1 Apr 20, 2018

erquhart Apr 20, 2018

tech4him1 Apr 20, 2018

tech4him1 Apr 20, 2018

erquhart Apr 20, 2018

tech4him1 Apr 20, 2018 •

edited

Loading

erquhart Apr 24, 2018

erquhart commented Apr 24, 2018 •

edited

Loading

erquhart commented May 15, 2018

erquhart commented May 25, 2018

ghost commented May 25, 2018 •

edited by ghost

Loading

erquhart commented May 25, 2018 •

edited

Loading

ghost commented May 25, 2018

return date object from date/datetime widgets if no format set #1296

return date object from date/datetime widgets if no format set #1296

Conversation

erquhart commented Apr 20, 2018 • edited Loading

erquhart commented Apr 20, 2018

verythorough commented Apr 20, 2018 • edited Loading

verythorough commented Apr 20, 2018 • edited Loading

tech4him1 Apr 20, 2018

Choose a reason for hiding this comment

erquhart Apr 20, 2018

Choose a reason for hiding this comment

tech4him1 Apr 20, 2018

Choose a reason for hiding this comment

tech4him1 Apr 20, 2018

Choose a reason for hiding this comment

erquhart Apr 20, 2018

Choose a reason for hiding this comment

tech4him1 Apr 20, 2018 • edited Loading

Choose a reason for hiding this comment

erquhart Apr 24, 2018

Choose a reason for hiding this comment

erquhart commented Apr 24, 2018 • edited Loading

erquhart commented May 15, 2018

erquhart commented May 25, 2018

ghost commented May 25, 2018 • edited by ghost Loading

erquhart commented May 25, 2018 • edited Loading

ghost commented May 25, 2018

erquhart commented Apr 20, 2018 •

edited

Loading

verythorough commented Apr 20, 2018 •

edited

Loading

verythorough commented Apr 20, 2018 •

edited

Loading

tech4him1 Apr 20, 2018 •

edited

Loading

erquhart commented Apr 24, 2018 •

edited

Loading

ghost commented May 25, 2018 •

edited by ghost

Loading

erquhart commented May 25, 2018 •

edited

Loading