MC-37351: Cart contents lost after switching to different store with different domain

bubasuma · bubasuma · commit fbd38132f051 · 2020-09-14T16:46:58.000-05:00
- Add customer ID in ContextInterface
- Move error handling from cache serializer
diff --git a/app/code/Magento/Customer/Model/StoreSwitcher/RedirectDataPostprocessor.php b/app/code/Magento/Customer/Model/StoreSwitcher/RedirectDataPostprocessor.php
@@ -65,7 +65,7 @@ public function process(ContextInterface $context, array $data): void
                 }
             } catch (NoSuchEntityException $e) {
                 $this->logger->error($e);
-                throw new LocalizedException(__('The requested customer does not exist.'), $e);
+                throw new LocalizedException(__('Failed to sign into the customer account.'), $e);
             } catch (LocalizedException $e) {
                 $this->logger->error($e);
                 throw new LocalizedException(__('There was an error retrieving the customer record.'), $e);
diff --git a/app/code/Magento/Store/Controller/Store/Redirect.php b/app/code/Magento/Store/Controller/Store/Redirect.php
@@ -7,6 +7,7 @@
 
 namespace Magento\Store\Controller\Store;
 
+use Magento\Authorization\Model\UserContextInterface;
 use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\Action\HttpGetActionInterface;
@@ -59,6 +60,10 @@ class Redirect extends Action implements HttpGetActionInterface, HttpPostActionI
      * @var ContextInterfaceFactory|null
      */
     private $contextFactory;
+    /**
+     * @var UserContextInterface|null
+     */
+    private $userContext;
 
     /**
      * @param Context $context
@@ -70,7 +75,9 @@ class Redirect extends Action implements HttpGetActionInterface, HttpPostActionI
      * @param StoreManagerInterface|null $storeManager
      * @param RedirectDataGenerator|null $redirectDataGenerator
      * @param ContextInterfaceFactory|null $contextFactory
+     * @param UserContextInterface|null $userContext
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         Context $context,
@@ -81,7 +88,8 @@ public function __construct(
         HashGenerator $hashGenerator,
         StoreManagerInterface $storeManager = null,
         ?RedirectDataGenerator $redirectDataGenerator = null,
-        ?ContextInterfaceFactory $contextFactory = null
+        ?ContextInterfaceFactory $contextFactory = null,
+        ?UserContextInterface $userContext = null
     ) {
         parent::__construct($context);
         $this->storeRepository = $storeRepository;
@@ -92,6 +100,8 @@ public function __construct(
             ?: ObjectManager::getInstance()->get(RedirectDataGenerator::class);
         $this->contextFactory = $contextFactory
             ?: ObjectManager::getInstance()->get(ContextInterfaceFactory::class);
+        $this->userContext = $userContext
+            ?: ObjectManager::getInstance()->get(UserContextInterface::class);
     }
 
     /**
@@ -122,7 +132,10 @@ public function execute()
                     [
                         'fromStore' => $fromStore,
                         'targetStore' => $targetStore,
-                        'redirectUrl' => $this->_redirect->getRedirectUrl()
+                        'redirectUrl' => $this->_redirect->getRedirectUrl(),
+                        'customerId' => $this->userContext->getUserType() === UserContextInterface::USER_TYPE_CUSTOMER ?
+                            (int) $this->userContext->getUserId()
+                            : null
                     ]
                 )
             );
diff --git a/app/code/Magento/Store/Model/StoreSwitcher/Context.php b/app/code/Magento/Store/Model/StoreSwitcher/Context.php
@@ -26,20 +26,27 @@ class Context implements ContextInterface
      * @var string
      */
     private $redirectUrl;
+    /**
+     * @var int|null
+     */
+    private $customerId;
 
     /**
      * @param StoreInterface $fromStore
      * @param StoreInterface $targetStore
      * @param string $redirectUrl
+     * @param int|null $customerId
      */
     public function __construct(
         StoreInterface $fromStore,
         StoreInterface $targetStore,
-        string $redirectUrl
+        string $redirectUrl,
+        ?int $customerId = null
     ) {
         $this->fromStore = $fromStore;
         $this->targetStore = $targetStore;
         $this->redirectUrl = $redirectUrl;
+        $this->customerId = $customerId;
     }
 
     /**
@@ -65,4 +72,12 @@ public function getRedirectUrl(): string
     {
         return $this->redirectUrl;
     }
+
+    /**
+     * @inheritDoc
+     */
+    public function getCustomerId(): ?int
+    {
+        return $this->customerId;
+    }
 }
