Merge branch 'pt-11491/5.2/add-cookie-consent' into 'master'

PT-11491 - Add PayPal cookies to consent manager

See merge request shopware/5/services/swagpaymentpaypalunified!32

Author: DennisGarding

Resources/services/subscribers.xml

@@ -70,6 +70,12 @@
             <tag name="shopware.event_subscriber"/>
         </service>
 
+        <service id="paypal_unified.subscriber.cookie_consent"
+                 class="SwagPaymentPayPalUnified\Subscriber\CookieConsent">
+            <argument type="service" id="snippets"/>
+            <tag name="shopware.event_subscriber"/>
+        </service>
+
         <service id="paypal_unified.subscriber.express_checkout"
                  class="SwagPaymentPayPalUnified\Subscriber\ExpressCheckout"
                  public="true">

Resources/snippets/frontend/paypal_unified/cookie_consent/cookie.ini

@@ -0,0 +1,5 @@
+[en_GB]
+cookie/label = "PayPal payments"
+
+[de_DE]
+cookie/label = "PayPal-Zahlungen"

Resources/views/frontend/_public/src/js/jquery.swag-paypal-unified.installments-banner.js

@@ -74,6 +74,9 @@
 
         init: function() {
             this.payPalInstallmentsBannerJS = window.payPalInstallmentsBannerJS;
+            if (this.payPalInstallmentsBannerJS === undefined) {
+                return;
+            }
 
             this.applyDataAttributes();
             $.publish('plugin/swagPayPalUnifiedInstallmentsBanner/init', this);

Subscriber/CookieConsent.php

@@ -0,0 +1,56 @@
+<?php declare(strict_types=1);
+/**
+ * (c) shopware AG <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SwagPaymentPayPalUnified\Subscriber;
+
+use Enlight\Event\SubscriberInterface;
+use Shopware\Bundle\CookieBundle\CookieCollection;
+use Shopware\Bundle\CookieBundle\Structs\CookieGroupStruct;
+use Shopware\Bundle\CookieBundle\Structs\CookieStruct;
+use Shopware_Components_Snippet_Manager as SnippetManager;
+
+class CookieConsent implements SubscriberInterface
+{
+    /**
+     * @var SnippetManager
+     */
+    private $snippetManager;
+
+    public function __construct(SnippetManager $snippetManager)
+    {
+        $this->snippetManager = $snippetManager;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            'CookieCollector_Collect_Cookies' => 'addPayPalCookie',
+        ];
+    }
+
+    /**
+     * @return CookieCollection
+     */
+    public function addPayPalCookie()
+    {
+        $collection = new CookieCollection();
+        $collection->add(new CookieStruct(
+            'paypal-cookies',
+            // PayPal Cookies are not handled by Shopware, because they are not set by the plugin.
+            // Therefore we use a regex which should not affect other cookies
+            '/^paypal-cookie-consent-manager$/',
+            $this->snippetManager->getNamespace('frontend/paypal_unified/cookie_consent/cookie')->get('cookie/label'),
+            CookieGroupStruct::TECHNICAL
+        ));
+
+        return $collection;
+    }
+}

Tests/Functional/Subscriber/CookieConsentTest.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * (c) shopware AG <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SwagPaymentPayPalUnified\Tests\Functional\Subscriber;
+
+use PHPUnit\Framework\TestCase;
+use Shopware\Bundle\CookieBundle\Structs\CookieStruct;
+use SwagPaymentPayPalUnified\Subscriber\CookieConsent;
+
+class CookieConsentTest extends TestCase
+{
+    public function test_can_be_created()
+    {
+        $subscriber = $this->getSubscriber();
+        static::assertNotNull($subscriber);
+    }
+
+    public function test_getSubscribedEvents_has_correct_events()
+    {
+        $events = CookieConsent::getSubscribedEvents();
+        static::assertCount(1, $events);
+        static::assertSame('addPayPalCookie', $events['CookieCollector_Collect_Cookies']);
+    }
+
+    public function test_addPayPalCookie()
+    {
+        $cookieCollection = $this->getSubscriber()->addPayPalCookie();
+        static::assertNotNull($cookieCollection);
+
+        /** @var CookieStruct|null $cookie */
+        $cookie = $cookieCollection->first();
+        static::assertInstanceOf(CookieStruct::class, $cookie);
+        static::assertSame('paypal-cookies', $cookie->getName());
+    }
+
+    /**
+     * @return CookieConsent
+     */
+    private function getSubscriber()
+    {
+        return new CookieConsent(Shopware()->Container()->get('snippets'));
+    }
+}

plugin.xml

@@ -5,13 +5,22 @@
     <label lang="de">PayPal</label>
     <label lang="en">PayPal</label>
 
-    <version>2.7.0</version>
+    <version>REPLACE-GLOBAL-WITH-NEXT-VERSION(2.8.0)</version>
     <copyright>(c) by shopware AG</copyright>
     <license>MIT</license>
     <link>http://store.shopware.com</link>
     <author>shopware AG</author>
     <compatibility minVersion="5.2.0" maxVersion="5.99.99"/>
 
+    <changelog version="REPLACE-GLOBAL-WITH-NEXT-VERSION">
+        <changes lang="de">
+            PT-11491 - PayPal-Cookies zum Consent-Manager hinzugefügt;
+        </changes>
+        <changes lang="en">
+            PT-11491 - Add PayPal cookies to consent manager;
+        </changes>
+    </changelog>
+
     <changelog version="2.7.0">
         <changes lang="de">
             PT-10536 - Behebt Anzeigefehler des Logos in Bestellbestätigungsmail;