Merge remote-tracking branch 'origin/ECP-9757' into ECP-9757

Author: candemiralp

Api/AnalyticsEventRepositoryInterface.php

@@ -0,0 +1,15 @@
+<?php
+namespace Adyen\Payment\Api;
+
+use Adyen\Payment\Api\Data\AnalyticsEventInterface;
+
+interface AnalyticsEventRepositoryInterface
+{
+    public function save(AnalyticsEventInterface $analyticsEvent): AnalyticsEventInterface;
+
+    public function getById(int $id): AnalyticsEventInterface;
+
+    public function delete(AnalyticsEventInterface $analyticsEvent): void;
+
+    public function deleteById(int $id): void;
+}

Api/Data/AnalyticsEventInterface.php

@@ -0,0 +1,94 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Api\Data;
+
+use DateTime;
+
+interface AnalyticsEventInterface
+{
+    const ADYEN_ANALYTICS_EVENT = 'adyen_analytics_event';
+    const TABLE_NAME_ALIAS = 'analytics_event';
+    const ENTITY_ID = 'entity_id';
+    const UUID = 'uuid';
+    const RELATION_ID = 'relation_id';
+    const TYPE = 'type';
+    const TOPIC = 'topic';
+    const MESSAGE = 'message';
+    const VERSION = 'version';
+    const ERROR_TYPE = 'error_type';
+    const ERROR_CODE = 'error_code';
+    const ERROR_COUNT = 'error_count';
+    const STATUS = 'status';
+    const CREATED_AT = 'created_at';
+    const UPDATED_AT = 'updated_at';
+    const SCHEDULED_PROCESSING_TIME = 'scheduled_processing_time';
+    const MAX_ERROR_COUNT = 5;
+
+    public function getEntityId();
+
+    public function setEntityId($entityId);
+
+    public function getRelationId(): string;
+
+    public function setRelationId(string $relationId): AnalyticsEventInterface;
+
+    public function getUuid(): string;
+
+    public function setUuid(string $uuid): AnalyticsEventInterface;
+
+    public function getType(): string;
+
+    public function setType(string $type): AnalyticsEventInterface;
+
+    public function getTopic(): string;
+
+    public function setTopic(string $topic): AnalyticsEventInterface;
+
+    public function getMessage(): ?string;
+
+    public function setMessage(?string $message = null): AnalyticsEventInterface;
+
+    public function getVersion(): string;
+
+    public function setVersion(string $version): AnalyticsEventInterface;
+
+    public function getErrorType(): ?string;
+
+    public function setErrorType(?string $errorType = null): AnalyticsEventInterface;
+
+    public function getErrorCode(): ?string;
+
+    public function setErrorCode(?string $errorCode = null): AnalyticsEventInterface;
+
+    public function getErrorCount(): int;
+
+    public function setErrorCount(int $errorCount): AnalyticsEventInterface;
+
+    public function getStatus(): string;
+
+    public function setStatus(string $status): AnalyticsEventInterface;
+
+    public function getCreatedAt(): string;
+
+    public function setCreatedAt(string $createdAt): AnalyticsEventInterface;
+
+    public function getCreatedAtTimestamp(): int;
+
+    public function getUpdatedAt(): ?string;
+
+    public function setUpdatedAt(?string $updatedAt = null): AnalyticsEventInterface;
+
+    public function getScheduledProcessingTime(): ?string;
+
+    public function setScheduledProcessingTime(?string $scheduledProcessingTime = null): AnalyticsEventInterface;
+}

Api/Data/AnalyticsEventStatusEnum.php

@@ -0,0 +1,20 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Api\Data;
+
+enum AnalyticsEventStatusEnum: int
+{
+    case PENDING = 0;
+    case PROCESSING = 1;
+    case DONE = 2;
+}

Api/Data/AnalyticsEventTypeEnum.php

@@ -0,0 +1,20 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Api\Data;
+
+enum AnalyticsEventTypeEnum: string
+{
+    case EXPECTED_START = 'expectedStart';
+    case EXPECTED_END = 'expectedEnd';
+    case UNEXPECTED_END = 'unexpectedEnd';
+}

Api/Data/ConfigurationEventType.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ *
+ * Adyen Payment Module
+ *
+ * Copyright (c) 2025 Adyen N.V.
+ * This file is open source and available under the MIT license.
+ * See the LICENSE file for more info.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Api\Data;
+
+enum ConfigurationEventType: string
+{
+    case PLUGIN_INSTALLATION = 'plugin_installation';
+}

Block/Checkout/Success.php