diff --git a/app/code/Magento/Store/Model/StoreSwitcher/ContextInterface.php b/app/code/Magento/Store/Model/StoreSwitcher/ContextInterface.php
@@ -34,4 +34,11 @@ public function getTargetStore(): StoreInterface;
      * @return string
      */
     public function getRedirectUrl(): string;
+
+    /**
+     * The logged in customer ID
+     *
+     * @return int
+     */
+    public function getCustomerId(): ?int;
 }
diff --git a/app/code/Magento/Store/Model/StoreSwitcher/HashProcessor.php b/app/code/Magento/Store/Model/StoreSwitcher/HashProcessor.php
@@ -7,11 +7,13 @@
 
 namespace Magento\Store\Model\StoreSwitcher;
 
+use Magento\Authorization\Model\UserContextInterface;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Message\ManagerInterface;
 use Magento\Store\Api\Data\StoreInterface;
 use Magento\Store\Model\StoreSwitcherInterface;
+use Psr\Log\LoggerInterface;
 
 /**
  * Process one time token and build redirect url
@@ -49,6 +51,14 @@ class HashProcessor implements StoreSwitcherInterface
      * @var RedirectDataValidator
      */
     private $dataValidator;
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+    /**
+     * @var UserContextInterface
+     */
+    private $userContext;
 
     /**
      * @param RequestInterface $request
@@ -58,6 +68,8 @@ class HashProcessor implements StoreSwitcherInterface
      * @param ContextInterfaceFactory $contextFactory
      * @param RedirectDataInterfaceFactory $dataFactory
      * @param RedirectDataValidator $dataValidator
+     * @param LoggerInterface $logger
+     * @param UserContextInterface $userContext
      */
     public function __construct(
         RequestInterface $request,
@@ -66,7 +78,9 @@ public function __construct(
         ManagerInterface $messageManager,
         ContextInterfaceFactory $contextFactory,
         RedirectDataInterfaceFactory $dataFactory,
-        RedirectDataValidator $dataValidator
+        RedirectDataValidator $dataValidator,
+        LoggerInterface $logger,
+        UserContextInterface $userContext
     ) {
         $this->request = $request;
         $this->postprocessor = $postprocessor;
@@ -75,6 +89,8 @@ public function __construct(
         $this->contextFactory = $contextFactory;
         $this->dataFactory = $dataFactory;
         $this->dataValidator = $dataValidator;
+        $this->logger = $logger;
+        $this->userContext = $userContext;
     }
 
     /**
@@ -91,11 +107,15 @@ public function switch(StoreInterface $fromStore, StoreInterface $targetStore, s
         $timestamp = (int) $this->request->getParam('time_stamp');
         $signature = (string) $this->request->getParam('signature');
         $data = (string) $this->request->getParam('data');
+        $customerId = $this->userContext->getUserType() === UserContextInterface::USER_TYPE_CUSTOMER ?
+            (int) $this->userContext->getUserId()
+            : null;
         $context = $this->contextFactory->create(
             [
                 'fromStore' => $fromStore,
                 'targetStore' => $targetStore,
-                'redirectUrl' => $redirectUrl
+                'redirectUrl' => $redirectUrl,
+                'customerId' => $customerId
             ]
         );
         $redirectDataObject = $this->dataFactory->create(
@@ -116,6 +136,11 @@ public function switch(StoreInterface $fromStore, StoreInterface $targetStore, s
             }
         } catch (LocalizedException $exception) {
             $this->messageManager->addErrorMessage($exception->getMessage());
+        } catch (\Throwable $exception) {
+            $this->logger->error($exception);
+            $this->messageManager->addErrorMessage(
+                __('Something went wrong while switching to the store.')
+            );
         }
 
         return $redirectUrl;
diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataCacheSerializer.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataCacheSerializer.php
@@ -7,10 +7,10 @@
 
 namespace Magento\Store\Model\StoreSwitcher;
 
+use http\Exception\InvalidArgumentException;
 use Magento\Framework\App\CacheInterface;
 use Magento\Framework\Math\Random;
 use Magento\Framework\Serialize\Serializer\Json;
-use Psr\Log\LoggerInterface;
 
 /**
  * Store switcher redirect data cache serializer
@@ -33,45 +33,30 @@ class RedirectDataCacheSerializer implements RedirectDataSerializerInterface
      * @var Random
      */
     private $random;
-    /**
-     * @var LoggerInterface
-     */
-    private $logger;
 
     /**
      * @param Json $json
      * @param Random $random
      * @param CacheInterface $cache
-     * @param LoggerInterface $logger
      */
     public function __construct(
         Json $json,
         Random $random,
-        CacheInterface $cache,
-        LoggerInterface $logger
+        CacheInterface $cache
     ) {
         $this->cache = $cache;
         $this->json = $json;
         $this->random = $random;
-        $this->logger = $logger;
     }
 
     /**
      * @inheritDoc
      */
     public function serialize(array $data): string
     {
-        $token = '';
-        try {
-            if ($data) {
-                $token = $this->random->getRandomString(self::CACHE_ID_LENGTH);
-                $cacheKey = self::CACHE_KEY_PREFIX . $token;
-                $this->cache->save($this->json->serialize($data), $cacheKey, [], self::CACHE_LIFE_TIME);
-            }
-        } catch (\Throwable $exception) {
-            $this->logger->error($exception);
-            $token = '';
-        }
+        $token = $this->random->getRandomString(self::CACHE_ID_LENGTH);
+        $cacheKey = self::CACHE_KEY_PREFIX . $token;
+        $this->cache->save($this->json->serialize($data), $cacheKey, [], self::CACHE_LIFE_TIME);
 
         return $token;
     }
@@ -81,18 +66,17 @@ public function serialize(array $data): string
      */
     public function unserialize(string $data): array
     {
-        $result = [];
-        try {
-            if (strlen($data) === self::CACHE_ID_LENGTH) {
-                $cacheKey = self::CACHE_KEY_PREFIX . $data;
-                $json = $this->cache->load($cacheKey);
-                $result = $this->json->unserialize($json);
-                $this->cache->remove($cacheKey);
-            }
-        } catch (\Throwable $exception) {
-            $this->logger->error($exception);
-            $result = [];
+        if (strlen($data) !== self::CACHE_ID_LENGTH) {
+            throw new InvalidArgumentException("Invalid cache key '$data' supplied.");
+        }
+
+        $cacheKey = self::CACHE_KEY_PREFIX . $data;
+        $json = $this->cache->load($cacheKey);
+        if (!$json) {
+            throw new InvalidArgumentException('Couldn\'t retrieve data from cache.');
         }
+        $result = $this->json->unserialize($json);
+        $this->cache->remove($cacheKey);
 
         return $result;
     }
diff --git a/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataGenerator.php b/app/code/Magento/Store/Model/StoreSwitcher/RedirectDataGenerator.php
@@ -8,6 +8,7 @@
 namespace Magento\Store\Model\StoreSwitcher;
 
 use Magento\Framework\Encryption\Encryptor;
+use Psr\Log\LoggerInterface;
 
 /**
  * Store switcher redirect data collector
@@ -30,23 +31,30 @@ class RedirectDataGenerator
      * @var Encryptor
      */
     private $encryptor;
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
 
     /**
      * @param Encryptor $encryptor
      * @param RedirectDataPreprocessorInterface $preprocessor
      * @param RedirectDataSerializerInterface $serializer
      * @param RedirectDataInterfaceFactory $dataFactory
+     * @param LoggerInterface $logger
      */
     public function __construct(
         Encryptor $encryptor,
         RedirectDataPreprocessorInterface $preprocessor,
         RedirectDataSerializerInterface $serializer,
-        RedirectDataInterfaceFactory $dataFactory
+        RedirectDataInterfaceFactory $dataFactory,
+        LoggerInterface $logger
     ) {
         $this->preprocessor = $preprocessor;
         $this->serializer = $serializer;
         $this->dataFactory = $dataFactory;
         $this->encryptor = $encryptor;
+        $this->logger = $logger;
     }
 
     /**
@@ -58,7 +66,12 @@ public function __construct(
     public function generate(ContextInterface $context): RedirectDataInterface
     {
         $data = $this->preprocessor->process($context, []);
-        $dataStr = $this->serializer->serialize($data);
+        try {
+            $dataStr = $this->serializer->serialize($data);
+        } catch (\Throwable $exception) {
+            $this->logger->error($exception);
+            $dataStr = '';
+        }
         $timestamp = time();
         $token = implode(
             ',',

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public function process(ContextInterface $context, array $data): void`
`65`	`65`	`}`
`66`	`66`	`} catch (NoSuchEntityException $e) {`
`67`	`67`	`$this->logger->error($e);`
`68`		`- throw new LocalizedException(__('The requested customer does not exist.'), $e);`
	`68`	`+ throw new LocalizedException(__('Failed to sign into the customer account.'), $e);`
`69`	`69`	`} catch (LocalizedException $e) {`
`70`	`70`	`$this->logger->error($e);`
`71`	`71`	`throw new LocalizedException(__('There was an error retrieving the customer record.'), $e);`