<!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>[56566] trunk: REST API: Avoid unnecessarily preparing item links REST API index.</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/56566">56566</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/56566","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-09-13 14:32:33 +0000 (Wed, 13 Sep 2023)</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: Avoid unnecessarily preparing item links REST API index.
Building upon the changes introduced in <a href="https://core.trac.wordpress.org/changeset/53760">[53760]</a>, this commit refines the behavior of the REST API index. Specifically, it addresses performance concerns related to the unnecessary preparation of item links, such as site icon and logo links.
Prior to this update, the index controller was invoking the prepare_links method regardless of whether the _links or _embedded fields were requested in the response. This led to unnecessary database lookups and decreased overall performance.
In this commit, we implement a more efficient approach. Now, the prepare_links method will only be called when the _links or _embedded fields are explicitly requested in the response. This optimization ensures that we prepare links only when they are intended for inclusion in the API response, reducing unnecessary overhead.
By implementing this improvement, we enhance the overall efficiency and performance of the WordPress core REST API index controller.
Props spacedmonkey, niravsherasiya7707, dlh, mukesh27, costdev, swissspidy.
Fixes <a href="https://core.trac.wordpress.org/ticket/57902">#57902</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>
<li><a href="#trunktestsphpunittestsrestapiphp">trunk/tests/phpunit/tests/rest-api.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 2023-09-13 13:00:59 UTC (rev 56565)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2023-09-13 14:32:33 UTC (rev 56566)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1273,11 +1273,24 @@
</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"> $response = new WP_REST_Response( $available );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response->add_link( 'help', 'https://developer.wordpress.org/rest-api/' );
- $this->add_active_theme_link_to_index( $response );
- $this->add_site_logo_to_index( $response );
- $this->add_site_icon_to_index( $response );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $fields = isset( $request['_fields'] ) ? $request['_fields'] : '';
+ $fields = wp_parse_list( $fields );
+ if ( empty( $fields ) ) {
+ $fields[] = '_links';
+ }
+
+ if ( $request->has_param( '_embed' ) ) {
+ $fields[] = '_embedded';
+ }
+
+ if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
+ $response->add_link( 'help', 'https://developer.wordpress.org/rest-api/' );
+ $this->add_active_theme_link_to_index( $response );
+ $this->add_site_logo_to_index( $response );
+ $this->add_site_icon_to_index( $response );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the REST API root index data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</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 2023-09-13 13:00:59 UTC (rev 56565)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2023-09-13 14:32:33 UTC (rev 56566)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1120,6 +1120,59 @@
</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 57902
+ *
+ * @covers WP_REST_Server::get_index
+ */
+ public function test_get_index_fields_name() {
+ $server = new WP_REST_Server();
+
+ $request = new WP_REST_Request( 'GET', '/' );
+ $request->set_param( '_fields', 'name' );
+ $index = $server->dispatch( $request );
+ $index = rest_filter_response_fields( $index, $server, $request );
+ $data = $index->get_data();
+ $links = $index->get_links();
+
+ $this->assertArrayHasKey( 'name', $data );
+ $this->assertArrayNotHasKey( 'help', $links );
+ }
+
+ /**
+ * @ticket 57902
+ *
+ * @covers WP_REST_Server::get_index
+ *
+ * @dataProvider data_get_index_should_return_help_and_not_name
+ *
+ * @param string $field The field to add to the request.
+ */
+ public function test_get_index_should_return_help_and_not_name( $field ) {
+ $server = new WP_REST_Server();
+
+ $request = new WP_REST_Request( 'GET', '/' );
+ $request->set_param( '_fields', $field );
+ $index = $server->dispatch( $request );
+ $index = rest_filter_response_fields( $index, $server, $request );
+ $data = $index->get_data();
+ $links = $index->get_links();
+
+ $this->assertArrayNotHasKey( 'name', $data );
+ $this->assertArrayHasKey( 'help', $links );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @throws Exception
+ *
+ * @return array
+ */
+ public function data_get_index_should_return_help_and_not_name() {
+ return self::text_array_to_dataprovider( array( '_links', '_embedded' ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50152
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_index_includes_link_to_active_theme_if_authenticated() {
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api.php 2023-09-13 13:00:59 UTC (rev 56565)
+++ trunk/tests/phpunit/tests/rest-api.php 2023-09-13 14:32:33 UTC (rev 56566)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2512,10 +2512,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'description', $preload_data['/']['body'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertArrayHasKey( 'routes', $preload_data['/']['body'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Filtered request only has the desired fields + links
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Filtered request only has the desired fields.
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><span class="cx" style="display: block; padding: 0 10px"> array_keys( $preload_data['/?_fields=description']['body'] ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- array( 'description', '_links' )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( 'description' )
</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">
</span></span></pre>
</div>
</div>
</body>
</html>