[WIP] Converted: Tracking to server side

Author: igormukhingmailcom

.phpstorm.meta.php

@@ -0,0 +1,3 @@
+<?php
+
+namespace PHPSTORM_META;

README.md

@@ -12,21 +12,15 @@ Track user behavior in Facebook.
 
 ### Step 1: Download the plugin
 
-This plugin uses the [TagBagBundle](https://github.com/Setono/TagBagBundle) to inject scripts onto your page.
-
 Open a command console, enter your project directory and execute the following command to download the latest stable version of this plugin:
 
 ```bash
 $ composer require setono/sylius-facebook-plugin
 
-# Omit this line if you want to override layout.html.twig as described at https://github.com/Setono/TagBagBundle#usage
-$ composer require setono/sylius-tag-bag-plugin
-
 ```
 
 This command requires you to have Composer installed globally, as explained in the [installation chapter](https://getcomposer.org/doc/00-intro.md) of the Composer documentation.
 
-
 ### Step 2: Enable the plugin
 
 Then, enable the plugin by adding it to the list of registered plugins/bundles
@@ -35,11 +29,8 @@ in `config/bundles.php` file of your project before (!) `SyliusGridBundle`:
 ```php
 <?php
 $bundles = [
-    Setono\TagBagBundle\SetonoTagBagBundle::class => ['all' => true],
-    
-    // Omit this line if you didn't install the SyliusTagBagPlugin in step 1
-    Setono\SyliusTagBagPlugin\SetonoSyliusTagBagPlugin::class => ['all' => true],
-    
+    Setono\ClientIdBundle\SetonoClientIdBundle::class => ['all' => true],
+    Setono\ConsentBundle\SetonoConsentBundle::class => ['all' => true],
     Setono\SyliusFacebookPlugin\SetonoSyliusFacebookPlugin::class => ['all' => true],
     Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];
@@ -48,18 +39,26 @@ $bundles = [
 ### Step 3: Configure plugin
 
 ```yaml
-# config/packages/_sylius.yaml
+# config/packages/setono_sylius_facebook.yaml
 imports:
-    # ...
     - { resource: "@SetonoSyliusFacebookPlugin/Resources/config/app/config.yaml" }
-    # ...
+
+setono_sylius_facebook:
+    access_token: '%env(FACEBOOK_ACCESS_TOKEN)%'
+```
+
+```dotenv
+# .env
+###> setono/sylius-facebook-plugin ###
+FACEBOOK_ACCESS_TOKEN=<YOUR TOKEN>
+###< setono/sylius-facebook-plugin ###
 ```
 
 ### Step 4: Import routing
 
 ```yaml
 # config/routes/setono_sylius_facebook.yaml
-setono_facebook_tracking:
+setono_sylius_facebook:
     resource: "@SetonoSyliusFacebookPlugin/Resources/config/routing.yaml"
 ```
 
@@ -76,9 +75,23 @@ When you create a pixel in Facebook you receive a pixel id.
 Now create a new pixel in your Sylius shop by navigating to `/admin/pixels/new`.
 Remember to enable the pixel and enable the channels you want to track. 
 
-### Step 7: You're ready!
+### Step 7. Configure cron
+
+Add `bin/console setono:sylius-facebook:send-pixel-events` command to your crontab.
+
+Schedule must be hourly or more frequently. 
+See [notes](https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api#batch-requests).
+
+### Step 8: You're ready!
 The events that are tracked are located in the [EventListener folder](src/EventListener).
 
+## Related links
+- https://developers.facebook.com/docs/marketing-api/audiences/guides/dynamic-product-audiences/#setuppixel
+- https://developers.facebook.com/docs/marketing-api/conversions-api
+- https://developers.facebook.com/docs/marketing-api/conversions-api/using-the-api
+- https://developers.facebook.com/docs/marketing-api/conversions-api/guides/business-sdk-features
+- https://github.com/facebook/facebook-php-business-sdk
+
 ## Contribute
 Ways you can contribute:
 * Translate [messages](src/Resources/translations/messages.en.yaml) and [validators](src/Resources/translations/validators.en.yaml) to your mother tongue

UPGRADE.md

@@ -0,0 +1,57 @@
+# UPGRADE FROM `1.0.x` to `2.0.x`
+
+1. As we're moving to server side tracking - we no longer need `SetonoTagBagBundle` 
+   and `SetonoSyliusTagBagPlugin`. 
+   
+- Remove them from `config/bundles.php`:
+
+    ```diff
+         $bundles = [
+     -       Setono\TagBagBundle\SetonoTagBagBundle::class => ['all' => true],
+     -       Setono\SyliusTagBagPlugin\SetonoSyliusTagBagPlugin::class => ['all' => true],
+     +       Setono\ClientIdBundle\SetonoClientIdBundle::class => ['all' => true],
+     +       Setono\ConsentBundle\SetonoConsentBundle::class => ['all' => true],
+
+             Setono\SyliusFacebookPlugin\SetonoSyliusFacebookPlugin::class => ['all' => true],
+             Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
+         ];
+    ```
+   
+- Remove `setono/sylius-tag-bag-plugin` if it used
+    
+    ```bash
+    composer remove setono/sylius-tag-bag-plugin
+    ```
+
+1. Remove custom event listeners extended from `Setono\SyliusFacebookPlugin\EventListener\TagSubscriber`
+   from your application:
+
+    ```php
+     -  namespace App\EventListener;
+   
+     -  use Setono\SyliusFacebookPlugin\EventListener\AbstractSubscriber;
+    
+     -  final class SomeTagSubscriber extends AbstractSubscriber
+     -  {
+     -  ...
+     -  }
+    ```
+1. Configure Access token
+
+    ```yaml
+    # config/packages/setono_sylius_facebook.yaml
+    ...
+    setono_sylius_facebook:
+        access_token: '%env(FACEBOOK_ACCESS_TOKEN)%'
+    ```
+    
+    ```dotenv
+    # .env
+    ###> setono/sylius-facebook-plugin ###
+    FACEBOOK_ACCESS_TOKEN=<YOUR TOKEN>
+    ###< setono/sylius-facebook-plugin ###
+    ```
+1. `src/EventListener/TagSubscriber.php -> src/EventListener/AbstractSubscriber.php`
+
+1. Add `bin/console setono:sylius-facebook:send-pixel-events`
+   command call to your CRON

composer.json

@@ -11,20 +11,41 @@
     "license": "MIT",
     "require": {
         "php": ">=7.4",
+        "ext-json": "*",
+        "facebook/php-business-sdk": "^12.0",
         "psr/event-dispatcher": "^1.0",
-        "setono/tag-bag-bundle": "^2.0",
-        "setono/tag-bag-twig": "^1.0",
+        "psr/log": "^1.1",
+        "setono/client-id-bundle": "^0.2",
+        "setono/client-id-contracts": "^0.2",
+        "setono/consent-bundle": "^0.1",
+        "setono/consent-contracts": "^0.1",
         "sylius/resource-bundle": "^1.6",
         "symfony/config": "^4.4 || ^5.0",
-        "thecodingmachine/safe": "^1.0"
+        "symfony/console": "^4.4 || ^5.0",
+        "symfony/dependency-injection": "^4.4 || ^5.0",
+        "symfony/event-dispatcher": "^4.4 || ^5.0",
+        "symfony/form": "^4.4 || ^5.0",
+        "symfony/http-client": "^5.3",
+        "symfony/http-client-contracts": "^2.4",
+        "symfony/http-foundation": "^4.4 || ^5.0.7",
+        "symfony/http-kernel": "^4.4 || ^5.1.5",
+        "symfony/messenger": "^4.4 || ^5.0",
+        "symfony/routing": "^4.4 || ^5.0",
+        "symfony/serializer": "^4.4 || ^5.0",
+        "symfony/workflow": "^4.4 || ^5.0",
+        "thecodingmachine/safe": "^1.0",
+        "webmozart/assert": "^1.10"
     },
     "require-dev": {
+        "matthiasnoback/symfony-config-test": "^4.3",
+        "matthiasnoback/symfony-dependency-injection-test": "^4.3",
         "phpspec/phpspec": "^6.3",
         "phpunit/phpunit": "^9.5",
+        "psalm/plugin-phpunit": "^0.16.0",
+        "psalm/plugin-symfony": "^2.4",
         "roave/security-advisories": "dev-latest",
-        "setono/code-quality-pack": "^1.5.1",
+        "setono/code-quality-pack": "^2.1.2",
         "setono/sylius-behat-pack": "^0.1",
-        "setono/sylius-tag-bag-plugin": "^1.1",
         "sylius/sylius": "~1.7.0",
         "symfony/debug-bundle": "^5.1",
         "symfony/dotenv": "^5.2",
@@ -54,9 +75,13 @@
     },
     "prefer-stable": true,
     "scripts": {
-        "analyse": "phpstan analyse -c phpstan.neon -l max src",
-        "check-style": "ecs check --ansi spec src",
-        "fix-style": "ecs check --ansi spec src --fix",
+        "analyse": [
+            "@ensure-test-container-exists",
+            "psalm"
+        ],
+        "check-style": "ecs check --ansi",
+        "ensure-test-container-exists": "[[ -f tests/Application/var/cache/test/ApplicationTests_Setono_SyliusFacebookPlugin_Application_KernelTestDebugContainer.xml ]] || tests/Application/bin/console cache:warmup --env=test",
+        "fix-style": "ecs check --ansi --fix",
         "phpspec": "phpspec run --ansi",
         "phpunit": "phpunit"
     }

easy-coding-standard.yml

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+use Symplify\EasyCodingStandard\ValueObject\Option;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $containerConfigurator->import('vendor/sylius-labs/coding-standard/ecs.php');
+    $containerConfigurator->parameters()->set(Option::PATHS, [
+        'src',
+        'tests',
+    ]);
+    $containerConfigurator->parameters()->set(Option::SKIP, [
+        'tests/Application/**',
+    ]);
+};

ecs.php

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<psalm
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    totallyTyped="true"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="spec"/>
+        <directory name="src"/>
+        <directory name="tests"/>
+        <ignoreFiles>
+            <directory name="tests/Application"/>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+    <plugins>
+        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
+            <containerXml>tests/Application/var/cache/test/ApplicationTests_Setono_SyliusFacebookPlugin_Application_KernelTestDebugContainer.xml</containerXml>
+        </pluginClass>
+        <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
+    </plugins>
+    <issueHandlers>
+        <UnnecessaryVarAnnotation errorLevel="suppress"/> <!-- We only use 'unnecessary' var annotations when we want to help PhpStorm :) -->
+        <DeprecatedMethod>
+            <errorLevel type="suppress">
+                <referencedMethod name="Symfony\Component\HttpFoundation\RequestStack::getMasterRequest"/>
+            </errorLevel>
+        </DeprecatedMethod>
+    </issueHandlers>
+</psalm>