Ensure that revisions get created when changesets are updated via explicit saves #111

westonruter · 2017-02-07T21:47:01Z

Found a bug with 0.6.0-rc1 whereby revisions were no longer being made as expected when explicitly clicking the Save Draft button in the UI. The opt-in for creating a revision in core is currently indicated by whether or not a customize_changeset_status param is present. This is not ideal, but since the param is getting stripped by Customize Snapshots if the status is the same as the current status, I added a workaround for this to explicitly indicate the need to create a revision via another channel. There is probably a better solution for this, not at least to allow a save_revision to be passed when calling wp.customize.previewer.save().

See: https://github.com/WordPress/wordpress-develop/blob/8900e2466e3a01c9c228ac31784aa70e8dcf3137/src/wp-includes/class-wp-customize-manager.php#L2279

…licit saves

westonruter · 2017-02-07T21:52:48Z

js/customize-snapshots.js

@@ -1113,6 +1113,7 @@
 				isSameStatus = api.state( 'changesetStatus' ).get() === originalOptions.data.customize_changeset_status;
 				if ( 'customize_save' === originalOptions.data.action && isSameStatus && options.data ) {
 					options.data = removeParam( options.data, 'customize_changeset_status' );


Why is the customize_changeset_status param getting removed, again? Is this still needed?

As we are checking customize_snapshots_create_revision customize_changeset_status does not need to be removed now.

@sayedtaqui but core will (somewhat unintuitively) create a new revision every time the customize_changeset_status is supplied. Wasn't there a reason for the param to be removed? Did it have something to do with passing the date?

@westonruter Yes we wanted to auto save the date and title in editbox, but we could not do wp.customize.previewer.save() without status because the default status is publish, and we did not want to create revision each time it auto saves the date/title.

OK, so then we need to still include the logic for removing the status parameter, but then an additional change is needed right? We need to omit the request for a revision when the date and title are modified?

Oh yes, thats correct.

coveralls · 2017-02-07T21:56:55Z

Coverage increased (+0.06%) to 76.923% when pulling e5aea6a on bugfix/create-revisions into 7910d6b on develop.

PatelUtkarsh · 2017-02-08T09:49:19Z

I think the code was adding status(revision) to request only when we change status from drop down.
@sayedtaqui Can you update such that it pass status when saved explicitly?

PatelUtkarsh

This looks good, Unless @sayedtaqui want to change this via using JS only.

mohdsayed · 2017-02-09T13:51:55Z

php/class-customize-snapshot-manager.php

@@ -104,6 +104,8 @@ function hooks() {
 		add_action( 'admin_bar_menu', array( $this, 'remove_all_non_snapshot_admin_bar_links' ), 100000 );
 		add_action( 'wp_before_admin_bar_render', array( $this, 'print_admin_bar_styles' ) );
 		add_filter( 'removable_query_args', array( $this, 'filter_removable_query_args' ) );
+		add_filter( 'wp_save_post_revision_post_has_changed', array( $this, '_filter_revision_post_has_changed' ), 20, 3 );
+		add_filter( 'save_post_customize_changeset', array( $this, 'create_initial_changeset_revision' ) );


@westonruter I think save_post_customize_changeset would be an action and not filter?
https://github.com/WordPress/WordPress/blob/b0bcea2a18f095e2d5b64554782591eacf492c21/wp-includes/post.php#L3494

You're right! It should be add_action here.

PatelUtkarsh · 2017-02-09T14:25:16Z

I think this is a better approach than doing it via just JS.

mohdsayed · 2017-02-09T14:58:38Z

I think checking the param customize_snapshots_create_revision is smarter than removing customize_changeset_status plus this

isSameStatus = api.state( 'changesetStatus' ).get() === originalOptions.data.customize_changeset_status

would return true in case of existing changeset which has draft status so creating revision for the first time makes perfect sense

Looks good 👍

coveralls · 2017-02-10T19:56:30Z

Coverage increased (+0.06%) to 76.923% when pulling 66b6bb0 on bugfix/create-revisions into 7910d6b on develop.

westonruter · 2017-02-11T06:45:29Z

@sayedtaqui I'm noticing something else here that is unexpected. If I open the customizer, change a setting, and then save the changeset as a draft; then if I click the edit icon, and then try supplying a title the changed title won't get saved until I try making another change to settings. In other words, it doesn't seem that the title changes are getting sent on change as expected.

Are you able to tie up the lose ends on this ticket, including sending the flag to indicate a revision should be made, as well as ensuring changes to the title cause a title update to be sent? Also, related is #112 where the date fields are being unexpectedly shown.

mohdsayed · 2017-02-13T07:10:11Z

Sure working on them.

…-snapshots into bugfix/create-revisions

mohdsayed · 2017-02-13T14:23:16Z

try supplying a title the changed title won't get saved until I try making another change to settings. In other words, it doesn't seem that the title changes are getting sent on change as expected.

@westonruter The title would not get saved if the date is not of future, once user updates the date to be of future, it will start auto-saving, but yes it should be happening only in case of future, which I have updated. Now working on the main issue..

coveralls · 2017-02-13T14:42:43Z

Coverage increased (+0.1%) to 77.005% when pulling 93ad522 on bugfix/create-revisions into 7910d6b on develop.

mohdsayed · 2017-02-13T17:59:00Z

@westonruter I wasn't able to finish it today, and I am going on a leave till next Tuesday, so may be @PatelUtkarsh can continue on this PR or I can do it when I come back. 👋

…d for editbox

coveralls · 2017-02-24T15:31:23Z

Coverage decreased (-0.04%) to 76.824% when pulling 4b69f1f on bugfix/create-revisions into 7910d6b on develop.

coveralls · 2017-02-24T15:31:23Z

Coverage decreased (-0.04%) to 76.824% when pulling 4b69f1f on bugfix/create-revisions into 7910d6b on develop.

…s in prefilter for editbox auto save.

coveralls · 2017-02-25T14:52:34Z

Coverage decreased (-0.04%) to 76.824% when pulling d3166d4 on bugfix/create-revisions into 7910d6b on develop.

coveralls · 2017-02-25T16:24:13Z

Coverage decreased (-0.04%) to 76.824% when pulling 7913f93 on bugfix/create-revisions into 7910d6b on develop.

coveralls · 2017-02-25T16:39:29Z

Coverage decreased (-0.04%) to 76.824% when pulling a268785 on bugfix/create-revisions into 7910d6b on develop.

mohdsayed · 2017-02-25T16:40:49Z

@westonruter Ready for review.

westonruter · 2017-02-28T05:18:04Z

@sayedtaqui On 4.6 I'm getting an error if I Save a snapshot, then make a change, and then hit Update. A modal pops open with “The snapshot could not be saved”, with the Ajax request returning with a bad_schedule_time error.

coveralls · 2017-02-28T05:24:25Z

Coverage increased (+0.02%) to 76.878% when pulling 383787c on bugfix/create-revisions into 7910d6b on develop.

Ensure that revisions get created when changesets are updated via exp…

e5aea6a

…licit saves

westonruter added this to the 0.6.0 milestone Feb 7, 2017

westonruter requested review from PatelUtkarsh and mohdsayed February 7, 2017 21:47

westonruter commented Feb 7, 2017

View reviewed changes

PatelUtkarsh approved these changes Feb 9, 2017

View reviewed changes

mohdsayed reviewed Feb 9, 2017

View reviewed changes

mohdsayed approved these changes Feb 9, 2017

View reviewed changes

westonruter changed the title ~~Ensure that revisions get created when changesets are updated via explicit saves~~ [WIP] Ensure that revisions get created when changesets are updated via explicit saves Feb 10, 2017

Use add_action instead of add_filter

66b6bb0

westonruter assigned mohdsayed Feb 11, 2017

mohdsayed added 5 commits February 13, 2017 16:27

Toggle date control for future status

00f7ad9

Seperate edit control's date and title observable values

d62a8ae

Misc code improvements.

6233030

Allow title to update without date in non future status

d4752ca

Merge branch 'bugfix/create-revisions' of github.com:xwp/wp-customize…

93ad522

…-snapshots into bugfix/create-revisions

mohdsayed mentioned this pull request Feb 13, 2017

Date fields display with error message when selecting non-schedule status #112

Closed

Remove customize_changeset_status param only if auto save is triggere…

4b69f1f

…d for editbox

Add condition to check if original data has customize_changeset_statu…

d3166d4

…s in prefilter for editbox auto save.

Fix AYS showing on page load

7913f93

Fix AYS supress condition.

a268785

mohdsayed changed the title ~~[WIP] Ensure that revisions get created when changesets are updated via explicit saves~~ Ensure that revisions get created when changesets are updated via explicit saves Feb 25, 2017

Prevent case of JS error on 4.6 when statusButton doesn't exist

383787c

westonruter merged commit 6438739 into develop Feb 28, 2017

westonruter deleted the bugfix/create-revisions branch February 28, 2017 07:27

mohdsayed mentioned this pull request Mar 2, 2017

Prevent removal of customize_changeset_status if the status are not same #126

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure that revisions get created when changesets are updated via explicit saves #111

Ensure that revisions get created when changesets are updated via explicit saves #111

westonruter commented Feb 7, 2017 •

edited

westonruter Feb 7, 2017

mohdsayed Feb 9, 2017

westonruter Feb 9, 2017

mohdsayed Feb 9, 2017

westonruter Feb 9, 2017

mohdsayed Feb 9, 2017

coveralls commented Feb 7, 2017 •

edited

PatelUtkarsh commented Feb 8, 2017

PatelUtkarsh left a comment

mohdsayed Feb 9, 2017

westonruter Feb 9, 2017

PatelUtkarsh commented Feb 9, 2017

mohdsayed commented Feb 9, 2017

coveralls commented Feb 10, 2017 •

edited

westonruter commented Feb 11, 2017

mohdsayed commented Feb 13, 2017

mohdsayed commented Feb 13, 2017 •

edited

coveralls commented Feb 13, 2017 •

edited

mohdsayed commented Feb 13, 2017 •

edited

coveralls commented Feb 24, 2017

coveralls commented Feb 24, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

mohdsayed commented Feb 25, 2017

westonruter commented Feb 28, 2017

coveralls commented Feb 28, 2017 •

edited

Ensure that revisions get created when changesets are updated via explicit saves #111

Ensure that revisions get created when changesets are updated via explicit saves #111

Conversation

westonruter commented Feb 7, 2017 • edited

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

coveralls commented Feb 7, 2017 • edited

PatelUtkarsh commented Feb 8, 2017

PatelUtkarsh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

PatelUtkarsh commented Feb 9, 2017

mohdsayed commented Feb 9, 2017

coveralls commented Feb 10, 2017 • edited

westonruter commented Feb 11, 2017

mohdsayed commented Feb 13, 2017

mohdsayed commented Feb 13, 2017 • edited

coveralls commented Feb 13, 2017 • edited

mohdsayed commented Feb 13, 2017 • edited

coveralls commented Feb 24, 2017

coveralls commented Feb 24, 2017 • edited

coveralls commented Feb 25, 2017 • edited

coveralls commented Feb 25, 2017 • edited

coveralls commented Feb 25, 2017 • edited

mohdsayed commented Feb 25, 2017

westonruter commented Feb 28, 2017

coveralls commented Feb 28, 2017 • edited

westonruter commented Feb 7, 2017 •

edited

coveralls commented Feb 7, 2017 •

edited

coveralls commented Feb 10, 2017 •

edited

mohdsayed commented Feb 13, 2017 •

edited

coveralls commented Feb 13, 2017 •

edited

mohdsayed commented Feb 13, 2017 •

edited

coveralls commented Feb 24, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

coveralls commented Feb 25, 2017 •

edited

coveralls commented Feb 28, 2017 •

edited