Changeset 57494

Timestamp:

01/31/2024 10:39:04 AM (12 months ago)

Author:

youknowriad

Message:

REST API: Add route for single styles revisions.

Adds a route for single global styles revisions: /wp/v2/global-styles/${ parentId }/revisions/${ revisionsId }
This fixes the getRevision actions in the core-data package.

Props ramonopoly, get_dave.
Fixes #59810.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-schema-setup.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (1 diff)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php

@@ -48 +48 @@
      *
      * @since 6.3.0
+     * @since 6.5.0 Added route to fetch individual global styles revisions.
      */
     public function register_routes() {
@@ -65 +66 @@
                     'permission_callback' => array( $this, 'get_item_permissions_check' ),
                     'args'                => $this->get_collection_params(),
+                ),
+                'schema' => array( $this, 'get_public_item_schema' ),
+            )
+        );
+
+        register_rest_route(
+            $this->namespace,
+            '/' . $this->parent_base . '/(?P<parent>[\d]+)/' . $this->rest_base . '/(?P<id>[\d]+)',
+            array(
+                'args'   => array(
+                    'parent' => array(
+                        'description' => __( 'The ID for the parent of the global styles revision.' ),
+                        'type'        => 'integer',
+                    ),
+                    'id'     => array(
+                        'description' => __( 'Unique identifier for the global styles revision.' ),
+                        'type'        => 'integer',
+                    ),
+                ),
+                array(
+                    'methods'             => WP_REST_Server::READABLE,
+                    'callback'            => array( $this, 'get_item' ),
+                    'permission_callback' => array( $this, 'get_item_permissions_check' ),
+                    'args'                => array(
+                        'context' => $this->get_context_param( array( 'default' => 'view' ) ),
+                    ),
                 ),
                 'schema' => array( $this, 'get_public_item_schema' ),
@@ -243 +270 @@
 
     /**
+     * Retrieves one global styles revision from the collection.
+     *
+     * @since 6.5.0
+     *
+     * @param WP_REST_Request $request Full details about the request.
+     * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
+     */
+    public function get_item( $request ) {
+        $parent = $this->get_parent( $request['parent'] );
+        if ( is_wp_error( $parent ) ) {
+            return $parent;
+        }
+
+        $revision = $this->get_revision( $request['id'] );
+        if ( is_wp_error( $revision ) ) {
+            return $revision;
+        }
+
+        $response = $this->prepare_item_for_response( $revision, $request );
+        return rest_ensure_response( $response );
+    }
+
+    /**
+     * Gets the global styles revision, if the ID is valid.
+     *
+     * @since 6.5.0
+     *
+     * @param int $id Supplied ID.
+     * @return WP_Post|WP_Error Revision post object if ID is valid, WP_Error otherwise.
+     */
+    protected function get_revision( $id ) {
+        $error = new WP_Error(
+            'rest_post_invalid_id',
+            __( 'Invalid global styles revision ID.' ),
+            array( 'status' => 404 )
+        );
+
+        if ( (int) $id <= 0 ) {
+            return $error;
+        }
+
+        $revision = get_post( (int) $id );
+        if ( empty( $revision ) || empty( $revision->ID ) || 'revision' !== $revision->post_type ) {
+            return $error;
+        }
+
+        return $revision;
+    }
+
+    /**
      * Checks the post_date_gmt or modified_gmt and prepare any post or
      * modified date for single post output.

trunk/tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php

@@ -227 +227 @@
     /**
      * @ticket 58524
+     * @ticket 59810
      *
      * @covers WP_REST_Global_Styles_Controller::register_routes
@@ -236 +237 @@
             $routes,
             'Global style revisions based on the given parentID route does not exist.'
+        );
+        $this->assertArrayHasKey(
+            '/wp/v2/global-styles/(?P<parent>[\d]+)/revisions/(?P<id>[\d]+)',
+            $routes,
+            'Single global style revisions based on the given parentID and revision ID route does not exist.'
         );
     }
@@ -303 +309 @@
         $this->assertSame( $this->revision_1_id, $data[2]['id'] );
         $this->check_get_revision_response( $data[2], $this->revision_1 );
+    }
+
+    /**
+     * @ticket 59810
+     *
+     * @covers WP_REST_Global_Styles_Controller::get_item
+     */
+    public function test_get_item() {
+        wp_set_current_user( self::$admin_id );
+
+        $request  = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions/' . $this->revision_1_id );
+        $response = rest_get_server()->dispatch( $request );
+        $data     = $response->get_data();
+
+        $this->assertSame( 200, $response->get_status(), 'Response status is 200.' );
+        $this->check_get_revision_response( $data, $this->revision_1 );
+    }
+
+    /**
+     * @ticket 59810
+     *
+     * @covers WP_REST_Global_Styles_Controller::get_revision
+     */
+    public function test_get_item_invalid_revision_id_should_error() {
+        wp_set_current_user( self::$admin_id );
+
+        $expected_error  = 'rest_post_invalid_id';
+        $expected_status = 404;
+        $request         = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions/20000001' );
+        $response        = rest_get_server()->dispatch( $request );
+
+        $this->assertErrorResponse( $expected_error, $response, $expected_status );
     }
 
@@ -798 +836 @@
      * @doesNotPerformAssertions
      */
-    public function test_get_item() {
-        // Controller does not implement get_item().
-    }
-
-    /**
-     * @doesNotPerformAssertions
-     */
     public function test_create_item() {
         // Controller does not implement create_item().

trunk/tests/phpunit/tests/rest-api/rest-schema-setup.php

@@ -136 +136 @@
             '/wp/v2/global-styles/(?P<id>[\/\w-]+)',
             '/wp/v2/global-styles/(?P<parent>[\d]+)/revisions',
+            '/wp/v2/global-styles/(?P<parent>[\d]+)/revisions/(?P<id>[\d]+)',
             '/wp/v2/global-styles/themes/(?P<stylesheet>[\/\s%\w\.\(\)\[\]\@_\-]+)/variations',
             '/wp/v2/global-styles/themes/(?P<stylesheet>[^\/:<>\*\?"\|]+(?:\/[^\/:<>\*\?"\|]+)?)',

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -10045 +10045 @@
             ]
         },
+        "/wp/v2/global-styles/(?P<parent>[\\d]+)/revisions/(?P<id>[\\d]+)": {
+            "namespace": "wp/v2",
+            "methods": [
+                "GET"
+            ],
+            "endpoints": [
+                {
+                    "methods": [
+                        "GET"
+                    ],
+                    "args": {
+                        "parent": {
+                            "description": "The ID for the parent of the global styles revision.",
+                            "type": "integer",
+                            "required": false
+                        },
+                        "id": {
+                            "description": "Unique identifier for the global styles revision.",
+                            "type": "integer",
+                            "required": false
+                        },
+                        "context": {
+                            "description": "Scope under which the request is made; determines fields present in response.",
+                            "type": "string",
+                            "enum": [
+                                "view",
+                                "embed",
+                                "edit"
+                            ],
+                            "default": "view",
+                            "required": false
+                        }
+                    }
+                }
+            ]
+        },
         "/wp/v2/global-styles/themes/(?P<stylesheet>[\\/\\s%\\w\\.\\(\\)\\[\\]\\@_\\-]+)/variations": {
             "namespace": "wp/v2",