Changeset 47559

Timestamp:

04/09/2020 07:28:58 PM (6 years ago)

Author:

kadamwhite

Message:

REST API: Handle parameter types consistently within set_param().

A request has multiple parameter types, including "query" and "json." Updating a parameter could previously modify a key's value in the wrong parameter type, leading to confusing and self-contradictory response objects.

Props mnelson4, TimothyBlynJacobs, vagios, jnylen0.
Fixes #40838.

Location:

trunk

Files:

• src/wp-includes/rest-api/class-wp-rest-request.php (modified) (2 diffs)
• tests/phpunit/tests/rest-api/rest-request.php (modified) (1 diff)

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

@@ -421 +421 @@
          * Sets a parameter on the request.
          *
+         * If the given parameter key exists in any parameter type an update will take place,
+         * otherwise a new param will be created in the first parameter type (respecting
+         * get_parameter_order()).
+         *
          * @since 4.4.0
          *
@@ -427 +431 @@
          */
         public function set_param( $key, $value ) {
-                $order                             = $this->get_parameter_order();
-                $this->params[ $order[0] ][ $key ] = $value;
+                $order     = $this->get_parameter_order();
+                $found_key = false;
+
+                foreach ( $order as $type ) {
+                        if ( 'defaults' !== $type && array_key_exists( $key, $this->params[ $type ] ) ) {
+                                $this->params[ $type ][ $key ] = $value;
+                                $found_key                     = true;
+                        }
+                }
+
+                if ( ! $found_key ) {
+                        $this->params[ $order[0] ][ $key ] = $value;
+                }
         }
 

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

@@ -651 +651 @@
                 );
         }
+
+        /**
+         * @ticket 40838
+         */
+        public function test_set_param_updates_param_in_json_and_query() {
+                $request = new WP_REST_Request();
+                $request->add_header( 'content-type', 'application/json' );
+                $request->set_method( 'POST' );
+                $request->set_body(
+                        wp_json_encode(
+                                array(
+                                        'param' => 'value_body',
+                                )
+                        )
+                );
+                $request->set_query_params(
+                        array(
+                                'param' => 'value_query',
+                        )
+                );
+                $request->set_param( 'param', 'new_value' );
+
+                $this->assertEquals( 'new_value', $request->get_param( 'param' ) );
+                $this->assertEquals( array(), $request->get_body_params() );
+                $this->assertEquals( array( 'param' => 'new_value' ), $request->get_json_params() );
+                $this->assertEquals( array( 'param' => 'new_value' ), $request->get_query_params() );
+        }
+
+        /**
+         * @ticket 40838
+         */
+        public function test_set_param_updates_param_if_already_exists_in_query() {
+                $request = new WP_REST_Request();
+                $request->add_header( 'content-type', 'application/json' );
+                $request->set_method( 'POST' );
+                $request->set_body(
+                        wp_json_encode(
+                                array(
+                                        'param_body' => 'value_body',
+                                )
+                        )
+                );
+                $original_defaults = array(
+                        'param_query' => 'default_query_value',
+                        'param_body'  => 'default_body_value',
+                );
+                $request->set_default_params( $original_defaults );
+                $request->set_query_params(
+                        array(
+                                'param_query' => 'value_query',
+                        )
+                );
+                $request->set_param( 'param_query', 'new_value' );
+
+                $this->assertEquals( 'new_value', $request->get_param( 'param_query' ) );
+                $this->assertEquals( array(), $request->get_body_params() );
+                $this->assertEquals( array( 'param_body' => 'value_body' ), $request->get_json_params() );
+                $this->assertEquals( array( 'param_query' => 'new_value' ), $request->get_query_params() );
+                // Verify the default wasn't overwritten.
+                $this->assertEquals( $original_defaults, $request->get_default_params() );
+        }
+
+        /**
+         * @ticket 40838
+         */
+        public function test_set_param_to_null_updates_param_in_json_and_query() {
+                $request = new WP_REST_Request();
+                $request->add_header( 'content-type', 'application/json' );
+                $request->set_method( 'POST' );
+                $request->set_body(
+                        wp_json_encode(
+                                array(
+                                        'param' => 'value_body',
+                                )
+                        )
+                );
+                $request->set_query_params(
+                        array(
+                                'param' => 'value_query',
+                        )
+                );
+                $request->set_param( 'param', null );
+
+                $this->assertEquals( null, $request->get_param( 'param' ) );
+                $this->assertEquals( array(), $request->get_body_params() );
+                $this->assertEquals( array( 'param' => null ), $request->get_json_params() );
+                $this->assertEquals( array( 'param' => null ), $request->get_query_params() );
+        }
+
+        /**
+         * @ticket 40838
+         */
+        public function test_set_param_from_null_updates_param_in_json_and_query_with_null() {
+                $request = new WP_REST_Request();
+                $request->add_header( 'content-type', 'application/json' );
+                $request->set_method( 'POST' );
+                $request->set_body(
+                        wp_json_encode(
+                                array(
+                                        'param' => null,
+                                )
+                        )
+                );
+                $request->set_query_params(
+                        array(
+                                'param' => null,
+                        )
+                );
+                $request->set_param( 'param', 'new_value' );
+
+                $this->assertEquals( 'new_value', $request->get_param( 'param' ) );
+                $this->assertEquals( array(), $request->get_body_params() );
+                $this->assertEquals( array( 'param' => 'new_value' ), $request->get_json_params() );
+                $this->assertEquals( array( 'param' => 'new_value' ), $request->get_query_params() );
+        }
 }