Changeset 47753

Timestamp:

05/03/2020 07:18:40 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

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

Location:

trunk

Files:

• src/wp-includes/rest-api.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-controller.php (modified) (4 diffs)
• tests/phpunit/tests/rest-api/rest-schema-sanitization.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-schema-validation.php (modified) (1 diff)
• tests/phpunit/tests/rest-api/rest-test-controller.php (modified) (1 diff)

trunk/src/wp-includes/rest-api.php

@@ -1392 +1392 @@
                     /* translators: %s: IP address. */
                     return new WP_Error( 'rest_invalid_param', sprintf( __( '%s is not a valid IP address.' ), $param ) );
+                }
+                break;
+            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;
@@ -1550 +1556 @@
             case 'ip':
                 return sanitize_text_field( $value );
+
+            case 'uuid':
+                return sanitize_text_field( $value );
         }
     }

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

@@ -44 +44 @@
                         'format' => 'email',
                     ),
+                    'someuuid'    => array(
+                        'type'   => 'string',
+                        'format' => 'uuid',
+                    ),
                 ),
             )
@@ -202 +206 @@
             'rest_invalid_date',
             rest_validate_request_arg( '2010-18-18T12:00:00', $this->request, 'somedate' )
+        );
+    }
+
+    /**
+     * @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' )
         );
     }
@@ -246 +264 @@
                 'someemail',
                 'somehex',
+                'someuuid',
                 'someenum',
                 'someargoptions',
@@ -276 +295 @@
                     'someemail',
                     'somehex',
+                    'someuuid',
                     'someenum',
                     'someargoptions',

trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

@@ -91 +91 @@
     }
 
+    /**
+     * @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 )
+        );
+    }
+
     public function test_type_array() {
         $schema = array(

trunk/tests/phpunit/tests/rest-api/rest-schema-validation.php

@@ -84 +84 @@
         $this->assertTrue( rest_validate_value_from_schema( '#FFF', $schema ) );
         $this->assertWPError( rest_validate_value_from_schema( 'WordPress', $schema ) );
+    }
+
+    /**
+     * @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 ) );
     }
 

trunk/tests/phpunit/tests/rest-api/rest-test-controller.php

@@ -70 +70 @@
                     'context' => array( 'view' ),
                 ),
+                'someuuid'       => array(
+                    'type'    => 'string',
+                    'format'  => 'uuid',
+                    'context' => array( 'view' ),
+                ),
                 'someenum'       => array(
                     'type'    => 'string',