ACP-3507 Applied CR fixes.

Author: stereomon

src/Spryker/Shared/AppWebhook/Transfer/app_webhook.transfer.xml

@@ -6,6 +6,7 @@
         <property name="mode" type="string"/>
         <property name="identifier" type="string" description="This is the default identifier set for internal processing."/>
         <property name="isRetry" type="bool" description="When this WebhookRequest was tried to be processed before we set this to not persist it again in the database."/>
+        <property name="retries" type="int" description="The number of how often this webhook was retried."/>
     </transfer>
 
     <transfer name="WebhookResponse" strict="true">

src/Spryker/Zed/AppWebhook/AppWebhookConfig.php

@@ -0,0 +1,25 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppWebhook;
+
+use Spryker\Zed\Kernel\AbstractBundleConfig;
+
+class AppWebhookConfig extends AbstractBundleConfig
+{
+    /**
+     * @api
+     *
+     * @var int
+     */
+    protected const NUMBER_OF_ALLOWED_RETRIES = 9;
+
+    public function getAllowedNumberOfWebhookRetries(): int
+    {
+        return static::NUMBER_OF_ALLOWED_RETRIES;
+    }
+}

src/Spryker/Zed/AppWebhook/AppWebhookDependencyProvider.php

@@ -10,6 +10,9 @@
 use Spryker\Zed\Kernel\AbstractBundleDependencyProvider;
 use Spryker\Zed\Kernel\Container;
 
