feat: support for dot-syntax query parameters in RequestBuilder (#8434)

Author: bshaffer

Core/src/RequestBuilder.php

@@ -112,8 +112,17 @@ public function build($resource, $method, array $options = [])
                     unset($options[$parameter]);
                 }
 
-                if ($parameterOptions['location'] === 'query' && array_key_exists($parameter, $options)) {
-                    $query[$parameter] = $options[$parameter];
+                if ($parameterOptions['location'] === 'query') {
+                    // flatten nested querystring parameters into dot-syntax
+                    if (false !== strpos($parameter, '.')) {
+                        list($object, $property) = explode('.', $parameter, 2);
+                        if (isset($options[$object][$property])) {
+                            $options[$parameter] = $options[$object][$property];
+                        }
+                    }
+                    if (array_key_exists($parameter, $options)) {
+                        $query[$parameter] = $options[$parameter];
+                    }
                 }
             }
         }

Core/tests/Unit/RequestBuilderTest.php

@@ -74,6 +74,31 @@ public function testBuildsNestedRequest()
         $this->assertEquals('{"referenceProp":"reference"}', (string) $request->getBody());
     }
 
+    public function testBuildsRequestWithObjectQuery()
+    {
+        // assert defining query parameters as arrays is flattened in querystring
+        $request = $this->builder->build('myResource', 'myMethod', [
+            'object' => ['queryParam' => 'object-query'],
+        ]);
+        $uri = $request->getUri();
+        $this->assertEquals('object.queryParam=object-query', $uri->getQuery());
+
+        // assert dot syntax works as well
+        $request = $this->builder->build('myResource', 'myMethod', [
+            'object.queryParam' => 'object-query-with-dot',
+        ]);
+        $uri = $request->getUri();
+        $this->assertEquals('object.queryParam=object-query-with-dot', $uri->getQuery());
+
+        // assert the object syntax takes precedence
+        $request = $this->builder->build('myResource', 'myMethod', [
+            'object' => ['queryParam' => 'object-query'],
+            'object.queryParam' => 'object-query-with-dot',
+        ]);
+        $uri = $request->getUri();
+        $this->assertEquals('object.queryParam=object-query', $uri->getQuery());
+    }
+
     public function testBuildsNestedRequestWithStringSplitting()
     {
         $builder = new RequestBuilder(

Core/tests/Unit/fixtures/service-fixture.json

@@ -20,6 +20,10 @@
               "type": "string",
               "location": "query"
             },
+            "object.queryParam": {
+              "type": "string",
+              "location": "query"
+            },
             "pathParam": {
               "type": "string",
               "required": true,

composer.json

@@ -58,7 +58,7 @@
         "phpdocumentor/reflection": "^5.0||^6.0",
         "erusev/parsedown": "^1.6",
         "phpseclib/phpseclib": "^3.0",
-        "google/cloud-tools": "^0.15.0",
+        "google/cloud-tools": "^0.16.0",
         "opis/closure": "^3.0",
         "flix-tech/avro-php": "^5.0.0",
         "phpspec/prophecy-phpunit": "^2.1",