Changeset 47328

Timestamp:

02/20/2020 04:56:17 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Don't assume all item schemas have properties.

All schema types, not just objects, are permitted as the base type of a resource. A future patch could add validation support for those types, but this fix only prevents a PHP warning from being issued.

Props dhavalkasvala, johnwatkins0, birgire.
Fixes #48785.

Location:

trunk

Files:

• src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php (modified) (1 diff)
• tests/phpunit/includes/bootstrap.php (modified) (1 diff)
• tests/phpunit/includes/class-wp-rest-test-configurable-controller.php (added)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (1 diff)

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

@@ -345 +345 @@
         $schema = $this->get_item_schema();
 
-        foreach ( $schema['properties'] as &$property ) {
-            unset( $property['arg_options'] );
+        if ( ! empty( $schema['properties'] ) ) {
+            foreach ( $schema['properties'] as &$property ) {
+                unset( $property['arg_options'] );
+            }
         }
 

trunk/tests/phpunit/includes/bootstrap.php

@@ -155 +155 @@
 require __DIR__ . '/spy-rest-server.php';
 require __DIR__ . '/class-wp-rest-test-search-handler.php';
+require __DIR__ . '/class-wp-rest-test-configurable-controller.php';
 require __DIR__ . '/class-wp-fake-block-type.php';
 

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

@@ -344 +344 @@
     }
 
+    /**
+     * @ticket 48785
+     */
+    public function test_get_public_item_schema_with_properties() {
+        $schema = ( new WP_REST_Test_Controller() )->get_public_item_schema();
+
+        // Double-check that the public item schema set in WP_REST_Test_Controller still has properties.
+        $this->assertArrayHasKey( 'properties', $schema );
+
+        // But arg_options should be removed.
+        $this->assertArrayNotHasKey( 'arg_options', $schema['properties']['someargoptions'] );
+    }
+
+    /**
+     * @ticket 48785
+     */
+    public function test_get_public_item_schema_no_properties() {
+        $controller = new WP_REST_Test_Configurable_Controller(
+            array(
+                '$schema'     => 'http://json-schema.org/draft-04/schema#',
+                'title'       => 'foo',
+                'type'        => 'string',
+                'description' => 'This is my magical endpoint that just returns a string.',
+            )
+        );
+
+        // Initial check that the test class is working as expected.
+        $this->assertArrayNotHasKey( 'properties', $controller->get_public_item_schema() );
+
+        // Test that the schema lacking 'properties' is returned as expected.
+        $this->assertEqualSetsWithIndex( $controller->get_public_item_schema(), $controller->get_test_schema() );
+    }
+
     public function test_add_additional_fields_to_object_respects_fields_param() {
         $controller = new WP_REST_Test_Controller();