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

Timestamp:

07/07/2020 08:45:55 PM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API, Meta: Introduce support for default metadata values.

The register_meta() API now officially supports specifying a default metadata value. When get_metadata() is called for a meta key that does not yet exist for the object, this default value will be returned instead of an empty string.

A new function is introduced get_metadata_raw to retrieve the raw metadata value from the database, without applying the registered default.

Props spacedmonkey, flixos90, rmccue, kadamwhite, mnelson4, johnbillion, chrisvanpatten, TimothyBlynJacobs.
Fixes #43941.

File:

• trunk/tests/phpunit/tests/rest-api/rest-post-meta-fields.php (modified) (2 diffs)

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

@@ -232 +232 @@
                 'type'         => 'string',
                 'show_in_rest' => true,
+            )
+        );
+
+        register_post_meta(
+            'post',
+            'with_default',
+            array(
+                'type'         => 'string',
+                'single'       => true,
+                'show_in_rest' => true,
+                'default'      => 'Goodnight Moon',
             )
         );
@@ -2787 +2798 @@
 
     /**
+     * @ticket 43941
+     * @dataProvider data_get_default_data
+     */
+    public function test_get_default_value( $args, $expected ) {
+        $object_type = 'post';
+        $meta_key    = 'registered_key1';
+        $registered  = register_meta(
+            $object_type,
+            $meta_key,
+            $args
+        );
+
+        $this->assertTrue( $registered );
+
+        // Check for default value.
+        $request  = new WP_REST_Request( 'GET', sprintf( '/wp/v2/posts/%d', self::$post_id ) );
+        $response = rest_get_server()->dispatch( $request );
+
+        $this->assertEquals( 200, $response->get_status() );
+
+        $data = $response->get_data();
+        $this->assertArrayHasKey( 'meta', $data );
+
+        $meta = (array) $data['meta'];
+        $this->assertArrayHasKey( $meta_key, $meta );
+        $this->assertEquals( $expected, $meta[ $meta_key ] );
+    }
+
+    public function data_get_default_data() {
+        return array(
+            array(
+                array(
+                    'show_in_rest' => true,
+                    'single'       => true,
+                    'default'      => 'wibble',
+                ),
+                'wibble',
+            ),
+            array(
+                array(
+                    'show_in_rest' => true,
+                    'single'       => false,
+                    'default'      => 'wibble',
+                ),
+                array( 'wibble' ),
+            ),
+            array(
+                array(
+                    'show_in_rest'   => true,
+                    'single'         => true,
+                    'object_subtype' => 'post',
+                    'default'        => 'wibble',
+                ),
+                'wibble',
+            ),
+            array(
+                array(
+                    'show_in_rest'   => true,
+                    'single'         => false,
+                    'object_subtype' => 'post',
+                    'default'        => 'wibble',
+                ),
+                array( 'wibble' ),
+            ),
+            array(
+                array(
+                    'single'       => true,
+                    'show_in_rest' => array(
+                        'schema' => array(
+                            'type'       => 'object',
+                            'properties' => array(
+                                'wibble' => array(
+                                    'type' => 'string',
+                                ),
+                            ),
+                        ),
+                    ),
+                    'type'         => 'object',
+                    'default'      => array( 'wibble' => 'dibble' ),
+                ),
+                array( 'wibble' => 'dibble' ),
+            ),
+            array(
+                array(
+                    'show_in_rest' => array(
+                        'schema' => array(
+                            'type'       => 'object',
+                            'properties' => array(
+                                'wibble' => array(
+                                    'type' => 'string',
+                                ),
+                            ),
+                        ),
+                    ),
+                    'type'         => 'object',
+                    'single'       => false,
+                    'default'      => array( 'wibble' => 'dibble' ),
+                ),
+                array( array( 'wibble' => 'dibble' ) ),
+            ),
+
+            array(
+                array(
+                    'show_in_rest' => array(
+                        'schema' => array(
+                            'type'  => 'array',
+                            'items' => array(
+                                'type' => 'string',
+                            ),
+                        ),
+                    ),
+                    'single'       => true,
+                    'type'         => 'array',
+                    'default'      => array( 'dibble' ),
+                ),
+                array( 'dibble' ),
+            ),
+            array(
+                array(
+                    'show_in_rest' => array(
+                        'schema' => array(
+                            'type'  => 'array',
+                            'items' => array(
+                                'type' => 'string',
+                            ),
+                        ),
+                    ),
+                    'single'       => false,
+                    'type'         => 'array',
+                    'default'      => array( 'dibble' ),
+                ),
+                array( array( 'dibble' ) ),
+            ),
+            'array of objects' => array(
+                array(
+                    'type'         => 'array',
+                    'single'       => true,
+                    'show_in_rest' => array(
+                        'schema' => array(
+                            'type'  => 'array',
+                            'items' => array(
+                                'type'       => 'object',
+                                'properties' => array(
+                                    'name' => array(
+                                        'type' => 'string',
+                                    ),
+                                ),
+                            ),
+                        ),
+                    ),
+                    'default'      => array(
+                        array(
+                            'name' => 'Kirk',
+                        ),
+                    ),
+                ),
+                array(
+                    array(
+                        'name' => 'Kirk',
+                    ),
+                ),
+            ),
+        );
+    }
+
+    /**
+     * @ticket 43941
+     */
+    public function test_set_default_in_schema() {
+        register_post_meta(
+            'post',
+            'greeting',
+            array(
+                'type'         => 'string',
+                'single'       => true,
+                'show_in_rest' => array(
+                    'schema' => array(
+                        'default' => 'Hello World',
+                    ),
+                ),
+            )
+        );
+
+        $response = rest_do_request( '/wp/v2/posts/' . self::$post_id );
+        $this->assertEquals( 'Hello World', $response->get_data()['meta']['greeting'] );
+    }
+
+    /**
+     * @ticket 43941
+     */
+    public function test_default_is_added_to_schema() {
+        $request  = new WP_REST_Request( 'OPTIONS', '/wp/v2/posts' );
+        $response = rest_do_request( $request );
+
+        $schema = $response->get_data()['schema']['properties']['meta']['properties']['with_default'];
+        $this->assertArrayHasKey( 'default', $schema );
+        $this->assertEquals( 'Goodnight Moon', $schema['default'] );
+    }
+
+    /**
      * Internal function used to disable an insert query which
      * will trigger a wpdb error for testing purposes.