[ECP-9177] Implement webhook clean-up cronjob for old webhooks

Api/Repository/AdyenNotificationRepositoryInterface.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2024 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Api\Repository;
+
+use Adyen\Payment\Api\Data\NotificationInterface;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\Exception\LocalizedException;
+
+interface AdyenNotificationRepositoryInterface
+{
+    /**
+     * Retrieve Adyen Notification entities which match a specified criteria.
+     *
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     *
+     * @throws LocalizedException
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface;
+
+    /**
+     * Deletes a specified Adyen notification.
+     *
+     * @param NotificationInterface $entity The notification ID.
+     * @return bool
+     */
+    public function delete(NotificationInterface $entity): bool;
+}

Cron/CleanupNotifications.php

@@ -0,0 +1,72 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2024 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Cron;
+
+use Adyen\Payment\Api\Repository\AdyenNotificationRepositoryInterface;
+use Adyen\Payment\Cron\Providers\NotificationsProviderInterface;
+use Adyen\Payment\Helper\Config;
+use Adyen\Payment\Logger\AdyenLogger;
+use Adyen\Payment\Model\Notification;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Store\Model\StoreManagerInterface;
+
+class CleanupNotifications
+{
+    /**
+     * @param NotificationsProviderInterface[] $providers
+     */
+    public function __construct(
+        private readonly array $providers,
+        private readonly AdyenLogger $adyenLogger,
+        private readonly Config $configHelper,
+        private readonly StoreManagerInterface $storeManager,
+        private readonly AdyenNotificationRepositoryInterface $adyenNotificationRepository
+    ) { }
+
+    /**
+     * @return void
+     * @throws NoSuchEntityException
+     */
+    public function execute(): void
+    {
+        $storeId = $this->storeManager->getStore()->getId();
+        $isWebhookCleanupEnabled = $this->configHelper->getIsWebhookCleanupEnabled($storeId);
+
+        if ($isWebhookCleanupEnabled) {
+            $numberOfItemsRemoved = 0;
+
+            foreach ($this->providers as $provider) {
+                /** @var Notification $notificationToCleanup */
+                foreach ($provider->provide() as $notificationToCleanup) {
+                    $isSuccessfullyDeleted = $this->adyenNotificationRepository->delete($notificationToCleanup);
+
+                    if ($isSuccessfullyDeleted) {
+                        $message = __('%1: Notification with entityId %2 has been deleted.',
+                            $provider->getProviderName(), $notificationToCleanup->getEntityId());
+                        $this->adyenLogger->addAdyenNotification($message);
+
+                        $numberOfItemsRemoved++;
+                    }
+                }
+            }
+
+            $successMessage = sprintf(
+                __('%s webhook notifications have been cleaned-up by the CleanupNotifications job.'),
+                $numberOfItemsRemoved
+            );
+            $this->adyenLogger->addAdyenDebug($successMessage);
+        } else {
+            $message = __('Webhook notification clean-up feature is disabled. The job has been skipped!');
+            $this->adyenLogger->addAdyenDebug($message);
+        }
+    }
+}

Cron/Providers/NotificationsProviderInterface.php

@@ -0,0 +1,25 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2024 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Cron\Providers;
+
+interface NotificationsProviderInterface
+{
+    /**
+     * @return array
+     */
+    public function provide(): array;
+
+    /**
+     * @return string
+     */
+    public function getProviderName(): string;
+}

Cron/Providers/ProcessedOldNotificationsProvider.php

@@ -0,0 +1,63 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2024 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Cron\Providers;
+
+use Adyen\Payment\Api\Repository\AdyenNotificationRepositoryInterface;
+use Adyen\Payment\Helper\Config;
+use Adyen\Payment\Logger\AdyenLogger;
+use Magento\Framework\Api\SearchCriteriaBuilder;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Store\Model\StoreManagerInterface;
+
+class ProcessedOldNotificationsProvider implements NotificationsProviderInterface
+{
+    public function __construct(
+        private readonly AdyenNotificationRepositoryInterface $adyenNotificationRepository,
+        private readonly SearchCriteriaBuilder $searchCriteriaBuilder,
+        private readonly Config $configHelper,
+        private readonly StoreManagerInterface $storeManager,
+        private readonly AdyenLogger $adyenLogger
+    ) { }
+
+    public function provide(): array
+    {
+        $storeId = $this->storeManager->getStore()->getId();
+        $numberOfDays = $this->configHelper->getRequiredDaysForOldWebhooks($storeId);
+
+        $dateFrom = date('Y-m-d H:i:s', time() - $numberOfDays * 24 * 60 * 60);
+
+        $searchCriteria = $this->searchCriteriaBuilder
+            ->addFilter('done', 1)
+            ->addFilter('processing', 0)
+            ->addFilter('created_at', $dateFrom, 'lteq')
+            ->create();
+
+        try {
+            $items = $this->adyenNotificationRepository->getList($searchCriteria);
+            return $items->getItems();
+        } catch (LocalizedException $e) {
+            $errorMessage = sprintf(
+                __('An error occurred while providing notifications older than %s days!'),
+                $numberOfDays
+            );
+
+            $this->adyenLogger->error($errorMessage);
+
+            return [];
+        }
+    }
+
+    public function getProviderName(): string
+    {
+        return "Adyen processed old webhook notifications";
+    }
+}

