Jetpack Sync: Add an extra flag on User role update events (#36112)

* Jetpack Sync: Update Users module with explicit flags on role changes

Author: fgiannar

projects/packages/sync/changelog/update-sync-module-user--handle-roles

@@ -0,0 +1,5 @@
+Significance: patch
+Type: changed
+Comment: Jetpack Sync: Adds an extra flag on User role update events
+
+

projects/packages/sync/src/modules/class-users.php

@@ -127,9 +127,9 @@ public function init_listeners( $callable ) {
 		add_action( 'jetpack_removed_user_from_blog', $callable, 10, 2 );
 
 		// User roles.
-		add_action( 'add_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );
+		add_action( 'add_user_role', array( $this, 'add_user_role_handler' ), 10, 2 );
 		add_action( 'set_user_role', array( $this, 'save_user_role_handler' ), 10, 3 );
-		add_action( 'remove_user_role', array( $this, 'save_user_role_handler' ), 10, 2 );
+		add_action( 'remove_user_role', array( $this, 'remove_user_role_handler' ), 10, 2 );
 
 		// User capabilities.
 		add_action( 'added_user_meta', array( $this, 'maybe_save_user_meta' ), 10, 4 );
@@ -512,6 +512,9 @@ public function save_user_handler( $user_id, $old_user_data = null ) {
 			if ( false === $user->has_prop( $user_field ) ) {
 				continue;
 			}
+			if ( 'ID' === $user_field ) {
+				continue;
+			}
 			if ( $user->$user_field !== $field_value ) {
 				if ( 'user_email' === $user_field ) {
 					/**
@@ -547,6 +550,44 @@ public function save_user_handler( $user_id, $old_user_data = null ) {
 		}
 	}
 
+	/**
+	 * Handler for add user role change.
+	 *
+	 * @access public
+	 *
+	 * @param int    $user_id   ID of the user.
+	 * @param string $role      New user role.
+	 */
+	public function add_user_role_handler( $user_id, $role ) {
+		$this->add_flags(
+			$user_id,
+			array(
+				'role_added' => $role,
+			)
+		);
+
+		$this->save_user_role_handler( $user_id, $role );
+	}
+
+	/**
+	 * Handler for remove user role change.
+	 *
+	 * @access public
+	 *
+	 * @param int    $user_id   ID of the user.
+	 * @param string $role      Removed user role.
+	 */
+	public function remove_user_role_handler( $user_id, $role ) {
+		$this->add_flags(
+			$user_id,
+			array(
+				'role_removed' => $role,
+			)
+		);
+
+		$this->save_user_role_handler( $user_id, $role );
+	}
+
 	/**
 	 * Handler for user role change.
 	 *

projects/plugins/jetpack/changelog/update-sync-module-user--handle-roles

@@ -0,0 +1,5 @@
+Significance: patch
+Type: other
+Comment: Jetpack plugin: Update Sync related unit tests
+
+

projects/plugins/jetpack/tests/php/sync/test_class.jetpack-sync-users.php

@@ -221,6 +221,10 @@ public function test_user_add_role_is_synced() {
 		$client_user = get_user_by( 'id', $this->user_id );
 		unset( $client_user->data->user_pass );
 		$this->assertUsersEqual( $client_user, $server_user );
+
+		$save_event = $this->server_event_storage->get_most_recent_event( 'jetpack_sync_save_user' );
+		$this->assertSame( 'author', $save_event->args[1]['role_added'] );
+		$this->assertEquals( $this->user_id, $save_event->args[0]->ID );
 	}
 
 	public function test_user_set_role_is_synced() {
@@ -233,6 +237,9 @@ public function test_user_set_role_is_synced() {
 		$client_user = get_user_by( 'id', $this->user_id );
 		unset( $client_user->data->user_pass );
 		$this->assertUsersEqual( $client_user, $server_user );
+
+		$save_event = $this->server_event_storage->get_most_recent_event( 'jetpack_sync_save_user' );
+		$this->assertTrue( $save_event->args[1]['role_changed'] );
 	}
 
 	public function test_user_set_role_is_synced_in_wp_update_user_context() {
@@ -261,23 +268,18 @@ public function test_user_set_role_is_synced_in_wp_update_user_context() {
 
 	public function test_user_remove_role_is_synced() {
 		$user = get_user_by( 'id', $this->user_id );
-		$user->add_role( 'author' );
-		$this->sender->do_sync();
-
-		$server_user = $this->server_replica_storage->get_user( $this->user_id );
-		$client_user = get_user_by( 'id', $this->user_id );
-		unset( $client_user->data->user_pass );
-		$this->assertUsersEqual( $client_user, $server_user );
-
-		// lets now remove role
-		$user->remove_role( 'author' );
+		$user->remove_role( 'subscriber' );
 		$this->sender->do_sync();
 
 		$server_user = $this->server_replica_storage->get_user( $this->user_id );
 
 		$client_user = get_user_by( 'id', $this->user_id );
 		unset( $client_user->data->user_pass );
 		$this->assertUsersEqual( $client_user, $server_user );
+
+		$save_event = $this->server_event_storage->get_most_recent_event( 'jetpack_sync_save_user' );
+		$this->assertSame( 'subscriber', $save_event->args[1]['role_removed'] );
+		$this->assertEquals( $this->user_id, $save_event->args[0]->ID );
 	}
 
 	// Capabilities syncing