@@ -79,11 +79,13 @@ public function __construct(
      * PresentToShopper e.g. Multibanco
      * Received e.g. Bank Transfer IBAN
      * @return bool
+     * @throws LocalizedException
      */
     public function renderAction(): bool
     {
+        $code = $this->getResultCode();
         if (
-            !empty($this->getOrder()->getPayment()->getAdditionalInformation('resultCode')) &&
+            !empty($code) &&
             !empty($this->getOrder()->getPayment()->getAdditionalInformation('action')) &&
             (
             in_array($this->getOrder()->getPayment()->getAdditionalInformation('resultCode'),
@@ -187,4 +189,52 @@ public function getIsCustomerLoggedIn(): bool
     {
         return $this->customerSession->isLoggedIn();
     }
+
+    public function getResultCode()
+    {
+        try {
+            return $this->getOrder()->getPayment()->getAdditionalInformation('resultCode');
+        } catch (\Throwable $e) {
+            return null;
+        }
+    }
+
+    /**
+     * Checks if the result code is an intermediate result.
+     *
+     * @return bool
+     */
+    public function isIntermediateResult(): bool
+    {
+        $code = $this->getResultCode();
+        if (empty($code)) {
+            return false;
+        }
+
+        return in_array(
+            $code,
+            [
+                PaymentResponseHandler::PENDING,
+                PaymentResponseHandler::RECEIVED
+            ],
+            true
+        );
+    }
+
+    /**
+     * Return a pending message that will be displayed to the customer.
+     *
+     * This message will be displayed when the payment is still being processed.
+     * The message will contain the order increment id if available.
+     *
+     * @throws LocalizedException
+     */
+    public function getPendingMessage()
+    {
+        return __(
+            'We’ve received your order %1, but your payment is still being processed. You’ll get an email once it’s confirmed. If the payment isn’t completed, your order may be cancelled automatically.',
+            $this->getOrder()->getIncrementId()
+        );
+    }
+
 }

Cron/AnalyticsEventsCleanUp.php

@@ -0,0 +1,54 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2026 Adyen NV (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Cron;
+
+use Adyen\Payment\Api\Data\AnalyticsEventInterface;
+use Adyen\Payment\Logger\AdyenLogger;
+use Adyen\Payment\Model\ResourceModel\AnalyticsEvent;
+use Adyen\Payment\Model\ResourceModel\AnalyticsEvent\CollectionFactory;
+use Exception;
+
+class AnalyticsEventsCleanUp
+{
+    /**
+     * @param CollectionFactory $analyticsEventCollectionFactory
+     * @param AnalyticsEvent $analyticsEventResourceModel
+     * @param AdyenLogger $adyenLogger
+     */
+    public function __construct(
+        private readonly CollectionFactory $analyticsEventCollectionFactory,
+        private readonly AnalyticsEvent $analyticsEventResourceModel,
+        private readonly AdyenLogger $adyenLogger
+    ) {}
+
+    /**
+     * This method is executed by the cron job `adyen_payment_clean_up_analytics_events` and deletes
+     * the analytics events that are older than 45 days OR are in the done state.
+     *
+     * @return void
+     */
+    public function execute(): void
+    {
+        try {
+            $collection = $this->analyticsEventCollectionFactory->create()->analyticsEventsToCleanUp();
+
+            $ids = $collection->getColumnValues(AnalyticsEventInterface::ENTITY_ID);
+            if (!empty($ids)) {
+                $this->analyticsEventResourceModel->deleteByIds($ids);
+            }
+        } catch (Exception $e) {
+            $this->adyenLogger->error(
+                sprintf("An error occurred while cleaning up the analytics events: %s", $e->getMessage())
+            );
+        }
+    }
+}

Cron/Providers/AnalyticsEventProviderInterface.php

@@ -0,0 +1,35 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2025 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Cron\Providers;
+
+use Adyen\Payment\Api\Data\AnalyticsEventInterface;
+
+interface AnalyticsEventProviderInterface
+{
+    const BATCH_SIZE = 1000;
+    const CLEAN_UP_BATCH_SIZE = 5000;
+
+    /**
+     * @return AnalyticsEventInterface[]
+     */
+    public function provide(): array;
+
+    /**
+     * @return string
+     */
+    public function getAnalyticsContext(): string;
+
+    /**
+     * @return string
+     */
+    public function getProviderName(): string;
+}

Cron/Providers/PendingErrorsAnalyticsEventsProvider.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ *
+ * Adyen Payment module (https://www.adyen.com/)
+ *
+ * Copyright (c) 2025 Adyen N.V. (https://www.adyen.com/)
+ * See LICENSE.txt for license details.
+ *
+ * Author: Adyen <magento@adyen.com>
+ */
+
+namespace Adyen\Payment\Cron\Providers;
+
+use Adyen\AdyenException;
+use Adyen\Payment\Api\Data\AnalyticsEventInterface;
+use Adyen\Payment\Api\Data\AnalyticsEventTypeEnum;
+use Adyen\Payment\Helper\CheckoutAnalytics;
+use Adyen\Payment\Model\ResourceModel\AnalyticsEvent\Collection as AnalyticsEventCollection;
+use Adyen\Payment\Model\ResourceModel\AnalyticsEvent\CollectionFactory as AnalyticsEventCollectionFactory;
+
+class PendingErrorsAnalyticsEventsProvider implements AnalyticsEventProviderInterface
+{
+    const PROVIDER_NAME = 'Pending analytics events for `errors` context';
+
+    public function __construct(
+        private readonly AnalyticsEventCollectionFactory $analyticsEventCollectionFactory
+    ) {}
+
+    /**
+     * @return AnalyticsEventInterface[]
+     * @throws AdyenException
+     */
+    public function provide(): array
+    {
+        $analyticsEventCollection = $this->analyticsEventCollectionFactory->create();
+
+        /** @var AnalyticsEventCollection $analyticsEventCollection */
+        $analyticsEventCollection = $analyticsEventCollection->pendingAnalyticsEvents([
+            AnalyticsEventTypeEnum::UNEXPECTED_END
+        ]);
+
+        return $analyticsEventCollection->getItems();
+    }
+
+    /**
+     * @return string
+     */
+    public function getProviderName(): string
+    {
+        return self::PROVIDER_NAME;
+    }
+
+    /**
+     * @return string
+     */
+    public function getAnalyticsContext(): string
+    {
+        return CheckoutAnalytics::CONTEXT_TYPE_ERRORS;
+    }
+}