<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[47138] trunk: REST API: Reuse previously-generated embedded objects when building collection response.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/47138">47138</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/47138","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>kadamwhite</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-01-30 20:20:30 +0000 (Thu, 30 Jan 2020)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/48838">#48838</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiclasswprestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/class-wp-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2020-01-30 20:06:13 UTC (rev 47137)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2020-01-30 20:20:30 UTC (rev 47138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -79,6 +79,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $route_options = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Caches embedded requests.
+ *
+ * @since 5.4.0
+ * @var array
+ */
+ protected $embed_cache = array();
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Instantiates the REST server.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -462,6 +470,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $embed ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->embed_cache = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> // Determine if this is a numeric array.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( wp_is_numeric_array( $data ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array_map( array( $this, 'embed_links' ), $data );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -468,6 +477,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $this->embed_links( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->embed_cache = array();
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,24 +598,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Run through our internal routing and serve.
- $request = WP_REST_Request::from_url( $item['href'] );
- if ( ! $request ) {
- $embeds[] = array();
- continue;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Embedded resources get passed context=embed.
- if ( empty( $request['context'] ) ) {
- $request['context'] = 'embed';
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Embedded resources get passed context=embed.
+ if ( empty( $request['context'] ) ) {
+ $request['context'] = 'embed';
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = $this->dispatch( $request );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = $this->dispatch( $request );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /** 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 );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /** 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 );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $embeds[] = $this->response_to_data( $response, false );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->embed_cache[ $item['href'] ] = $this->response_to_data( $response, false );
+ }
+
+ $embeds[] = $this->embed_cache[ $item['href'] ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Determine if any real links were found.
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-server.php 2020-01-30 20:06:13 UTC (rev 47137)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2020-01-30 20:20:30 UTC (rev 47138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -678,6 +678,108 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @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() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Ensure embedding is a no-op without links in the data.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_link_embedding_without_links() {
</span></span></pre>
</div>
</div>
</body>
</html>