Merge branch 'sw-25013/5.6.4/fix-moving-slt-cookie' into '5.6.4'

SW-25013 - Fix moving the SLT cookie by adding a validity check

See merge request shopware/5/product/shopware!216

Author: shyim

engine/Shopware/Components/Privacy/CookieRemoveSubscriber.php

@@ -27,9 +27,11 @@
 use Enlight\Event\SubscriberInterface;
 use Enlight_Controller_Request_RequestHttp as Request;
 use Enlight_Controller_Response_ResponseHttp as Response;
+use Shopware\Bundle\CookieBundle\CookieCollection;
 use Shopware\Bundle\CookieBundle\CookieGroupCollection;
 use Shopware\Bundle\CookieBundle\Services\CookieHandler;
 use Shopware\Bundle\CookieBundle\Services\CookieHandlerInterface;
+use Shopware\Bundle\CookieBundle\Structs\CookieStruct;
 use Shopware_Components_Config as Config;
 use Symfony\Component\HttpFoundation\Cookie;
 
@@ -117,6 +119,8 @@ private function removeCookiesFromPreferences(Request $request, Response $respon
 
         $preferences = json_decode($preferences, true);
 
+        $preferences = $this->removeInvalidCookiesFromPreferences($request, $response, $preferences);
+
         $this->removeCookies($request, $response, function (string $cookieName) use ($preferences) {
             return $this->cookieHandler->isCookieAllowedByPreferences($cookieName, $preferences);
         });
@@ -165,6 +169,43 @@ private function removeCookies(Request $request, Response $response, callable $v
         }
     }
 
+    private function removeInvalidCookiesFromPreferences(Request $request, Response $response, array $preferences): array
+    {
+        $allowedCookies = $this->cookieHandler->getCookies();
+
+        foreach ($preferences['groups'] as $group) {
+            foreach ($group['cookies'] as $cookie) {
+                $cookieCollection = $allowedCookies->getGroupByName($group['name'])->getCookies();
+
+                if ($this->hasCookieWithTechnicalName($cookieCollection, $cookie['name'])) {
+                    continue;
+                }
+
+                unset($preferences['groups'][$group['name']]['cookies'][$cookie['name']]);
+                $this->setNewPreferencesCookie($request, $response, $preferences);
+            }
+        }
+
+        return $preferences;
+    }
+
+    private function hasCookieWithTechnicalName(CookieCollection $cookieCollection, string $technicalName): bool
+    {
+        return $cookieCollection->exists(static function (string $key, CookieStruct $cookieStruct) use ($technicalName) {
+            return $cookieStruct->getName() === $technicalName;
+        });
+    }
+
+    private function setNewPreferencesCookie(Request $request, Response $response, array $preferences): void
+    {
+        $expire = new \DateTime();
+        $expire->modify('+180 day');
+
+        $response->headers->setCookie(
+            new Cookie(CookieHandler::PREFERENCES_COOKIE_NAME, json_encode($preferences), $expire, $request->getBasePath() . '/', null, false, false, true)
+        );
+    }
+
     private function convertToArray(CookieGroupCollection $cookieGroupCollection): array
     {
         return json_decode(json_encode($cookieGroupCollection), true);

tests/Functional/Components/Privacy/CookieRemoveSubscriberTest.php

@@ -180,18 +180,18 @@ public function testPostDispatchShouldRemoveCookiesDueToPreferences(): void
         $_COOKIE[CookieHandler::PREFERENCES_COOKIE_NAME] = json_encode([
             'groups' => [
                 [
-                    'name' => 'foo',
+                    'name' => 'comfort',
                     'cookies' => [
                         [
-                            'name' => 'removeMe',
+                            'name' => 'sUniqueID',
                             'active' => false,
                         ],
                     ],
                 ],
             ],
         ]);
         $controller = $this->getController();
-        $controller->Response()->setCookie('removeMe', 'foo');
+        $controller->Response()->setCookie('sUniqueID', 'foo');
 
         $cookieRemoveSubscriber->onPostDispatch($this->getEventArgs($controller));
         $responseCookies = $controller->Response()->getCookies();

themes/Frontend/Responsive/frontend/_public/src/js/jquery.cookie-consent-manager.js

@@ -206,7 +206,7 @@
 
         parsePreferences: function () {
             var me = this,
-                groupNames = Object.keys(this.preferences['groups']),
+                groupNames = Object.keys(me.preferences['groups']),
                 group,
                 groupRequired,
                 cookieNames,
@@ -223,8 +223,8 @@
                     cookie = me.findCookieByName(cookieName);
                     me.toggleCookie(cookie, groupRequired || me.preferences['groups'][groupName].cookies[cookieName].active);
 
-                    me.checkActiveStateForAllCookiesOfGroup(group, me.preferences['groups'][groupName].cookies[cookieName].active);
-                })
+                    me.checkActiveStateForAllCookiesOfGroup(group, groupRequired || me.preferences['groups'][groupName].cookies[cookieName].active);
+                });
             });
         },