[ECP-9686] Create a class to clean-up additional information

Author: candemiralp

Api/CleanupAdditionalInformationInterface.php

@@ -0,0 +1,32 @@
+<?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;
+
+use Magento\Sales\Api\Data\OrderPaymentInterface;
+
+interface CleanupAdditionalInformationInterface
+{
+    const FIELD_ACTION = 'action';
+    const FIELD_ADDITIONAL_DATA = 'additionalData';
+
+    const FIELDS_TO_BE_CLEANED_UP = [
+        self::FIELD_ACTION,
+        self::FIELD_ADDITIONAL_DATA
+    ];
+
+    /**
+     * @param OrderPaymentInterface $orderPayment
+     * @return OrderPaymentInterface
+     */
+    public function execute(OrderPaymentInterface $orderPayment): OrderPaymentInterface;
+}

Helper/Webhook/AuthorisationWebhookHandler.php

@@ -12,6 +12,7 @@
 
 namespace Adyen\Payment\Helper\Webhook;
 
+use Adyen\Payment\Api\CleanupAdditionalInformationInterface;
 use Adyen\Payment\Api\Repository\AdyenNotificationRepositoryInterface;
 use Adyen\Payment\Helper\AdyenOrderPayment;
 use Adyen\Payment\Helper\CaseManagement;
@@ -41,6 +42,7 @@ class AuthorisationWebhookHandler implements WebhookHandlerInterface
      * @param PaymentMethods $paymentMethodsHelper
      * @param CartRepositoryInterface $cartRepository
      * @param AdyenNotificationRepositoryInterface $notificationRepository
+     * @param CleanupAdditionalInformationInterface $cleanupAdditionalInformation
      */
     public function __construct(
         private readonly AdyenOrderPayment $adyenOrderPaymentHelper,
@@ -52,7 +54,8 @@ public function __construct(
         private readonly Invoice $invoiceHelper,
         private readonly PaymentMethods $paymentMethodsHelper,
         private readonly CartRepositoryInterface $cartRepository,
-        private readonly AdyenNotificationRepositoryInterface $notificationRepository
+        private readonly AdyenNotificationRepositoryInterface $notificationRepository,
+        private readonly CleanupAdditionalInformationInterface $cleanupAdditionalInformation
     ) { }
 
     /**
@@ -113,6 +116,9 @@ private function handleSuccessfulAuthorisation(Order $order, Notification $notif
             // Set authorized amount in sales_order_payment
             $order->getPayment()->setAmountAuthorized($order->getGrandTotal());
             $order->getPayment()->setBaseAmountAuthorized($order->getBaseGrandTotal());
+
+            // Clean-up the data temporarily stored in `additional_information`
+            $this->cleanupAdditionalInformation->execute($order->getPayment());
         } else {
             $this->orderHelper->addWebhookStatusHistoryComment($order, $notification);
         }
@@ -186,6 +192,9 @@ private function handleFailedAuthorisation(Order $order, Notification $notificat
             $order->setState(Order::STATE_NEW);
         }
 
+        // Clean-up the data temporarily stored in `additional_information`
+        $this->cleanupAdditionalInformation->execute($order->getPayment());
+
         return $this->orderHelper->holdCancelOrder($order, true);
     }
 

Model/CleanupAdditionalInformation.php

@@ -0,0 +1,34 @@
+<?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\Model;
+
+use Adyen\Payment\Api\CleanupAdditionalInformationInterface;
+use Magento\Sales\Api\Data\OrderPaymentInterface;
+
+class CleanupAdditionalInformation implements CleanupAdditionalInformationInterface
+{
+    /**
+     * This method cleans-up the unnecessary fields in `additional_information` of OrderPayment object.
+     *
+     * @param OrderPaymentInterface $orderPayment
+     * @return OrderPaymentInterface
+     */
+    public function execute(OrderPaymentInterface $orderPayment): OrderPaymentInterface
+    {
+        foreach (self::FIELDS_TO_BE_CLEANED_UP as $field) {
+            $orderPayment->unsAdditionalInformation($field);
+        }
+
+        return $orderPayment;
+    }
+}

Test/Unit/Model/CleanupAdditionalInformationTest.php

@@ -0,0 +1,49 @@
+<?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\Test\Helper\Unit\Model;
+
+use Adyen\Payment\Api\CleanupAdditionalInformationInterface;
+use Adyen\Payment\Model\CleanupAdditionalInformation;
+use Adyen\Payment\Test\Unit\AbstractAdyenTestCase;
+use Magento\Sales\Model\Order\Payment;
+use PHPUnit\Framework\MockObject\MockObject;
+
+class CleanupAdditionalInformationTest extends AbstractAdyenTestCase
+{
+    protected ?CleanupAdditionalInformation $cleanupAdditionalInformation;
+    protected Payment|MockObject $orderPaymentMock;
+
+    public function setUp(): void
+    {
+        $this->orderPaymentMock = $this->createMock(Payment::class);
+
+        $this->cleanupAdditionalInformation = new CleanupAdditionalInformation();
+    }
+
+    public function tearDown(): void
+    {
+        $this->cleanupAdditionalInformation = null;
+    }
+
+    public function testExecute()
+    {
+        $this->orderPaymentMock->expects($this->exactly(2))
+            ->method('unsAdditionalInformation')
+            ->willReturnMap([
+                [CleanupAdditionalInformationInterface::FIELD_ADDITIONAL_DATA, $this->orderPaymentMock],
+                [CleanupAdditionalInformationInterface::FIELD_ACTION, $this->orderPaymentMock]
+            ]);
+
+        $result = $this->cleanupAdditionalInformation->execute($this->orderPaymentMock);
+        $this->assertInstanceOf(Payment::class, $result);
+    }
+}

etc/di.xml

@@ -1655,6 +1655,8 @@
                 type="Adyen\Payment\Model\AdyenCreditmemoRepository" />
     <preference for="Adyen\Payment\Api\Repository\AdyenOrderPaymentRepositoryInterface"
                 type="Adyen\Payment\Model\AdyenOrderPaymentRepository" />
+    <preference for="Adyen\Payment\Api\CleanupAdditionalInformationInterface"
+                type="Adyen\Payment\Model\CleanupAdditionalInformation" />
     <type name="Magento\Vault\Api\PaymentTokenRepositoryInterface">
         <plugin name="AdyenPaymentVaultDeleteToken" type="Adyen\Payment\Plugin\PaymentVaultDeleteToken" sortOrder="10" />
     </type>