Helper/Config.php

@@ -57,6 +57,8 @@ class Config
     const XML_RECURRING_CONFIGURATION = 'recurring_configuration';
     const XML_ALLOW_MULTISTORE_TOKENS = 'allow_multistore_tokens';
     const XML_THREEDS_FLOW = 'threeds_flow';
+    const XML_CLEANUP_OLD_WEBHOOKS = 'cleanup_old_webhooks';
+    const XML_REQUIRED_DAYS_OLD_WEBHOOKS = 'required_days_old_webhooks';
 
     protected ScopeConfigInterface $scopeConfig;
     private EncryptorInterface $encryptor;
@@ -592,6 +594,25 @@ public function getThreeDSFlow(int $storeId = null): string
         );
     }
 
+    public function getIsWebhookCleanupEnabled(int $storeId = null): bool
+    {
+        return $this->getConfigData(
+            self::XML_CLEANUP_OLD_WEBHOOKS,
+            self::XML_ADYEN_ABSTRACT_PREFIX,
+            $storeId,
+            true
+        );
+    }
+
+    public function getRequiredDaysForOldWebhooks(int $storeId = null): int
+    {
+        return (int) $this->getConfigData(
+            self::XML_REQUIRED_DAYS_OLD_WEBHOOKS,
+            self::XML_ADYEN_ABSTRACT_PREFIX,
+            $storeId
+        );
+    }
+
     public function getIsCvcRequiredForRecurringCardPayments(int $storeId = null): bool
     {
          return (bool) $this->getConfigData(

Model/AdyenNotificationRepository.php

@@ -0,0 +1,62 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2024 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <[email protected]>
+ */
+
+namespace Adyen\Payment\Model;
+
+use Adyen\Payment\Api\Data\NotificationInterface;
+use Adyen\Payment\Api\Repository\AdyenNotificationRepositoryInterface;
+use Adyen\Payment\Model\ResourceModel\Notification\CollectionFactory;
+use Magento\Framework\Api\Search\SearchResultFactory;
+use Magento\Framework\Api\SearchCriteria\CollectionProcessor;
+use Magento\Framework\Api\SearchCriteriaInterface;
+use Magento\Framework\Api\SearchResultsInterface;
+use Magento\Framework\ObjectManagerInterface;
+
+class AdyenNotificationRepository implements AdyenNotificationRepositoryInterface
+{
+    /**
+     * @param SearchResultFactory $searchResultsFactory
+     * @param CollectionFactory $collectionFactory
+     * @param CollectionProcessor $collectionProcessor
+     * @param ObjectManagerInterface $objectManager
+     * @param string $resourceModel
+     */
+    public function __construct(
+        private readonly SearchResultFactory $searchResultsFactory,
+        private readonly CollectionFactory $collectionFactory,
+        private readonly CollectionProcessor $collectionProcessor,
+        private readonly ObjectManagerInterface $objectManager,
+        private readonly string $resourceModel
+    ) { }
+
+    /**
+     * @param SearchCriteriaInterface $searchCriteria
+     * @return SearchResultsInterface
+     */
+    public function getList(SearchCriteriaInterface $searchCriteria): SearchResultsInterface
+    {
+        $searchResult = $this->searchResultsFactory->create();
+        $collection = $this->collectionFactory->create();
+        $this->collectionProcessor->process($searchCriteria, $collection);
+        $searchResult->setItems($collection->getItems());
+        $searchResult->setTotalCount($collection->getSize());
+
+        return $searchResult;
+    }
+
+    public function delete(NotificationInterface $entity): bool
+    {
+        $resource = $this->objectManager->get($this->resourceModel);
+        $resource->delete($entity);
+
+        return true;
+    }
+}