Changeset 47911

Timestamp:

06/04/2020 04:41:47 PM (6 years ago)

Author:

whyisjake

Message:

REST API: Ensure that all properties of get_endpoint_args_for_item_schema are listed.

• Add new var $valid_schema_properties to match rest_validate_value_from_schema()
• Unit test to ensure all valid properties exists, and non-valid properties are ignored

Fixes: #50301.
Props: pentatonicfunk, TimothyBlynJacobs.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-test-controller.php (modified) (2 diffs)

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

@@ -627 +627 @@
         public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
 
-                $schema            = $this->get_item_schema();
-                $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
-                $endpoint_args     = array();
+                $schema                  = $this->get_item_schema();
+                $schema_properties       = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
+                $endpoint_args           = array();
+                $valid_schema_properties = array(
+                        'type',
+                        'format',
+                        'enum',
+                        'items',
+                        'properties',
+                        'additionalProperties',
+                        'minimum',
+                        'maximum',
+                        'exclusiveMinimum',
+                        'exclusiveMaximum',
+                        'minLength',
+                        'maxLength',
+                        'pattern',
+                );
 
                 foreach ( $schema_properties as $field_id => $params ) {
@@ -655 +670 @@
                         }
 
-                        foreach ( array( 'type', 'format', 'enum', 'items', 'properties', 'additionalProperties' ) as $schema_prop ) {
+                        foreach ( $valid_schema_properties as $schema_prop ) {
                                 if ( isset( $params[ $schema_prop ] ) ) {
                                         $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];

trunk/tests/phpunit/tests/rest-api/rest-controller.php

@@ -246 +246 @@
 
                 $this->assertEquals( 'a', $args['somedefault']['default'] );
+        }
+
+        /**
+         * @ticket 50301
+         */
+        public function test_get_endpoint_args_for_item_schema_arg_properties() {
+
+                $controller = new WP_REST_Test_Controller();
+                $args       = $controller->get_endpoint_args_for_item_schema();
+
+                foreach ( array( 'minLength', 'maxLength', 'pattern' ) as $property ) {
+                        $this->assertArrayHasKey( $property, $args['somestring'] );
+                }
+
+                foreach ( array( 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum' ) as $property ) {
+                        $this->assertArrayHasKey( $property, $args['someinteger'] );
+                }
+
+                $this->assertArrayHasKey( 'items', $args['somearray'] );
+
+                foreach ( array( 'properties', 'additionalProperties' ) as $property ) {
+                        $this->assertArrayHasKey( $property, $args['someobject'] );
+                }
+
+                // ignored properties
+                $this->assertArrayNotHasKey( 'ignored_prop', $args['someobject'] );
+
         }
 
@@ -268 +295 @@
                                 'someargoptions',
                                 'somedefault',
+                                'somearray',
+                                'someobject',
                         ),
                         $fields
@@ -299 +328 @@
                                         'someargoptions',
                                         'somedefault',
+                                        'somearray',
+                                        'someobject',
                                 ),
                         ),

trunk/tests/phpunit/tests/rest-api/rest-test-controller.php

@@ -40 +40 @@
                                         'type'        => 'string',
                                         'description' => 'A pretty string.',
+                                        'minLength'   => 3,
+                                        'maxLength'   => 3,
+                                        'pattern'     => '[a-zA-Z]+',
                                         'context'     => array( 'view' ),
                                 ),
                                 'someinteger'    => array(
-                                        'type'    => 'integer',
-                                        'context' => array( 'view' ),
+                                        'type'             => 'integer',
+                                        'minimum'          => 100,
+                                        'maximum'          => 200,
+                                        'exclusiveMinimum' => true,
+                                        'exclusiveMaximum' => true,
+                                        'context'          => array( 'view' ),
                                 ),
                                 'someboolean'    => array(
@@ -94 +101 @@
                                         'default' => 'a',
                                 ),
+                                'somearray'      => array(
+                                        'type'    => 'array',
+                                        'items'   => array(
+                                                'type' => 'string',
+                                        ),
+                                        'context' => array( 'view' ),
+                                ),
+                                'someobject'     => array(
+                                        'type'                 => 'object',
+                                        'additionalProperties' => array(
+                                                'type' => 'string',
+                                        ),
+                                        'properties'           => array(
+                                                'object_id' => array(
+                                                        'type' => 'integer',
+                                                ),
+                                        ),
+                                        'ignored_prop'         => 'ignored_prop',
+                                        'context'              => array( 'view' ),
+                                ),
                         ),
                 );