Added: Bot detecting

Setono · Nov 19, 2021 · a3bb879 · a3bb879
1 parent d028fb1
commit a3bb879
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,7 @@ in `config/bundles.php` file of your project before (!) `SyliusGridBundle`:
 $bundles = [
     Setono\ClientIdBundle\SetonoClientIdBundle::class => ['all' => true],
     Setono\ConsentBundle\SetonoConsentBundle::class => ['all' => true],
+    Setono\BotDetectionBundle\SetonoBotDetectionBundle::class => ['all' => true],
     Setono\SyliusFacebookPlugin\SetonoSyliusFacebookPlugin::class => ['all' => true],
     Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],
 ];

diff --git a/UPGRADE.md b/UPGRADE.md
@@ -3,14 +3,15 @@
 1. As we're moving to server side tracking - we no longer need `SetonoTagBagBundle` 
    and `SetonoSyliusTagBagPlugin`. 
 
-- Remove them from `config/bundles.php`:
+- Remove them from `config/bundles.php` and add ones we're using:
 
     ```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\BotDetectionBundle\SetonoBotDetectionBundle::class => ['all' => true],
 
              Setono\SyliusFacebookPlugin\SetonoSyliusFacebookPlugin::class => ['all' => true],
              Sylius\Bundle\GridBundle\SyliusGridBundle::class => ['all' => true],

diff --git a/composer.json b/composer.json
@@ -19,6 +19,7 @@
         "fzaninotto/faker": "^1.6",
         "knplabs/knp-menu": "^3.0",
         "psr/log": "^1.1",
+        "setono/bot-detection-bundle": "^1.1",
         "setono/client-id-bundle": "^0.2",
         "setono/client-id-contracts": "^0.2",
         "setono/consent-bundle": "^0.1",

diff --git a/src/EventListener/AbstractSubscriber.php b/src/EventListener/AbstractSubscriber.php
@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusFacebookPlugin\EventListener;
 
+use Setono\BotDetectionBundle\BotDetector\BotDetectorInterface;
 use Setono\SyliusFacebookPlugin\Context\PixelContextInterface;
 use Setono\SyliusFacebookPlugin\Generator\PixelEventsGeneratorInterface;
 use Symfony\Bundle\SecurityBundle\Security\FirewallMap;
@@ -21,16 +22,20 @@ abstract class AbstractSubscriber implements EventSubscriberInterface
 
     protected PixelEventsGeneratorInterface $pixelEventsGenerator;
 
+    protected BotDetectorInterface $botDetector;
+
     public function __construct(
         RequestStack $requestStack,
         FirewallMap $firewallMap,
         PixelContextInterface $pixelContext,
-        PixelEventsGeneratorInterface $pixelEventsGenerator
+        PixelEventsGeneratorInterface $pixelEventsGenerator,
+        BotDetectorInterface $botDetector
     ) {
         $this->requestStack = $requestStack;
         $this->firewallMap = $firewallMap;
         $this->pixelContext = $pixelContext;
         $this->pixelEventsGenerator = $pixelEventsGenerator;
+        $this->botDetector = $botDetector;
     }
 
     protected function isShopContext(Request $request = null): bool
@@ -60,6 +65,14 @@ protected function isRequestEligible(): bool
             return false;
         }
 
-        return $this->isShopContext();
+        if (!$this->isShopContext()) {
+            return false;
+        }
+
+        if ($this->botDetector->isBotRequest()) {
+            return false;
+        }
+
+        return true;
     }
 }
diff --git a/src/EventListener/AddToCartSubscriber.php b/src/EventListener/AddToCartSubscriber.php
@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusFacebookPlugin\EventListener;
 
+use Setono\BotDetectionBundle\BotDetector\BotDetectorInterface;
 use Setono\SyliusFacebookPlugin\Context\PixelContextInterface;
 use Setono\SyliusFacebookPlugin\Generator\PixelEventsGeneratorInterface;
 use Setono\SyliusFacebookPlugin\ServerSide\ServerSideEventInterface;
@@ -21,9 +22,16 @@ public function __construct(
         FirewallMap $firewallMap,
         PixelContextInterface $pixelContext,
         PixelEventsGeneratorInterface $pixelEventsGenerator,
+        BotDetectorInterface $botDetector,
         CartContextInterface $cartContext
     ) {
-        parent::__construct($requestStack, $firewallMap, $pixelContext, $pixelEventsGenerator);
+        parent::__construct(
+            $requestStack,
+            $firewallMap,
+            $pixelContext,
+            $pixelEventsGenerator,
+            $botDetector
+        );
 
         $this->cartContext = $cartContext;
     }

diff --git a/src/EventListener/InitiateCheckoutSubscriber.php b/src/EventListener/InitiateCheckoutSubscriber.php
@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusFacebookPlugin\EventListener;
 
+use Setono\BotDetectionBundle\BotDetector\BotDetectorInterface;
 use Setono\SyliusFacebookPlugin\Context\PixelContextInterface;
 use Setono\SyliusFacebookPlugin\Generator\PixelEventsGeneratorInterface;
 use Setono\SyliusFacebookPlugin\ServerSide\ServerSideEventInterface;
@@ -22,9 +23,16 @@ public function __construct(
         FirewallMap $firewallMap,
         PixelContextInterface $pixelContext,
         PixelEventsGeneratorInterface $pixelEventsGenerator,
+        BotDetectorInterface $botDetector,
         CartContextInterface $cartContext
     ) {
-        parent::__construct($requestStack, $firewallMap, $pixelContext, $pixelEventsGenerator);
+        parent::__construct(
+            $requestStack,
+            $firewallMap,
+            $pixelContext,
+            $pixelEventsGenerator,
+            $botDetector
+        );
 
         $this->cartContext = $cartContext;
     }

diff --git a/src/EventListener/PurchaseSubscriber.php b/src/EventListener/PurchaseSubscriber.php
@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusFacebookPlugin\EventListener;
 
+use Setono\BotDetectionBundle\BotDetector\BotDetectorInterface;
 use Setono\SyliusFacebookPlugin\Context\PixelContextInterface;
 use Setono\SyliusFacebookPlugin\Generator\PixelEventsGeneratorInterface;
 use Setono\SyliusFacebookPlugin\ServerSide\ServerSideEventInterface;
@@ -23,9 +24,16 @@ public function __construct(
         FirewallMap $firewallMap,
         PixelContextInterface $pixelContext,
         PixelEventsGeneratorInterface $pixelEventsGenerator,
+        BotDetectorInterface $botDetector,
         OrderRepositoryInterface $orderRepository
     ) {
-        parent::__construct($requestStack, $firewallMap, $pixelContext, $pixelEventsGenerator);
+        parent::__construct(
+            $requestStack,
+            $firewallMap,
+            $pixelContext,
+            $pixelEventsGenerator,
+            $botDetector
+        );
 
         $this->orderRepository = $orderRepository;
     }

diff --git a/src/EventListener/ViewCategorySubscriber.php b/src/EventListener/ViewCategorySubscriber.php
@@ -4,6 +4,7 @@
 
 namespace Setono\SyliusFacebookPlugin\EventListener;
 
+use Setono\BotDetectionBundle\BotDetector\BotDetectorInterface;
 use Setono\SyliusFacebookPlugin\Context\PixelContextInterface;
 use Setono\SyliusFacebookPlugin\Data\ViewCategoryData;
 use Setono\SyliusFacebookPlugin\Generator\PixelEventsGeneratorInterface;
@@ -33,10 +34,17 @@ public function __construct(
         FirewallMap $firewallMap,
         PixelContextInterface $pixelContext,
         PixelEventsGeneratorInterface $pixelEventsGenerator,
+        BotDetectorInterface $botDetector,
         LocaleContextInterface $localeContext,
         TaxonRepositoryInterface $taxonRepository
     ) {
-        parent::__construct($requestStack, $firewallMap, $pixelContext, $pixelEventsGenerator);
+        parent::__construct(
+            $requestStack,
+            $firewallMap,
+            $pixelContext,
+            $pixelEventsGenerator,
+            $botDetector
+        );
 
         $this->localeContext = $localeContext;
         $this->taxonRepository = $taxonRepository;

diff --git a/src/Resources/config/services/event_listener.xml b/src/Resources/config/services/event_listener.xml
@@ -10,6 +10,7 @@
             <argument type="service" id="security.firewall.map"/>
             <argument type="service" id="setono_sylius_facebook.context.pixel"/>
             <argument type="service" id="setono_sylius_facebook.generator.pixel_events"/>
+            <argument type="service" id="setono_bot_detection.bot_detector.default"/>
         </service>
 
         <service id="setono_sylius_facebook.event_listener.add_to_cart"

diff --git a/tests/Application/config/bundles.php b/tests/Application/config/bundles.php
@@ -54,5 +54,6 @@
     Symfony\Bundle\WebProfilerBundle\WebProfilerBundle::class => ['dev' => true, 'test' => true, 'test_cached' => true],
     Setono\ClientIdBundle\SetonoClientIdBundle::class => ['all' => true],
     Setono\ConsentBundle\SetonoConsentBundle::class => ['all' => true],
+    Setono\BotDetectionBundle\SetonoBotDetectionBundle::class => ['all' => true],
     FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle::class => ['test' => true, 'test_cached' => true],
 ];