MC-18270: When persistent cart is disabled, logged in users still have a persistent cart session

Author: Oleksandr Iegorov

app/code/Magento/Persistent/Observer/CheckExpirePersistentQuoteObserver.php

@@ -6,6 +6,7 @@
 namespace Magento\Persistent\Observer;
 
 use Magento\Framework\Event\ObserverInterface;
+use Magento\Quote\Model\Quote;
 
 /**
  * Observer of expired session
@@ -68,6 +69,11 @@ class CheckExpirePersistentQuoteObserver implements ObserverInterface
      */
     private $checkoutPagePath = 'checkout';
 
+    /**
+     * @var Quote
+     */
+    private $quote;
+
     /**
      * @param \Magento\Persistent\Helper\Session $persistentSession
      * @param \Magento\Persistent\Helper\Data $persistentData
@@ -100,30 +106,81 @@ public function __construct(
      *
      * @param \Magento\Framework\Event\Observer $observer
      * @return void
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     public function execute(\Magento\Framework\Event\Observer $observer)
     {
         if (!$this->_persistentData->canProcess($observer)) {
             return;
         }
 
+        //clear persistent when persistent data is disabled
+        if ($this->isPersistentQuoteOutdated()) {
+            $this->_eventManager->dispatch('persistent_session_expired');
+            $this->quoteManager->expire();
+            $this->_checkoutSession->clearQuote();
+            return;
+        }
+
         if ($this->_persistentData->isEnabled() &&
             !$this->_persistentSession->isPersistent() &&
             !$this->_customerSession->isLoggedIn() &&
             $this->_checkoutSession->getQuoteId() &&
             !$this->isRequestFromCheckoutPage($this->request) &&
             // persistent session does not expire on onepage checkout page
-            (
-                $this->_checkoutSession->getQuote()->getIsPersistent() ||
-                $this->_checkoutSession->getQuote()->getCustomerIsGuest()
-            )
+            $this->isNeedToExpireSession()
         ) {
             $this->_eventManager->dispatch('persistent_session_expired');
             $this->quoteManager->expire();
             $this->_customerSession->setCustomerId(null)->setCustomerGroupId(null);
         }
     }
 
+    /**
+     * Checks if current quote marked as persistent and Persistence Functionality is disabled.
+     *
+     * @return bool
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function isPersistentQuoteOutdated(): bool
+    {
+        if ((!$this->_persistentData->isEnabled() || !$this->_persistentData->isShoppingCartPersist())
+            && !$this->_customerSession->isLoggedIn()
+            && $this->_checkoutSession->getQuoteId()) {
+            return (bool)$this->getQuote()->getIsPersistent();
+        }
+        return false;
+    }
+
+    /**
+     * Condition checker
+     *
+     * @return bool
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function isNeedToExpireSession(): bool
+    {
+        return $this->getQuote()->getIsPersistent() || $this->getQuote()->getCustomerIsGuest();
+    }
+
+    /**
+     * Getter for Quote with micro optimization
+     *
+     * @return Quote
+     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     */
+    private function getQuote(): Quote
+    {
+        if ($this->quote === null) {
+            $this->quote = $this->_checkoutSession->getQuote();
+        }
+        return $this->quote;
+    }
+
     /**
      * Check current request is coming from onepage checkout page.
      *

app/code/Magento/Persistent/Test/Unit/Observer/CheckExpirePersistentQuoteObserverTest.php

@@ -116,7 +116,7 @@ public function testExecuteWhenPersistentIsNotEnabled()
             ->method('canProcess')
             ->with($this->observerMock)
             ->willReturn(true);
-        $this->persistentHelperMock->expects($this->once())->method('isEnabled')->willReturn(false);
+        $this->persistentHelperMock->expects($this->exactly(2))->method('isEnabled')->willReturn(false);
         $this->eventManagerMock->expects($this->never())->method('dispatch');
         $this->model->execute($this->observerMock);
     }
@@ -144,7 +144,9 @@ public function testExecuteWhenPersistentIsEnabled(
             ->method('canProcess')
             ->with($this->observerMock)
             ->willReturn(true);
-        $this->persistentHelperMock->expects($this->once())->method('isEnabled')->willReturn(true);
+        $this->persistentHelperMock->expects($this->atLeastOnce())
+            ->method('isEnabled')
+            ->willReturn(true);
         $this->sessionMock->expects($this->once())->method('isPersistent')->willReturn(false);
         $this->checkoutSessionMock
             ->method('getQuote')

dev/tests/integration/testsuite/Magento/Braintree/Controller/Paypal/PlaceOrderTest.php

@@ -47,7 +47,7 @@ protected function setUp()
 
         $this->session = $this->getMockBuilder(Session::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getQuote', 'setLastOrderStatus', 'unsLastBillingAgreementReferenceId'])
+            ->setMethods(['getQuote', 'setLastOrderStatus', 'unsLastBillingAgreementReferenceId', 'getQuoteId'])
             ->getMock();
 
         $adapterFactory = $this->getMockBuilder(BraintreeAdapterFactory::class)
@@ -76,6 +76,9 @@ protected function tearDown()
     /**
      * Tests a negative scenario for a place order flow when exception throws after placing an order.
      *
+     *
+     * @magentoAppArea frontend
+     * @magentoAppIsolation enabled
      * @magentoDataFixture Magento/Braintree/Fixtures/paypal_quote.php
      */
     public function testExecuteWithFailedOrder()
@@ -85,6 +88,8 @@ public function testExecuteWithFailedOrder()
 
         $this->session->method('getQuote')
             ->willReturn($quote);
+        $this->session->method('getQuoteId')
+            ->willReturn($quote->getId());
 
         $this->adapter->method('sale')
             ->willReturn($this->getTransactionStub('authorized'));