[ECP-9593] Implement an abstract handler for order status history

Gateway/Response/AbstractOrderStatusHistoryHandler.php

@@ -0,0 +1,55 @@
+<?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 <[email protected]>
+ */
+
+namespace Adyen\Payment\Gateway\Response;
+
+use Adyen\AdyenException;
+use Adyen\Payment\Helper\OrderStatusHistory;
+use Magento\Payment\Gateway\Helper\SubjectReader;
+use Magento\Payment\Gateway\Response\HandlerInterface;
+
+class AbstractOrderStatusHistoryHandler implements HandlerInterface
+{
+    /**
+     * @param string $eventType Indicates the API call event type (authorization, capture etc.)
+     * @param OrderStatusHistory $orderStatusHistoryHelper
+     */
+    public function __construct(
+        protected readonly string $eventType,
+        protected readonly OrderStatusHistory $orderStatusHistoryHelper
+    ) { }
+
+    /**
+     * @throws AdyenException
+     */
+    public function handle(array $handlingSubject, array $responseCollection): void
+    {
+        if (empty($this->eventType)) {
+            throw new AdyenException(
+                __('Order status history can not be handled due to missing event type!')
+            );
+        }
+
+        $readPayment = SubjectReader::readPayment($handlingSubject);
+        $payment = $readPayment->getPayment();
+        $order = $payment->getOrder();
+
+        // Temporary workaround to clean-up `hasOnlyGiftCards` key. It needs to be handled separately.
+        if (isset($responseCollection['hasOnlyGiftCards'])) {
+            unset($responseCollection['hasOnlyGiftCards']);
+        }
+
+        foreach ($responseCollection as $response) {
+            $comment = $this->orderStatusHistoryHelper->buildComment($response, $this->eventType);
+            $order->addCommentToStatusHistory($comment, $order->getStatus());
+        }
+    }
+}

Helper/OrderStatusHistory.php

@@ -0,0 +1,37 @@
+<?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 <[email protected]>
+ */
+
+namespace Adyen\Payment\Helper;
+
+class OrderStatusHistory
+{
+    public function buildComment(array $response, string $actionName): String
+    {
+        $comment = __("Adyen %1 API response:", $actionName) . '<br />';
+
+        if (isset($response['resultCode'])) {
+            $comment .= __("Result Code: %1", $response['resultCode']) . '<br />';
+        }
+
+        // Modification responses contain `status` but not `resultCode`.
+        if (isset($response['status'])) {
+            $comment .= __("Status: %1", $response['status']) . '<br />';
+        }
+
+        if (isset($response['pspReference'])) {
+            $comment .= __("PSP reference: %1", $response['pspReference']);
+        }
+
+        $comment .= '<br />';
+
+        return $comment;
+    }
+}

etc/di.xml

@@ -1334,11 +1334,31 @@
             <argument name="handlers" xsi:type="array">
                 <item name="payment_details" xsi:type="string">Adyen\Payment\Gateway\Response\CheckoutPaymentsDetailsHandler</item>
                 <item name="vault_details" xsi:type="string">Adyen\Payment\Gateway\Response\VaultDetailsHandler</item>
-                <item name="payment_comments" xsi:type="string">Adyen\Payment\Gateway\Response\CheckoutPaymentCommentHistoryHandler</item>
+                <item name="order_status_history" xsi:type="string">AdyenPaymentAuthorisationOrderStatusHistoryHandler</item>
                 <item name="state_data" xsi:type="string">Adyen\Payment\Gateway\Response\StateDataHandler</item>
             </argument>
         </arguments>
     </virtualType>
+    <virtualType name="AdyenPaymentAuthorisationOrderStatusHistoryHandler" type="Adyen\Payment\Gateway\Response\AbstractOrderStatusHistoryHandler">
+        <arguments>
+            <argument name="eventType" xsi:type="string">authorisation</argument>
+        </arguments>
+    </virtualType>
+    <virtualType name="AdyenPaymentCaptureOrderStatusHistoryHandler" type="Adyen\Payment\Gateway\Response\AbstractOrderStatusHistoryHandler">
+        <arguments>
+            <argument name="eventType" xsi:type="string">capture</argument>
+        </arguments>
+    </virtualType>
+    <virtualType name="AdyenPaymentRefundOrderStatusHistoryHandler" type="Adyen\Payment\Gateway\Response\AbstractOrderStatusHistoryHandler">
+        <arguments>
+            <argument name="eventType" xsi:type="string">refund</argument>
+        </arguments>
+    </virtualType>
+    <virtualType name="AdyenPaymentCancellationOrderStatusHistoryHandler" type="Adyen\Payment\Gateway\Response\AbstractOrderStatusHistoryHandler">
+        <arguments>
+            <argument name="eventType" xsi:type="string">cancellation</argument>
+        </arguments>
+    </virtualType>
     <virtualType name="AdyenPaymentBoletoResponseHandlerComposite" type="Magento\Payment\Gateway\Response\HandlerChain">
         <arguments>
             <argument name="handlers" xsi:type="array">
@@ -1359,23 +1379,23 @@
         <arguments>
             <argument name="handlers" xsi:type="array">
                 <item name="capture" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentCaptureDetailsHandler</item>
-                <item name="payment_comments" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentCommentHistoryHandler</item>
+                <item name="order_comment_history" xsi:type="string">AdyenPaymentCaptureOrderStatusHistoryHandler</item>
             </argument>
         </arguments>
     </virtualType>
     <virtualType name="AdyenPaymentRefundResponseHandlerComposite" type="Magento\Payment\Gateway\Response\HandlerChain">
         <arguments>
             <argument name="handlers" xsi:type="array">
                 <item name="capture" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentRefundDetailsHandler</item>
-                <item name="payment_comments" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentCommentHistoryRefundHandler</item>
+                <item name="order_comment_history" xsi:type="string">AdyenPaymentRefundOrderStatusHistoryHandler</item>
             </argument>
         </arguments>
     </virtualType>
     <virtualType name="AdyenPaymentCancelResponseHandlerComposite" type="Magento\Payment\Gateway\Response\HandlerChain">
         <arguments>
             <argument name="handlers" xsi:type="array">
                 <item name="cancel" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentCancelDetailsHandler</item>
-                <item name="payment_comments" xsi:type="string">Adyen\Payment\Gateway\Response\PaymentCommentHistoryHandler</item>
+                <item name="order_comment_history" xsi:type="string">AdyenPaymentCancellationOrderStatusHistoryHandler</item>
             </argument>
         </arguments>
     </virtualType>