<!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>[57611] trunk: REST API: Improve error handling in REST meta fields</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/57611">57611</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/57611","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>2024-02-13 09:55:38 +0000 (Tue, 13 Feb 2024)</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: Improve error handling in REST meta fields
This update modifies the error handling mechanism in the REST API meta fields functionality. Instead of halting execution and returning on the first encountered error, it now collects all errors in a WP_Error object and continues execution. Thus, this enhancement enables handling and displaying of multiple errors in a single response, improving the debugging process.
Props TimothyBlynJacobs, spacedmonkey, hellofromTonya, oglekler.
Fixes <a href="https://core.trac.wordpress.org/ticket/48823">#48823</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapifieldsclasswprestmetafieldsphp">trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestpostmetafieldsphp">trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapifieldsclasswprestmetafieldsphp"></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/fields/class-wp-rest-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2024-02-13 09:08:43 UTC (rev 57610)
+++ trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php 2024-02-13 09:55:38 UTC (rev 57611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,6 +141,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_value( $meta, $object_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = $this->get_registered_fields();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error = new WP_Error();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $fields as $meta_key => $args ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = $args['name'];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,35 +164,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $current = get_metadata( $this->get_meta_type(), $object_id, $meta_key, true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( rest_validate_value_from_schema( $current, $args['schema'] ) ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->add(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'rest_invalid_stored_value',
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: Custom field key. */
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'status' => 500 )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ continue;
</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="cx" style="display: block; padding: 0 10px"> $result = $this->delete_meta_value( $object_id, $meta_key, $name );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $result ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $result;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->merge_from( $result );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</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 ( ! $args['single'] && is_array( $value ) && count( array_filter( $value, 'is_null' ) ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->add(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'rest_invalid_stored_value',
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: Custom field key. */
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf( __( 'The %s property has an invalid stored value, and cannot be updated to null.' ), $name ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( 'status' => 500 )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ continue;
</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"> $is_valid = rest_validate_value_from_schema( $value, $args['schema'], 'meta.' . $name );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $is_valid ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $is_valid->add_data( array( 'status' => 400 ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $is_valid;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->merge_from( $is_valid );
+ continue;
</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"> $value = rest_sanitize_value_from_schema( $value, $args['schema'] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -203,10 +207,15 @@
</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 ( is_wp_error( $result ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $result;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error->merge_from( $result );
+ continue;
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $error->has_errors() ) {
+ return $error;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return null;
</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="trunktestsphpunittestsrestapirestpostmetafieldsphp"></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-post-meta-fields.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2024-02-13 09:08:43 UTC (rev 57610)
+++ trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php 2024-02-13 09:55:38 UTC (rev 57611)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3096,6 +3096,52 @@
</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 48823
+ */
+ public function test_multiple_errors_are_returned_at_once() {
+ $this->grant_write_permission();
+ register_post_meta(
+ 'post',
+ 'error_1',
+ array(
+ 'single' => true,
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'enum' => array( 'a', 'b' ),
+ ),
+ ),
+ )
+ );
+ register_post_meta(
+ 'post',
+ 'error_2',
+ array(
+ 'single' => true,
+ 'show_in_rest' => array(
+ 'schema' => array(
+ 'minLength' => 1,
+ ),
+ ),
+ )
+ );
+
+ $request = new WP_REST_Request( 'PUT', '/wp/v2/posts/' . self::$post_id );
+ $request->set_body_params(
+ array(
+ 'meta' => array(
+ 'error_1' => 'c',
+ 'error_2' => '',
+ ),
+ )
+ );
+ $response = rest_do_request( $request );
+ $error = $response->as_error();
+ $this->assertWPError( $error );
+ $this->assertContains( 'meta.error_1 is not one of a and b.', $error->get_error_messages() );
+ $this->assertContains( 'meta.error_2 must be at least 1 character long.', $error->get_error_messages() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Internal function used to disable an insert query which
</span><span class="cx" style="display: block; padding: 0 10px"> * will trigger a wpdb error for testing purposes.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>