Show "Publish: Immediately" for new drafts by inferring floating date #9967

kadamwhite · 2018-09-17T13:57:26Z

Description

This addresses the post date label issue described in #7195 with an alternative to the previously-proposed solution in PR #8395.

Rather than forcing a new property into the API to work around the nuances of how dates are stored in the database, we can use what @earnjam and @TimothyBJacobs proposed in https://core.trac.wordpress.org/ticket/39953 and infer that a post's date is "floating" (i.e. that it should be published immediately) by comparing the date modified to the listed publish date. In that Trac thread @TimothyBJacobs explained,

If the date and the modified date are the same, then we're still working on the post because those are both updated at every write. As mentioned we don't have an actual created_at date. This would save us having to add the new field. We couldn't figure out a time when those two dates wouldn't match, and in testing it looked like it would work to fulfill Gutenberg's needs.

Note that this works in Gutenberg because on save, we only send back values which have been edited. To fully address this issue throughout WordPress, changes will be needed in Trac to ensure that we apply the same logic when preparing posts to be saved to the database.

How has this been tested?

I created this patch with @earnjam at the WCNYC contributor day, and I have tested it by creating several posts to ensure various combinations of draft and auto-draft correctly reflect manually-specified dates and the Immediately placeholder. To reproduce these tests,

Create a new post and look at the date label. It should display "Immediately."
Update the title (or any other non-date field) and save a draft. Post should still display Publish: "Immediately."
Test publish vs manually-specify date:

To test that date is set properly when publishing, publish the post and ensure the date that is displayed on the front-end and when reloading the post in the editor reflects the time at which the post was published.
To test that the date is set properly when manually specifying a date, click "Immediately" and set a manual date at which the post should be published. Reload the page and ensure the provided date still displays.

Screenshots

Types of changes

Bug fix for PostScheduleLabel component.
Adds unit tests for PostScheduleLabel component.

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
My code has proper inline documentation.

* Close #7195 * Close #8395 * Close #9030 * Close #9967 * Fix #10182

packages/editor/src/components/post-schedule/label.js

Move logic to determine whether a post should be considered to have a floating date from the PostScheduleLabel component into a new selector isEditedPostDateFloating.

kadamwhite · 2018-09-27T14:23:20Z

@youknowriad I have added a commit to introduce a isEditedPostDateFloating selector, which produces a value to be consumed within the component instead of relying on the component code to apply the date logic.

youknowriad

Thanks for the update, Code looks good, I'll just do some testing a bit after (unless someone beats me to it) and approve.

youknowriad · 2018-09-27T14:26:50Z

