Changeset 50150 for trunk/tests/phpunit/tests/rest-api/rest-request.php

Timestamp:

02/02/2021 05:26:06 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Return detailed error information from request validation.

Previously, only the first error message for each parameter was made available. Now, all error messages for a parameter are concatenated. Additionally, the detailed error for each parameter is made available in a new details section of the validation error. Each error is formatted following the standard REST API error formatting.

The WP_REST_Server::error_to_response method has been abstracted out into a standalone function rest_convert_error_to_response to allow for reuse by WP_REST_Request. The formatted errors now also contain an additional_data property which contains the additional error data provided by WP_Error::get_all_error_data.

Props dlh, xkon, TimothyBlynJacobs.
Fixes #46191.

File:

• trunk/tests/phpunit/tests/rest-api/rest-request.php (modified) (2 diffs)

trunk/tests/phpunit/tests/rest-api/rest-request.php

@@ -463 +463 @@
     }
 
+    /**
+     * @ticket 46191
+     */
+    public function test_sanitize_params_error_multiple_messages() {
+        $this->request->set_url_params(
+            array(
+                'failparam' => '123',
+            )
+        );
+        $this->request->set_attributes(
+            array(
+                'args' => array(
+                    'failparam' => array(
+                        'sanitize_callback' => function () {
+                            $error = new WP_Error( 'invalid', 'Invalid.' );
+                            $error->add( 'invalid', 'Super Invalid.' );
+                            $error->add( 'broken', 'Broken.' );
+
+                            return $error;
+                        },
+                    ),
+                ),
+            )
+        );
+
+        $valid = $this->request->sanitize_params();
+        $this->assertWPError( $valid );
+        $data = $valid->get_error_data();
+
+        $this->assertInternalType( 'array', $data );
+        $this->assertArrayHasKey( 'params', $data );
+        $this->assertArrayHasKey( 'failparam', $data['params'] );
+        $this->assertEquals( 'Invalid. Super Invalid. Broken.', $data['params']['failparam'] );
+    }
+
+    /**
+     * @ticket 46191
+     */
+    public function test_sanitize_params_provides_detailed_errors() {
+        $this->request->set_url_params(
+            array(
+                'failparam' => '123',
+            )
+        );
+        $this->request->set_attributes(
+            array(
+                'args' => array(
+                    'failparam' => array(
+                        'sanitize_callback' => function () {
+                            return new WP_Error( 'invalid', 'Invalid.', 'mydata' );
+                        },
+                    ),
+                ),
+            )
+        );
+
+        $valid = $this->request->sanitize_params();
+        $this->assertWPError( $valid );
+
+        $data = $valid->get_error_data();
+        $this->assertArrayHasKey( 'details', $data );
+        $this->assertArrayHasKey( 'failparam', $data['details'] );
+        $this->assertEquals(
+            array(
+                'code'    => 'invalid',
+                'message' => 'Invalid.',
+                'data'    => 'mydata',
+            ),
+            $data['details']['failparam']
+        );
+    }
+
     public function test_sanitize_params_with_null_callback() {
         $this->request->set_url_params(
@@ -651 +723 @@
         $this->assertSame( array( 'someinteger', 'someotherparams' ), array_keys( $error_data['params'] ) );
         $this->assertSame( 'This is not valid!', $error_data['params']['someotherparams'] );
+    }
+
+
+    /**
+     * @ticket 46191
+     */
+    public function test_invalid_params_error_multiple_messages() {
+        $this->request->set_url_params(
+            array(
+                'failparam' => '123',
+            )
+        );
+        $this->request->set_attributes(
+            array(
+                'args' => array(
+                    'failparam' => array(
+                        'validate_callback' => function () {
+                            $error = new WP_Error( 'invalid', 'Invalid.' );
+                            $error->add( 'invalid', 'Super Invalid.' );
+                            $error->add( 'broken', 'Broken.' );
+
+                            return $error;
+                        },
+                    ),
+                ),
+            )
+        );
+
+        $valid = $this->request->has_valid_params();
+        $this->assertWPError( $valid );
+        $data = $valid->get_error_data();
+
+        $this->assertInternalType( 'array', $data );
+        $this->assertArrayHasKey( 'params', $data );
+        $this->assertArrayHasKey( 'failparam', $data['params'] );
+        $this->assertEquals( 'Invalid. Super Invalid. Broken.', $data['params']['failparam'] );
+    }
+
+    /**
+     * @ticket 46191
+     */
+    public function test_invalid_params_provides_detailed_errors() {
+        $this->request->set_url_params(
+            array(
+                'failparam' => '123',
+            )
+        );
+        $this->request->set_attributes(
+            array(
+                'args' => array(
+                    'failparam' => array(
+                        'validate_callback' => function () {
+                            return new WP_Error( 'invalid', 'Invalid.', 'mydata' );
+                        },
+                    ),
+                ),
+            )
+        );
+
+        $valid = $this->request->has_valid_params();
+        $this->assertWPError( $valid );
+
+        $data = $valid->get_error_data();
+        $this->assertArrayHasKey( 'details', $data );
+        $this->assertArrayHasKey( 'failparam', $data['details'] );
+        $this->assertEquals(
+            array(
+                'code'    => 'invalid',
+                'message' => 'Invalid.',
+                'data'    => 'mydata',
+            ),
+            $data['details']['failparam']
+        );
     }