feat: support updateProductData of cart on customer login

Closes #377

Author: Jens Schulze

src/Core/Request/Customers/CustomerLoginRequest.php

@@ -30,6 +30,7 @@ class CustomerLoginRequest extends AbstractApiRequest
     const ANONYMOUS_CART_SIGN_IN_MODE = 'anonymousCartSignInMode';
     const SIGN_IN_MODE_MERGE = 'MergeWithExistingCustomerCart';
     const SIGN_IN_MODE_NEW = 'UseAsNewActiveCustomerCart';
+    const UPDATE_PRODUCT_DATA = 'updateProductData';
 
     /**
      * @var string
@@ -48,6 +49,11 @@ class CustomerLoginRequest extends AbstractApiRequest
 
     protected $anonymousCartSignInMode;
 
+    /**
+     * @var bool
+     */
+    protected $updateProductData;
+
     protected $resultClass = CustomerSigninResult::class;
 
     /**
@@ -140,6 +146,24 @@ public function setAnonymousCartSignInMode($anonymousCartSignInMode)
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function getUpdateProductData()
+    {
+        return $this->updateProductData;
+    }
+
+    /**
+     * @param bool $updateProductData
+     * @return $this
+     */
+    public function setUpdateProductData($updateProductData)
+    {
+        $this->updateProductData = $updateProductData;
+        return $this;
+    }
+
     /**
      * @param string $email
      * @param string $password
@@ -152,6 +176,27 @@ public static function ofEmailAndPassword($email, $password, $anonymousCartId =
         return new static($email, $password, $anonymousCartId, $context);
     }
 
+    /**
+     * @param string $email
+     * @param string $password
+     * @param bool $updateProductData
+     * @param string $anonymousCartId
+     * @param Context $context
+     * @return static
+     */
+    public static function ofEmailPasswordAndUpdateProductData(
+        $email,
+        $password,
+        $updateProductData,
+        $anonymousCartId = null,
+        Context $context = null
+    ) {
+        $request = new static($email, $password, $anonymousCartId, $context);
+        $request->setUpdateProductData($updateProductData);
+
+        return $request;
+    }
+
     /**
      * @return JsonRequest
      * @internal
@@ -168,6 +213,9 @@ public function httpRequest()
         if (!is_null($this->anonymousCartSignInMode)) {
             $payload[static::ANONYMOUS_CART_SIGN_IN_MODE] = $this->anonymousCartSignInMode;
         }
+        if (!is_null($this->updateProductData)) {
+            $payload[static::UPDATE_PRODUCT_DATA] = $this->updateProductData;
+        }
         return new JsonRequest(HttpMethod::POST, $this->getPath(), $payload);
     }
 

src/Core/Request/Me/MeLoginRequest.php

@@ -33,6 +33,7 @@ class MeLoginRequest extends AbstractApiRequest
     const ANONYMOUS_CART_SIGN_IN_MODE = 'anonymousCartSignInMode';
     const SIGN_IN_MODE_MERGE = 'MergeWithExistingCustomerCart';
     const SIGN_IN_MODE_NEW = 'UseAsNewActiveCustomerCart';
+    const UPDATE_PRODUCT_DATA = 'updateProductData';
 
     /**
      * @var string
@@ -51,6 +52,11 @@ class MeLoginRequest extends AbstractApiRequest
 
     protected $anonymousCartSignInMode;
 
+    /**
+     * @var bool
+     */
+    protected $updateProductData;
+
     protected $resultClass = CustomerSigninResult::class;
 
     /**
@@ -143,6 +149,24 @@ public function setAnonymousCartSignInMode($anonymousCartSignInMode)
         return $this;
     }
 
+    /**
+     * @return bool
+     */
+    public function getUpdateProductData()
+    {
+        return $this->updateProductData;
+    }
+
+    /**
+     * @param bool $updateProductData
+     * @return $this
+     */
+    public function setUpdateProductData($updateProductData)
+    {
+        $this->updateProductData = $updateProductData;
+        return $this;
+    }
+
     /**
      * @param string $email
      * @param string $password
@@ -155,6 +179,27 @@ public static function ofEmailAndPassword($email, $password, $anonymousCartId =
         return new static($email, $password, $anonymousCartId, $context);
     }
 
+    /**
+     * @param string $email
+     * @param string $password
+     * @param bool $updateProductData
+     * @param string $anonymousCartId
+     * @param Context $context
+     * @return static
+     */
+    public static function ofEmailPasswordAndUpdateProductData(
+        $email,
+        $password,
+        $updateProductData,
+        $anonymousCartId = null,
+        Context $context = null
+    ) {
+        $request = new static($email, $password, $anonymousCartId, $context);
+        $request->setUpdateProductData($updateProductData);
+
+        return $request;
+    }
+
     /**
      * @return string
      * @internal
@@ -180,6 +225,9 @@ public function httpRequest()
         if (!is_null($this->anonymousCartSignInMode)) {
             $payload[static::ANONYMOUS_CART_SIGN_IN_MODE] = $this->anonymousCartSignInMode;
         }
+        if (!is_null($this->updateProductData)) {
+            $payload[static::UPDATE_PRODUCT_DATA] = $this->updateProductData;
+        }
         return new JsonRequest(HttpMethod::POST, $this->getPath(), $payload);
     }
 

tests/integration/Customer/CustomerLoginRequestTest.php

@@ -390,4 +390,47 @@ public function testCartMergeOnLogin()
         $this->assertSame(CartState::MERGED, $anonCart->getCartState());
         $this->assertSame($customer->getId(), $loggedInCart->getCustomerId());
     }
+
+    public function testCartUpdateProductDataOnLogin()
+    {
+        $client = $this->getClient();
+
+        $customerDraft = $this->getCustomerDraft();
+        $customer = $this->createCustomer($customerDraft);
+
+        $customerCartDraft = $this->getCartDraft();
+        $customerCartDraft->setCustomerId($customer->getId());
+        $customerCart = $this->getCart($customerCartDraft);
+
+        $anonCartDraft = $this->getCartDraft();
+        $request = CartCreateRequest::ofDraft($anonCartDraft);
+        $response = $request->executeWithClient($client);
+        $anonCart = $request->mapResponse($response);
+
+        $request = CustomerLoginRequest::ofEmailPasswordAndUpdateProductData(
+            $customer->getEmail(),
+            $customerDraft->getPassword(),
+            true,
+            $anonCart->getId()
+        )->setAnonymousCartSignInMode(CustomerLoginRequest::SIGN_IN_MODE_MERGE);
+        $body = json_decode((string)$request->httpRequest()->getBody(), true);
+        $this->assertTrue($body['updateProductData']);
+        $response = $request->executeWithClient($client);
+        $result = $request->mapResponse($response);
+
+        $loggedInCart = $result->getCart();
+
+        $request = CartByIdGetRequest::ofId($anonCart->getId());
+        $response = $request->executeWithClient($client);
+        $anonCart = $request->mapResponse($response);
+
+        $request = CartDeleteRequest::ofIdAndVersion($anonCart->getId(), $anonCart->getVersion());
+        $response = $request->executeWithClient($client);
+        $anonCart = $request->mapResponse($response);
+
+        $this->assertNotSame($anonCart->getId(), $loggedInCart->getId());
+        $this->assertSame($customerCart->getId(), $loggedInCart->getId());
+        $this->assertSame(CartState::MERGED, $anonCart->getCartState());
+        $this->assertSame($customer->getId(), $loggedInCart->getCustomerId());
+    }
 }

tests/integration/Me/MeRequestTest.php

@@ -263,7 +263,7 @@ public function testMeDelete()
         $this->customer = null;
 
         $this->assertFalse($response->isError());
-        
+
         $request = CustomerByIdGetRequest::ofId($customer->getId());
         $response = $request->executeWithClient($this->getClient());
         $this->assertTrue($response->isError());
@@ -299,6 +299,38 @@ public function testLoginSuccess()
         $this->assertSame($customer->getId(), $result->getCustomer()->getId());
     }
 
+    public function testLoginSuccessUpdateProductData()
+    {
+        $customerDraft = $this->getCustomerDraft();
+        $customer = $this->getCustomer($customerDraft);
+
+        $config = $this->getClientConfig(['manage_my_profile']);
+        $config->setGrantType(Config::GRANT_TYPE_PASSWORD)
+            ->setUsername($customer->getEmail())
+            ->setPassword($customerDraft->getPassword())
+        ;
+
+        $handler = new TestHandler();
+        $logger = new Logger('testOauth');
+        $logger->pushHandler($handler);
+
+        $client = Client::ofConfigCacheAndLogger($config, $this->getCache(), $this->getLogger());
+        $client->getOauthManager()->getHttpClient(['verify' => $this->getVerifySSL()])->setLogger($logger);
+        $client->getHttpClient(['verify' => $this->getVerifySSL()]);
+
+        $request = MeLoginRequest::ofEmailPasswordAndUpdateProductData(
+            $customer->getEmail(),
+            $customerDraft->getPassword(),
+            true
+        );
+        $body = json_decode((string)$request->httpRequest()->getBody(), true);
+        $this->assertTrue($body['updateProductData']);
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+
+        $this->assertSame($customer->getId(), $result->getCustomer()->getId());
+    }
+
     public function testLoginSuccessLowerCased()
     {
         $customerDraft = $this->getCustomerDraft();