Merge pull request #23 from BitBagCommerce/UC-23

[UC-23] Remove GA4 and DataFeed plugins from composer.json dependency

Author: tomkalon

UPGRADE.md

@@ -1,122 +1,11 @@
-# UPGRADE FROM `v1.3.X` TO `v1.4.0`
+# UPGRADE FROM `1.0` TO `1.1`
 
-First step is upgrading Sylius with composer
+### Dependencies
 
-- `composer require sylius/sylius:~1.4.0`
+1. Removed `bitbag/google-analytics-4-plugin` dependency (see “Behavioral changes”).
+2. Removed `bitbag/sylius-feed-plugin` dependency (see “Behavioral changes”).
 
-### Test application database
+### Behavioral changes
 
-#### Migrations
-
-If you provide migrations with your plugin, take a look at following changes:
-
-* Change base `AbstractMigration` namespace to `Doctrine\Migrations\AbstractMigration`
-* Add `: void` return types to both `up` and `down` functions
-
-#### Schema update
-
-If you don't use migrations, just run `(cd tests/Application && bin/console doctrine:schema:update --force)` to update the test application's database schema.
-
-### Dotenv
-
-* `composer require symfony/dotenv:^4.2 --dev`
-* Follow [Symfony dotenv update guide](https://symfony.com/doc/current/configuration/dot-env-changes.html) to incorporate required changes in `.env` files structure. Remember - they should be done on `tests/Application/` level! Optionally, you can take a look at [corresponding PR](https://github.com/Sylius/PluginSkeleton/pull/156/) introducing these changes in **PluginSkeleton** (this PR also includes changes with Behat - see below)
-
-Don't forget to clear the cache (`tests/Application/bin/console cache:clear`) to be 100% everything is loaded properly.
-
-### Test application kernel
-
-The kernel of the test application needs to be replaced with this [file](https://github.com/Sylius/PluginSkeleton/blob/1.4/tests/Application/Kernel.php).
-The location of the kernel is: `tests/Application/Kernel.php` (replace the content with the content of the file above).
-The container cleanup method is removed in the new version and keeping it will cause problems with for example the `TagAwareAdapter` which will call `commit()` on its pool from its destructor. If its pool is `TraceableAdapter` with pool `ArrayAdapter`, then the pool property of `TraceableAdapter` will be nullified before the destructor is executed and cause an error.
-
----
-
-### Behat
-
-If you're using Behat and want to be up-to-date with our configuration
-
-* Update required extensions with `composer require friends-of-behat/symfony-extension:^2.0 friends-of-behat/page-object-extension:^0.3 --dev`
-* Remove extensions that are not needed yet with `composer remove friends-of-behat/context-service-extension friends-of-behat/cross-container-extension friends-of-behat/service-container-extension --dev`
-* Update your `behat.yml` - look at the diff [here](https://github.com/Sylius/Sylius-Standard/pull/322/files#diff-7bde54db60a6e933518d8b61b929edce)
-* Add `SymfonyExtensionBundle` to your `tests/Application/config/bundles.php`:
-    ```php
-    return [
-        //...
-        FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle::class => ['test' => true, 'test_cached' => true],
-    ];
-    ```
-* If you use our Travis CI configuration, follow [these changes](https://github.com/Sylius/PluginSkeleton/pull/156/files#diff-354f30a63fb0907d4ad57269548329e3) introduced in `.travis.yml` file
-* Create `tests/Application/config/services_test.yaml` file with the following code and add these your own Behat services as well:
-    ```yaml
-    imports:
-        - { resource: "../../../vendor/sylius/sylius/src/Sylius/Behat/Resources/config/services.xml" }
-    ```
-* Remove all `__symfony__` prefixes in your Behat services
-* Remove all `<tag name="fob.context_service" />` tags from your Behat services
-* Make your Behat services public by default with `<defaults public="true" />`
-* Change `contexts_services ` in your suite definitions to `contexts`
-* Take a look at [SymfonyExtension UPGRADE guide](https://github.com/FriendsOfBehat/SymfonyExtension/blob/master/UPGRADE-2.0.md) if you have any more problems
-
-### Phpstan
-
-* Fix the container XML path parameter in the `phpstan.neon` file as done [here](https://github.com/Sylius/PluginSkeleton/commit/37fa614dbbcf8eb31b89eaf202b4bd4d89a5c7b3)
-
-# UPGRADE FROM `v1.2.X` TO `v1.4.0`
-
-Firstly, check out the [PluginSkeleton 1.3 upgrade guide](https://github.com/Sylius/PluginSkeleton/blob/1.4/UPGRADE-1.3.md) to update Sylius version step by step.
-To upgrade to Sylius 1.4 follow instructions from [the previous section](https://github.com/Sylius/PluginSkeleton/blob/1.4/UPGRADE-1.4.md#upgrade-from-v13x-to-v140) with following changes:
-
-### Doctrine migrations
-
-* Change namespaces of copied migrations to `Sylius\Migrations`
-
-### Dotenv
-
-* These changes are not required, but can be done as well, if you've changed application directory structure in `1.2.x` to `1.3` update
-
-### Behat
-
-* Add `\FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle()` to your bundles lists in `tests/Application/AppKernel.php` (preferably only in `test` environment)
-* Import Sylius Behat services in `tests/Application/config/config_test.yml` and your own Behat services as well:
-    ```yaml
-    imports:
-        - { resource: "../../../../vendor/sylius/sylius/src/Sylius/Behat/Resources/config/services.xml" }
-    ```
-* Specify test application's kernel path in `behat.yml`:
-    ```yaml
-     FriendsOfBehat\SymfonyExtension:
-        kernel:
-          class: AppKernel
-          path: tests/Application/app/AppKernel.php
-    ```
-
-
-# UPGRADE FROM `v1.2.X` TO `v1.3.0`
-
-## Application
-
-* Run `composer require sylius/sylius:~1.3.0 --no-update`
-
-* Add the following code in your `behat.yml(.dist)` file:
-
-    ```yaml
-    default:
-        extensions:
-            FriendsOfBehat\SymfonyExtension:
-                env_file: ~  
-    ```
-    
-* Incorporate changes from the following files into plugin's test application:
-
-    * [`tests/Application/package.json`](https://github.com/Sylius/PluginSkeleton/blob/1.3/tests/Application/package.json) ([see diff](https://github.com/Sylius/PluginSkeleton/pull/134/files#diff-726e1353c14df7d91379c0dea6b30eef)) 
-    * [`tests/Application/.babelrc`](https://github.com/Sylius/PluginSkeleton/blob/1.3/tests/Application/.babelrc) ([see diff](https://github.com/Sylius/PluginSkeleton/pull/134/files#diff-a2527d9d8ad55460b2272274762c9386))
-    * [`tests/Application/.eslintrc.js`](https://github.com/Sylius/PluginSkeleton/blob/1.3/tests/Application/.eslintrc.js) ([see diff](https://github.com/Sylius/PluginSkeleton/pull/134/files#diff-396c8c412b119deaa7dd84ae28ae04ca))
-     
-* Update PHP and JS dependencies by running `composer update` and `(cd tests/Application && yarn upgrade)`
-
-* Clear cache by running `(cd tests/Application && bin/console cache:clear)`
-
-* Install assets by `(cd tests/Application && bin/console assets:install web)` and `(cd tests/Application && yarn build)`
-
-* optionally, remove the build for PHP 7.1. in `.travis.yml`
+1.  If you don’t provide an alternative to `bitbag/google-analytics-4-plugin`, you lose automatic dataLayer pushes for Google Analytics 4.
+2. No product feed is generated by default.

composer.json

@@ -6,18 +6,15 @@
     "license": "MIT",
     "require": {
         "php": "^8.1",
-        "bitbag/coding-standard": "^3.0",
-        "bitbag/google-analytics-4-plugin": "^1.0",
         "sylius/sylius": "~1.13.0",
+        "symfony/amqp-messenger": "^5.4 || ^6.4 || ^7.0",
         "symfony/messenger": "^5.4 || ^6.4",
-        "symfony/webpack-encore-bundle": "^1.15",
-        "ext-openssl": "*",
-        "bitbag/sylius-feed-plugin": "~0.2",
-        "symfony/amqp-messenger": "^5.4 || ^6.4 || ^7.0"
+        "symfony/webpack-encore-bundle": "^1.15"
     },
     "require-dev": {
         "behat/behat": "^3.6.1",
         "behat/mink-selenium2-driver": "^1.4",
+        "bitbag/coding-standard": "^3.0",
         "dbrekelmans/bdi": "^1.1",
         "dmore/behat-chrome-extension": "^1.3",
         "dmore/chrome-mink-driver": "^2.7",
@@ -38,7 +35,6 @@
         "phpunit/phpunit": "^10.5",
         "polishsymfonycommunity/symfony-mocker-container": "^1.0",
         "robertfausk/behat-panther-extension": "^1.1",
-        "setono/sylius-feed-plugin": "dev-master",
         "sylius-labs/coding-standard": "^4.2",
         "sylius-labs/suite-tags-extension": "^0.2",
         "symfony/browser-kit": "^5.4 || ^6.4",

config/bundles.php

@@ -2,8 +2,5 @@
 
 return [
     League\FlysystemBundle\FlysystemBundle::class => ['all' => true],
-    Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin::class => ['all' => true],
-    Setono\DoctrineORMBatcherBundle\SetonoDoctrineORMBatcherBundle::class => ['all' => true],
-    Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
     Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];

config/config.yml

@@ -12,5 +12,3 @@ imports:
     - { resource: "events.yaml" }
     - { resource: "monolog.yaml" }
     - { resource: "packages/*" }
-
-    - { resource: "@SetonoSyliusFeedPlugin/Resources/config/app/config.yaml" }

config/packages/uid.yaml

@@ -1,6 +1,3 @@
-setono_sylius_feed:
-    resource: "@SetonoSyliusFeedPlugin/Resources/config/routing.yaml"
-
 bitbag_user_com_customer_agreements_endpoint:
     path: /user-com/customer-agreements
     controller: bit_bag.sylius_user_com_plugin.controller.user_com_agreements_controller

config/routes.yaml

@@ -6,7 +6,6 @@
 2. Add required environment variables to your `.env` file:
     ```dotenv
         USER_COM_FRONTEND_API_KEY=""
-        GOOGLE_ANALYTICS_TAG=""
         USER_COM_ENCRYPTION_KEY=your-32-character-long-key
         USER_COM_ENCRYPTION_IV=your-16-character-long-iv
         MESSENGER_USER_COM_ASYNCHRONOUS_DSN=""
@@ -16,11 +15,7 @@
     return [
         ...
             BitBag\SyliusUserComPlugin\BitBagSyliusUserComPlugin::class => ['all' => true],
-            Spinbits\SyliusGoogleAnalytics4Plugin\SpinbitsSyliusGoogleAnalytics4Plugin::class => ['all' => true],
             League\FlysystemBundle\FlysystemBundle::class => ['all' => true],
-            Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin::class => ['all' => true],
-            Setono\DoctrineORMBatcherBundle\SetonoDoctrineORMBatcherBundle::class => ['all' => true],
-           //Sylius grid bundle should be under Setono\SyliusFeedPlugin\SetonoSyliusFeedPlugin
             Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
         ...
     ];
@@ -51,21 +46,15 @@
     ```
     
     >`UserComApiAwareTrait` contains mapping for annotations and for attributes which are required by UserCom integration. If you're using xml mapping, you should add mapping for those properties in your `Channel.orm.xml` file.
-
-7. Take advantage of channel based configuration of GoogleAnalyticsPlugin by adding :
-    ```yaml
-    spinbits_sylius_google_analytics4:
-      id: "%env(GOOGLE_ANALYTICS_TAG)%"
-      enabled: true
-    ```
-8. Compile assets
+   
+7. Compile assets
 ```bash
   yarn install && yarn build
 ```
-9. Add API credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that API credentials are set.
+8. Add API credentials and GTM to your channel configuration in admin panel. If you decided to extend different object, please make sure that API credentials are set.
 ![Channel configuration](../doc/user_com_configuration.png)
 
-10. Configure consumer to run in supervisor:
+9. Configure consumer to run in supervisor:
 ```bash
    bin/console messenger:consume user_com_asynchronous
 ```

doc/installation.md

@@ -4,20 +4,13 @@
 
 namespace BitBag\SyliusUserComPlugin;
 
-use BitBag\SyliusUserComPlugin\DependencyInjection\LogoutSubscriberPass;
 use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
-use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 final class BitBagSyliusUserComPlugin extends Bundle
 {
     use SyliusPluginTrait;
 
-    public function build(ContainerBuilder $container): void
-    {
-        $container->addCompilerPass(new LogoutSubscriberPass());
-    }
-
     public function getPath(): string
     {
         return \dirname(__DIR__);