Merge pull request #1442 from algolia/bugfix/MAGE-787

Fix issue with cookies not cleared when customer logs out

Author: mohitalgolia

Helper/InsightsHelper.php

@@ -5,7 +5,9 @@
 use Algolia\AlgoliaSearch\Helper\Configuration\PersonalizationHelper;
 use Algolia\AlgoliaSearch\Insights\UserInsightsClient;
 use Algolia\AlgoliaSearch\InsightsClient;
+use Magento\Customer\Model\Customer;
 use Magento\Customer\Model\Session as CustomerSession;
+use Magento\Framework\Session\SessionManagerInterface;
 use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
 use Magento\Framework\Stdlib\CookieManagerInterface;
 
@@ -48,12 +50,14 @@ class InsightsHelper
     public function __construct(
         ConfigHelper $configHelper,
         PersonalizationHelper $personalizationHelper,
+        SessionManagerInterface $sessionManager,
         CookieManagerInterface $cookieManager,
         CookieMetadataFactory $cookieMetadataFactory,
         CustomerSession $customerSession
     ) {
         $this->configHelper = $configHelper;
         $this->personalizationHelper = $personalizationHelper;
+        $this->sessionManager = $sessionManager;
         $this->cookieManager = $cookieManager;
         $this->cookieMetadataFactory = $cookieMetadataFactory;
         $this->customerSession = $customerSession;
@@ -142,11 +146,11 @@ private function getUserToken()
     }
 
     /**
-     * @param \Magento\Customer\Model\Customer $customer
+     * @param Customer $customer
      *
      * @return string
      */
-    public function setUserToken(\Magento\Customer\Model\Customer $customer)
+    public function setUserToken(Customer $customer)
     {
         $userToken = base64_encode('customer-' . $customer->getEmail() . '-' . $customer->getId());
         $userToken = 'aa-' . preg_replace('/[^A-Za-z0-9\-]/', '', $userToken);
@@ -166,4 +170,5 @@ public function setUserToken(\Magento\Customer\Model\Customer $customer)
 
         return $userToken;
     }
+
 }

Observer/Insights/CustomerLogout.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Algolia\AlgoliaSearch\Observer\Insights;
+
+use Algolia\AlgoliaSearch\Helper\InsightsHelper;
+use Magento\Framework\Event\ObserverInterface;
+use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
+use Magento\Framework\Stdlib\Cookie\PhpCookieManager;
+
+class CustomerLogout implements ObserverInterface
+{
+    /**
+     * @var PhpCookieManager
+     */
+    private $cookieManager;
+
+    /**
+     * @var CookieMetadataFactory
+     */
+    private $cookieMetadataFactory;
+
+    /**
+     * RefreshCustomerData constructor.
+     * @param PhpCookieManager $cookieManager
+     * @param CookieMetadataFactory $cookieMetadataFactory
+     */
+    public function __construct(
+        PhpCookieManager $cookieManager,
+        CookieMetadataFactory $cookieMetadataFactory
+    ) {
+        $this->cookieManager = $cookieManager;
+        $this->cookieMetadataFactory = $cookieMetadataFactory;
+    }
+
+    /**
+     * Check and clear session data if persistent session expired
+     *
+     * @param \Magento\Framework\Event\Observer $observer
+     * @return void
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function execute(\Magento\Framework\Event\Observer $observer)
+    {
+        if ($this->cookieManager->getCookie(InsightsHelper::ALGOLIA_CUSTOMER_USER_TOKEN_COOKIE_NAME)) {
+            $metadata = $this->cookieMetadataFactory->createCookieMetadata();
+            $metadata->setPath('/');
+            $this->cookieManager->deleteCookie(InsightsHelper::ALGOLIA_CUSTOMER_USER_TOKEN_COOKIE_NAME, $metadata);
+        }
+    }
+}

etc/frontend/events.xml

@@ -23,4 +23,10 @@
     <event name="checkout_onepage_controller_success_action">
         <observer name="algoliasearch_insights_place_order_event" instance="Algolia\AlgoliaSearch\Observer\Insights\CheckoutOnepageControllerSuccessAction" />
     </event>
+    <event name="customer_logout">
+        <observer name="algoliasearch_personalization_unset_user_token" instance="Algolia\AlgoliaSearch\Observer\Insights\CustomerLogout" />
+    </event>
+    <event name="persistent_session_expired">
+        <observer name="refresh_customer_data" instance="Algolia\AlgoliaSearch\Observer\Insights\CustomerLogout" />
+    </event>
 </config>

view/frontend/web/insights.js

@@ -37,7 +37,8 @@ define(
             initializeAnalytics: function () {
                 algoliaAnalytics.init({
                     appId:  this.config.applicationId,
-                    apiKey: this.config.apiKey
+                    apiKey: this.config.apiKey,
+                    useCookie: true,
                 });
 
                 var userAgent = 'insights-js-in-magento (' + this.config.extensionVersion + ')';