Add a "debug" config to print HTTP requests and responses (#758)

* Draft a "debug" config

* Bugfix

* Bugfixes

Author: Nyholm

src/AbstractApi.php

@@ -136,7 +136,16 @@ final protected function getResponse(Request $request, ?RequestContext $context
             ]
         );
 
-        return new Response($response, $this->httpClient, $this->logger);
+        if ($debug = \filter_var($this->configuration->get('debug'), \FILTER_VALIDATE_BOOLEAN)) {
+            $this->logger->debug('AsyncAws HTTP request sent: {method} {endpoint}', [
+                'method' => $request->getMethod(),
+                'endpoint' => $request->getEndpoint(),
+                'headers' => json_encode($request->getHeaders()),
+                'body' => 0 === $length ? null : $requestBody,
+            ]);
+        }
+
+        return new Response($response, $this->httpClient, $this->logger, $debug);
     }
 
     /**

src/Configuration.php

@@ -17,6 +17,7 @@ final class Configuration
     public const DEFAULT_REGION = 'us-east-1';
 
     public const OPTION_REGION = 'region';
+    public const OPTION_DEBUG = 'debug';
     public const OPTION_PROFILE = 'profile';
     public const OPTION_ACCESS_KEY_ID = 'accessKeyId';
     public const OPTION_SECRET_ACCESS_KEY = 'accessKeySecret';
@@ -34,6 +35,7 @@ final class Configuration
 
     private const AVAILABLE_OPTIONS = [
         self::OPTION_REGION => true,
+        self::OPTION_DEBUG => true,
         self::OPTION_PROFILE => true,
         self::OPTION_ACCESS_KEY_ID => true,
         self::OPTION_SECRET_ACCESS_KEY => true,
@@ -69,6 +71,7 @@ final class Configuration
 
     private const DEFAULT_OPTIONS = [
         self::OPTION_REGION => self::DEFAULT_REGION,
+        self::OPTION_DEBUG => 'false',
         self::OPTION_PROFILE => 'default',
         self::OPTION_SHARED_CREDENTIALS_FILE => '~/.aws/credentials',
         self::OPTION_SHARED_CONFIG_FILE => '~/.aws/config',

src/Response.php

@@ -68,11 +68,17 @@ class Response
      */
     private $logger;
 
-    public function __construct(ResponseInterface $response, HttpClientInterface $httpClient, LoggerInterface $logger)
+    /**
+     * @var bool
+     */
+    private $debug;
+
+    public function __construct(ResponseInterface $response, HttpClientInterface $httpClient, LoggerInterface $logger, bool $debug = false)
     {
         $this->httpResponse = $response;
         $this->httpClient = $httpClient;
         $this->logger = $logger;
+        $this->debug = $debug;
     }
 
     public function __destruct()
@@ -114,6 +120,21 @@ public function resolve(?float $timeout = null): bool
             $this->resolveResult = new NetworkException('Could not contact remote server.', 0, $e);
         }
 
+        if (true === $this->debug) {
+            $httpStatusCode = $this->httpResponse->getInfo('http_code');
+            if (0 === $httpStatusCode) {
+                // Network exception
+                $this->logger->debug('AsyncAws HTTP request could not be sent due network issues');
+            } else {
+                $this->logger->debug('AsyncAws HTTP response received with status code {status_code}', [
+                    'status_code' => $httpStatusCode,
+                    'headers' => json_encode($this->httpResponse->getHeaders(false)),
+                    'body' => $this->httpResponse->getContent(false),
+                ]);
+                $this->bodyDownloaded = true;
+            }
+        }
+
         return $this->getResolveStatus();
     }