Merge pull request #2 from picqer/fix-config-on-specific-sales-channel

Haal webhook instellingen bij bijbehorend verkoopkanaal op

Author: cwdt

README.md

@@ -16,6 +16,8 @@ This project can easily be installed through Composer.
 3. Fill out the general configuration information:
     + Subdomain: is the prefix of your domain name. If your log on to 'my-shop.picqer.com', then fill in 'my-shop'.
     + Connection Key: can be found in Picqer > Settings > Webshops > Shopware shop. Copy and paste this field.
+    + Disable sending webhooks for this sales channel
+    + Enable debug logging: Only enable when the plugin is not working, this will log errors in the communication with Picqer.
 
 Orders will now be pushed to Picqer immediately.
 

composer.json

@@ -20,7 +20,7 @@
     ],
     "require": {
         "php": ">=7.4",
-        "shopware/core": "6.4.*",
+        "shopware/core": "^6.4",
         "ext-curl": "*",
         "ext-json": "*"
     },

src/Client/CurlPicqerClient.php

@@ -6,7 +6,7 @@
 
 final class CurlPicqerClient implements PicqerClient
 {
-    const USER_AGENT = 'Picqer Shopware 6 Plugin (version 1.0.0)';
+    const USER_AGENT = 'Picqer Shopware 6 Plugin (version 1.1.0)';
 
     public function pushOrder(string $subdomain, string $connectionKey, string $id): void
     {
@@ -16,13 +16,13 @@ public function pushOrder(string $subdomain, string $connectionKey, string $id):
         );
     }
 
