Changeset 56819 for trunk/tests/phpunit/tests/post/wpPostType.php

Timestamp:

10/10/2023 02:03:03 PM (3 years ago)

Author:

spacedmonkey

Message:

REST API: Fix issue with Template and Template Part Revision/Autosave REST API controllers.

The Template and Template Part REST API controllers have unique characteristics compared to other post type REST API controllers. They do not rely on integer IDs to reference objects; instead, they use a combination of the theme name and slug of the template, like 'twentytwentyfourhome.' Consequently, when the post types template and template part were introduced in [52062], it led to the registration of REST API endpoints for autosaves and revisions with invalid URL structures.

In this commit, we introduce new functionality to enable custom autosave and revisions endpoints to be registered at the post type level. Similar to the 'rest_controller_class' parameter, developers can now define 'revisions_rest_controller' and 'autosave_rest_controller.' This empowers developers to create custom controllers for these functionalities. Additionally, we introduce a 'late_route_registration' parameter, which proves helpful when dealing with custom URL patterns and regex pattern matching issues.
This commit registers new classes for template and template part autosave and revisions controllers, differentiating them from standard controllers in the following ways:

• The response shape now matches that of the template controller.
• Permission checks align with the template controller.
• A custom URL pattern is introduced to support slug-based identification of templates.

Furthermore, we've updated the utility function '_build_block_template_result_from_post' to support passing revision post objects. This enhancement ensures compatibility with the custom revisions controller.

Props spacedmonkey, revgeorge, andraganescu, hellofromTonya, antonvlasenko, kadamwhite, ironprogrammer, costdev, mukesh27, timothyblynjacobs, adamsilverstein.
Fixes 56922.

File:

• trunk/tests/phpunit/tests/post/wpPostType.php (modified) (1 diff)

trunk/tests/phpunit/tests/post/wpPostType.php

@@ -230 +230 @@
                 $this->assertSame( 3, $action->get_call_count() );
         }
