Do not modify http client state (#755)

Author: norkunas

src/Contracts/Http.php

@@ -4,15 +4,46 @@
 
 namespace Meilisearch\Contracts;
 
+use Meilisearch\Exceptions\ApiException;
+use Meilisearch\Exceptions\JsonDecodingException;
+use Meilisearch\Exceptions\JsonEncodingException;
+
 interface Http
 {
+    /**
+     * @throws ApiException
+     * @throws JsonDecodingException
+     */
     public function get(string $path, array $query = []);
 
+    /**
+     * @param non-empty-string|null $contentType
+     *
+     * @throws ApiException
+     * @throws JsonEncodingException
+     * @throws JsonDecodingException
+     */
     public function post(string $path, $body = null, array $query = [], ?string $contentType = null);
 
+    /**
+     * @param non-empty-string|null $contentType
+     *
+     * @throws ApiException
+     * @throws JsonEncodingException
+     * @throws JsonDecodingException
+     */
     public function put(string $path, $body = null, array $query = [], ?string $contentType = null);
 
+    /**
+     * @throws ApiException
+     * @throws JsonEncodingException
+     * @throws JsonDecodingException
+     */
     public function patch(string $path, $body = null, array $query = []);
 
+    /**
+     * @throws ApiException
+     * @throws JsonDecodingException
+     */
     public function delete(string $path, array $query = []);
 }

src/Http/Client.php

@@ -27,12 +27,18 @@ class Client implements Http
     private ClientInterface $http;
     private RequestFactoryInterface $requestFactory;
     private StreamFactoryInterface $streamFactory;
-    /** @var array<string,string> */
+    /**
+     * @var array<string, string|string[]>
+     */
     private array $headers;
+    /**
+     * @var non-empty-string
+     */
     private string $baseUrl;
     private Json $json;
 
     /**
+     * @param non-empty-string   $url
      * @param array<int, string> $clientAgents
      */
     public function __construct(
@@ -72,7 +78,7 @@ public function get(string $path, array $query = [])
     }
 
     /**
-     * @param mixed|null $body
+     * @param non-empty-string|null $contentType
      *
      * @throws ApiException
      * @throws ClientExceptionInterface
@@ -81,57 +87,48 @@ public function get(string $path, array $query = [])
      */
     public function post(string $path, $body = null, array $query = [], ?string $contentType = null)
     {
-        if (!\is_null($contentType)) {
-            $this->headers['Content-type'] = $contentType;
-        } else {
-            $this->headers['Content-type'] = 'application/json';
+        if (null === $contentType) {
             $body = $this->json->serialize($body);
         }
         $request = $this->requestFactory->createRequest(
             'POST',
             $this->baseUrl.$path.$this->buildQueryString($query)
         )->withBody($this->streamFactory->createStream($body));
 
-        return $this->execute($request);
+        return $this->execute($request, ['Content-type' => $contentType ?? 'application/json']);
     }
 
+    /**
+     * @param non-empty-string|null $contentType
+     *
+     * @throws ApiException
+     * @throws ClientExceptionInterface
+     * @throws CommunicationException
+     * @throws JsonEncodingException
+     */
     public function put(string $path, $body = null, array $query = [], ?string $contentType = null)
     {
-        if (!\is_null($contentType)) {
-            $this->headers['Content-type'] = $contentType;
-        } else {
-            $this->headers['Content-type'] = 'application/json';
+        if (null === $contentType) {
             $body = $this->json->serialize($body);
         }
         $request = $this->requestFactory->createRequest(
             'PUT',
             $this->baseUrl.$path.$this->buildQueryString($query)
         )->withBody($this->streamFactory->createStream($body));
 
-        return $this->execute($request);
+        return $this->execute($request, ['Content-type' => $contentType ?? 'application/json']);
     }
 
-    /**
-     * @param mixed|null $body
-     *
-     * @throws ApiException
-     * @throws JsonEncodingException
-     */
     public function patch(string $path, $body = null, array $query = [])
     {
-        $this->headers['Content-type'] = 'application/json';
         $request = $this->requestFactory->createRequest(
             'PATCH',
             $this->baseUrl.$path.$this->buildQueryString($query)
         )->withBody($this->streamFactory->createStream($this->json->serialize($body)));
 
-        return $this->execute($request);
+        return $this->execute($request, ['Content-type' => 'application/json']);
     }
 
-    /**
-     * @throws ClientExceptionInterface
-     * @throws ApiException
-     */
     public function delete(string $path, array $query = [])
     {
         $request = $this->requestFactory->createRequest(
@@ -143,13 +140,15 @@ public function delete(string $path, array $query = [])
     }
 
     /**
+     * @param array<string, string|string[]> $headers
+     *
      * @throws ApiException
      * @throws ClientExceptionInterface
      * @throws CommunicationException
      */
-    private function execute(RequestInterface $request)
+    private function execute(RequestInterface $request, array $headers = [])
     {
-        foreach ($this->headers as $header => $value) {
+        foreach (array_merge($this->headers, $headers) as $header => $value) {
             $request = $request->withAddedHeader($header, $value);
         }