feat(ClientLogging): support setting X-External-User-ID header

Author: nikossvnk

src/Core/Request/AbstractApiRequest.php

@@ -27,6 +27,7 @@
  */
 abstract class AbstractApiRequest implements ClientRequestInterface, ContextAwareInterface
 {
+    const EXTERNAL_USER_HEADER = 'X-External-User-ID';
     use ContextTrait;
 
     /**
@@ -43,6 +44,8 @@ abstract class AbstractApiRequest implements ClientRequestInterface, ContextAwar
 
     protected $resultClass = JsonObject::class;
 
+    protected $headers = [];
+
     /**
      * @param JsonEndpoint $endpoint
      * @param Context $context
@@ -93,6 +96,17 @@ public function setIdentifier($identifier)
         return $this;
     }
 
+    /**
+     * @param string $externalUserId
+     * @return $this
+     */
+    public function setExternalUserId($externalUserId)
+    {
+        $this->headers[self::EXTERNAL_USER_HEADER] = $externalUserId;
+
+        return $this;
+    }
+
     /**
      * @param JsonEndpoint $endpoint
      * @return $this
@@ -241,6 +255,9 @@ public function map(array $data, Context $context = null, MapperInterface $mappe
      */
     public function executeWithClient(Client $client, array $headers = null)
     {
-        return $client->execute($this, $headers);
+        if (!is_null($headers)) {
+            $this->headers = array_merge($headers, $this->headers);
+        }
+        return $client->execute($this, $this->headers);
     }
 }

tests/integration/Customer/CustomerUpdateRequestTest.php

@@ -9,6 +9,8 @@
 use Commercetools\Core\ApiTestCase;
 use Commercetools\Core\Model\Common\Address;
 use Commercetools\Core\Model\Common\AddressCollection;
+use Commercetools\Core\Model\Common\CreatedBy;
+use Commercetools\Core\Model\Common\LastModifiedBy;
 use Commercetools\Core\Model\Customer\Customer;
 use Commercetools\Core\Model\Customer\CustomerDraft;
 use Commercetools\Core\Model\CustomField\CustomFieldObjectDraft;
@@ -547,7 +549,6 @@ public function testCompanyName()
 
         $this->assertSame($customer->getVersion(), $result->getVersion());
         $this->assertSame($customer->getCompanyName(), $result->getCompanyName());
-
     }
 
     public function testDateOfBirth()
@@ -653,6 +654,48 @@ public function testCustomField()
         $this->assertSame($this->getTestRun(), $customer->getCustom()->getFields()->getTestField());
     }
 
+
+    public function testSetExternalUserOnCustomerUpdate()
+    {
+        $draft = $this->getDraft('name');
+
+        $request = CustomerCreateRequest::ofDraft($draft);
+        $request->setExternalUserId('custom-external-user-id');
+
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+
+        $this->cleanupRequests[] = $this->deleteRequest = CustomerDeleteRequest::ofIdAndVersion(
+            $result->getCustomer()->getId(),
+            $result->getCustomer()->getVersion()
+        );
+        $customer = $result->getCustomer();
+
+        $this->assertInstanceOf(Customer::class, $customer);
+        $this->assertInstanceOf(CreatedBy::class, $customer->getCreatedBy());
+        $this->assertInstanceOf(LastModifiedBy::class, $customer->getLastModifiedBy());
+        $this->assertSame('custom-external-user-id', $customer->getCreatedBy()->getExternalUserId());
+        $this->assertSame('custom-external-user-id', $customer->getLastModifiedBy()->getExternalUserId());
+
+        $key = 'new-' . $this->getTestRun();
+        $request = CustomerUpdateRequest::ofIdAndVersion($customer->getId(), $customer->getVersion())
+            ->addAction(
+                CustomerSetKeyAction::of()->setKey($key)
+            )
+        ;
+        $request->setExternalUserId('another-user');
+
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertInstanceOf(Customer::class, $result);
+        $this->assertInstanceOf(CreatedBy::class, $result->getCreatedBy());
+        $this->assertInstanceOf(LastModifiedBy::class, $result->getLastModifiedBy());
+        $this->assertSame('custom-external-user-id', $result->getCreatedBy()->getExternalUserId());
+        $this->assertSame('another-user', $result->getLastModifiedBy()->getExternalUserId());
+    }
+
     public function localeProvider()
     {
         return [