[PW-3130] Use the generic component for stored payment methods (#919)

* Tokenize payment methods in payment response handler

Do not save recurring details "manually" for /payments/details response

* Standardise Oneclick Observer

* Use generic component for recurring payments

* sonarcloud suggestions

* Remove unused div

Gateway/Request/OneclickAuthorizationDataBuilder.php

@@ -55,20 +55,6 @@ class OneclickAuthorizationDataBuilder implements BuilderInterface
         $paymentDataObject = \Magento\Payment\Gateway\Helper\SubjectReader::readPayment($buildSubject);
         $payment = $paymentDataObject->getPayment();
 
-        // If ccType is set use this. For bcmc you need bcmc otherwise it will fail
-        $requestBody['paymentMethod']['type'] = "scheme";
-        if ($variant = $payment->getAdditionalInformation(AdyenOneclickDataAssignObserver::VARIANT)) {
-            $requestBody['paymentMethod']['type'] = $variant;
-        }
-
-        if ($securityCode = $payment->getAdditionalInformation(
-            AdyenOneclickDataAssignObserver::ENCRYPTED_SECURITY_CODE
-        )) {
-            $requestBody['paymentMethod']['encryptedSecurityCode'] = $securityCode;
-        }
-
-        $payment->unsAdditionalInformation(AdyenOneclickDataAssignObserver::ENCRYPTED_SECURITY_CODE);
-
         if ($payment->getAdditionalInformation('customer_interaction')) {
             $shopperInteraction = "Ecommerce";
         } else {
@@ -76,9 +62,7 @@ class OneclickAuthorizationDataBuilder implements BuilderInterface
         }
 
         $requestBody['shopperInteraction'] = $shopperInteraction;
-        $requestBody['paymentMethod']['recurringDetailReference'] = $payment->getAdditionalInformation(
-            AdyenOneclickDataAssignObserver::RECURRING_DETAIL_REFERENCE
-        );
+
 
         // if it is a sepadirectdebit set selectedBrand to sepadirectdebit in the case of oneclick
         if ($payment->getCcType() == "sepadirectdebit") {

Helper/Data.php

@@ -1713,7 +1713,7 @@ class Data extends AbstractHelper
                         $billingAgreement->getAgreementId(),
                         $order->getId()
                     )) {
-                        // save into sales_billing_agreement_order
+                        // save into billing_agreement_order
                         $billingAgreement->addOrderRelation($order);
                     }
                     // add to order to save agreement
@@ -1733,6 +1733,7 @@ class Data extends AbstractHelper
             $comment = $order->addStatusHistoryComment($message);
 
             $order->addRelatedObject($comment);
+            $order->save();
         }
     }
 

Helper/PaymentResponseHandler.php

@@ -27,6 +27,7 @@ use Adyen\Payment\Logger\AdyenLogger;
 use Magento\Sales\Api\Data\OrderInterface;
 use Magento\Sales\Api\Data\OrderPaymentInterface;
 use Magento\Sales\Model\Order;
+use Adyen\Payment\Helper\Vault;
 
 class PaymentResponseHandler
 {
@@ -41,12 +42,36 @@ class PaymentResponseHandler
     const ERROR = 'Error';
     const CANCELLED = 'Cancelled';
 
+    /**
+     * @var AdyenLogger
+     */
     private $adyenLogger;
 
+    /**
+     * @var Data
+     */
+    private $adyenHelper;
+
+    /**
+     * @var Vault
+     */
+    private $vaultHelper;
+
+    /**
+     * PaymentResponseHandler constructor.
+     *
+     * @param AdyenLogger $adyenLogger
+     * @param Data $adyenHelper
+     * @param \Adyen\Payment\Helper\Vault $vaultHelper
+     */
     public function __construct(
-        AdyenLogger $adyenLogger
+        AdyenLogger $adyenLogger,
+        Data $adyenHelper,
+        Vault $vaultHelper
     ) {
         $this->adyenLogger = $adyenLogger;
+        $this->adyenHelper = $adyenHelper;
+        $this->vaultHelper = $vaultHelper;
     }
 
     public function formatPaymentResponse($resultCode, $action = null, $additionalData = null)
@@ -144,6 +169,24 @@ class PaymentResponseHandler
                 }
                 break;
             case self::AUTHORISED:
+                if (!empty($paymentsResponse['pspReference'])) {
+                    // set pspReference as transactionId
+                    $payment->setCcTransId($paymentsResponse['pspReference']);
+                    $payment->setLastTransId($paymentsResponse['pspReference']);
+
+                    // set transaction
+                    $payment->setTransactionId($paymentsResponse['pspReference']);
+                }
+
+                if (!empty($paymentsResponse['additionalData']['recurring.recurringDetailReference']) &&
+                    $payment->getMethodInstance()->getCode() !== \Adyen\Payment\Model\Ui\AdyenOneclickConfigProvider::CODE) {
+                    if ($this->adyenHelper->isCreditCardVaultEnabled()) {
+                        $this->vaultHelper->saveRecurringDetails($payment, $paymentsResponse['additionalData']);
+                    } else {
+                        $order = $payment->getOrder();
+                        $this->adyenHelper->createAdyenBillingAgreement($order, $paymentsResponse['additionalData']);
+                    }
+                }
             case self::IDENTIFY_SHOPPER:
             case self::CHALLENGE_SHOPPER:
                 break;

