<!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>[48555] trunk: REST API: Optimize rest_filter_response_by_context performance.</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/48555">48555</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/48555","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>TimothyBlynJacobs</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-07-21 21:20:22 +0000 (Tue, 21 Jul 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: Optimize rest_filter_response_by_context performance.
In <a href="https://core.trac.wordpress.org/changeset/47758">[47758]</a> a new function `rest_filter_response_by_context` was introduced to expand the JSON schema features supported by the context filtering mechanism.
This commit improves the performance of that function by eliminating repetitive comparisons and loops. Additionally, it improves multi-type support for object + array types.
Fixes <a href="https://core.trac.wordpress.org/ticket/50700">#50700</a>.
Props dlh.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.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="trunksrcwpincludesrestapiphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api.php 2020-07-21 21:04:57 UTC (rev 48554)
+++ trunk/src/wp-includes/rest-api.php 2020-07-21 21:20:22 UTC (rev 48555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2052,15 +2052,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $data;
</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">+ $is_array_type = 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) );
+ $is_object_type = 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) );
+
+ if ( $is_array_type && $is_object_type ) {
+ if ( rest_is_array( $data ) ) {
+ $is_object_type = false;
+ } else {
+ $is_array_type = false;
+ }
+ }
+
+ $has_additional_properties = $is_object_type && isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $data as $key => $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $check = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'array' === $type || ( is_array( $type ) && in_array( 'array', $type, true ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $is_array_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $check = isset( $schema['items'] ) ? $schema['items'] : array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( 'object' === $type || ( is_array( $type ) && in_array( 'object', $type, true ) ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $is_object_type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $schema['properties'][ $key ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $check = $schema['properties'][ $key ];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( isset( $schema['additionalProperties'] ) && is_array( $schema['additionalProperties'] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $has_additional_properties ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $check = $schema['additionalProperties'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2070,6 +2083,12 @@
</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 ( ! in_array( $context, $check['context'], true ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $is_array_type ) {
+ // All array items share schema, so there's no need to check each one.
+ $data = array();
+ break;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_object( $data ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $data->$key );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</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 2020-07-21 21:04:57 UTC (rev 48554)
+++ trunk/tests/phpunit/tests/rest-api.php 2020-07-21 21:20:22 UTC (rev 48555)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1085,7 +1085,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function _dp_rest_filter_response_by_context() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'default' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'default' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1106,7 +1106,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'first' => 'a' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'keeps missing context' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'keeps missing context' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1129,7 +1129,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'second' => 'b',
</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">- 'removes empty context' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'removes empty context' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1150,7 +1150,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'first' => 'a' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'nested properties' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'nested properties' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1179,7 +1179,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'parent' => array( 'child' => 'hi' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'grand child properties' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'grand child properties' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1215,7 +1215,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'parent' => array( 'child' => array( 'grand' => 'hi' ) ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'array' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'array' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1250,7 +1250,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'arr' => array( array( 'visible' => 'hi' ) ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'additional properties' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'additional properties' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1284,7 +1284,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'additional' => array( 'a' => '1' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'multiple types object' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'multiple types object' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1313,7 +1313,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'multi' => array( 'a' => '1' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'multiple types array' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'multiple types array' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1348,7 +1348,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'multi' => array( array( 'visible' => '1' ) ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'grand child properties does not traverses missing context' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'does not traverse missing context' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1391,6 +1391,126 @@
</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">+ 'object with no matching properties' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ array(
+ 'a' => 'hi',
+ 'b' => 'hello',
+ ),
+ array(),
+ ),
+ 'array whose type does not match' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => 'object',
+ 'properties' => array(
+ 'arr' => array(
+ 'type' => 'array',
+ 'context' => array( 'view' ),
+ 'items' => array(
+ 'type' => 'string',
+ 'context' => array( 'edit' ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'arr' => array( 'foo', 'bar', 'baz' ),
+ ),
+ array( 'arr' => array() ),
+ ),
+ 'array and object type passed object' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => array( 'array', 'object' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ ),
+ 'items' => array(
+ 'type' => 'object',
+ 'context' => array( 'edit' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ 'a' => 'foo',
+ 'b' => 'bar',
+ ),
+ array(
+ 'a' => 'foo',
+ 'b' => 'bar',
+ ),
+ ),
+ 'array and object type passed array' => array(
+ array(
+ '$schema' => 'http://json-schema.org/draft-04/schema#',
+ 'type' => array( 'array', 'object' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ ),
+ 'items' => array(
+ 'type' => 'object',
+ 'context' => array( 'edit' ),
+ 'properties' => array(
+ 'a' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ 'b' => array(
+ 'type' => 'string',
+ 'context' => array( 'view' ),
+ ),
+ ),
+ ),
+ ),
+ array(
+ array(
+ 'a' => 'foo',
+ 'b' => 'bar',
+ ),
+ array(
+ 'a' => 'foo',
+ 'b' => 'bar',
+ ),
+ ),
+ 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">
</span></span></pre>
</div>
</div>
</body>
</html>