Merge branch 'next-14363/webhook-dispatching-over-queue' into 'trunk'

NEXT-14363 - Webhook dispatching over queue

See merge request shopware/6/product/platform!4999

Author: keulinho

changelog/_unreleased/2021-03-31-add-the-current-sw-version-to-all-outgoing-request-to-external-apps.md

@@ -1,7 +1,6 @@
 ---
 title: Add the current sw version to all outgoing request to external apps
 issue: NEXT-14359
-flag: FEATURE_NEXT_13992
 ---
 # Core
 * Changed method `execute` in `src/Core/Framework/App/ActionButton/Executor.php` to add `shopware version` to `action button requests` 

changelog/_unreleased/2021-04-28-webhook-dispatching-over-queue.md

@@ -0,0 +1,9 @@
+---
+title: Webhook dispatching over queue
+issue: NEXT-14363
+flag: FEATURE_NEXT_14363
+---
+# Core
+* Added `src\Core\Framework\Webhook\Message\WebhookEventMessage` class
+* Added `src\Core\Framework\Webhook\Handler\WebhookEventMessageHandler` class
+* Changed method `callWebhooks` in `src\Core\Framework\Webhook\WebhookDispatcher` to handle webhooks asynchronous over the queue

src/Core/Framework/DependencyInjection/webhook.xml

@@ -13,6 +13,7 @@
             <argument type="service" id="service_container"/>
             <argument type="service" id="Shopware\Core\Framework\Webhook\Hookable\HookableEventFactory"/>
             <argument>%kernel.shopware_version%</argument>
+            <argument type="service" id="Symfony\Component\Messenger\MessageBusInterface"/>
         </service>
 
         <service id="Shopware\Core\Framework\Webhook\WebhookCacheClearer">
@@ -43,5 +44,13 @@
             <argument type="service" id="Shopware\Core\Framework\Event\BusinessEventCollector"/>
             <argument type="service" id="Shopware\Core\Framework\DataAbstractionLayer\DefinitionInstanceRegistry"/>
         </service>
+
+        <service id="Shopware\Core\Framework\Webhook\Handler\WebhookEventMessageHandler">
+            <argument type="service" id="shopware.app_system.guzzle"/>
+            <argument type="service" id="app.repository"/>
+
+            <tag name="messenger.message_handler"/>
+            <tag name="shopware.feature" flag="FEATURE_NEXT_14363"/>
+        </service>
     </services>
 </container>

src/Core/Framework/Resources/config/packages/shopware.yaml

@@ -118,18 +118,17 @@ shopware:
               major: false
               description: "App System 3.0 - Payments"
               # issue: NEXT-14357
-            - name: FEATURE_NEXT_13992
+            - name: FEATURE_NEXT_14363
               default: false
               major: false
-              description: "App System 3.0"
-              # issue: NEXT-13992
+              description: "App System 3.0 - Dispatch webhook overqueue"
+              # issue: NEXT-14363
             - name: FEATURE_NEXT_12654
               default: false
               major: false
               description: "Preview available variables of email templates in the administration"
               # issue: NEXT-12654
 
-
     logger:
         file_rotation_count: 14
 

src/Core/Framework/Test/Webhook/Handler/WebhookEventMessageHandlerTest.php

@@ -0,0 +1,81 @@
+<?php declare(strict_types=1);
+
+namespace Shopware\Core\Framework\Test\Webhook\Handler;
+
+use GuzzleHttp\Psr7\Response;
+use PHPUnit\Framework\TestCase;
+use Shopware\Core\Framework\Context;
+use Shopware\Core\Framework\Feature;
+use Shopware\Core\Framework\Test\App\GuzzleTestClientBehaviour;
+use Shopware\Core\Framework\Test\TestCaseBase\IntegrationTestBehaviour;
+use Shopware\Core\Framework\Uuid\Uuid;
+use Shopware\Core\Framework\Webhook\Handler\WebhookEventMessageHandler;
+use Shopware\Core\Framework\Webhook\Message\WebhookEventMessage;
+
+class WebhookEventMessageHandlerTest extends TestCase
+{
+    use IntegrationTestBehaviour;
+    use GuzzleTestClientBehaviour;
+
+    private WebhookEventMessageHandler $webhookEventMessageHandler;
+
+    public function setUp(): void
+    {
+        Feature::skipTestIfInActive('FEATURE_NEXT_14363', $this);
+        $this->webhookEventMessageHandler = $this->getContainer()->get(WebhookEventMessageHandler::class);
+    }
+
+    public function testGetHandledMessages(): void
+    {
+        /** @var array $subscribedMessages */
+        $subscribedMessages = $this->webhookEventMessageHandler::getHandledMessages();
+
+        static::assertCount(1, $subscribedMessages);
+        static::assertEquals(WebhookEventMessage::class, $subscribedMessages[0]);
+    }
+
+    public function testSendSuccessful(): void
+    {
+        $webhookId = Uuid::randomHex();
+        $appId = Uuid::randomHex();
+
+        $appRepository = $this->getContainer()->get('app.repository');
+        $appRepository->create([[
+            'id' => $appId,
+            'name' => 'SwagApp',
+            'active' => true,
+            'path' => __DIR__ . '/Manifest/_fixtures/test',
+            'version' => '0.0.1',
+            'label' => 'test',
+            'appSecret' => 's3cr3t',
+            'integration' => [
+                'label' => 'test',
+                'writeAccess' => false,
+                'accessKey' => 'api access key',
+                'secretAccessKey' => 'test',
+            ],
+            'aclRole' => [
+                'name' => 'SwagApp',
+            ],
+            'webhooks' => [
+                [
+                    'id' => $webhookId,
+                    'name' => 'hook1',
+                    'eventName' => 'order',
+                    'url' => 'https://test.com',
+                ],
+            ],
+        ]], Context::createDefaultContext());
+
+        $this->appendNewResponse(new Response(200));
+
+        (($this->webhookEventMessageHandler)(new WebhookEventMessage(['payload'], $appId, $webhookId, '6.4', 'https://test.com')));
+
+        $request = $this->getLastRequest();
+        static::assertEquals('POST', $request->getMethod());
+        $body = $request->getBody()->getContents();
+        static::assertEquals($body, json_encode(['payload']));
+        static::assertTrue($request->hasHeader('sw-version'));
+        static::assertEquals($request->getHeaderLine('sw-version'), '6.4');
+    }
+}