<!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>[47809] trunk: REST API: Check required properties are provided when validating an object.</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/47809">47809</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/47809","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-05-16 18:41:41 +0000 (Sat, 16 May 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: Check required properties are provided when validating an object.
Previously, the WP_REST_Request object validated that top-level properties were defined, but this did not extend to those object's required properties. This adds validation to rest_validate_value_from_schema() directly.
Both the v3 and v4 JSON Schema syntax for required properties is supported.
Props sorenbronsted.
Fixes <a href="https://core.trac.wordpress.org/ticket/48818">#48818</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemavalidationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-validation.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-05-16 18:40:52 UTC (rev 47808)
+++ trunk/src/wp-includes/rest-api.php 2020-05-16 18:41:41 UTC (rev 47809)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1284,6 +1284,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_invalid_param', sprintf( __( '%1$s is not of type %2$s.' ), $param, 'object' ) );
</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">+ if ( isset( $args['required'] ) && is_array( $args['required'] ) ) { // schema version 4
+ foreach ( $args['required'] as $name ) {
+ if ( ! array_key_exists( $name, $value ) ) {
+ /* translators: 1: Property of an object, 2: Parameter. */
+ return new WP_Error( 'rest_property_required', sprintf( __( '%1$s is a required property of %2$s.' ), $name, $param ) );
+ }
+ }
+ } elseif ( isset( $args['properties'] ) ) { // schema version 3
+ foreach ( $args['properties'] as $name => $property ) {
+ if ( isset( $property['required'] ) && true === $property['required'] && ! array_key_exists( $name, $value ) ) {
+ /* translators: 1: Property of an object, 2: Parameter. */
+ return new WP_Error( 'rest_property_required', sprintf( __( '%1$s is a required property of %2$s.' ), $name, $param ) );
+ }
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $value as $property => $v ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $args['properties'][ $property ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $is_valid = rest_validate_value_from_schema( $v, $args['properties'][ $property ], $param . '[' . $property . ']' );
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemavalidationphp"></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-schema-validation.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-05-16 18:40:52 UTC (rev 47808)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-05-16 18:41:41 UTC (rev 47809)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2,7 +2,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Unit tests covering schema validation and sanitization functionality.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @package WordPress
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @package WordPress
</ins><span class="cx" style="display: block; padding: 0 10px"> * @subpackage REST API
</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">@@ -409,4 +409,322 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // three supplementary Unicode code point is to long
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( rest_validate_value_from_schema( $mb_char . $mb_char . $mb_char, $schema ) );
</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 48818
+ * @dataProvider data_required_property
+ */
+ public function test_property_is_required( $data, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_prop' => array(
+ 'type' => 'string',
+ ),
+ 'my_required_prop' => array(
+ 'type' => 'string',
+ 'required' => true,
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $data, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_property
+ */
+ public function test_property_is_required_v4( $data, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_prop' => array(
+ 'type' => 'string',
+ ),
+ 'my_required_prop' => array(
+ 'type' => 'string',
+ ),
+ ),
+ 'required' => array( 'my_required_prop' ),
+ );
+
+ $valid = rest_validate_value_from_schema( $data, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ public function data_required_property() {
+ return array(
+ array(
+ array(
+ 'my_required_prop' => 'test',
+ 'my_prop' => 'test',
+ ),
+ true,
+ ),
+ array( array( 'my_prop' => 'test' ), false ),
+ array( array(), false ),
+ );
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_nested_property
+ */
+ public function test_nested_property_is_required( $data, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_object' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_nested_prop' => array(
+ 'type' => 'string',
+ ),
+ 'my_required_nested_prop' => array(
+ 'type' => 'string',
+ 'required' => true,
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $data, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_nested_property
+ */
+ public function test_nested_property_is_required_v4( $data, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_object' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'my_nested_prop' => array(
+ 'type' => 'string',
+ ),
+ 'my_required_nested_prop' => array(
+ 'type' => 'string',
+ ),
+ ),
+ 'required' => array( 'my_required_nested_prop' ),
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $data, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ public function data_required_nested_property() {
+ return array(
+ array(
+ array(
+ 'my_object' => array(
+ 'my_required_nested_prop' => 'test',
+ 'my_nested_prop' => 'test',
+ ),
+ ),
+ true,
+ ),
+ array(
+ array(
+ 'my_object' => array(
+ 'my_nested_prop' => 'test',
+ ),
+ ),
+ false,
+ ),
+ array(
+ array(),
+ true,
+ ),
+ );
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_deeply_nested_property
+ */
+ public function test_deeply_nested_v3_required_property( $value, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'propA' => array(
+ 'type' => 'object',
+ 'required' => true,
+ 'properties' => array(
+ 'propB' => array(
+ 'type' => 'object',
+ 'required' => true,
+ 'properties' => array(
+ 'propC' => array(
+ 'type' => 'string',
+ 'required' => true,
+ ),
+ 'propD' => array(
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $value, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_deeply_nested_property
+ */
+ public function test_deeply_nested_v4_required_property( $value, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'required' => array( 'propA' ),
+ 'properties' => array(
+ 'propA' => array(
+ 'type' => 'object',
+ 'required' => array( 'propB' ),
+ 'properties' => array(
+ 'propB' => array(
+ 'type' => 'object',
+ 'required' => array( 'propC' ),
+ 'properties' => array(
+ 'propC' => array(
+ 'type' => 'string',
+ ),
+ 'propD' => array(
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $value, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ /**
+ * @ticket 48818
+ * @dataProvider data_required_deeply_nested_property
+ */
+ public function test_deeply_nested_mixed_version_required_property( $value, $expected ) {
+ $schema = array(
+ 'type' => 'object',
+ 'required' => array( 'propA' ),
+ 'properties' => array(
+ 'propA' => array(
+ 'type' => 'object',
+ 'required' => array( 'propB' ),
+ 'properties' => array(
+ 'propB' => array(
+ 'type' => 'object',
+ 'properties' => array(
+ 'propC' => array(
+ 'type' => 'string',
+ 'required' => true,
+ ),
+ 'propD' => array(
+ 'type' => 'string',
+ ),
+ ),
+ ),
+ ),
+ ),
+ ),
+ );
+
+ $valid = rest_validate_value_from_schema( $value, $schema );
+
+ if ( $expected ) {
+ $this->assertTrue( $valid );
+ } else {
+ $this->assertWPError( $valid );
+ }
+ }
+
+ public function data_required_deeply_nested_property() {
+ return array(
+ array(
+ array(),
+ false,
+ ),
+ array(
+ array(
+ 'propA' => array(),
+ ),
+ false,
+ ),
+ array(
+ array(
+ 'propA' => array(
+ 'propB' => array(),
+ ),
+ ),
+ false,
+ ),
+ array(
+ array(
+ 'propA' => array(
+ 'propB' => array(
+ 'propD' => 'd',
+ ),
+ ),
+ ),
+ false,
+ ),
+ array(
+ array(
+ 'propA' => array(
+ 'propB' => array(
+ 'propC' => 'c',
+ ),
+ ),
+ ),
+ true,
+ ),
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>