Merge pull request #87 from xwp/feature/concurrency-hooks

Add hooks to support customize-concurrency plugin.

js/customize-snapshots.js

@@ -609,7 +609,7 @@
 			}
 		} );
 
-		request.done( function() {
+		request.done( function( response ) {
 			var url = api.previewer.previewUrl(),
 				regex = new RegExp( '([?&])customize_snapshot_uuid=.*?(&|$)', 'i' ),
 				notFound = -1,
@@ -642,7 +642,8 @@
 			api.trigger( 'customize-snapshots-update', {
 				previewUrl: url,
 				customizeUrl: customizeUrl,
-				uuid: component.data.uuid
+				uuid: component.data.uuid,
+				response: response
 			} );
 		} );
 

php/class-customize-snapshot-manager.php

@@ -1130,6 +1130,14 @@ public function handle_update_snapshot_request() {
 			) );
 		}
 
+		/**
+		 * Add any additional checks before saving snapshot.
+		 *
+		 * @param Customize_Snapshot         $snapshot         Snapshot to be saved.
+		 * @param Customize_Snapshot_Manager $snapshot_manager Snapshot manager.
+		 */
+		do_action( 'customize_snapshot_save_before', $this->snapshot, $this );
+
 		// Set the snapshot UUID.
 		$post_type = get_post_type_object( Post_Type::SLUG );
 		$authorized = ( $post ?
@@ -1190,6 +1198,8 @@ function( $value ) {
 			wp_send_json_error( $data );
 		}
 
+		/** This filter is documented in wp-includes/class-wp-customize-manager.php */
+		$data = apply_filters( 'customize_save_response', $data, $this->customize_manager );
 		wp_send_json_success( $data );
 	}
 

tests/php/test-class-ajax-customize-snapshot-manager.php

@@ -40,6 +40,27 @@ class Test_Ajax_Customize_Snapshot_Manager extends \WP_Ajax_UnitTestCase {
 	 */
 	protected $manager;
 
+	/**
+	 * Test snapshot for test_handle_update_snapshot_request_actions_and_filters().
+	 *
+	 * @var Customize_Snapshot
+	 */
+	public $actioned_snapshot;
+
+	/**
+	 * Test snapshot manager for test_handle_update_snapshot_request_actions_and_filters().
+	 *
+	 * @var Customize_Snapshot_Manager
+	 */
+	public $actioned_snapshot_manager;
+
+	/**
+	 * Test customize manager for test_handle_update_snapshot_request_actions_and_filters().
+	 *
+	 * @var \WP_Customize_Manager
+	 */
+	public $filtered_customizer;
+
 	/**
 	 * Set up before class.
 	 */
@@ -532,4 +553,53 @@ function test_ajax_update_snapshot_ok_for_draft_and_pending_but_not_future() {
 		);
 		$this->assertSame( $expected_results, $response );
 	}
+
+	/**
+	 * Test actions and filters to make sure they are passing correct params.
+	 *
+	 * @covers \CustomizeSnapshots\Customize_Snapshot_Manager::handle_update_snapshot_request()
+	 */
+	function test_handle_update_snapshot_request_actions_and_filters() {
+		unset( $GLOBALS['wp_customize'] );
+		remove_all_actions( 'wp_ajax_' . Customize_Snapshot_Manager::AJAX_ACTION );
+
+		add_filter( 'user_has_cap', function( $allcaps, $caps, $args ) {
+			$allcaps['customize'] = true;
+			if ( ! empty( $allcaps['edit_posts'] ) && ! empty( $args ) && 'customize' === $args[0] ) {
+				$allcaps = array_merge( $allcaps, array_fill_keys( $caps, true ) );
+			}
+			return $allcaps;
+		}, 10, 3 );
+		$this->set_current_user( 'contributor' );
+		$post_vars = array(
+			'action' => Customize_Snapshot_Manager::AJAX_ACTION,
+			'nonce' => wp_create_nonce( Customize_Snapshot_Manager::AJAX_ACTION ),
+			'customize_snapshot_uuid' => self::UUID,
+		);
+
+		$this->plugin = new Plugin();
+		$this->plugin->init();
+		$this->add_setting();
+
+		$that = $this; // For PHP 5.3.
+		add_action( 'customize_snapshot_save_before', function( $test_snapshot, $test_snapshot_manager ) use ( $that ) {
+			$that->actioned_snapshot = $test_snapshot;
+			$that->actioned_snapshot_manager = $test_snapshot_manager;
+		}, 10, 2 );
+		add_filter( 'customize_save_response', function( $data, $test_customizer ) use ( $that ) {
+			$that->filtered_customizer = $test_customizer;
+			return $data;
+		}, 10, 2 );
+
+		$this->set_input_vars( $post_vars );
+		$this->make_ajax_call( Customize_Snapshot_Manager::AJAX_ACTION );
+
+		$manager = new Customize_Snapshot_Manager( $this->plugin );
+		$manager->ensure_customize_manager();
+		$manager->init();
+
+		$this->assertEquals( $manager->snapshot(), $this->actioned_snapshot );
+		$this->assertEquals( $manager, $this->actioned_snapshot_manager );
+		$this->assertEquals( $manager->customize_manager, $this->filtered_customizer );
+	}
 }