Changeset 57611

Timestamp:

02/13/2024 09:55:38 AM (10 months ago)

Author:

spacedmonkey

Message:

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 #48823.

Location:

trunk

Files:

• src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php (modified) (8 diffs)
• tests/phpunit/tests/rest-api/rest-post-meta-fields.php (modified) (1 diff)

trunk/src/wp-includes/rest-api/fields/class-wp-rest-meta-fields.php

@@ -142 +142 @@
     public function update_value( $meta, $object_id ) {
         $fields = $this->get_registered_fields();
+        $error  = new WP_Error();
 
         foreach ( $fields as $meta_key => $args ) {
@@ -164 +165 @@
 
                     if ( is_wp_error( rest_validate_value_from_schema( $current, $args['schema'] ) ) ) {
-                        return new WP_Error(
+                        $error->add(
                             'rest_invalid_stored_value',
                             /* translators: %s: Custom field key. */
@@ -170 +171 @@
                             array( 'status' => 500 )
                         );
+                        continue;
                     }
                 }
@@ -175 +177 @@
                 $result = $this->delete_meta_value( $object_id, $meta_key, $name );
                 if ( is_wp_error( $result ) ) {
-                    return $result;
+                    $error->merge_from( $result );
                 }
                 continue;
@@ -181 +183 @@
 
             if ( ! $args['single'] && is_array( $value ) && count( array_filter( $value, 'is_null' ) ) ) {
-                return new WP_Error(
+                $error->add(
                     'rest_invalid_stored_value',
                     /* translators: %s: Custom field key. */
@@ -187 +189 @@
                     array( 'status' => 500 )
                 );
+                continue;
             }
 
@@ -192 +195 @@
             if ( is_wp_error( $is_valid ) ) {
                 $is_valid->add_data( array( 'status' => 400 ) );
-                return $is_valid;
+                $error->merge_from( $is_valid );
+                continue;
             }
 
@@ -204 +208 @@
 
             if ( is_wp_error( $result ) ) {
-                return $result;
-            }
+                $error->merge_from( $result );
+                continue;
+            }
+        }
+
+        if ( $error->has_errors() ) {
+            return $error;
         }
 

trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php

@@ -3097 +3097 @@
 
     /**
+     * @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() );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.