ACP2E-4149: Header Login/Logout Not Updating in Multi-Store Setup with Shared Cookies

Author: abukatar

app/code/Magento/Customer/Test/Unit/ViewModel/Customer/AuthTest.php

@@ -1,13 +1,14 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2023 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
 namespace Magento\Customer\Test\Unit\ViewModel\Customer;
 
 use Magento\Customer\ViewModel\Customer\Auth;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Http\Context;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -19,6 +20,11 @@ class AuthTest extends TestCase
      */
     private mixed $contextMock;
 
+    /**
+     * @var ScopeConfigInterface|MockObject
+     */
+    private mixed $scopeConfigMock;
+
     /**
      * @var Auth
      */
@@ -33,8 +39,13 @@ protected function setUp(): void
             ->disableOriginalConstructor()
             ->getMock();
 
+        $this->scopeConfigMock = $this->getMockBuilder(ScopeConfigInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->model = new Auth(
-            $this->contextMock
+            $this->contextMock,
+            $this->scopeConfigMock
         );
         parent::setUp();
     }

app/code/Magento/Customer/ViewModel/Customer/Auth.php

@@ -1,15 +1,17 @@
 <?php
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2015 Adobe
+ * All Rights Reserved.
  */
 declare(strict_types=1);
 
 namespace Magento\Customer\ViewModel\Customer;
 
 use Magento\Customer\Model\Context;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Http\Context as HttpContext;
 use Magento\Framework\View\Element\Block\ArgumentInterface;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * Customer's auth view model
@@ -18,9 +20,11 @@ class Auth implements ArgumentInterface
 {
     /**
      * @param HttpContext $httpContext
+     * @param ScopeConfigInterface $scopeConfig
      */
     public function __construct(
-        private HttpContext $httpContext
+        private HttpContext $httpContext,
+        private ScopeConfigInterface $scopeConfig
     ) {
     }
 
@@ -33,4 +37,17 @@ public function isLoggedIn(): bool
     {
         return $this->httpContext->getValue(Context::CONTEXT_AUTH) ?? false;
     }
+
+    /**
+     * Get customer account share scope
+     *
+     * @return int
+     */
+    public function getCustomerShareScope(): int
+    {
+        return (int) $this->scopeConfig->getValue(
+            'customer/account_share/scope',
+            ScopeInterface::SCOPE_WEBSITE
+        );
+    }
 }

app/code/Magento/Customer/view/frontend/templates/js/customer-data.phtml

@@ -33,7 +33,8 @@ $cookieSettings = $block->getCookieSettings();
                 "cookieLifeTime": "<?= $escaper->escapeJs($block->getCookieLifeTime()) ?>",
                 "cookieDomain": "<?= $escaper->escapeJs($cookieSettings->getCookieDomain()) ?>",
                 "updateSessionUrl": "<?= $escaper->escapeJs($customerDataUrl) ?>",
-                "isLoggedIn": "<?= /* @noEscape */ $auth->isLoggedIn() ?>"
+                "isLoggedIn": "<?= /* @noEscape */ $auth->isLoggedIn() ?>",
+                "customerShare": "<?= $escaper->escapeJs($auth->getCustomerShareScope()) ?>"
             }
         }
     }

app/code/Magento/Customer/view/frontend/web/js/customer-data.js

@@ -17,6 +17,8 @@ define([
 ], function ($, _, ko, sectionConfig, url) {
     'use strict';
 
+    const GLOBAL_SHARE = '0';
+
     var options = {},
         storage,
         storageInvalidation,
@@ -47,17 +49,22 @@ define([
      * Invalidate Cache By Close Cookie Session
      */
     invalidateCacheByCloseCookieSession = function () {
-        var isLoggedIn = parseInt(options.isLoggedIn, 10) || 0;
+        var isLoggedIn = parseInt(options.isLoggedIn, 10) || 0,
+            loginStorage = $.localStorage;
 
         if (!$.cookieStorage.isSet('mage-cache-sessid')) {
             storage.removeAll();
         }
 
-        if (!$.localStorage.isSet('mage-customer-login')) {
-            $.localStorage.set('mage-customer-login', isLoggedIn);
+        if (options.customerShare === GLOBAL_SHARE) {
+            loginStorage = $.cookieStorage;
+        }
+
+        if (!loginStorage.isSet('mage-customer-login')) {
+            loginStorage.set('mage-customer-login', isLoggedIn);
         }
-        if ($.localStorage.get('mage-customer-login') !== isLoggedIn) {
-            $.localStorage.set('mage-customer-login', isLoggedIn);
+        if (loginStorage.get('mage-customer-login') !== isLoggedIn) {
+            loginStorage.set('mage-customer-login', isLoggedIn);
             storage.removeAll();
         }
 

dev/tests/js/jasmine/tests/app/code/Magento/Customer/frontend/js/customer-data.test.js

@@ -1,6 +1,6 @@
 /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
+ * Copyright 2020 Adobe
+ * All Rights Reserved.
  */
 
 /* eslint max-nested-callbacks: 0 */
@@ -122,6 +122,7 @@ define([
                 clearLocalStorage();
                 injector.clean();
                 injector.remove();
+                // eslint-disable-next-line no-unused-vars
             } catch (e) {
             }
         });
@@ -525,5 +526,43 @@ define([
                 expect(obj.hasOwnProperty('Magento_Customer/js/customer-data')).toBeDefined();
             });
         });
+
+        describe('Customer share scope handling', function () {
+            var originalCookieStorage,
+                originalLocalStorage;
+
+            beforeEach(function () {
+                originalCookieStorage = $.cookieStorage;
+                originalLocalStorage = $.localStorage;
+
+                $.cookieStorage = jasmine.createSpyObj('cookieStorage', ['isSet', 'get', 'set', 'setConf']);
+                $.localStorage = jasmine.createSpyObj('localStorage', ['isSet', 'get', 'set']);
+            });
+
+            afterEach(function () {
+                $.cookieStorage = originalCookieStorage;
+                $.localStorage = originalLocalStorage;
+            });
+
+            it('Should use cookieStorage for login state when customerShare is global (0)', function () {
+                init({
+                    customerShare: '0',
+                    isLoggedIn: '1'
+                });
+
+                expect($.cookieStorage.isSet).toHaveBeenCalledWith('mage-customer-login');
+                expect($.cookieStorage.get).toHaveBeenCalledWith('mage-customer-login');
+            });
+
+            it('Should use localStorage for login state when customerShare is not global (1)', function () {
+                init({
+                    customerShare: '1',
+                    isLoggedIn: '1'
+                });
+
+                expect($.localStorage.isSet).toHaveBeenCalledWith('mage-customer-login');
+                expect($.localStorage.get).toHaveBeenCalledWith('mage-customer-login');
+            });
+        });
     });
 });