Log incoming webhooks

src/Controller/HandleWebhookControllerAction.php → src/Controller/HandleWebhookAction.php

@@ -4,32 +4,56 @@
 
 namespace Setono\SyliusPeakPlugin\Controller;
 
+use Doctrine\Persistence\ManagerRegistry;
+use Psr\Log\LoggerAwareInterface;
+use Setono\Doctrine\ORMTrait;
 use Setono\PeakWMS\Parser\WebhookParser;
 use Setono\PeakWMS\Parser\WebhookParserInterface;
+use Setono\SyliusPeakPlugin\Factory\WebhookFactoryInterface;
+use Setono\SyliusPeakPlugin\Logger\WebhookLogger;
 use Setono\SyliusPeakPlugin\WebhookHandler\WebhookHandlerInterface;
 use Symfony\Component\HttpFoundation\JsonResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
 
-final class HandleWebhookControllerAction
+final class HandleWebhookAction
 {
+    use ORMTrait;
+
     public function __construct(
         private readonly WebhookParserInterface $webhookParser,
         private readonly WebhookHandlerInterface $webhookHandler,
+        private readonly WebhookFactoryInterface $webhookFactory,
+        ManagerRegistry $managerRegistry,
     ) {
+        $this->managerRegistry = $managerRegistry;
     }
 
     public function __invoke(Request $request): JsonResponse
     {
+        $webhook = null;
+
         try {
+            $webhook = $this->webhookFactory->createFromRequest($request);
+            $logger = new WebhookLogger($webhook);
+
+            if ($this->webhookHandler instanceof LoggerAwareInterface) {
+                $this->webhookHandler->setLogger($logger);
+            }
+
             $dataClass = WebhookParser::convertNameToDataClass($request->query->getInt('name'));
 
             $data = $this->webhookParser->parse($request->getContent(), $dataClass);
 
             $this->webhookHandler->handle($data);
         } catch (\InvalidArgumentException $e) {
             throw new BadRequestHttpException($e->getMessage());
+        } finally {
+            if (null !== $webhook) {
+                $this->getManager($webhook)->persist($webhook);
+                $this->getManager($webhook)->flush();
+            }
         }
 
         return new JsonResponse(status: Response::HTTP_NO_CONTENT);

src/DependencyInjection/Configuration.php

@@ -7,6 +7,7 @@
 use Setono\SyliusPeakPlugin\Model\InventoryUpdate;
 use Setono\SyliusPeakPlugin\Model\UploadOrderRequest;
 use Setono\SyliusPeakPlugin\Model\UploadProductVariantRequest;
+use Setono\SyliusPeakPlugin\Model\Webhook;
 use Setono\SyliusPeakPlugin\Model\WebhookRegistration;
 use Sylius\Component\Resource\Factory\Factory;
 use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
@@ -64,6 +65,20 @@ private function addResourcesSection(ArrayNodeDefinition $node): void
                                 ->end()
                             ->end()
                         ->end()
+                        ->arrayNode('webhook')
+                            ->addDefaultsIfNotSet()
+                            ->children()
+                                ->variableNode('options')->end()
+                                ->arrayNode('classes')
+                                    ->addDefaultsIfNotSet()
+                                    ->children()
+                                        ->scalarNode('model')->defaultValue(Webhook::class)->cannotBeEmpty()->end()
+                                        ->scalarNode('repository')->cannotBeEmpty()->end()
+                                        ->scalarNode('factory')->defaultValue(Factory::class)->end()
+                                    ->end()
+                                ->end()
+                            ->end()
+                        ->end()
                         ->arrayNode('webhook_registration')
                             ->addDefaultsIfNotSet()
                             ->children()

src/Factory/WebhookFactory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPeakPlugin\Factory;
+
+use Setono\SyliusPeakPlugin\Model\WebhookInterface;
+use Sylius\Component\Resource\Factory\FactoryInterface;
+use Symfony\Component\HttpFoundation\Request;
+use Webmozart\Assert\Assert;
+
+final class WebhookFactory implements WebhookFactoryInterface
+{
+    public function __construct(private readonly FactoryInterface $decorated)
+    {
+    }
+
+    public function createNew(): WebhookInterface
+    {
+        $obj = $this->decorated->createNew();
+        Assert::isInstanceOf($obj, WebhookInterface::class);
+
+        return $obj;
+    }
+
+    public function createFromRequest(Request $request): WebhookInterface
+    {
+        $obj = $this->createNew();
+        $obj->setMethod($request->getMethod());
+        $obj->setUrl($request->getUri());
+        $obj->setHeaders($request->headers->all());
+        $obj->setBody($request->getContent());
+        $obj->setRemoteIp($request->getClientIp());
+
+        return $obj;
+    }
+}

src/Factory/WebhookFactoryInterface.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPeakPlugin\Factory;
+
+use Setono\SyliusPeakPlugin\Model\WebhookInterface;
+use Sylius\Component\Resource\Factory\FactoryInterface;
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * @extends FactoryInterface<WebhookInterface>
+ */
+interface WebhookFactoryInterface extends FactoryInterface
+{
+    public function createNew(): WebhookInterface;
+
+    public function createFromRequest(Request $request): WebhookInterface;
+}

src/Logger/WebhookLogger.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPeakPlugin\Logger;
+
+use Psr\Log\AbstractLogger;
+use Setono\SyliusPeakPlugin\Model\WebhookInterface;
+
+final class WebhookLogger extends AbstractLogger
+{
+    public function __construct(private readonly WebhookInterface $webhook)
+    {
+    }
+
+    public function log($level, \Stringable|string $message, array $context = []): void
+    {
+        $this->webhook->addLog(sprintf('[%s] %s', (new \DateTimeImmutable())->format(\DATE_ATOM), (string) $message));
+    }
+}

src/Model/Webhook.php

@@ -0,0 +1,109 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPeakPlugin\Model;
+
+class Webhook implements WebhookInterface
+{
+    protected ?int $id = null;
+
+    protected ?string $method = null;
+
+    protected ?string $url = null;
+
+    /** @var array<string, list<string|null>>|null */
+    protected ?array $headers = null;
+
+    protected ?string $body = null;
+
+    protected ?string $remoteIp = null;
+
+    protected ?string $log = null;
+
+    protected \DateTimeInterface $createdAt;
+
+    public function __construct()
+    {
+        $this->createdAt = new \DateTimeImmutable();
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+
+    public function getMethod(): ?string
+    {
+        return $this->method;
+    }
+
+    public function setMethod(?string $method): void
+    {
+        $this->method = $method;
+    }
+
+    public function getUrl(): ?string
+    {
+        return $this->url;
+    }
+
+    public function setUrl(?string $url): void
+    {
+        $this->url = $url;
+    }
+
+    public function getHeaders(): array
+    {
+        return $this->headers ?? [];
+    }
+
+    public function setHeaders(?array $headers): void
+    {
+        $this->headers = $headers;
+    }
+
+    public function getBody(): ?string
+    {
+        return $this->body;
+    }
+
+    public function setBody(?string $body): void
+    {
+        $this->body = $body;
+    }
+
+    public function getRemoteIp(): ?string
+    {
+        return $this->remoteIp;
+    }
+
+    public function setRemoteIp(?string $remoteIp): void
+    {
+        $this->remoteIp = $remoteIp;
+    }
+
+    public function getLog(): ?string
+    {
+        return $this->log;
+    }
+
+    public function setLog(?string $log): void
+    {
+        $this->log = $log;
+    }
+
+    public function addLog(string $log): void
+    {
+        if (null === $this->log) {
+            $this->log = '';
+        }
+
+        $this->log = $log . \PHP_EOL . $this->log;
+    }
+
+    public function getCreatedAt(): \DateTimeInterface
+    {
+        return $this->createdAt;
+    }
+}

src/Model/WebhookInterface.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusPeakPlugin\Model;
+
+use Sylius\Component\Resource\Model\ResourceInterface;
+
+interface WebhookInterface extends ResourceInterface
+{
+    public function getId(): ?int;
+
+    public function getMethod(): ?string;
+
+    public function setMethod(?string $method): void;
+
+    public function getUrl(): ?string;
+
+    public function setUrl(?string $url): void;
+
+    /**
+     * @return array<string, list<string|null>>
+     */
+    public function getHeaders(): array;
+
+    /**
+     * @param array<string, list<string|null>>|null $headers
+     */
+    public function setHeaders(?array $headers): void;
+
+    public function getBody(): ?string;
+
+    public function setBody(?string $body): void;
+
+    public function getRemoteIp(): ?string;
+
+    public function setRemoteIp(?string $remoteIp): void;
+
+    public function getLog(): ?string;
+
+    public function setLog(?string $log): void;
+
+    public function addLog(string $log): void;
+
+    public function getCreatedAt(): \DateTimeInterface;
+}

src/Registrar/WebhookRegistrar.php

@@ -87,6 +87,7 @@ private function getWebhooks(): array
         foreach ([Name::StockAdjust, Name::PickOrderPacked] as $name) {
             $webhooks[] = new Webhook(
                 name: $name,
+                // todo this URL should include some kind of key to make it secure
                 url: $this->urlGenerator->generate(
                     name: 'setono_sylius_peak_global_webhook',
                     parameters: ['name' => $name->value],

src/Resources/config/doctrine/model/Webhook.orm.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<doctrine-mapping xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+                  xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+                  xsi:schemaLocation="http://doctrine-project.org/schemas/orm/doctrine-mapping
+                                      http://doctrine-project.org/schemas/orm/doctrine-mapping.xsd">
+    <mapped-superclass name="Setono\SyliusPeakPlugin\Model\Webhook"
+                       table="setono_sylius_peak_wms__webhook">
+        <id name="id" type="integer">
+            <generator strategy="AUTO"/>
+        </id>
+
+        <field name="method" type="string"/>
+        <field name="url" type="string"/>
+        <field name="headers" type="json"/>
+        <field name="body" type="text"/>
+        <field name="remoteIp" type="string"/>
+        <field name="log" type="text" nullable="true"/>
+        <field name="createdAt" type="datetime"/>
+    </mapped-superclass>
+</doctrine-mapping>

src/Resources/config/routes/global.yaml

@@ -2,4 +2,4 @@ setono_sylius_peak_global_webhook:
     path: /peak/webhook
     methods: [POST]
     defaults:
-        _controller: Setono\SyliusPeakPlugin\Controller\HandleWebhookControllerAction
+        _controller: Setono\SyliusPeakPlugin\Controller\HandleWebhookAction

src/Resources/config/services/controller.xml

@@ -14,9 +14,11 @@
             <tag name="controller.service_arguments"/>
         </service>
 
-        <service id="Setono\SyliusPeakPlugin\Controller\HandleWebhookControllerAction" public="true">
+        <service id="Setono\SyliusPeakPlugin\Controller\HandleWebhookAction" public="true">
             <argument type="service" id="Setono\PeakWMS\Parser\WebhookParserInterface"/>
             <argument type="service" id="Setono\SyliusPeakPlugin\WebhookHandler\WebhookHandlerInterface"/>
+            <argument type="service" id="setono_sylius_peak.factory.webhook"/>
+            <argument type="service" id="doctrine"/>
         </service>
     </services>
 </container>

src/Resources/config/services/factory.xml

@@ -4,6 +4,11 @@
     <services>
         <!-- todo missing aliases -->
 
+        <service id="Setono\SyliusPeakPlugin\Factory\WebhookFactory"
+                 decorates="setono_sylius_peak.factory.webhook" decoration-priority="64">
+            <argument type="service" id="Setono\SyliusPeakPlugin\Factory\WebhookFactory.inner"/>
+        </service>
+
         <service id="Setono\SyliusPeakPlugin\Factory\WebhookRegistrationFactory"
                  decorates="setono_sylius_peak.factory.webhook_registration" decoration-priority="64">
             <argument type="service" id="Setono\SyliusPeakPlugin\Factory\WebhookRegistrationFactory.inner"/>