Model/AdyenPaymentDetails.php

@@ -27,7 +27,6 @@ use Adyen\AdyenException;
 use Adyen\Payment\Api\AdyenPaymentDetailsInterface;
 use Adyen\Payment\Helper\Data;
 use Adyen\Payment\Helper\PaymentResponseHandler;
-use Adyen\Payment\Helper\Vault;
 use Adyen\Payment\Logger\AdyenLogger;
 use Magento\Checkout\Model\Session;
 use Magento\Framework\Exception\LocalizedException;
@@ -50,11 +49,6 @@ class AdyenPaymentDetails implements AdyenPaymentDetailsInterface
      */
     private $adyenLogger;
 
-    /**
-     * @var Vault
-     */
-    private $vaultHelper;
-
     /**
      * @var OrderRepositoryInterface
      */
@@ -71,7 +65,6 @@ class AdyenPaymentDetails implements AdyenPaymentDetailsInterface
      * @param Session $checkoutSession
      * @param Data $adyenHelper
      * @param AdyenLogger $adyenLogger
-     * @param Vault $vaultHelper
      * @param OrderRepositoryInterface $orderRepository
      * @param PaymentResponseHandler $paymentResponseHandler
      */
@@ -79,14 +72,12 @@ class AdyenPaymentDetails implements AdyenPaymentDetailsInterface
         Session $checkoutSession,
         Data $adyenHelper,
         AdyenLogger $adyenLogger,
-        Vault $vaultHelper,
         OrderRepositoryInterface $orderRepository,
         PaymentResponseHandler $paymentResponseHandler
     ) {
         $this->checkoutSession = $checkoutSession;
         $this->adyenHelper = $adyenHelper;
         $this->adyenLogger = $adyenLogger;
-        $this->vaultHelper = $vaultHelper;
         $this->orderRepository = $orderRepository;
         $this->paymentResponseHandler = $paymentResponseHandler;
     }
@@ -139,14 +130,7 @@ class AdyenPaymentDetails implements AdyenPaymentDetailsInterface
             throw new LocalizedException(__('Payment details call failed'));
         }
 