-    private function post(string $url, array $body): void
+    private function post(string $endpoint, array $body): void
     {
         $session = curl_init();
 
         curl_setopt($session, CURLOPT_USERAGENT, self::USER_AGENT);
 
-        curl_setopt($session, CURLOPT_URL, $url);
+        curl_setopt($session, CURLOPT_URL, $endpoint);
         curl_setopt($session, CURLOPT_HTTPHEADER, [
             'Content-Type: application/json',
             'Accept: application/json'
@@ -42,7 +42,7 @@ private function post(string $url, array $body): void
         curl_close($session);
 
         if ($errorNo) {
-            throw new RequestFailedException($errorMessage);
+            throw new RequestFailedException($endpoint, $errorMessage);
         }
     }
 }

src/Exception/IncompleteConfigurationException.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace Picqer\Shopware6Plugin\Exception;
+
+use Exception;
+
+class IncompleteConfigurationException extends Exception
+{
+    /**
+     * @var string|null
+     */
+    private $subdomain;
+
+    /**
+     * @var string|null
+     */
+    private $connectionKey;
+
+    public function __construct(
+        string $subdomain = null,
+        string $connectionKey = null
+    ) {
+        $this->subdomain = $subdomain;
+        $this->connectionKey = $connectionKey;
+    }
+
+    public function getSubdomain()
+    {
+        return $this->subdomain;
+    }
+
+    public function getConnectionKey()
+    {
+        return $this->connectionKey;
+    }
+}

src/Exception/InvalidConfigException.php renamed to src/Exception/OrderNotFoundException.php

@@ -4,7 +4,7 @@
 
 use Exception;
 
-class InvalidConfigException extends Exception
+final class OrderNotFoundException extends Exception
 {
 
 }

src/Exception/RequestFailedException.php

@@ -6,5 +6,22 @@
 
 class RequestFailedException extends Exception
 {
+    /**
+     * @var string
+     */
+    private $endpoint;
 
+    public function __construct(
+        string $endpoint,
+        string $message
+    ) {
+        $this->endpoint = $endpoint;
+
+        parent::__construct($message);
+    }
+
+    public function getEndpoint(): string
+    {
+        return $this->endpoint;
+    }
 }

src/Resources/config/config.xml

@@ -9,8 +9,16 @@
         <label>Subdomain</label>
     </input-field>
     <input-field>
-        <name >connectionkey</name>
+        <name>connectionkey</name>
         <label>Connection Key</label>
     </input-field>
+    <input-field type="bool">
+        <name>disabled</name>
+        <label>Disable sending webhooks for this sales channel</label>
+    </input-field>
+    <input-field type="bool">
+        <name>debug</name>
+        <label>Enable debug logging</label>
+    </input-field>
 </card>
 </config>

src/Resources/config/services.xml

@@ -10,6 +10,7 @@
         <service id="Picqer\Shopware6Plugin\Subscriber\EventSubscriber">
             <argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService" />
             <argument type="service" id="Picqer\Shopware6Plugin\Client\CurlPicqerClient" />
+            <argument type="service" id="order.repository" />
             <argument type="service" id="logger" />
             <tag name="kernel.event_subscriber"/>
         </service>

src/Subscriber/EventSubscriber.php

@@ -2,77 +2,139 @@
 
 namespace Picqer\Shopware6Plugin\Subscriber;
 
+use Exception;
 use Picqer\Shopware6Plugin\Client\PicqerClient;
-use Picqer\Shopware6Plugin\Exception\InvalidConfigException;
+use Picqer\Shopware6Plugin\Exception\IncompleteConfigurationException;
+use Picqer\Shopware6Plugin\Exception\OrderNotFoundException;
 use Picqer\Shopware6Plugin\Exception\RequestFailedException;
 use Psr\Log\LoggerInterface;
+use Shopware\Core\Checkout\Order\OrderEntity;
 use Shopware\Core\Checkout\Order\OrderEvents;
+use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Event\EntityWrittenEvent;
+use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
 use Shopware\Core\System\SystemConfig\SystemConfigService;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 final class EventSubscriber implements EventSubscriberInterface
 {
+    /**
+     * @var SystemConfigService
+     */
     private $configService;
+
+    /**
+     * @var PicqerClient
+     */
     private $client;
+
+    /**
+     * @var EntityRepository
+     */
+    private $orderRepository;
+
+    /**
+     * @var LoggerInterface
+     */
     private $logger;
 
-    public function __construct(SystemConfigService $configService, PicqerClient $client, LoggerInterface $logger)
-    {
-        $this->client = $client;
+    public function __construct(
+        SystemConfigService $configService,
+        PicqerClient $client,
+        EntityRepository $orderRepository,
+        LoggerInterface $logger
+    ) {
         $this->configService = $configService;
+        $this->client = $client;
+        $this->orderRepository = $orderRepository;
         $this->logger = $logger;
     }
 
     public static function getSubscribedEvents(): array
     {
         return [
-            OrderEvents::ORDER_WRITTEN_EVENT => 'pushOrder',
+            OrderEvents::ORDER_WRITTEN_EVENT => 'handle',
         ];
     }
 
-    public function pushOrder(EntityWrittenEvent $event): void
+    public function handle(EntityWrittenEvent $event): void
     {
-        if (!isset($event->getIds()[0])) {
+        if (! isset($event->getIds()[0])) {
             return;
         }
 
-        $id = $event->getIds()[0];
+        $orderId = $event->getIds()[0];
 
         try {
-            $this->client->pushOrder(
-                $this->getConfigurationValue('subdomain'),
-                $this->getConfigurationValue('connectionkey'),
-                $id
-            );
-        } catch (InvalidConfigException $e) {
-            /*
-            * It is possible that the configuration values are not yet set
-            * due to the fact that a plugin needs to be installed and activated before you can configure these.
-            *
-            * Picqer will check the webshop on interval as well.
-            * When a call fails there might be a delay in orders showing up in Picqer, but they will not get lost.
-            *
-            * We choose to silently fail to prevent any disturbances of the webshop.
-            */
-
-            $this->logger->info('[Picqer] Plugin configuration is invalid', [
-                'message' => $e->getMessage(),
-            ]);
-        } catch(RequestFailedException $e) {
-            $this->logger->info('[Picqer] Could not call webhook', [
+            $order = $this->orderRepository->search(new Criteria([$orderId]), $event->getContext())->first();
+            if (! $order instanceof OrderEntity) {
+                throw new OrderNotFoundException(sprintf('Order [%s] not found', $orderId));
+            }
+
+            $salesChannelId = $order->getSalesChannelId();
+            $disabled = $this->configService->getBool($this->buildConfigKey('disabled'), $salesChannelId);
+            if ($disabled) {
+                return;
+            }
+
+            $subdomain = $this->configService->getString($this->buildConfigKey('subdomain'), $salesChannelId);
+            $connectionKey = $this->configService->getString($this->buildConfigKey('connectionkey'), $salesChannelId);
+            $debug = $this->configService->getBool($this->buildConfigKey('debug'), $salesChannelId);
+
+            $this->pushOrderToPicqer($subdomain, $connectionKey, $order, $debug, $salesChannelId);
+        } catch (Exception $e) {
+            $this->logger->error('[Picqer] Caught unexpected exception', [
+                'exception' => get_class($e),
                 'message' => $e->getMessage(),
+                'orderId' => $orderId,
             ]);
         }
     }
 
-    private function getConfigurationValue(string $type): string
+    private function buildConfigKey(string $key): string
     {
-        $value = $this->configService->get(sprintf('PicqerExtendedIntegration.config.%s', $type));
-        if (!is_string($value)) {
-            throw new InvalidConfigException(sprintf('%s not set', ucfirst($type)));
-        }
+        return sprintf('PicqerExtendedIntegration.config.%s', $key);
+    }
+
+    private function pushOrderToPicqer(
+        string $subdomain,
+        string $connectionKey,
+        OrderEntity $order,
+        bool $debug,
+        string $salesChannelId
+    ): void {
+        try {
+            if (empty($subdomain) || empty($connectionKey)) {
+                throw new IncompleteConfigurationException($subdomain, $connectionKey);
+            }
+
+            $this->client->pushOrder(
+                $subdomain,
+                $connectionKey,
+                $order->getId()
+            );
+        } catch (IncompleteConfigurationException $e) {
+            if (! $debug) {
+                return;
+            }
+
+            $this->logger->error('[Picqer] Subdomain and/or connection-key not configured', [
+                'subdomain' => $e->getSubdomain(),
+                'connectionKey' => $e->getConnectionKey(),
+                'orderId' => $order->getId(),
+                'salesChannelId' => $salesChannelId,
+            ]);
+        } catch (RequestFailedException $e) {
+            if (! $debug) {
+                return;
+            }
 
-        return $value;
+            $this->logger->error('[Picqer] Could not call webhook', [
+                'endpoint' => $e->getEndpoint(),
+                'message' => $e->getMessage(),
+                'orderId' => $order->getId(),
+                'salesChannelId' => $salesChannelId,
+            ]);
+        }
     }
 }