Add support for Lists in querystring (#2018)

Author: jderusse

src/AbstractApi.php

@@ -15,6 +15,7 @@
 use AsyncAws\Core\Exception\LogicException;
 use AsyncAws\Core\Exception\RuntimeException;
 use AsyncAws\Core\HttpClient\AwsRetryStrategy;
+use AsyncAws\Core\HttpClient\BuildHttpQueryTrait;
 use AsyncAws\Core\Signer\Signer;
 use AsyncAws\Core\Signer\SignerV4;
 use AsyncAws\Core\Stream\StringStream;
@@ -32,6 +33,8 @@
  */
 abstract class AbstractApi
 {
+    use BuildHttpQueryTrait;
+
     /**
      * @var HttpClientInterface
      */
@@ -230,9 +233,9 @@ protected function getEndpointMetadata(?string $region): array
     /**
      * Build the endpoint full uri.
      *
-     * @param string                $uri    or path
-     * @param array<string, string> $query  parameters that should go in the query string
-     * @param ?string               $region region provided by the user in the `@region` parameter of the Input
+     * @param string                         $uri    or path
+     * @param array<string, string|string[]> $query  parameters that should go in the query string
+     * @param ?string                        $region region provided by the user in the `@region` parameter of the Input
      */
     protected function getEndpoint(string $uri, array $query, ?string $region): string
     {
@@ -260,7 +263,7 @@ protected function getEndpoint(string $uri, array $query, ?string $region): stri
             return $endpoint;
         }
 
-        return $endpoint . (false === strpos($endpoint, '?') ? '?' : '&') . http_build_query($query, '', '&', \PHP_QUERY_RFC3986);
+        return $endpoint . (false === strpos($endpoint, '?') ? '?' : '&') . $this->buildHttpQuery($query);
     }
 
     /**
@@ -272,7 +275,7 @@ protected function discoverEndpoints(?string $region): array
     }
 
     /**
-     * @param array<string, string> $query
+     * @param array<string, string|string[]> $query
      *
      * @return string
      */
@@ -316,7 +319,7 @@ private function getDiscoveredEndpoint(string $uri, array $query, ?string $regio
             return $endpoint;
         }
 
-        return $endpoint . (false === strpos($endpoint, '?') ? '?' : '&') . http_build_query($query);
+        return $endpoint . (false === strpos($endpoint, '?') ? '?' : '&') . $this->buildHttpQuery($query);
     }
 
     /**

src/HttpClient/BuildHttpQueryTrait.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace AsyncAws\Core\HttpClient;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ */
+trait BuildHttpQueryTrait
+{
+    /**
+     * Build a query string from an array of key value pairs
+     * This function does not modify the provided keys when an array is encountered (like `http_build_query()` would).
+     *
+     * @param array<string, string|string[]> $query
+     */
+    private function buildHttpQuery(array $query): string
+    {
+        if (empty($query)) {
+            return '';
+        }
+
+        $qs = '';
+        foreach ($query as $k => $v) {
+            $k = rawurlencode($k);
+            if (!\is_array($v)) {
+                $qs .= $k . '=' . rawurlencode($v) . '&';
+            } else {
+                foreach ($v as $vv) {
+                    $qs .= $k . '=' . rawurlencode($vv) . '&';
+                }
+            }
+        }
+
+        return $qs ? substr($qs, 0, -1) : '';
+    }
+}

src/Request.php

@@ -4,6 +4,7 @@
 
 use AsyncAws\Core\Exception\InvalidArgument;
 use AsyncAws\Core\Exception\LogicException;
+use AsyncAws\Core\HttpClient\BuildHttpQueryTrait;
 use AsyncAws\Core\Stream\RequestStream;
 
 /**
@@ -13,6 +14,8 @@
  */
 final class Request
 {
+    use BuildHttpQueryTrait;
+
     /**
      * @var string
      */
@@ -39,7 +42,7 @@ final class Request
     private $queryString;
 
     /**
-     * @var array<string, string>
+     * @var array<string, string|string[]>
      */
     private $query;
 
@@ -59,8 +62,8 @@ final class Request
     private $parsed;
 
     /**
-     * @param array<string, string> $query
-     * @param array<string, string> $headers
+     * @param array<string, string|string[]> $query
+     * @param array<string, string>          $headers
      */
     public function __construct(string $method, string $uri, array $query, array $headers, RequestStream $body, string $hostPrefix = '')
     {
@@ -141,20 +144,26 @@ public function removeQueryAttribute(string $name): void
         $this->endpoint = '';
     }
 
-    public function setQueryAttribute(string $name, string $value): void
+    /**
+     * @param string|string[] $value
+     */
+    public function setQueryAttribute(string $name, string|array $value): void
     {
         $this->query[$name] = $value;
         $this->queryString = null;
         $this->endpoint = '';
     }
 
-    public function getQueryAttribute(string $name): ?string
+    /**
+     * @return string|string[]|null
+     */
+    public function getQueryAttribute(string $name): string|array|null
     {
         return $this->query[$name] ?? null;
     }
 
     /**
-     * @return array<string, string>
+     * @return array<string, string|string[]>
      */
     public function getQuery(): array
     {
@@ -207,7 +216,7 @@ public function setEndpoint(string $endpoint): void
     private function getQueryString(): string
     {
         if (null === $this->queryString) {
-            $this->queryString = http_build_query($this->query, '', '&', \PHP_QUERY_RFC3986);
+            $this->queryString = $this->buildHttpQuery($this->query);
         }
 
         return $this->queryString;