feat(Client): support creation of correlation id at client side

Closes #328

Author: Jens Schulze

composer.json

@@ -58,14 +58,16 @@
     "cache/redis-adapter": "^0.4.0",
     "cache/filesystem-adapter": "^0.3.0",
     "cache/void-adapter": "^0.3",
-    "incenteev/composer-parameter-handler": "^2.1"
+    "incenteev/composer-parameter-handler": "^2.1",
+    "ramsey/uuid": "^3.6"
   },
   "replaces": {
     "commercetools/commons": "*"
   },
   "suggest": {
     "cache/redis-adapter": "For usage of a redis server to store the client access token",
-    "cache/doctrine-adapter": "For usage of a doctrine cache instance to store the client access token"
+    "cache/doctrine-adapter": "For usage of a doctrine cache instance to store the client access token",
+    "ramsey/uuid": "For using the correlation id feature to uniquely identify requests against CTP"
   },
   "scripts": {
     "updateConfig": [

src/Core/Client.php

@@ -6,6 +6,7 @@
 
 namespace Commercetools\Core;
 
+use Commercetools\Core\Client\Adapter\CorrelationIdAdapter;
 use Commercetools\Core\Response\ErrorResponse;
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
@@ -206,6 +207,9 @@ public function getHttpClient($options = [])
                     $this->getConfig()->getMessageFormatter()
                 );
             }
+            if ($this->getConfig()->getEnableCorrelationId() && $client instanceof CorrelationIdAdapter) {
+                $client->enableCorrelationId($this->getConfig()->getProject());
+            }
         }
 
         return $this->httpClient;

src/Core/Client/Adapter/CorrelationIdAdapter.php

@@ -0,0 +1,11 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Client\Adapter;
+
+interface CorrelationIdAdapter
+{
+    public function enableCorrelationId($projectKey = null);
+}

src/Core/Client/Adapter/Guzzle5Adapter.php

@@ -5,6 +5,7 @@
 
 namespace Commercetools\Core\Client\Adapter;
 
+use Commercetools\Core\Helper\Subscriber\CorrelationIdSubscriber;
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Pool;
@@ -17,7 +18,7 @@
 use Commercetools\Core\Error\ApiException;
 use Psr\Log\LogLevel;
 
-class Guzzle5Adapter implements AdapterInterface
+class Guzzle5Adapter implements AdapterInterface, CorrelationIdAdapter
 {
     /**
      * @var Client
@@ -68,6 +69,13 @@ public function addHandler($handler)
         $this->getEmitter()->attach($handler);
     }
 
+    public function enableCorrelationId($projectKey = null)
+    {
+        if (class_exists('\Ramsey\Uuid\Uuid')) {
+            $this->getEmitter()->attach(new CorrelationIdSubscriber($projectKey));
+        };
+    }
+
     /**
      * @internal
      * @return \GuzzleHttp\Event\Emitter|\GuzzleHttp\Event\EmitterInterface

src/Core/Client/Adapter/Guzzle6Adapter.php

@@ -18,8 +18,9 @@
 use Commercetools\Core\Error\Message;
 use Commercetools\Core\Error\ApiException;
 use Psr\Log\LogLevel;
+use Ramsey\Uuid\Uuid;
 
-class Guzzle6Adapter implements AdapterInterface
+class Guzzle6Adapter implements AdapterInterface, CorrelationIdAdapter
 {
     /**
      * @var Client
@@ -52,6 +53,20 @@ public function setLogger(LoggerInterface $logger, $logLevel = LogLevel::INFO, $
         $this->addHandler(self::log($logger, $formatter, $logLevel));
     }
 
+    public function enableCorrelationId($projectKey = null)
+    {
+        if (class_exists('\Ramsey\Uuid\Uuid')) {
+            $projectKey = !is_null($projectKey) ? $projectKey : 'php';
+            $this->addHandler(Middleware::mapRequest(function (RequestInterface $request) use ($projectKey) {
+                $uuid = Uuid::uuid4()->toString();
+                return $request->withAddedHeader(
+                    AbstractApiResponse::X_CORRELATION_ID,
+                    $projectKey . '-' . $uuid
+                );
+            }));
+        };
+    }
+
     /**
      * Middleware that logs requests, responses, and errors using a message
      * formatter.

src/Core/Config.php

@@ -152,6 +152,8 @@ class Config implements ContextAwareInterface
 
     protected $messageFormatter;
 
+    protected $enableCorrelationId = false;
+
     /**
      * @param array $configValues
      * @return static
@@ -405,7 +407,7 @@ public function getThrowExceptions()
      */
     public function setThrowExceptions($throwExceptions)
     {
-        $this->throwExceptions = $throwExceptions;
+        $this->throwExceptions = (bool)$throwExceptions;
 
         return $this;
     }
@@ -587,4 +589,22 @@ public function setMessageFormatter($messageFormatter)
         $this->messageFormatter = $messageFormatter;
         return $this;
     }
