<!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>[47911] trunk: REST API: Ensure that all properties of `get_endpoint_args_for_item_schema` are listed.</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/47911">47911</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/47911","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>whyisjake</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-06-04 16:41:47 +0000 (Thu, 04 Jun 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: Ensure that all properties of `get_endpoint_args_for_item_schema` are listed.
* Add new var $valid_schema_properties to match rest_validate_value_from_schema()
* Unit test to ensure all valid properties exists, and non-valid properties are ignored
Fixes: <a href="https://core.trac.wordpress.org/ticket/50301">#50301</a>.
Props: pentatonicfunk, TimothyBlynJacobs.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiresttestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-test-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestcontrollerphp"></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/endpoints/class-wp-rest-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-06-04 15:46:00 UTC (rev 47910)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-controller.php 2020-06-04 16:41:47 UTC (rev 47911)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -626,9 +626,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $schema = $this->get_item_schema();
- $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
- $endpoint_args = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $schema = $this->get_item_schema();
+ $schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
+ $endpoint_args = array();
+ $valid_schema_properties = array(
+ 'type',
+ 'format',
+ 'enum',
+ 'items',
+ 'properties',
+ 'additionalProperties',
+ 'minimum',
+ 'maximum',
+ 'exclusiveMinimum',
+ 'exclusiveMaximum',
+ 'minLength',
+ 'maxLength',
+ 'pattern',
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $schema_properties as $field_id => $params ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -654,7 +669,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $endpoint_args[ $field_id ]['required'] = true;
</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">- foreach ( array( 'type', 'format', 'enum', 'items', 'properties', 'additionalProperties' ) as $schema_prop ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $valid_schema_properties as $schema_prop ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $params[ $schema_prop ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestcontrollerphp"></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-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-06-04 15:46:00 UTC (rev 47910)
+++ trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-06-04 16:41:47 UTC (rev 47911)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -248,6 +248,33 @@
</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 50301
+ */
+ public function test_get_endpoint_args_for_item_schema_arg_properties() {
+
+ $controller = new WP_REST_Test_Controller();
+ $args = $controller->get_endpoint_args_for_item_schema();
+
+ foreach ( array( 'minLength', 'maxLength', 'pattern' ) as $property ) {
+ $this->assertArrayHasKey( $property, $args['somestring'] );
+ }
+
+ foreach ( array( 'minimum', 'maximum', 'exclusiveMinimum', 'exclusiveMaximum' ) as $property ) {
+ $this->assertArrayHasKey( $property, $args['someinteger'] );
+ }
+
+ $this->assertArrayHasKey( 'items', $args['somearray'] );
+
+ foreach ( array( 'properties', 'additionalProperties' ) as $property ) {
+ $this->assertArrayHasKey( $property, $args['someobject'] );
+ }
+
+ // ignored properties
+ $this->assertArrayNotHasKey( 'ignored_prop', $args['someobject'] );
+
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_get_fields_for_response,
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_fields_for_response( $param, $expected ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,6 +294,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'someenum',
</span><span class="cx" style="display: block; padding: 0 10px"> 'someargoptions',
</span><span class="cx" style="display: block; padding: 0 10px"> 'somedefault',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'somearray',
+ 'someobject',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $fields
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,6 +327,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'someenum',
</span><span class="cx" style="display: block; padding: 0 10px"> 'someargoptions',
</span><span class="cx" style="display: block; padding: 0 10px"> 'somedefault',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'somearray',
+ 'someobject',
</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>
<a id="trunktestsphpunittestsrestapiresttestcontrollerphp"></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-test-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-test-controller.php 2020-06-04 15:46:00 UTC (rev 47910)
+++ trunk/tests/phpunit/tests/rest-api/rest-test-controller.php 2020-06-04 16:41:47 UTC (rev 47911)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,11 +39,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'somestring' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => 'A pretty string.',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'minLength' => 3,
+ 'maxLength' => 3,
+ 'pattern' => '[a-zA-Z]+',
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'someinteger' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'type' => 'integer',
- 'context' => array( 'view' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'type' => 'integer',
+ 'minimum' => 100,
+ 'maximum' => 200,
+ 'exclusiveMinimum' => true,
+ 'exclusiveMaximum' => true,
+ 'context' => array( 'view' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'someboolean' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'boolean',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -93,6 +100,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => 'a',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'somearray' => array(
+ 'type' => 'array',
+ 'items' => array(
+ 'type' => 'string',
+ ),
+ 'context' => array( 'view' ),
+ ),
+ 'someobject' => array(
+ 'type' => 'object',
+ 'additionalProperties' => array(
+ 'type' => 'string',
+ ),
+ 'properties' => array(
+ 'object_id' => array(
+ 'type' => 'integer',
+ ),
+ ),
+ 'ignored_prop' => 'ignored_prop',
+ 'context' => array( 'view' ),
+ ),
</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>