Merge pull request #5232 from google/enhancement/4481-fix-response-shape

Fix the shape of sharing settings response to always be an object.
google · May 19, 2022 · a16315e · a16315e
2 parents 47ab905 + c158b62
commit a16315e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/includes/Core/Modules/REST_Dashboard_Sharing_Controller.php b/includes/Core/Modules/REST_Dashboard_Sharing_Controller.php
@@ -95,7 +95,9 @@ function ( $new_owner_id, $module_slug ) use ( $original_module_owners ) {
 						return new WP_REST_Response(
 							array(
 								'settings'    => $new_sharing_settings,
-								'newOwnerIDs' => $changed_module_owners,
+								// Cast array to an object so JSON encoded response is always an object,
+								// even when the array is empty.
+								'newOwnerIDs' => (object) $changed_module_owners,
 							)
 						);
 					},

diff --git a/tests/phpunit/integration/Core/Modules/REST_Dashboard_Sharing_ControllerTest.php b/tests/phpunit/integration/Core/Modules/REST_Dashboard_Sharing_ControllerTest.php
@@ -149,7 +149,7 @@ public function test_get_rest_routes__success() {
 		);
 		$expected_response = array(
 			'settings'    => $expected_sharing_settings,
-			'newOwnerIDs' => array(
+			'newOwnerIDs' => (object) array(
 				// ownerID should be updated as settings have changed.
 				'pagespeed-insights' => $admin_2->ID,
 			),