packages/editor/src/components/post-schedule/label.js

 		dateI18n( settings.formats.datetime, date ) :
 		__( 'Immediately' );
 }

 export default withSelect( ( select ) => {
 	return {
 		date: select( 'core/editor' ).getEditedPostAttribute( 'date' ),
+		floating: select( 'core/editor' ).isEditedPostDateFloating(),


minor: maybe isFloating to clarify that it's a boolean?

kadamwhite · 2018-09-27T14:35:14Z

Good point about the property naming, I have made that change 👍

youknowriad · 2018-09-27T14:50:09Z

packages/editor/src/store/selectors.js

+ *
+ * @return {boolean} Whether the edited post has a floating date value.
+ */
+export function isEditedPostDateFloating( state ) {


I expect this new selector to generate some changes in the docs if you run npm run docs:build. Can you commit these changes?

I expect this new selector to generate some changes in the docs if you run npm run docs:build. Can you commit these changes?

This was never done and there are local changes to commit on master after running the command.

Please review #10234

😬 my bad, @aduth , hadn't had time to circle back to this and had missed that piece of feedback. I'll know for next time.

No worries @kadamwhite

youknowriad

LGTM 👍

mtias · 2018-10-09T12:01:10Z

Thanks for the work here @kadamwhite.

… edited (#28127) The algorithm to infer the "floating" status of post dates have been introduced in #9967. It works well but it should be using the persisted post status and not the edited one. Co-authored-by: Bernie Reiter <ockham@raz.or.at>

Show "Publish: Immediately" for new drafts by inferring floating date

493a2de

kadamwhite mentioned this pull request Sep 17, 2018

Show "Publish: Immediately" as date for new drafts without a date #8395

Closed

4 tasks

tofumatt mentioned this pull request Sep 26, 2018

Post never appears as set to publish "immediately" #10182

Closed

tofumatt added a commit that referenced this pull request Sep 26, 2018

fix: Show "Publish Immediately"

8509802

* Close #7195 * Close #8395 * Close #9030 * Close #9967 * Fix #10182

tofumatt mentioned this pull request Sep 26, 2018

fix: Show "Publish Immediately" #10183

Closed

youknowriad reviewed Sep 26, 2018

View reviewed changes

packages/editor/src/components/post-schedule/label.js Show resolved Hide resolved

Add isEditedPostDateFloating selector

b6834b2

Move logic to determine whether a post should be considered to have a floating date from the PostScheduleLabel component into a new selector isEditedPostDateFloating.

youknowriad reviewed Sep 27, 2018

View reviewed changes

Rename "floating" component property to "isFloating" for type clarity

8235fe7

youknowriad reviewed Sep 27, 2018

View reviewed changes

youknowriad approved these changes Sep 27, 2018

View reviewed changes

youknowriad added this to the 4.0 milestone Sep 27, 2018

youknowriad merged commit af53caa into master Oct 2, 2018

youknowriad deleted the fix/7195-infer-publish-immediately branch October 2, 2018 10:54

kadamwhite mentioned this pull request Oct 4, 2018

Clarify how to work with dates WP-API/docs#36

Open

mtias added the [Feature] Saving Related to saving functionality label Oct 9, 2018

earnjam mentioned this pull request Oct 18, 2018

Publish date uses draft create date and not updated on publish #7195

Closed

davisshaver mentioned this pull request Jan 3, 2019

Post date should not be updated when post is set "pending review" #13176

Closed

earnjam mentioned this pull request Jan 3, 2019

Account for "pending" status when evaluating floating post dates #13178

Merged

earnjam mentioned this pull request May 9, 2019

No way to clear publish date from datepicker once set #12048

Closed

snyk-bot mentioned this pull request Nov 18, 2020

[Snyk] Fix for 1 vulnerabilities wpscholar/gutenberg#12

Open

snyk-bot mentioned this pull request Dec 17, 2020

[Snyk] Security upgrade jest from 25.5.4 to 26.0.0 wpscholar/gutenberg#14

Open

youknowriad mentioned this pull request Jan 12, 2021

Fix floating date status inferred for posts where the status has been edited #28127

Merged

This was referenced Mar 30, 2021

[Snyk] Security upgrade @jest/reporters from 25.5.1 to 26.0.0 wpscholar/gutenberg#23

Open

[Snyk] Fix for 1 vulnerabilities wpscholar/gutenberg#24

Open

snyk-bot mentioned this pull request Sep 15, 2021

[Snyk] Fix for 1 vulnerabilities Verdinjoshua26/gutenberg#20

Open

snyk-bot mentioned this pull request Sep 16, 2021

[Snyk] Security upgrade @jest/reporters from 25.5.1 to 26.0.0 Verdinjoshua26/gutenberg#22

Open

This was referenced Jun 23, 2023

[Snyk] Fix for 1 vulnerabilities Verdinjoshua26/gutenberg#77

Open

[Snyk] Fix for 1 vulnerabilities Verdinjoshua26/gutenberg#79

Open

Verdinjoshua26 mentioned this pull request Sep 7, 2023

[Snyk] Security upgrade jest from 25.5.4 to 26.0.0 Verdinjoshua26/gutenberg#85

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Show "Publish: Immediately" for new drafts by inferring floating date #9967

Show "Publish: Immediately" for new drafts by inferring floating date #9967

kadamwhite commented Sep 17, 2018 •

edited

kadamwhite commented Sep 27, 2018 •

edited

youknowriad left a comment

youknowriad Sep 27, 2018

kadamwhite commented Sep 27, 2018

youknowriad Sep 27, 2018

aduth Oct 3, 2018

kadamwhite Oct 4, 2018

aduth Oct 4, 2018

youknowriad left a comment

mtias commented Oct 9, 2018

Show "Publish: Immediately" for new drafts by inferring floating date #9967

Show "Publish: Immediately" for new drafts by inferring floating date #9967

Conversation

kadamwhite commented Sep 17, 2018 • edited

Description

How has this been tested?

Screenshots

Types of changes

Checklist:

kadamwhite commented Sep 27, 2018 • edited

youknowriad left a comment

Choose a reason for hiding this comment

youknowriad Sep 27, 2018

Choose a reason for hiding this comment

kadamwhite commented Sep 27, 2018

youknowriad Sep 27, 2018

Choose a reason for hiding this comment

aduth Oct 3, 2018

Choose a reason for hiding this comment

kadamwhite Oct 4, 2018

Choose a reason for hiding this comment

aduth Oct 4, 2018

Choose a reason for hiding this comment

youknowriad left a comment

Choose a reason for hiding this comment

mtias commented Oct 9, 2018

kadamwhite commented Sep 17, 2018 •

edited

kadamwhite commented Sep 27, 2018 •

edited