+
+        /**
+         * @ticket 56922
+         *
+         * @dataProvider data_should_have_correct_custom_revisions_and_autosaves_controllers_properties
+         *
+         * @covers WP_Post_Type::set_props
+         *
+         * @param string      $property_name           Property name.
+         * @param string      $property_value          Property value.
+         * @param string|bool $expected_property_value Expected property value.
+         */
+        public function test_should_have_correct_custom_revisions_and_autosaves_controllers_properties( $property_name, $property_value, $expected_property_value ) {
+                $properties = null === $property_value ? array() : array( $property_name => $property_value );
+
+                $post_type = new WP_Post_Type( 'test_post_type', $properties );
+
+                $this->assertObjectHasProperty( $property_name, $post_type, "The WP_Post_Type object does not have the expected {$property_name} property." );
+                $this->assertSame(
+                        $expected_property_value,
+                        $post_type->$property_name,
+                        sprintf( 'Expected the property "%s" to have the %s value.', $property_name, var_export( $expected_property_value, true ) )
+                );
+        }
+
+        /**
+         * Data provider for test_should_allow_to_set_custom_revisions_and_autosaves_controllers_properties.
+         *
+         * @return array[] Arguments {
+         *     @type string $property_name           Property name.
+         *     @type string $property_value          Property value.
+         *     @type string|bool $expected_property_value Expected property value.
+         * }
+         */
+        public function data_should_have_correct_custom_revisions_and_autosaves_controllers_properties() {
+                return array(
+                        'autosave_rest_controller_class property'  => array(
+                                'autosave_rest_controller_class',
+                                'My_Custom_Template_Autosaves_Controller',
+                                'My_Custom_Template_Autosaves_Controller',
+                        ),
+                        'autosave_rest_controller_class property (null value)' => array(
+                                'autosave_rest_controller_class',
+                                null,
+                                false,
+                        ),
+                        'revisions_rest_controller_class property' => array(
+                                'revisions_rest_controller_class',
+                                'My_Custom_Template_Revisions_Controller',
+                                'My_Custom_Template_Revisions_Controller',
+                        ),
+                        'revisions_rest_controller_class property (null value)' => array(
+                                'revisions_rest_controller_class',
+                                null,
+                                false,
+                        ),
+                );
+        }
+
+        /**
+         * @ticket 56922
+         *
+         * @covers WP_Post_Type::get_revisions_rest_controller
+         *
+         * @dataProvider data_get_revisions_rest_controller_should_return_correct_values
+         *
+         * @param bool        $show_in_rest                    Enables "show_in_rest" support.
+         * @param bool        $supports_revisions              Enables revisions support.
+         * @param string|bool $revisions_rest_controller_class Custom revisions REST controller class.
+         * @param string|null $expected_value                  Expected value.
+         */
+        public function test_get_revisions_rest_controller_should_return_correct_values( $show_in_rest, $supports_revisions, $revisions_rest_controller_class, $expected_value ) {
+                $post_type  = 'test_post_type';
+                $properties = array(
+                        'show_in_rest'                    => $show_in_rest,
+                        'supports'                        => $supports_revisions ? array( 'revisions' ) : array(),
+                        'revisions_rest_controller_class' => $revisions_rest_controller_class,
+                );
+                register_post_type( $post_type, $properties );
+                $post_type = get_post_type_object( $post_type );
+
+                $controller = $post_type->get_revisions_rest_controller();
+                if ( $expected_value ) {
+                        $this->assertInstanceOf( $expected_value, $controller );
+
+                        return;
+                }
+
+                $this->assertSame( $expected_value, $controller );
+        }
+
+        /**
+         * Data provider for test_get_revisions_rest_controller_should_return_correct_values.
+         *
+         * @return array[] Arguments {
+         *     @type bool             $show_in_rest                    Enables "show_in_rest" support.
+         *     @type bool             $supports_revisions              Enables revisions support.
+         *     @type string|bool      $revisions_rest_controller_class Custom revisions REST controller class.
+         *     @type string|null      $expected_value                  Expected value.
+         * }
+         */
+        public function data_get_revisions_rest_controller_should_return_correct_values() {
+                return array(
+                        'disable show_in_rest'                => array(
+                                false,
+                                false,
+                                false,
+                                null,
+                        ),
+                        'disable revisions support'           => array(
+                                true,
+                                false,
+                                false,
+                                null,
+                        ),
+                        'default rest revisions controller'   => array(
+                                true,
+                                true,
+                                false,
+                                WP_REST_Revisions_Controller::class,
+                        ),
+                        'incorrect rest revisions controller' => array(
+                                true,
+                                true,
+                                stdClass::class,
+                                null,
+                        ),
+                        'correct rest revisions controller'   => array(
+                                true,
+                                true,
+                                WP_REST_Template_Revisions_Controller::class,
+                                WP_REST_Template_Revisions_Controller::class,
+                        ),
+                );
+        }
+
+        /**
+         * @ticket 56922
+         *
+         * @covers WP_Post_Type::get_autosave_rest_controller
+         *
+         * @dataProvider data_get_autosave_rest_controller_should_return_correct_values
+         *
+         * @param bool        $show_in_rest                   Enables "show_in_rest" support.
+         * @param string      $post_type                      Post type.
+         * @param string|bool $autosave_rest_controller_class Custom autosave REST controller class.
+         * @param string|null $expected_value                 Expected value.
+         */
+        public function test_get_autosave_rest_controller_should_return_correct_values( $show_in_rest, $post_type, $autosave_rest_controller_class, $expected_value ) {
+                $properties = array(
+                        'show_in_rest'                   => $show_in_rest,
+                        'autosave_rest_controller_class' => $autosave_rest_controller_class,
+                );
+                register_post_type( $post_type, $properties );
+                $post_type = get_post_type_object( $post_type );
+
+                $controller = $post_type->get_autosave_rest_controller();
+                if ( $expected_value ) {
+                        $this->assertInstanceOf( $expected_value, $controller );
+
+                        return;
+                }
+
+                $this->assertSame( $expected_value, $controller );
+        }
+
+        /**
+         * Data provider for test_get_autosave_rest_controller_should_return_correct_values.
+         *
+         * @return array[] Arguments {
+         *     @type bool        $show_in_rest                   Enables "show_in_rest" support.
+         *     @type string      $post_type                      Post type.
+         *     @type string|bool $autosave_rest_controller_class Custom autosave REST controller class.
+         *     @type string|null $expected_value                 Expected value.
+         * }
+         */
+        public function data_get_autosave_rest_controller_should_return_correct_values() {
+                return array(
+                        'disable show_in_rest'               => array(
+                                false,
+                                'attachment',
+                                false,
+                                null,
+                        ),
+                        'invalid post type'                  => array(
+                                true,
+                                'attachment',
+                                false,
+                                null,
+                        ),
+                        'default rest autosave controller'   => array(
+                                true,
+                                'test_post_type',
+                                false,
+                                WP_REST_Autosaves_Controller::class,
+                        ),
+                        'incorrect rest autosave controller' => array(
+                                true,
+                                'test_post_type',
+                                stdClass::class,
+                                null,
+                        ),
+                        'correct rest autosave controller'   => array(
+                                true,
+                                'test_post_type',
+                                WP_REST_Template_Autosaves_Controller::class,
+                                WP_REST_Template_Autosaves_Controller::class,
+                        ),
+                );
+        }
 }