Implement support for the host prefix in operations (#1514)

* Implement support for the host prefix in operations

This is needed to have a working implementation of LocationService.

* Keep the original query string when possible

Author: stof

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Added
 
 - Support for LocationService
+- Support for hostPrefix in requests
 
 ## 1.19.0
 

src/Request.php

@@ -33,6 +33,11 @@ final class Request
      */
     private $body;
 
+    /**
+     * @var string|null
+     */
+    private $queryString;
+
     /**
      * @var array<string, string>
      */
@@ -43,6 +48,11 @@ final class Request
      */
     private $endpoint;
 
+    /**
+     * @var string
+     */
+    private $hostPrefix;
+
     /**
      * @var array{scheme: string, host: string, port: int|null}|null
      */
@@ -52,7 +62,7 @@ final class Request
      * @param array<string, string> $query
      * @param array<string, string> $headers
      */
-    public function __construct(string $method, string $uri, array $query, array $headers, RequestStream $body)
+    public function __construct(string $method, string $uri, array $query, array $headers, RequestStream $body, string $hostPrefix = '')
     {
         $this->method = $method;
         $this->uri = $uri;
@@ -62,6 +72,7 @@ public function __construct(string $method, string $uri, array $query, array $he
         }
         $this->body = $body;
         $this->query = $query;
+        $this->hostPrefix = $hostPrefix;
         $this->endpoint = '';
     }
 
@@ -126,12 +137,14 @@ public function hasQueryAttribute(string $name): bool
     public function removeQueryAttribute(string $name): void
     {
         unset($this->query[$name]);
+        $this->queryString = null;
         $this->endpoint = '';
     }
 
     public function setQueryAttribute(string $name, string $value): void
     {
         $this->query[$name] = $value;
+        $this->queryString = null;
         $this->endpoint = '';
     }
 
@@ -148,35 +161,55 @@ public function getQuery(): array
         return $this->query;
     }
 
+    public function getHostPrefix(): string
+    {
+        return $this->hostPrefix;
+    }
+
+    public function setHostPrefix(string $hostPrefix): void
+    {
+        $this->hostPrefix = $hostPrefix;
+        $this->endpoint = '';
+    }
+
     public function getEndpoint(): string
     {
         if (empty($this->endpoint)) {
             if (null === $this->parsed) {
                 throw new LogicException('Request::$endpoint must be set before using it.');
             }
 
-            $this->endpoint = $this->parsed['scheme'] . '://' . $this->parsed['host'] . (isset($this->parsed['port']) ? ':' . $this->parsed['port'] : '') . $this->uri . ($this->query ? (false === strpos($this->uri, '?') ? '?' : '&') . http_build_query($this->query, '', '&', \PHP_QUERY_RFC3986) : '');
+            $this->endpoint = $this->parsed['scheme'] . '://' . $this->hostPrefix . $this->parsed['host'] . (isset($this->parsed['port']) ? ':' . $this->parsed['port'] : '') . $this->uri . ($this->query ? (false === strpos($this->uri, '?') ? '?' : '&') . $this->getQueryString() : '');
         }
 
         return $this->endpoint;
     }
 
     public function setEndpoint(string $endpoint): void
     {
-        if (!empty($this->endpoint)) {
+        if (null !== $this->parsed) {
             throw new LogicException('Request::$endpoint cannot be changed after it has a value.');
         }
 
-        $this->endpoint = $endpoint;
-        $parsed = parse_url($this->endpoint);
+        $parsed = parse_url($endpoint);
 
         if (false === $parsed || !isset($parsed['scheme'], $parsed['host'])) {
             throw new InvalidArgument(sprintf('The endpoint "%s" is invalid.', $endpoint));
         }
 
         $this->parsed = ['scheme' => $parsed['scheme'], 'host' => $parsed['host'], 'port' => $parsed['port'] ?? null];
 
+        $this->queryString = $parsed['query'] ?? '';
         parse_str($parsed['query'] ?? '', $this->query);
         $this->uri = $parsed['path'] ?? '/';
     }
+
+    private function getQueryString(): string
+    {
+        if (null === $this->queryString) {
+            $this->queryString = http_build_query($this->query, '', '&', \PHP_QUERY_RFC3986);
+        }
+
+        return $this->queryString;
+    }
 }

tests/Unit/Signer/SignerV4Test.php

@@ -156,6 +156,8 @@ private function parseRequest(string $req): Request
 
         $req = new Request($method, '/', [], $headers, StringStream::create(implode("\n", $lines)));
         $req->setEndpoint('https://' . $headers['Host'] . $path);
+        // Ensure that the memoized property is filled, so that comparison works consistently.
+        $req->getEndpoint();
 
         return $req;
     }