-        //TODO test this with payments that return additionalData
-        //TODO check for Authorized result code and move to the handler
-        if (!empty($paymentDetails['additionalData'])) {
-            $this->vaultHelper->saveRecurringDetails($payment, $paymentDetails['additionalData']);
-        }
-
-        //TODO check if order save is necessary to save additionalData
-
+        // Handle response
         if (!$this->paymentResponseHandler->handlePaymentResponse($paymentDetails, $payment, $order)) {
             $this->checkoutSession->restoreQuote();
             throw new LocalizedException(__('The payment is REFUSED.'));

Observer/AdyenCcDataAssignObserver.php

@@ -37,6 +37,7 @@ class AdyenCcDataAssignObserver extends AbstractDataAssignObserver
     const GUEST_EMAIL = 'guestEmail';
     const COMBO_CARD_TYPE = 'combo_card_type';
     const STATE_DATA = 'stateData';
+    const STORE_PAYMENT_METHOD = 'storePaymentMethod';
 
     /**
      * Approved root level keys from additional data array
@@ -113,5 +114,10 @@ class AdyenCcDataAssignObserver extends AbstractDataAssignObserver
         if (!empty($additionalData[self::CC_TYPE])) {
             $paymentInfo->setCcType($additionalData[self::CC_TYPE]);
         }
+
+        // set storeCc
+        if (!empty($stateData[self::STORE_PAYMENT_METHOD])) {
+            $paymentInfo->setAdditionalInformation(self::STORE_CC, $stateData[self::STORE_PAYMENT_METHOD]);
+        }
     }
 }

Observer/AdyenOneclickDataAssignObserver.php

@@ -23,39 +23,34 @@
 
 namespace Adyen\Payment\Observer;
 
+use Adyen\Service\Validator\CheckoutStateDataValidator;
+use Adyen\Service\Validator\DataArrayValidator;
 use Magento\Framework\Event\Observer;
 use Magento\Payment\Observer\AbstractDataAssignObserver;
 use Magento\Quote\Api\Data\PaymentInterface;
 
 class AdyenOneclickDataAssignObserver extends AbstractDataAssignObserver
 {
-    const RECURRING_DETAIL_REFERENCE = 'recurring_detail_reference';
-    const ENCRYPTED_SECURITY_CODE = 'cvc';
+    const CC_TYPE = 'cc_type';
+    const BRAND = 'brand';
     const NUMBER_OF_INSTALLMENTS = 'number_of_installments';
-    const VARIANT = 'variant';
-    const JAVA_ENABLED = 'java_enabled';
-    const SCREEN_COLOR_DEPTH = 'screen_color_depth';
-    const SCREEN_WIDTH = 'screen_width';
-    const SCREEN_HEIGHT = 'screen_height';
-    const TIMEZONE_OFFSET = 'timezone_offset';
-    const LANGUAGE = 'language';
+    const STATE_DATA = 'stateData';
 
     /**
+     * Approved root level keys from additional data array
+     *
      * @var array
      */
-    protected $additionalInformationList = [
-        self::RECURRING_DETAIL_REFERENCE,
-        self::ENCRYPTED_SECURITY_CODE,
+    private static $approvedAdditionalDataKeys = [
+        self::STATE_DATA,
         self::NUMBER_OF_INSTALLMENTS,
-        self::VARIANT,
-        self::JAVA_ENABLED,
-        self::SCREEN_COLOR_DEPTH,
-        self::SCREEN_WIDTH,
-        self::SCREEN_HEIGHT,
-        self::TIMEZONE_OFFSET,
-        self::LANGUAGE
     ];
 
+    /**
+     * @var CheckoutStateDataValidator
+     */
+    private $checkoutStateDataValidator;
+
     /**
      * @var \Adyen\Payment\Helper\Data
      */
@@ -72,9 +67,11 @@ class AdyenOneclickDataAssignObserver extends AbstractDataAssignObserver
      * @param \Adyen\Payment\Helper\Data $adyenHelper
      */
     public function __construct(
+        CheckoutStateDataValidator $checkoutStateDataValidator,
         \Adyen\Payment\Helper\Data $adyenHelper,
         \Magento\Framework\Model\Context $context
     ) {
+        $this->checkoutStateDataValidator = $checkoutStateDataValidator;
         $this->adyenHelper = $adyenHelper;
         $this->appState = $context->getAppState();
     }
@@ -85,27 +82,47 @@ class AdyenOneclickDataAssignObserver extends AbstractDataAssignObserver
      */
     public function execute(Observer $observer)
     {
+        // Get request fields
         $data = $this->readDataArgument($observer);
 
+        // Get additional data array
         $additionalData = $data->getData(PaymentInterface::KEY_ADDITIONAL_DATA);
         if (!is_array($additionalData)) {
             return;
         }
 
-        $paymentInfo = $this->readPaymentModelArgument($observer);
+        // Get a validated additional data array
+        $additionalData = DataArrayValidator::getArrayOnlyWithApprovedKeys(
+            $additionalData,
+            self::$approvedAdditionalDataKeys
+        );
 
-        // set ccType
-        $variant = $additionalData['variant'];
-        $ccType = $this->adyenHelper->getMagentoCreditCartType($variant);
-        $paymentInfo->setCcType($ccType);
+        // json decode state data
+        $stateData = [];
+        if (!empty($additionalData[self::STATE_DATA])) {
+            $stateData = json_decode($additionalData[self::STATE_DATA], true);
+        }
 
-        foreach ($this->additionalInformationList as $additionalInformationKey) {
-            if (isset($additionalData[$additionalInformationKey])) {
-                $paymentInfo->setAdditionalInformation(
-                    $additionalInformationKey,
-                    $additionalData[$additionalInformationKey]
+        // Get validated state data array
+        if (!empty($stateData)) {
+            $stateData = $this->checkoutStateDataValidator->getValidatedAdditionalData(
+                $stateData
             );
         }
+
+        // Replace state data with the decoded and validated state data
+        $additionalData[self::STATE_DATA] = $stateData;
+
+        // Set additional data in the payment
+        $paymentInfo = $this->readPaymentModelArgument($observer);
+        foreach ($additionalData as $key => $data) {
+            $paymentInfo->setAdditionalInformation($key, $data);
+        }
+
+        // set ccType
+        if (!empty($stateData[self::BRAND])) {
+            $ccType = $this->adyenHelper->getMagentoCreditCartType($stateData[self::BRAND]);
+            $paymentInfo->setCcType($ccType);
         }
 
         // set customerInteraction
@@ -115,11 +132,6 @@ class AdyenOneclickDataAssignObserver extends AbstractDataAssignObserver
         } else {
             $paymentInfo->setAdditionalInformation('customer_interaction', false);
         }
-
-        // set ccType
-        $variant = $additionalData['variant'];
-        $ccType = $this->adyenHelper->getMagentoCreditCartType($variant);
-        $paymentInfo->setAdditionalInformation('cc_type', $ccType);
     }
 
     /**

view/frontend/web/template/payment/oneclick-form.html

@@ -71,6 +71,12 @@
             <fieldset
                     data-bind="attr: {class: 'fieldset payment items ccard ' + getCode(), id: 'payment_form_' + $parent.getCode() + '_' + value}">
 
+                <div id="oneclick_actionModalWrapper">
+                    <div id="oneclick_actionModal">
+                        <div id="oneclick_actionContainer"></div>
+                    </div>
+                </div>
+
                 <!-- ko if: agreement_data.card -->
                 <div class="field number">
                     <label class="label">
@@ -135,10 +141,6 @@
                 </div>
                 <!-- /ko -->
 
-                <div id="threeDS2ModalOneClick">
-                    <div id="threeDS2ContainerOneClick"></div>
-                </div>
-
             </fieldset>
 
             <div class="checkout-agreements-block">