+/**
+ * @method \Spryker\Zed\AppWebhook\AppWebhookConfig getConfig()
+ */
 class AppWebhookDependencyProvider extends AbstractBundleDependencyProvider
 {
     /**

src/Spryker/Zed/AppWebhook/Business/AppWebhookBusinessFactory.php

@@ -17,13 +17,15 @@
 /**
  * @method \Spryker\Zed\AppWebhook\Persistence\AppWebhookEntityManagerInterface getEntityManager()
  * @method \Spryker\Zed\AppWebhook\Persistence\AppWebhookRepositoryInterface getRepository()
+ * @method \Spryker\Zed\AppWebhook\AppWebhookConfig getConfig()
  */
 class AppWebhookBusinessFactory extends AbstractBusinessFactory
 {
     public function createWebhookHandler(): WebhookHandler
     {
         return new WebhookHandler(
             $this->getAppWebhookHandlerPlugins(),
+            $this->getConfig(),
             $this->getEntityManager(),
             $this->createIdentifierBuilder(),
         );

src/Spryker/Zed/AppWebhook/Business/Exception/AllowedNumberOfRetriesExceededException.php

@@ -0,0 +1,12 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppWebhook\Business\Exception;
+
+class AllowedNumberOfRetriesExceededException extends AppWebhookException
+{
+}

src/Spryker/Zed/AppWebhook/Business/Exception/AppWebhookException.php

@@ -0,0 +1,14 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppWebhook\Business\Exception;
+
+use Exception;
+
+class AppWebhookException extends Exception
+{
+}

src/Spryker/Zed/AppWebhook/Business/MessageBuilder/MessageBuilder.php

@@ -0,0 +1,16 @@
+<?php
+
+/**
+ * Copyright © 2016-present Spryker Systems GmbH. All rights reserved.
+ * Use of this software requires acceptance of the Evaluation License Agreement. See LICENSE file.
+ */
+
+namespace Spryker\Zed\AppWebhook\Business\MessageBuilder;
+
+class MessageBuilder
+{
+    public static function allowedNumberOfRetriesExceeded(): string
+    {
+        return 'Allowed number of retries exceeded.';
+    }
+}

src/Spryker/Zed/AppWebhook/Business/WebhookHandler/WebhookHandler.php

@@ -9,7 +9,10 @@
 
 use Generated\Shared\Transfer\WebhookRequestTransfer;
 use Generated\Shared\Transfer\WebhookResponseTransfer;
+use Spryker\Zed\AppWebhook\AppWebhookConfig;
+use Spryker\Zed\AppWebhook\Business\Exception\AllowedNumberOfRetriesExceededException;
 use Spryker\Zed\AppWebhook\Business\Identifier\IdentifierBuilderInterface;
+use Spryker\Zed\AppWebhook\Business\MessageBuilder\MessageBuilder;
 use Spryker\Zed\AppWebhook\Persistence\AppWebhookEntityManagerInterface;
 use Throwable;
 
@@ -20,6 +23,7 @@ class WebhookHandler
      */
     public function __construct(
         protected array $webhookHandlerPlugins,
+        protected AppWebhookConfig $appWebhookConfig,
         protected AppWebhookEntityManagerInterface $appWebhookEntityManager,
         protected IdentifierBuilderInterface $identifierBuilder
     ) {
@@ -36,6 +40,13 @@ public function handleWebhook(WebhookRequestTransfer $webhookRequestTransfer, We
             $this->appWebhookEntityManager->saveWebhookRequest($webhookRequestTransfer);
         }
 
+        // Delete the webhook when the number of retries is exceeded and throw an exception.
+        if ($webhookRequestTransfer->getIsRetry() === true && $webhookRequestTransfer->getRetries() >= $this->appWebhookConfig->getAllowedNumberOfWebhookRetries()) {
+            $this->appWebhookEntityManager->deleteWebhookRequest($webhookRequestTransfer);
+
+            throw new AllowedNumberOfRetriesExceededException(MessageBuilder::allowedNumberOfRetriesExceeded());
+        }
+
         try {
             foreach ($this->webhookHandlerPlugins as $webhookHandlerPlugin) {
                 if (!$webhookHandlerPlugin->canHandle($webhookRequestTransfer)) {

src/Spryker/Zed/AppWebhook/Persistence/AppWebhookPersistenceFactory.php

@@ -15,6 +15,7 @@
 /**
  * @method \Spryker\Zed\AppWebhook\Persistence\AppWebhookEntityManagerInterface getEntityManager()
  * @method \Spryker\Zed\AppWebhook\Persistence\AppWebhookRepositoryInterface getRepository()
+ * @method \Spryker\Zed\AppWebhook\AppWebhookConfig getConfig()
  */
 class AppWebhookPersistenceFactory extends AbstractPersistenceFactory
 {

src/Spryker/Zed/AppWebhook/Persistence/Propel/Mapper/WebhookInboxMapper.php

@@ -16,6 +16,9 @@ public function mapWebhookInboxEntityToWebhookRequestTransfer(
         SpyWebhookInbox $spyWebhookInbox,
         WebhookRequestTransfer $webhookRequestTransfer
     ): WebhookRequestTransfer {
-        return $webhookRequestTransfer->fromArray(json_decode($spyWebhookInbox->getWebhook(), true));
+        $webhookRequestTransfer->fromArray(json_decode($spyWebhookInbox->getWebhook(), true));
+        $webhookRequestTransfer->setRetries($spyWebhookInbox->getRetries());
+
+        return $webhookRequestTransfer;
     }
 }

tests/SprykerTest/Shared/AppWebhook/_support/Helper/AppWebhookHelper.php

@@ -105,7 +105,7 @@ public function handleWebhook(
         };
     }
 
-    public function haveWebhookRequestPersisted(WebhookRequestTransfer $webhookRequestTransfer, string $message = ''): void
+    public function haveWebhookRequestPersisted(WebhookRequestTransfer $webhookRequestTransfer, string $message = '', ?int $numberOfRetries = null): void
     {
         $spyWebhookInboxEntity = new SpyWebhookInbox();
         $spyWebhookInboxEntity
@@ -114,6 +114,10 @@ public function haveWebhookRequestPersisted(WebhookRequestTransfer $webhookReque
             ->setMessage($message)
             ->setSequenceNumber($this->getSequenceNumber($webhookRequestTransfer->getIdentifierOrFail()));
 
+        if ($numberOfRetries) {
+            $spyWebhookInboxEntity->setRetries($numberOfRetries + 1);
+        }
+
         $spyWebhookInboxEntity->save();
     }
 

tests/SprykerTest/Zed/AppWebhook/Business/AppWebhookFacadeTest.php

@@ -14,6 +14,7 @@
 use Generated\Shared\Transfer\WebhookResponseTransfer;
 use Ramsey\Uuid\Uuid;
 use Spryker\Zed\AppWebhook\AppWebhookDependencyProvider;
+use Spryker\Zed\AppWebhook\Business\Exception\AllowedNumberOfRetriesExceededException;
 use Spryker\Zed\AppWebhook\Business\Identifier\IdentifierBuilderInterface;
 use SprykerTest\Zed\AppWebhook\AppWebhookBusinessTester;
 
@@ -370,6 +371,86 @@ public function testGivenAnUnprocessedWebhookRequestWhenItWillBeRetriedAndIsSucc
         $this->tester->assertWebhookIsNotPersisted($identifier);
     }
 
+    /**
+     * @group single
+     */
+    public function testGivenAnUnprocessedWebhookRequestWhenItWillBeRetriedAndTheNumberOfRetriesIsHigherThanTheConfiguredAllowedNumberOfRetriesThenItWillBeDeleted(): void
+    {
+        // Arrange
+        $identifier = Uuid::uuid4()->toString(); // The one that is already persisted
+
+        $webhookRequestTransfer = new WebhookRequestTransfer();
+        $webhookRequestTransfer
+            ->setContent('{foo: bar}')
+            ->setMode('async')
+            ->setIdentifier($identifier)
+            ->setIsRetry(true)
+            ->setRetries($this->tester->getModuleConfig()->getAllowedNumberOfWebhookRetries() + 1);
+
+        $this->tester->haveWebhookRequestPersisted($webhookRequestTransfer, 'First message', $this->tester->getModuleConfig()->getAllowedNumberOfWebhookRetries());
+
+        $webhookResponseTransfer = new WebhookResponseTransfer();
+
+        $callable = function (WebhookRequestTransfer $webhookRequestTransfer, WebhookResponseTransfer $webhookResponseTransfer) use ($identifier) {
+            $webhookResponseTransfer
+                ->setIsHandled(false); // This will make it fail
+
+            return $webhookResponseTransfer;
+        };
+
+        $webhookHandlerPlugin = $this->tester->createSuccessfulWebhookHandlerPlugin($callable);
+
+        $this->tester->setDependency(AppWebhookDependencyProvider::PLUGINS_WEBHOOK_HANDLER, [$webhookHandlerPlugin]);
+
+        // Expect
+        $this->expectException(AllowedNumberOfRetriesExceededException::class);
+
+        // Act
+        $webhookResponseTransfer = $this->tester->getFacade()->handleWebhook($webhookRequestTransfer, $webhookResponseTransfer);
+
+        // Assert
+        // Ensure that the WebhookRequest is deleted from the persistence as it seems to never possible to handle it.
+        $this->tester->assertWebhookIsNotPersisted($identifier);
+    }
+
+    /**
+     * @group single
+     */
+    public function testGivenAnUnprocessedWebhookRequestWhenItWillBeRetriedAndTheNumberOfRetriesIsHigherThanTheConfiguredAllowedNumberOfRetriesThenAnExceptionIsThrown(): void
+    {
+        // Arrange
+        $identifier = Uuid::uuid4()->toString(); // The one that is already persisted
+
+        $webhookRequestTransfer = new WebhookRequestTransfer();
+        $webhookRequestTransfer
+            ->setContent('{foo: bar}')
+            ->setMode('async')
+            ->setIdentifier($identifier)
+            ->setIsRetry(true)
+            ->setRetries($this->tester->getModuleConfig()->getAllowedNumberOfWebhookRetries() + 1);
+
+        $this->tester->haveWebhookRequestPersisted($webhookRequestTransfer, 'First message', $this->tester->getModuleConfig()->getAllowedNumberOfWebhookRetries());
+
+        $webhookResponseTransfer = new WebhookResponseTransfer();
+
+        $callable = function (WebhookRequestTransfer $webhookRequestTransfer, WebhookResponseTransfer $webhookResponseTransfer) use ($identifier) {
+            $webhookResponseTransfer
+                ->setIsHandled(false); // This will make it fail
+
+            return $webhookResponseTransfer;
+        };
+
+        $webhookHandlerPlugin = $this->tester->createSuccessfulWebhookHandlerPlugin($callable);
+
+        $this->tester->setDependency(AppWebhookDependencyProvider::PLUGINS_WEBHOOK_HANDLER, [$webhookHandlerPlugin]);
+
+        // Expect
+        $this->expectException(AllowedNumberOfRetriesExceededException::class);
+
+        // Act
+        $webhookResponseTransfer = $this->tester->getFacade()->handleWebhook($webhookRequestTransfer, $webhookResponseTransfer);
+    }
+
     /**
      * @group single
      */

tests/SprykerTest/Zed/AppWebhook/_support/AppWebhookBusinessTester.php

@@ -28,6 +28,7 @@
  * @SuppressWarnings(PHPMD)
  *
  * @method \Spryker\Zed\AppWebhook\Business\AppWebhookFacadeInterface getFacade(?string $moduleName = NULL)
+ * @method \Spryker\Zed\AppWebhook\AppWebhookConfig getModuleConfig(?string $moduleName = NULL)
  */
 class AppWebhookBusinessTester extends Actor
 {