Changeset 46563

Timestamp:

10/21/2019 07:08:34 PM (7 years ago)

Author:

kadamwhite

Message:

REST API: Cast empty meta values to correct scalar types in REST response.

Introducing complex meta value handling in [45807] unintentionally removed value casting for empty scalar meta values.

Props TimothyBlynJacobs, chrisvanpatten, rmccue, kadamwhite.
Fixes #48363.

Location:

trunk

Files:

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

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

@@ -431 +431 @@
 
                         if ( null === $rest_args['schema']['default'] ) {
-                                $rest_args['schema']['default'] = $this->get_default_for_type( $type );
+                                $rest_args['schema']['default'] = static::get_empty_value_for_type( $type );
                         }
 
@@ -502 +502 @@
                 }
 
+                if ( '' === $value && in_array( $schema['type'], array( 'boolean', 'integer', 'number' ), true ) ) {
+                        $value = static::get_empty_value_for_type( $schema['type'] );
+                }
+
                 if ( is_wp_error( rest_validate_value_from_schema( $value, $schema ) ) ) {
                         return null;
@@ -560 +564 @@
 
         /**
-         * Gets the default value for a schema type.
+         * Gets the empty value for a schema type.
          *
          * @since 5.3.0
@@ -567 +571 @@
          * @return mixed
          */
-        protected function get_default_for_type( $type ) {
+        protected static function get_empty_value_for_type( $type ) {
                 switch ( $type ) {
                         case 'string':

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

@@ -1980 +1980 @@
         /**
          * @ticket 43392
-         */
-        public function test_meta_values_are_not_set_to_null_in_response_if_type_safely_serializable() {
-                register_post_meta(
-                        'post',
-                        'boolean',
+         * @ticket 48363
+         * @dataProvider _dp_meta_values_are_not_set_to_null_in_response_if_type_safely_serializable
+         */
+        public function test_meta_values_are_not_set_to_null_in_response_if_type_safely_serializable( $type, $stored, $expected ) {
+                register_post_meta(
+                        'post',
+                        'safe',
                         array(
                                 'single'       => true,
                                 'show_in_rest' => true,
-                                'type'         => 'boolean',
-                        )
-                );
-
-                update_post_meta( self::$post_id, 'boolean', 'true' );
+                                'type'         => $type,
+                        )
+                );
+
+                update_post_meta( self::$post_id, 'safe', $stored );
 
                 $request  = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
                 $response = rest_get_server()->dispatch( $request );
 
-                $this->assertTrue( $response->get_data()['meta']['boolean'] );
+                $this->assertSame( $expected, $response->get_data()['meta']['safe'] );
+        }
+
+        public function _dp_meta_values_are_not_set_to_null_in_response_if_type_safely_serializable() {
+                return array(
+                        array( 'boolean', 'true', true ),
+                        array( 'boolean', 'false', false ),
+                        array( 'boolean', '1', true ),
+                        array( 'boolean', '0', false ),
+                        array( 'boolean', '', false ),
+                        array( 'integer', '', 0 ),
+                        array( 'integer', '1', 1 ),
+                        array( 'integer', '0', 0 ),
+                        array( 'number', '', 0.0 ),
+                        array( 'number', '1.1', 1.1 ),
+                        array( 'number', '0.0', 0.0 ),
+                        array( 'string', '', '' ),
+                        array( 'string', '1', '1' ),
+                        array( 'string', '0', '0' ),
+                        array( 'string', 'str', 'str' ),
+                );
         }
 
@@ -2600 +2622 @@
 
         /**
+         * @ticket 48363
+         */
+        public function test_boolean_meta_update_to_false_stores_0() {
+                $this->grant_write_permission();
+
+                register_post_meta(
+                        'post',
+                        'boolean',
+                        array(
+                                'single'            => true,
+                                'type'              => 'boolean',
+                                'show_in_rest'      => true,
+                                'sanitize_callback' => function( $value ) {
+                                        return $value ? '1' : '0';
+                                },
+                        )
+                );
+
+                update_post_meta( self::$post_id, 'boolean', 1 );
+
+                $request = new WP_REST_Request( 'PUT', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+                $request->set_body_params(
+                        array(
+                                'meta' => array(
+                                        'boolean' => false,
+                                ),
+                        )
+                );
+
+                $response = rest_get_server()->dispatch( $request );
+                $this->assertEquals( 200, $response->get_status() );
+                $this->assertEquals( '0', get_post_meta( self::$post_id, 'boolean', true ) );
+        }
+
+        /**
          * Internal function used to disable an insert query which
          * will trigger a wpdb error for testing purposes.