Add/features enabled rest endpoint (#39475)

* Added features enabled rest endpoint --------- Co-authored-by: sergeymitr <[email protected]>
Automattic · Sep 23, 2024 · 1d8d319 · 1d8d319
1 parent 8caefec
commit 1d8d319
Show file tree

Hide file tree

Showing 19 changed files with 145 additions and 18 deletions.
diff --git a/projects/packages/connection/changelog/add-features-enabled-rest-endpoint b/projects/packages/connection/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: major
+Type: removed
+
+Connection: Removed deprecated features_enabled method
diff --git a/projects/packages/connection/legacy/class-jetpack-xmlrpc-server.php b/projects/packages/connection/legacy/class-jetpack-xmlrpc-server.php
@@ -823,24 +823,6 @@ public function disconnect_blog() {
 		return false;
 	}
 
-	/**
-	 * Deprecated: This method is no longer part of the Connection package and now lives on the Jetpack plugin.
-	 *
-	 * Returns what features are enabled. Uses the slug of the modules files.
-	 *
-	 * @deprecated since 1.25.0
-	 * @see Jetpack_XMLRPC_Methods::features_enabled() in the Jetpack plugin
-	 *
-	 * @return array
-	 */
-	public function features_enabled() {
-		_deprecated_function( __METHOD__, '1.25.0', 'Jetpack_XMLRPC_Methods::features_enabled()' );
-		if ( class_exists( 'Jetpack_XMLRPC_Methods' ) ) {
-			return Jetpack_XMLRPC_Methods::features_enabled();
-		}
-		return array();
-	}
-
 	/**
 	 * Deprecated: This method is no longer part of the Connection package and now lives on the Jetpack plugin.
 	 *

diff --git a/projects/plugins/automattic-for-agencies-client/changelog/add-features-enabled-rest-endpoint b/projects/plugins/automattic-for-agencies-client/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/backup/changelog/add-features-enabled-rest-endpoint b/projects/plugins/backup/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/boost/changelog/add-features-enabled-rest-endpoint b/projects/plugins/boost/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/inspect/changelog/add-features-enabled-rest-endpoint b/projects/plugins/inspect/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/jetpack/_inc/lib/class.core-rest-api-endpoints.php b/projects/plugins/jetpack/_inc/lib/class.core-rest-api-endpoints.php
@@ -802,6 +802,21 @@ public static function register_endpoints() {
 				'permission_callback' => array( static::class, 'get_features_permission_check' ),
 			)
 		);
+
+		/**
+		 * Get the list of enabled Jetpack features.
+		 *
+		 * @since $$next-version$$
+		 */
+		register_rest_route(
+			'jetpack/v4',
+			'/features/enabled',
+			array(
+				'methods'             => WP_REST_Server::READABLE,
+				'callback'            => array( static::class, 'get_features_enabled' ),
+				'permission_callback' => array( static::class, 'get_features_permission_check' ),
+			)
+		);
 	}
 
 	/**
@@ -4498,6 +4513,21 @@ public static function get_features_available() {
 		return $modules;
 	}
 
+	/**
+	 * Returns what features are enabled. Uses the slug of the modules files.
+	 *
+	 * @return array
+	 */
+	public static function get_features_enabled() {
+		$raw_modules = Jetpack::get_active_modules();
+		$modules     = array();
+		foreach ( $raw_modules as $module ) {
+			$modules[] = Jetpack::get_module_slug( $module );
+		}
+
+		return $modules;
+	}
+
 	/**
 	 * Verify that the API client is allowed to replace user token.
 	 *

diff --git a/projects/plugins/jetpack/changelog/add-features-enabled-rest-endpoint b/projects/plugins/jetpack/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: enhancement
+
+Adding features enabled rest endpoint
diff --git a/projects/plugins/jetpack/class-jetpack-xmlrpc-methods.php b/projects/plugins/jetpack/class-jetpack-xmlrpc-methods.php
@@ -61,6 +61,8 @@ public static function features_available() {
 	/**
 	 * Returns what features are enabled. Uses the slug of the modules files.
 	 *
+	 * @deprecated $$next-version$$
+	 * @see Jetpack_Core_Json_Api_Endpoints::get_features_enabled()
 	 * @return array
 	 */
 	public static function features_enabled() {

diff --git a/projects/plugins/jetpack/tests/php/_inc/lib/test_class.rest-api-authentication.php b/projects/plugins/jetpack/tests/php/_inc/lib/test_class.rest-api-authentication.php
@@ -286,6 +286,50 @@ public function test_jetpack_rest_api_get_features_available_authentication_succ
 		$this->assertEquals( 200, $response->get_status() );
 	}
 
