Changeset 41839 for trunk/tests/phpunit/tests/ajax/CustomizeManager.php

Timestamp:

10/12/2017 04:00:15 AM (7 years ago)

Author:

westonruter

Message:

Customize: Add changeset locking in Customizer to prevent users from overriding each other's changes.

• Customization locking is checked when changesets are saved and when heartbeat ticks.
• Lock is lifted immediately upon a user closing the Customizer.
• Heartbeat is introduced into Customizer.
• Changes made to user after it was locked by another user are stored as an autosave revision for restoration.
• Lock notification displays link to preview the other user's changes on the frontend.
• A user loading a locked Customizer changeset will be presented with an option to take over.
• Autosave revisions attached to a published changeset are converted into auto-drafts so that they will be presented to users for restoration.
• Focus constraining is improved in overlay notifications.
• Escape key is stopped from propagating in overlay notifications, and it dismisses dismissible overlay notifications.
• Introduces changesetLocked state which is used to disable the Save button and suppress the AYS dialog when leaving the Customizer.
• Fixes bug where users could be presented with each other's autosave revisions.

Props sayedwp, westonruter, melchoyce.
See #31436, #31897, #39896.
Fixes #42024.

File:

• trunk/tests/phpunit/tests/ajax/CustomizeManager.php (modified) (7 diffs)

trunk/tests/phpunit/tests/ajax/CustomizeManager.php

@@ -517 +517 @@
      *
      * @ticket 39896
-     * @covers WP_Customize_Manager::handle_dismiss_autosave_request()
+     * @covers WP_Customize_Manager::handle_dismiss_autosave_or_lock_request()
      * @covers WP_Customize_Manager::dismiss_user_auto_draft_changesets()
      */
-    public function test_handle_dismiss_autosave_request() {
+    public function test_handle_dismiss_autosave_or_lock_request() {
         $uuid = wp_generate_uuid4();
         $wp_customize = $this->set_up_valid_state( $uuid );
 
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertFalse( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'invalid_nonce', $this->_last_response_parsed['data'] );
 
-        $nonce = wp_create_nonce( 'customize_dismiss_autosave' );
+        $nonce = wp_create_nonce( 'customize_dismiss_autosave_or_lock' );
         $_POST['nonce'] = $_GET['nonce'] = $_REQUEST['nonce'] = $nonce;
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+
+        $_POST['dismiss_lock'] = $_GET['dismiss_lock'] = $_REQUEST['dismiss_lock'] = true;
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
+        $this->assertFalse( $this->_last_response_parsed['success'] );
+        $this->assertEquals( 'no_changeset_to_dismiss_lock', $this->_last_response_parsed['data'] );
+
+        $_POST['dismiss_autosave'] = $_GET['dismiss_autosave'] = $_REQUEST['dismiss_autosave'] = true;
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertFalse( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'no_auto_draft_to_delete', $this->_last_response_parsed['data'] );
@@ -560 +567 @@
             $this->assertFalse( (bool) get_post_meta( $post_id, '_customize_restore_dismissed', true ) );
         }
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertTrue( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'auto_draft_dismissed', $this->_last_response_parsed['data'] );
@@ -573 +580 @@
 
         // Subsequent test results in none dismissed.
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertFalse( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'no_auto_draft_to_delete', $this->_last_response_parsed['data'] );
@@ -586 +593 @@
             'status' => 'draft',
         ) );
+
+        $_POST['dismiss_autosave'] = $_GET['dismiss_autosave'] = $_REQUEST['dismiss_autosave'] = false;
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
+        $this->assertTrue( $this->_last_response_parsed['success'] );
+        $this->assertEquals( 'changeset_lock_dismissed', $this->_last_response_parsed['data'] );
+
+        $_POST['dismiss_autosave'] = $_GET['dismiss_autosave'] = $_REQUEST['dismiss_autosave'] = true;
         $this->assertNotInstanceOf( 'WP_Error', $r );
         $this->assertFalse( wp_get_post_autosave( $wp_customize->changeset_post_id() ) );
@@ -591 +605 @@
 
         // Since no autosave yet, confirm no action.
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertFalse( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'no_autosave_revision_to_delete', $this->_last_response_parsed['data'] );
@@ -611 +625 @@
 
         // Confirm autosave gets deleted.
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertTrue( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'autosave_revision_deleted', $this->_last_response_parsed['data'] );
@@ -617 +631 @@
 
         // Since no autosave yet, confirm no action.
-        $this->make_ajax_call( 'customize_dismiss_autosave' );
+        $this->make_ajax_call( 'customize_dismiss_autosave_or_lock' );
         $this->assertFalse( $this->_last_response_parsed['success'] );
         $this->assertEquals( 'no_autosave_revision_to_delete', $this->_last_response_parsed['data'] );