Changeset 47138

Timestamp:

01/30/2020 08:20:30 PM (5 years ago)

Author:

kadamwhite

Message:

REST API: Reuse previously-generated embedded objects when building collection response.

Store each generated embedded object in a temporary cache when querying for linked resources so that repeated links to the same resource do not trigger repeated queries or processing.

Props TimothyBlynJacobs.
Fixes #48838.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-server.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-server.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -78 +78 @@
      */
     protected $route_options = array();
+
+    /**
+     * Caches embedded requests.
+     *
+     * @since 5.4.0
+     * @var array
+     */
+    protected $embed_cache = array();
 
     /**
@@ -463 +471 @@
 
         if ( $embed ) {
+            $this->embed_cache = array();
             // Determine if this is a numeric array.
             if ( wp_is_numeric_array( $data ) ) {
@@ -469 +478 @@
                 $data = $this->embed_links( $data );
             }
+            $this->embed_cache = array();
         }
 
@@ -589 +599 @@
                 }
 
-                // Run through our internal routing and serve.
-                $request = WP_REST_Request::from_url( $item['href'] );
-                if ( ! $request ) {
-                    $embeds[] = array();
-                    continue;
-                }
-
-                // Embedded resources get passed context=embed.
-                if ( empty( $request['context'] ) ) {
-                    $request['context'] = 'embed';
-                }
-
-                $response = $this->dispatch( $request );
-
-                /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
-                $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );
-
-                $embeds[] = $this->response_to_data( $response, false );
+                if ( ! array_key_exists( $item['href'], $this->embed_cache ) ) {
+                    // Run through our internal routing and serve.
+                    $request = WP_REST_Request::from_url( $item['href'] );
+                    if ( ! $request ) {
+                        $embeds[] = array();
+                        continue;
+                    }
+
+                    // Embedded resources get passed context=embed.
+                    if ( empty( $request['context'] ) ) {
+                        $request['context'] = 'embed';
+                    }
+
+                    $response = $this->dispatch( $request );
+
+                    /** This filter is documented in wp-includes/rest-api/class-wp-rest-server.php */
+                    $response = apply_filters( 'rest_post_dispatch', rest_ensure_response( $response ), $this, $request );
+
+                    $this->embed_cache[ $item['href'] ] = $this->response_to_data( $response, false );
+                }
+
+                $embeds[] = $this->embed_cache[ $item['href'] ];
             }
 

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

@@ -676 +676 @@
         $this->assertEquals( 'Test message', $up_data['message'] );
         $this->assertEquals( 403, $up_data['data']['status'] );
+    }
+
+    /**
+     * @ticket 48838
+     */
+    public function test_link_embedding_clears_cache() {
+        $post_id = self::factory()->post->create();
+
+        $response = new WP_REST_Response();
+        $response->add_link( 'post', rest_url( 'wp/v2/posts/' . $post_id ), array( 'embeddable' => true ) );
+
+        $data = rest_get_server()->response_to_data( $response, true );
+        $this->assertArrayHasKey( 'post', $data['_embedded'] );
+        $this->assertCount( 1, $data['_embedded']['post'] );
+
+        wp_update_post(
+            array(
+                'ID'         => $post_id,
+                'post_title' => 'My Awesome Title',
+            )
+        );
+
+        $data = rest_get_server()->response_to_data( $response, true );
+        $this->assertArrayHasKey( 'post', $data['_embedded'] );
+        $this->assertCount( 1, $data['_embedded']['post'] );
+        $this->assertEquals( 'My Awesome Title', $data['_embedded']['post'][0]['title']['rendered'] );
+    }
+
+    /**
+     * @ticket 48838
+     */
+    public function test_link_embedding_cache() {
+        $response = new WP_REST_Response(
+            array(
+                'id' => 1,
+            )
+        );
+        $response->add_link(
+            'author',
+            rest_url( 'wp/v2/users/1' ),
+            array( 'embeddable' => true )
+        );
+        $response->add_link(
+            'author',
+            rest_url( 'wp/v2/users/1' ),
+            array( 'embeddable' => true )
+        );
+
+        $mock = new MockAction();
+        add_filter( 'rest_post_dispatch', array( $mock, 'filter' ) );
+
+        $data = rest_get_server()->response_to_data( $response, true );
+
+        $this->assertArrayHasKey( '_embedded', $data );
+        $this->assertArrayHasKey( 'author', $data['_embedded'] );
+        $this->assertCount( 2, $data['_embedded']['author'] );
+
+        $this->assertCount( 1, $mock->get_events() );
+    }
+
+    /**
+     * @ticket 48838
+     */
+    public function test_link_embedding_cache_collection() {
+        $response = new WP_REST_Response(
+            array(
+                array(
+                    'id'     => 1,
+                    '_links' => array(
+                        'author' => array(
+                            array(
+                                'href'       => rest_url( 'wp/v2/users/1' ),
+                                'embeddable' => true,
+                            ),
+                        ),
+                    ),
+                ),
+                array(
+                    'id'     => 2,
+                    '_links' => array(
+                        'author' => array(
+                            array(
+                                'href'       => rest_url( 'wp/v2/users/1' ),
+                                'embeddable' => true,
+                            ),
+                        ),
+                    ),
+                ),
+            )
+        );
+
+        $mock = new MockAction();
+        add_filter( 'rest_post_dispatch', array( $mock, 'filter' ) );
+
+        $data = rest_get_server()->response_to_data( $response, true );
+
+        $embeds = wp_list_pluck( $data, '_embedded' );
+        $this->assertCount( 2, $embeds );
+        $this->assertArrayHasKey( 'author', $embeds[0] );
+        $this->assertArrayHasKey( 'author', $embeds[1] );
+
+        $this->assertCount( 1, $mock->get_events() );
     }