Merge pull request #54 from BitBagCommerce/1.1

senghe · web-flow · commit a8b45e2d7487 · 2025-11-25T14:06:07.000+01:00
1.1
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -61,11 +61,7 @@ jobs:
             -
                 name: Output PHP version for Symfony CLI
                 run: php -v | head -n 1 | awk '{ print $2 }' > .php-version
-
-            -
-                name: Install certificates
-                run: symfony server:ca:install
-
+                
             -
                 name: Run Chrome Headless
                 run: google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1 > /dev/null 2>&1 &
diff --git a/behat.yml.dist b/behat.yml.dist
@@ -20,7 +20,7 @@ default:
 
         Behat\MinkExtension:
             files_path: "%paths.base%/vendor/sylius/sylius/src/Sylius/Behat/Resources/fixtures/"
-            base_url: "https://127.0.0.1:8080/"
+            base_url: "http://127.0.0.1:8080/"
             default_session: symfony
             javascript_session: panther
             sessions:
diff --git a/composer.json b/composer.json
@@ -53,6 +53,15 @@
             "dealerdirect/phpcodesniffer-composer-installer": false,
             "phpstan/extension-installer": true,
             "symfony/flex": true
+        },
+        "audit": {
+            "ignore": [
+                "PKSA-gs8r-6kz6-pp56",
+                "PKSA-gnn4-pxdg-q76m",
+                "PKSA-yhcn-xrg3-68b1",
+                "PKSA-2wrf-1xmk-1pky",
+                "PKSA-4g5g-4rkv-myqs"
+            ]
         }
     },
     "extra": {
diff --git a/config/config.yml b/config/config.yml
@@ -2,7 +2,8 @@ parameters:
     user_com.frontend_api_key: '%env(USER_COM_FRONTEND_API_KEY)%'
     user_com.encryption_key: '%env(USER_COM_ENCRYPTION_KEY)%'
     user_com.encryption_iv: '%env(USER_COM_ENCRYPTION_IV)%'
-
+    user_com.cookie_domain: '%env(USER_COM_COOKIE_DOMAIN)%'
+    
 twig:
     globals:
         user_com_frontend_api_key: '%user_com.frontend_api_key%'
diff --git a/config/services/api.xml b/config/services/api.xml
@@ -21,5 +21,9 @@
             <argument type="service" id="monolog.logger.user_com"/>
             <argument type="service" id="bit_bag.sylius_user_com_plugin.manager.user_com_api_token_manager"/>
         </service>
+
+        <service id="bit_bag.sylius_user_com_plugin.openapi.factory" class="BitBag\SyliusUserComPlugin\OpenApi\OpenApiFactory" decorates="api_platform.openapi.factory">
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.openapi.factory.inner" />
+        </service>
     </services>
 </container>
diff --git a/config/services/cookie.xml b/config/services/cookie.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <defaults autowire="false" autoconfigure="false"/>
+        <service id="bit_bag.sylius_user_com_plugin.cookie.cookie_queue" class="BitBag\SyliusUserComPlugin\Cookie\CookieQueue" />
+    </services>
+</container>
diff --git a/config/services/event_subscriber.xml b/config/services/event_subscriber.xml
@@ -15,5 +15,13 @@
             <argument type="service" id="monolog.logger.user_com"/>
             <tag name="kernel.event_subscriber"/>
         </service>
+
+        <service id="bit_bag.sylius_user_com_plugin.event_subscriber.cookie_flusher_subscriber" class="BitBag\SyliusUserComPlugin\EventSubscriber\CookieFlusherSubscriber">
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.cookie.cookie_queue" />
+            <tag name="kernel.event_listener"
+                 event="kernel.response"
+                 method="onResponse"
+                 priority="0"/>
+        </service>
     </services>
 </container>
diff --git a/config/services/manager.xml b/config/services/manager.xml
@@ -9,6 +9,8 @@
         >
             <argument type="service" id="request_stack"/>
             <argument type="service" id="security.token_storage"/>
+            <argument type="service" id="bit_bag.sylius_user_com_plugin.cookie.cookie_queue"/>
+            <argument>%user_com.cookie_domain%</argument>
         </service>
 
         <service
diff --git a/doc/adjustments.md b/doc/adjustments.md
@@ -10,6 +10,11 @@ There is designated validator to check if request payload contains required fiel
 If there will be any field added by User.com, you can adjust this validator to check if this field is present in request payload.
 Also, in `BitBag\SyliusUserComPlugin\Assigner\AgreementsAssigner` you can adjust existing logic to assign agreements to customer in a way that suits your needs.
 
+The endpoint is exposed in `Swagger` under `UserComAgreements`, making it easy to test and explore directly from the API documentation.
+
+>If you use several channels, remember to select one of the available channels using the get method and parameters before using the API:
+`?_channel_code=CHANNEL_CODE`
+
 ```php
 public function assign(CustomerInterface $customer, array $agreements): void
     {
diff --git a/doc/functionalities.md b/doc/functionalities.md
@@ -22,13 +22,17 @@ The **BitBagSyliusUserComPlugin** integrates **User.com** with Sylius-based stor
 ### 4. Event-Driven System
 - Each customer interaction generates an **event**, which is stored and sent to **User.com** for automation and reporting.
 
-### 5. Product Persistence & Feed Generation
+### 5. Product Persistence
 - **Persists products** within the system for accurate data reporting.
-- Generates a **product feed** that can be used for marketing and analytics purposes.
 
 ### 6. Tag Manager Script Injection
 - Allows users to **inject custom scripts** via **Tag Manager**.
 - Enables integration with **third-party tracking tools**.
 
 ### 7. User information object 
 - you can use `user_com_customer_info` in browser console to check currently logged in customer data
+
+### 8. Webhook Endpoint: Updating User Marketing Consents
+- Exposes a dedicated endpoint for handling User.com webhooks (`UserComAgreements` in `Swagger`),
+allowing the update of user marketing consents. By default, it manages the `subscribedToNewsletter` flag,
+but the mechanism is fully extensible to support additional types of consents.”
diff --git a/doc/installation.md b/doc/installation.md
@@ -8,8 +8,20 @@
         USER_COM_FRONTEND_API_KEY=""
         USER_COM_ENCRYPTION_KEY=your-32-character-long-key
         USER_COM_ENCRYPTION_IV=your-16-character-long-iv
+        USER_COM_COOKIE_DOMAIN=""
         MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
     ```
+   - You can find the `USER_COM_FRONTEND_API_KEY` in the User.Com integration guide for `Google Tag Manager (Settings->Setup & Integrations)`. 
+   - `USER_COM_ENCRYPTION_KEY` and `USER_COM_ENCRYPTION_IV` are required for cookie encryption.
+- You can generate the encryption key and IV using the following command:
+    ```bash
+      php -r '$key = bin2hex(random_bytes(16)); echo "USER_COM_ENCRYPTION_KEY=\"" . $key . "\"\n"; $iv = bin2hex(random_bytes(8)); echo "USER_COM_ENCRYPTION_IV=\"" . $iv . "\"\n";'
+    ```
+   - `MESSENGER_USER_COM_ASYNCHRONOUS_DSN` is the DSN for the messenger transport that will handle asynchronous messages. You can use different transports like `doctrine://default`, `amqp://guest:guest@localhost:5672/%2f/messages`, etc.
+
+  - `USER_COM_COOKIE_DOMAIN` is optional, if not set, cookies will be set for the current domain.
+
+
 3. Add plugin dependencies to `config/bundles.php` file. Make sure that none of the bundles are duplicated.
     ```php
     return [
diff --git a/ecs.php b/ecs.php
@@ -18,4 +18,3 @@
         VisibilityRequiredFixer::class => ['*Spec.php'],
     ]);
 };
-
diff --git a/src/Api/UserApi.php b/src/Api/UserApi.php
@@ -28,7 +28,7 @@ public function findUser(
         $url = $this->getApiEndpointUrl(
             $resource,
             self::FIND_USER_ENDPOINT,
-            sprintf('?%s=%s', $field, $value),
+            sprintf('?%s=%s', $field, rawurlencode($value)),
         );
 
         return $this->request(
diff --git a/src/Builder/Payload/CustomerPayloadBuilder.php b/src/Builder/Payload/CustomerPayloadBuilder.php
@@ -25,8 +25,8 @@ public function build(string $email, ?CustomerInterface $customer = null, ?Addre
         $payload = [
             'custom_id' => strtolower($customer?->getEmail() ?? $email),
             'email' => strtolower($customer?->getEmail() ?? $email),
-            'firstName' => $customer?->getFirstName(),
-            'lastName' => $customer?->getLastName(),
+            'first_name' => $customer?->getFirstName(),
+            'last_name' => $customer?->getLastName(),
             'phone_number' => $customer?->getPhoneNumber(),
             'country' => $address?->getCountryCode(),
             'region' => $address?->getProvinceCode(),
diff --git a/src/Cookie/CookieQueue.php b/src/Cookie/CookieQueue.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusUserComPlugin\Cookie;
+
+use Symfony\Component\HttpFoundation\Cookie;
+
+final class CookieQueue implements CookieQueueInterface
+{
+    private array $queued = [];
+
+    public function queue(Cookie $cookie): void
+    {
+        $this->queued[] = $cookie;
+    }
+
+    /** @return Cookie[] */
+    public function pullAll(): array
+    {
+        $all = $this->queued;
+        $this->queued = [];
+
+        return $all;
+    }
+}
diff --git a/src/Cookie/CookieQueueInterface.php b/src/Cookie/CookieQueueInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusUserComPlugin\Cookie;
+
+use Symfony\Component\HttpFoundation\Cookie;
+
+interface CookieQueueInterface
+{
+    public function queue(Cookie $cookie): void;
+
+    /** @return  Cookie[] */
+    public function pullAll(): array;
+}
diff --git a/src/EventSubscriber/CookieFlusherSubscriber.php b/src/EventSubscriber/CookieFlusherSubscriber.php
@@ -0,0 +1,31 @@
+<?php
+
+/*
+ * This file has been created by developers from BitBag.
+ * Feel free to contact us once you face any issues or want to start
+ * You can find more information about us on https://bitbag.io and write us
+ * an email on hello@bitbag.io.
+ */
+
+declare(strict_types=1);
+
+namespace BitBag\SyliusUserComPlugin\EventSubscriber;
+
+use BitBag\SyliusUserComPlugin\Cookie\CookieQueueInterface;
+use Symfony\Component\HttpKernel\Event\ResponseEvent;
+
+final class CookieFlusherSubscriber
+{
+    public function __construct(private readonly CookieQueueInterface $queue)
+    {
+    }
+
+    public function onResponse(ResponseEvent $event): void
+    {
+        $response = $event->getResponse();
+
+        foreach ($this->queue->pullAll() as $cookie) {
+            $response->headers->setCookie($cookie);
+        }
+    }
+}
diff --git a/src/EventSubscriber/CustomerProfileUpdatedSubscriberInterface.php b/src/EventSubscriber/CustomerProfileUpdatedSubscriberInterface.php
@@ -24,6 +24,7 @@ interface CustomerProfileUpdatedSubscriberInterface
         'sylius_customer_profile' => 'customer_profile_update',
         'sylius_admin_customer_update' => 'admin_customer_update',
         'sylius_shop_account_profile_update' => 'shop_customer_update',
+        'sylius_shop_account_address_book_set_as_default' => 'shop_customer_default_address_update',
         'sylius_shop_register' => 'customer_registration',
         'sylius_shop_checkout_address' => 'customer_order_address_provided',
     ];
diff --git a/src/Manager/CookieManager.php b/src/Manager/CookieManager.php
@@ -11,7 +11,9 @@
 
 namespace BitBag\SyliusUserComPlugin\Manager;
 
+use BitBag\SyliusUserComPlugin\Cookie\CookieQueueInterface;
 use Sylius\Component\Core\Model\AdminUserInterface;
+use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 
@@ -20,6 +22,8 @@ final class CookieManager implements CookieManagerInterface
     public function __construct(
         private readonly RequestStack $requestStack,
         private readonly TokenStorageInterface $tokenStorage,
+        private readonly CookieQueueInterface $queue,
+        private readonly ?string $cookieDomain = null,
     ) {
     }
 
@@ -41,11 +45,29 @@ public function getUserComCookie(): ?string
 
     public function setUserComCookie(string $value): void
     {
-        $request = $this->requestStack->getCurrentRequest();
-        if (null === $request) {
-            return;
+        $cookie = Cookie::create(self::CHAT_COOKIE_NAME)
+            ->withValue($value)
+            ->withPath('/')
+            ->withSecure(true)
+            ->withExpires(new \DateTimeImmutable('+1 year'))
+            ->withHttpOnly(false)
+            ->withSameSite('lax');
+
+        if (null !== $this->cookieDomain && '' !== $this->cookieDomain) {
+            $cookie = $cookie->withDomain($this->cookieDomain);
+        } else {
+            $request = $this->requestStack->getCurrentRequest();
+            if (null === $request) {
+                return;
+            }
+
+            $domain = $this->getBaseDomain($request->getHost());
+            if (null !== $domain) {
+                $cookie = $cookie->withDomain($domain);
+            }
         }
-        $request->cookies->set(self::CHAT_COOKIE_NAME, $value);
+
+        $this->queue->queue($cookie);
     }
 
     private function isShopUser(): bool
@@ -59,4 +81,22 @@ private function isShopUser(): bool
 
         return true;
     }
+
+    private function getBaseDomain(string $host): ?string
+    {
+        $host = (string) preg_replace('/:\d+$/', '', $host);
+
+        if ($host === 'localhost' || filter_var($host, \FILTER_VALIDATE_IP) !== false) {
+            return null;
+        }
+
+        $parts = explode('.', $host);
+        $count = count($parts);
+
+        if ($count >= 2) {
+            return '.' . $parts[$count - 2] . '.' . $parts[$count - 1];
+        }
+
+        return null;
+    }
 }
diff --git a/src/Manager/OrderUpdateManagerInterface.php b/src/Manager/OrderUpdateManagerInterface.php
@@ -16,8 +16,8 @@
 interface OrderUpdateManagerInterface
 {
     public const PRODUCT_EVENT_MAP = [
-        OrderInterface::STATE_NEW => 'purchase',
-        OrderInterface::STATE_FULFILLED => 'reservation',
+        OrderInterface::STATE_NEW => 'order',
+        OrderInterface::STATE_FULFILLED => 'purchase',
         OrderInterface::STATE_CANCELLED => 'remove',
     ];
 
diff --git a/src/OpenApi/OpenApiFactory.php b/src/OpenApi/OpenApiFactory.php
diff --git a/src/Updater/CustomerWithKeyUpdater.php b/src/Updater/CustomerWithKeyUpdater.php
diff --git a/templates/Scripts/_userComScripts.html.twig b/templates/Scripts/_userComScripts.html.twig
diff --git a/tests/Application/.env b/tests/Application/.env

Original file line number	Diff line number	Diff line change
`@@ -61,11 +61,7 @@ jobs:`
`61`	`61`	`-`
`62`	`62`	`name: Output PHP version for Symfony CLI`
`63`	`63`	`run: php -v \| head -n 1 \| awk '{ print $2 }' > .php-version`
`64`		`-`
`65`		`- -`
`66`		`- name: Install certificates`
`67`		`- run: symfony server:ca:install`
`68`		`-`
	`64`	`+`
`69`	`65`	`-`
`70`	`66`	`name: Run Chrome Headless`
`71`	`67`	`run: google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1 > /dev/null 2>&1 &`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@`
`9`	`9`	`>`
`10`	`10`	`<argument type="service" id="request_stack"/>`
`11`	`11`	`<argument type="service" id="security.token_storage"/>`
	`12`	`+ <argument type="service" id="bit_bag.sylius_user_com_plugin.cookie.cookie_queue"/>`
	`13`	`+ <argument>%user_com.cookie_domain%</argument>`
`12`	`14`	`</service>`
`13`	`15`
`14`	`16`	`<service`