+
+    /**
+     * @return bool
+     */
+    public function getEnableCorrelationId()
+    {
+        return $this->enableCorrelationId;
+    }
+
+    /**
+     * @param bool $enableCorrelationId
+     * @return Config
+     */
+    public function setEnableCorrelationId($enableCorrelationId)
+    {
+        $this->enableCorrelationId = (bool)$enableCorrelationId;
+        return $this;
+    }
 }

src/Core/Helper/Subscriber/CorrelationIdSubscriber.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Helper\Subscriber;
+
+use Commercetools\Core\Response\AbstractApiResponse;
+use GuzzleHttp\Event\BeforeEvent;
+use GuzzleHttp\Event\RequestEvents;
+use GuzzleHttp\Event\SubscriberInterface;
+use Ramsey\Uuid\Uuid;
+
+class CorrelationIdSubscriber implements SubscriberInterface
+{
+    private $projectKey;
+
+    public function __construct($projectKey = null)
+    {
+        $projectKey = !is_null($projectKey) ? $projectKey : 'php';
+        $this->projectKey = $projectKey;
+    }
+
+    public function getEvents()
+    {
+        return ['before' => ['onBefore', RequestEvents::PREPARE_REQUEST - 10]];
+    }
+
+    public function onBefore(BeforeEvent $event, $name)
+    {
+        $event->getRequest()->addHeader(AbstractApiResponse::X_CORRELATION_ID, $this->getCorrelationId());
+    }
+
+    private function getCorrelationId()
+    {
+        return $this->projectKey . '-' . Uuid::uuid4()->toString();
+    }
+}

tests/integration/ClientTest.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Project;
+
+use Commercetools\Core\ApiTestCase;
+use Commercetools\Core\Model\Project\Project;
+use Commercetools\Core\Request\Project\ProjectGetRequest;
+use Commercetools\Core\Response\AbstractApiResponse;
+
+class ClientTest extends ApiTestCase
+{
+    public function testCorrelationId()
+    {
+        $request = ProjectGetRequest::of();
+
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+
+        $this->assertInstanceOf(Project::class, $result);
+        $this->assertStringStartsWith(
+            $this->getClient()->getConfig()->getProject(),
+            current($response->getHeader(AbstractApiResponse::X_CORRELATION_ID))
+        );
+    }
+}

tests/integration/Project/ProjectGetRequestTest.php

@@ -0,0 +1,24 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Project;
+
+use Commercetools\Core\ApiTestCase;
+use Commercetools\Core\Model\Project\Project;
+use Commercetools\Core\Request\Project\ProjectGetRequest;
+
+class ProjectGetRequestTest extends ApiTestCase
+{
+    public function testGetProject()
+    {
+        $request = ProjectGetRequest::of();
+
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+
+        $this->assertInstanceOf(Project::class, $result);
+        $this->assertSame($this->getClient()->getConfig()->getProject(), $result->getKey());
+    }
+}

tests/myapp.yml.dist

@@ -4,3 +4,4 @@ parameters:
   project: Your Commercetools project key
   oauth_url: https://auth.sphere.io
   api_url: https://api.sphere.io
+  enableCorrelationId: 1