Changeset 44269

Timestamp:

12/17/2018 05:59:44 PM (6 years ago)

Author:

desrosj

Message:

REST API: Preserve unknown, respect null in server-side block rendering.

• Skips validation where there is no attribute definition, but keeps the attribute value. Previously, the attribute would be omitted from the attributes passed to render_callback. Notably, this resolves an issue where render_callback cannot receive a block's align and customClassName attribute values, since these are defined as a client-side filter.
• Validates null as a proper value in its own right. Previously, a client implementation of a block could track {“attribute":null} as an explicitly empty value, and the server would wrongly initiate defaulting behavior. The new behavior will now only populate a default value if the attribute is not defined at all, including when unset in its being invalid per the attribute schema.

Props aduth, noisysocks, youknowriad, danielbachhuber.

Merges [43918] to trunk.

See #45145 for the patch, #45098 for the original ticket.

Location:

trunk

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-block-type.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php (modified) (1 diff)
• tests/phpunit/tests/blocks/block-type.php (modified) (3 diffs)
• tests/phpunit/tests/rest-api/rest-block-renderer-controller.php (modified) (1 diff)
• tests/qunit/fixtures/wp-api-generated.js (modified) (6 diffs)

trunk/src/wp-includes/class-wp-block-type.php

@@ -124 +124 @@
     /**
      * Validates attributes against the current block schema, populating
-     * defaulted and missing values, and omitting unknown attributes.
+     * defaulted and missing values.
      *
      * @since 5.0.0
@@ -132 +132 @@
      */
     public function prepare_attributes_for_render( $attributes ) {
+        // If there are no attribute definitions for the block type, skip
+        // processing and return vebatim.
         if ( ! isset( $this->attributes ) ) {
             return $attributes;
         }
 
-        $prepared_attributes = array();
-
-        foreach ( $this->attributes as $attribute_name => $schema ) {
-            $value = null;
-
-            if ( isset( $attributes[ $attribute_name ] ) ) {
-                $is_valid = rest_validate_value_from_schema( $attributes[ $attribute_name ], $schema );
-                if ( ! is_wp_error( $is_valid ) ) {
-                    $value = rest_sanitize_value_from_schema( $attributes[ $attribute_name ], $schema );
-                }
+        foreach ( $attributes as $attribute_name => $value ) {
+            // If the attribute is not defined by the block type, it cannot be
+            // validated.
+            if ( ! isset( $this->attributes[ $attribute_name ] ) ) {
+                continue;
             }
 
-            if ( is_null( $value ) && isset( $schema['default'] ) ) {
-                $value = $schema['default'];
+            $schema = $this->attributes[ $attribute_name ];
+
+            // Validate value by JSON schema. An invalid value should revert to
+            // its default, if one exists. This occurs by virtue of the missing
+            // attributes loop immediately following. If there is not a default
+            // assigned, the attribute value should remain unset.
+            $is_valid = rest_validate_value_from_schema( $value, $schema );
+            if ( is_wp_error( $is_valid ) ) {
+                unset( $attributes[ $attribute_name ] );
             }
-
-            $prepared_attributes[ $attribute_name ] = $value;
-        }
-
-        return $prepared_attributes;
+        }
+
+        // Populate values of any missing attributes for which the block type
+        // defines a default.
+        $missing_schema_attributes = array_diff_key( $this->attributes, $attributes );
+        foreach ( $missing_schema_attributes as $attribute_name => $schema ) {
+            if ( isset( $schema['default'] ) ) {
+                $attributes[ $attribute_name ] = $schema['default'];
+            }
+        }
+
+        return $attributes;
     }
 

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-block-renderer-controller.php

@@ -62 +62 @@
                                 'additionalProperties' => false,
                                 'properties'           => $block_type->get_attributes(),
+                                'default'              => array(),
                             ),
                             'post_id'    => array(

trunk/tests/phpunit/tests/blocks/block-type.php

@@ -169 +169 @@
             'wrongTypeDefaulted' => 5,
             /* missingDefaulted */
-            'undefined'          => 'omit',
+            'undefined'          => 'include',
+            'intendedNull'       => null,
         );
 
@@ -190 +191 @@
                         'default' => 'define',
                     ),
+                    'intendedNull'       => array(
+                        'type'    => array( 'string', 'null' ),
+                        'default' => 'wrong',
+                    ),
                 ),
             )
@@ -199 +204 @@
             array(
                 'correct'            => 'include',
-                'wrongType'          => null,
+                /* wrongType */
                 'wrongTypeDefaulted' => 'defaulted',
                 'missingDefaulted'   => 'define',
+                'undefined'          => 'include',
+                'intendedNull'       => null,
             ),
             $prepared_attributes
         );
+    }
+
+    /**
+     * @ticket 45145
+     */
+    function test_prepare_attributes_none_defined() {
+        $attributes = array( 'exists' => 'keep' );
+
+        $block_type = new WP_Block_Type( 'core/dummy', array() );
+
+        $prepared_attributes = $block_type->prepare_attributes_for_render( $attributes );
+
+        $this->assertEquals( $attributes, $prepared_attributes );
     }
 

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

@@ -320 +320 @@
         $defaults   = array();
         foreach ( $block_type->attributes as $key => $attribute ) {
-            $defaults[ $key ] = isset( $attribute['default'] ) ? $attribute['default'] : null;
+            if ( isset( $attribute['default'] ) ) {
+                $defaults[ $key ] = $attribute['default'];
+            }
         }
 

trunk/tests/qunit/fixtures/wp-api-generated.js

@@ -4318 +4318 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/block block",
                             "type": "object"
@@ -4357 +4358 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/latest-comments block",
                             "type": "object"
@@ -4396 +4398 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/archives block",
                             "type": "object"
@@ -4435 +4438 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/categories block",
                             "type": "object"
@@ -4474 +4478 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/latest-posts block",
                             "type": "object"
@@ -4513 +4518 @@
                         "attributes": {
                             "required": false,
+                            "default": [],
                             "description": "Attributes for core/shortcode block",
                             "type": "object"