+	/**
+	 * @author darssen
+	 *
+	 * Test the 'features/enabled' endpoint authentication.
+	 *
+	 * @since $$next-version$$
+	 */
+	public function test_jetpack_rest_api_get_features_enabled_authentication_success() {
+		add_filter( 'pre_option_jetpack_private_options', array( $this, 'mock_jetpack_private_options' ), 10, 2 );
+		$token     = 'pretend_this_is_valid_blog_token:1:0';
+		$timestamp = (string) time();
+		$nonce     = 'testing123';
+		$body_hash = '';
+
+		$_GET['token']     = $token;
+		$_GET['timestamp'] = $timestamp;
+		$_GET['nonce']     = $nonce;
+		$_GET['body-hash'] = $body_hash;
+		$_GET['signature'] = base64_encode(
+			hash_hmac(
+				'sha1',
+				implode(
+					"\n",
+					array(
+						$token,
+						$timestamp,
+						$nonce,
+						$body_hash,
+						'GET',
+						'example.org',
+						'80',
+						'/jetpack/v4/features/enabled',
+						'qstest=yep',
+					)
+				) . "\n",
+				'secret_blog',
+				true
+			)
+		);
+		$this->request     = new WP_REST_Request( 'GET', '/jetpack/v4/features/enabled' );
+		$response          = $this->server->dispatch( $this->request );
+		$this->assertEquals( 200, $response->get_status() );
+	}
+
 	/**
 	 * @author jnylen0
 	 */

diff --git a/projects/plugins/jetpack/tests/php/_inc/lib/test_class.rest-api-endpoints.php b/projects/plugins/jetpack/tests/php/_inc/lib/test_class.rest-api-endpoints.php
@@ -1237,4 +1237,17 @@ public function test_features_available_unauthorized() {
 		$this->assertResponseStatus( 401, $response );
 		$this->assertResponseData( array( 'code' => 'invalid_permission_fetch_features' ), $response );
 	}
+
+	/**
+	 * Test the 'features/enabled' endpoint, unauthorized.
+	 *
+	 * @since $$next-version$$
+	 */
+	public function test_features_enabled_unauthorized() {
+		// Create REST request in JSON format and dispatch
+		$response = $this->create_and_get_request( 'features/enabled' );
+
+		$this->assertResponseStatus( 401, $response );
+		$this->assertResponseData( array( 'code' => 'invalid_permission_fetch_features' ), $response );
+	}
 } // class end
diff --git a/projects/plugins/migration/changelog/add-features-enabled-rest-endpoint b/projects/plugins/migration/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/mu-wpcom-plugin/changelog/add-features-enabled-rest-endpoint b/projects/plugins/mu-wpcom-plugin/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/protect/changelog/add-features-enabled-rest-endpoint b/projects/plugins/protect/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/search/changelog/add-features-enabled-rest-endpoint b/projects/plugins/search/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/social/changelog/add-features-enabled-rest-endpoint b/projects/plugins/social/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/starter-plugin/changelog/add-features-enabled-rest-endpoint b/projects/plugins/starter-plugin/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/videopress/changelog/add-features-enabled-rest-endpoint b/projects/plugins/videopress/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method
diff --git a/projects/plugins/wpcomsh/changelog/add-features-enabled-rest-endpoint b/projects/plugins/wpcomsh/changelog/add-features-enabled-rest-endpoint
@@ -0,0 +1,4 @@
+Significance: minor
+Type: removed
+
+Connection: Removed features_enabled deprecated method