<!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>[47753] trunk: REST API: Support the uuid JSON Schema format.</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/47753">47753</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/47753","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-03 19:18:40 +0000 (Sun, 03 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: Support the uuid JSON Schema format.
This accepts a uuid of any version. A future commit could add support for restricting uuids to a specific version.
Props johnwatkins0.
Fixes <a href="https://core.trac.wordpress.org/ticket/50053">#50053</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiphp">trunk/src/wp-includes/rest-api.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestcontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemasanitizationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestschemavalidationphp">trunk/tests/phpunit/tests/rest-api/rest-schema-validation.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="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-03 14:41:03 UTC (rev 47752)
+++ trunk/src/wp-includes/rest-api.php 2020-05-03 19:18:40 UTC (rev 47753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1393,6 +1393,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_invalid_param', sprintf( __( '%s is not a valid IP address.' ), $param ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ case 'uuid':
+ if ( ! wp_is_uuid( $value ) ) {
+ /* translators: %s is the name of a JSON field expecting a valid uuid. */
+ return new WP_Error( 'rest_invalid_uuid', sprintf( __( '%s is not a valid UUID.' ), $param ) );
+ }
+ break;
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1549,6 +1555,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'ip':
</span><span class="cx" style="display: block; padding: 0 10px"> return sanitize_text_field( $value );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ case 'uuid':
+ return sanitize_text_field( $value );
</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="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-05-03 14:41:03 UTC (rev 47752)
+++ trunk/tests/phpunit/tests/rest-api/rest-controller.php 2020-05-03 19:18:40 UTC (rev 47753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,6 +43,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'format' => 'email',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'someuuid' => array(
+ 'type' => 'string',
+ 'format' => 'uuid',
+ ),
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,6 +208,20 @@
</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 50053
+ */
+ public function test_validate_schema_format_uuid() {
+ $this->assertTrue(
+ rest_validate_request_arg( '123e4567-e89b-12d3-a456-426655440000', $this->request, 'someuuid' )
+ );
+
+ $this->assertErrorResponse(
+ 'rest_invalid_uuid',
+ rest_validate_request_arg( '123e4567-e89b-12d3-a456-426655440000X', $this->request, 'someuuid' )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_get_endpoint_args_for_item_schema_description() {
</span><span class="cx" style="display: block; padding: 0 10px"> $controller = new WP_REST_Test_Controller();
</span><span class="cx" style="display: block; padding: 0 10px"> $args = $controller->get_endpoint_args_for_item_schema();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -245,6 +263,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'somedate',
</span><span class="cx" style="display: block; padding: 0 10px"> 'someemail',
</span><span class="cx" style="display: block; padding: 0 10px"> 'somehex',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'someuuid',
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,6 +294,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'somedate',
</span><span class="cx" style="display: block; padding: 0 10px"> 'someemail',
</span><span class="cx" style="display: block; padding: 0 10px"> 'somehex',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'someuuid',
</ins><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></span></pre></div>
<a id="trunktestsphpunittestsrestapirestschemasanitizationphp"></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-sanitization.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-sanitization.php 2020-05-03 14:41:03 UTC (rev 47752)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php 2020-05-03 19:18:40 UTC (rev 47753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -90,6 +90,22 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '', rest_sanitize_value_from_schema( 'WordPress', $schema ) );
</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 50053
+ */
+ public function test_format_uuid() {
+ $schema = array(
+ 'type' => 'string',
+ 'format' => 'uuid',
+ );
+ $this->assertEquals( '44', rest_sanitize_value_from_schema( 44, $schema ) );
+ $this->assertEquals( 'hello', rest_sanitize_value_from_schema( 'hello', $schema ) );
+ $this->assertEquals(
+ '123e4567-e89b-12d3-a456-426655440000',
+ rest_sanitize_value_from_schema( '123e4567-e89b-12d3-a456-426655440000', $schema )
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_type_array() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'array',
</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-03 14:41:03 UTC (rev 47752)
+++ trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php 2020-05-03 19:18:40 UTC (rev 47753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -85,6 +85,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertWPError( rest_validate_value_from_schema( 'WordPress', $schema ) );
</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 50053
+ */
+ public function test_format_uuid() {
+ $schema = array(
+ 'type' => 'string',
+ 'format' => 'uuid',
+ );
+ $this->assertTrue( rest_validate_value_from_schema( '123e4567-e89b-12d3-a456-426655440000', $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( '123e4567-e89b-12d3-a456-426655440000X', $schema ) );
+ $this->assertWPError( rest_validate_value_from_schema( '123e4567-e89b-?2d3-a456-426655440000', $schema ) );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_format_date_time() {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</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-05-03 14:41:03 UTC (rev 47752)
+++ trunk/tests/phpunit/tests/rest-api/rest-test-controller.php 2020-05-03 19:18:40 UTC (rev 47753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,6 +69,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'format' => 'hex-color',
</span><span class="cx" style="display: block; padding: 0 10px"> 'context' => array( 'view' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'someuuid' => array(
+ 'type' => 'string',
+ 'format' => 'uuid',
+ 'context' => array( 'view' ),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'someenum' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'enum' => array( 'a', 'b', 'c' ),
</span></span></pre>
</div>
</div>
</body>
</html>