Changeset 48306 for trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

Timestamp:

07/05/2020 12:13:37 AM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Make multi-typed schemas more robust.

A multi-type schema is a schema where the type keyword is an array of possible types instead of a single type. For instance, [ 'object', 'string' ] would allow objects or string values.

In [46249] basic support for these schemas was introduced. The validator would loop over each schema type trying to find a version that matched. This worked for valid values, but for invalid values it provided unhelpful error messages. The sanitizer also had its utility restricted.

In this commit, the validators and sanitizers will first determine the best type of the passed value and then apply the schema with that set type. In the case that a value could match multiple types, the schema of the first matching type will be used.

To maintain backward compatibility, if unsupported schema types are used, the value will always pass validation. A doing it wrong notice is issued in this case.

Fixes #50300.
Props pentatonicfunk, dlh, TimothyBlynJacobs.

File:

• trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php (modified) (3 diffs)

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

@@ -342 +342 @@
         $this->assertNull( rest_sanitize_value_from_schema( null, $schema ) );
         $this->assertEquals( '2019-09-19T18:00:00', rest_sanitize_value_from_schema( '2019-09-19T18:00:00', $schema ) );
-        $this->assertNull( rest_sanitize_value_from_schema( 'lalala', $schema ) );
+        $this->assertEquals( 'lalala', rest_sanitize_value_from_schema( 'lalala', $schema ) );
     }
 
@@ -395 +395 @@
         $this->assertEquals( 'My Value', rest_sanitize_value_from_schema( 'My Value', $schema ) );
         $this->assertEquals( array( 'raw' => 'My Value' ), rest_sanitize_value_from_schema( array( 'raw' => 'My Value' ), $schema ) );
-        $this->assertNull( rest_sanitize_value_from_schema( array( 'raw' => 1 ), $schema ) );
+        $this->assertEquals( array( 'raw' => '1' ), rest_sanitize_value_from_schema( array( 'raw' => 1 ), $schema ) );
     }
 
@@ -424 +424 @@
         $this->assertEquals( array( 'raw' => false ), rest_sanitize_value_from_schema( array( 'raw' => 0 ), $schema ) );
 
-        $this->assertNull( rest_sanitize_value_from_schema( array( 'raw' => 'something non boolean' ), $schema ) );
+        $this->assertEquals( array( 'raw' => true ), rest_sanitize_value_from_schema( array( 'raw' => 'something non boolean' ), $schema ) );
+    }
+
+    /**
+     * @ticket 50300
+     */
+    public function test_multi_type_with_no_known_types() {
+        $this->setExpectedIncorrectUsage( 'rest_handle_multi_type_schema' );
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+        $schema = array(
+            'type' => array( 'invalid', 'type' ),
+        );
+
+        $this->assertEquals( 'My Value', rest_sanitize_value_from_schema( 'My Value', $schema ) );
+    }
+
+    /**
+     * @ticket 50300
+     */
+    public function test_multi_type_with_some_unknown_types() {
+        $this->setExpectedIncorrectUsage( 'rest_handle_multi_type_schema' );
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+        $schema = array(
+            'type' => array( 'object', 'type' ),
+        );
+
+        $this->assertEquals( 'My Value', rest_sanitize_value_from_schema( 'My Value', $schema ) );
+    }
+
+    /**
+     * @ticket 50300
+     */
+    public function test_multi_type_returns_null_if_no_valid_type() {
+        $schema = array(
+            'type' => array( 'number', 'string' ),
+        );
+
+        $this->assertNull( rest_sanitize_value_from_schema( array( 'Hello!' ), $schema ) );
     }
 }