Changeset 45706 for trunk/tests/phpunit/tests/rest-api/rest-controller.php

Timestamp:

07/31/2019 08:20:02 PM (6 years ago)

Author:

kadamwhite

Message:

REST API: Skip processing fields which are not present in the selected context.

In WP_REST_Controller::get_fields_for_response(), exclude fields which are not registered to appear in the request's context.

In conjunction with r45705 this prevents the unnecessary computation of the sample permalink when making a request that is not context=edit.

Props dlh.
Fixes #45605.

File:

• trunk/tests/phpunit/tests/rest-api/rest-controller.php (modified) (1 diff)

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

@@ -256 +256 @@
     }
 
+    public function test_get_fields_for_response_filters_by_context() {
+        $controller = new WP_REST_Test_Controller();
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+        $request->set_param( 'context', 'view' );
+
+        $schema = $controller->get_item_schema();
+        $field  = 'somefield';
+
+        $listener = new MockAction();
+        $method   = 'action';
+
+        register_rest_field(
+            $schema['title'],
+            $field,
+            array(
+                'schema'       => array(
+                    'type'    => 'string',
+                    'context' => array( 'embed' ),
+                ),
+                'get_callback' => array( $listener, $method ),
+            )
+        );
+
+        $controller->prepare_item_for_response( array(), $request );
+
+        $this->assertSame( 0, $listener->get_call_count( $method ) );
+
+        $request->set_param( 'context', 'embed' );
+
+        $controller->prepare_item_for_response( array(), $request );
+
+        $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+    }
+
+    public function test_filtering_fields_for_response_by_context_returns_fields_with_no_context() {
+        $controller = new WP_REST_Test_Controller();
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+        $request->set_param( 'context', 'view' );
+
+        $schema = $controller->get_item_schema();
+        $field  = 'somefield';
+
+        $listener = new MockAction();
+        $method   = 'action';
+
+        register_rest_field(
+            $schema['title'],
+            $field,
+            array(
+                'schema'       => array(
+                    'type' => 'string',
+                ),
+                'get_callback' => array( $listener, $method ),
+            )
+        );
+
+        $controller->prepare_item_for_response( array(), $request );
+
+        $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+    }
+
+    public function test_filtering_fields_for_response_by_context_returns_fields_with_no_schema() {
+        $controller = new WP_REST_Test_Controller();
+
+        $request = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
+        $request->set_param( 'context', 'view' );
+
+        $schema = $controller->get_item_schema();
+        $field  = 'somefield';
+
+        $listener = new MockAction();
+        $method   = 'action';
+
+        register_rest_field(
+            $schema['title'],
+            $field,
+            array(
+                'get_callback' => array( $listener, $method ),
+            )
+        );
+
+        $controller->prepare_item_for_response( array(), $request );
+
+        $this->assertGreaterThan( 0, $listener->get_call_count( $method ) );
+    }
+
     public function test_add_additional_fields_to_object_respects_fields_param() {
         $controller = new WP_REST_Test_Controller();