MC-18194: Saved Credit Card Feature with Vault is not displaying proper information of card in order information page

Author: Mastiuhin Olexandr

app/code/Magento/Vault/Model/Method/Vault.php

@@ -21,6 +21,7 @@
 use Magento\Vault\Api\PaymentTokenManagementInterface;
 use Magento\Vault\Block\Form;
 use Magento\Vault\Model\VaultPaymentInterface;
+use Magento\Framework\Serialize\Serializer\Json;
 
 /**
  * Class Vault
@@ -103,6 +104,11 @@ class Vault implements VaultPaymentInterface
      */
     private $code;
 
+    /**
+     * @var Json
+     */
+    private $jsonSerializer;
+
     /**
      * Constructor
      *
@@ -116,6 +122,7 @@ class Vault implements VaultPaymentInterface
      * @param PaymentTokenManagementInterface $tokenManagement
      * @param OrderPaymentExtensionInterfaceFactory $paymentExtensionFactory
      * @param string $code
+     * @param Json $jsonSerializer
      *
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
@@ -129,7 +136,8 @@ public function __construct(
         Command\CommandManagerPoolInterface $commandManagerPool,
         PaymentTokenManagementInterface $tokenManagement,
         OrderPaymentExtensionInterfaceFactory $paymentExtensionFactory,
-        $code
+        $code,
+        Json $jsonSerializer
     ) {
         $this->config = $config;
         $this->configFactory = $configFactory;
@@ -141,21 +149,14 @@ public function __construct(
         $this->tokenManagement = $tokenManagement;
         $this->paymentExtensionFactory = $paymentExtensionFactory;
         $this->code = $code;
-    }
-
-    /**
-     * @return MethodInterface
-     */
-    private function getVaultProvider()
-    {
-        return $this->vaultProvider;
+        $this->jsonSerializer = $jsonSerializer;
     }
 
     /**
      * Unifies configured value handling logic
      *
      * @param string $field
-     * @param null $storeId
+     * @param int|null $storeId
      * @return mixed
      */
     private function getConfiguredValue($field, $storeId = null)
@@ -226,8 +227,8 @@ public function canOrder()
      */
     public function canAuthorize()
     {
-        return $this->getVaultProvider()->canAuthorize()
-        && $this->getVaultProvider()->getConfigData(static::CAN_AUTHORIZE);
+        return $this->vaultProvider->canAuthorize()
+        && $this->vaultProvider->getConfigData(static::CAN_AUTHORIZE);
     }
 
     /**
@@ -236,8 +237,8 @@ public function canAuthorize()
      */
     public function canCapture()
     {
-        return $this->getVaultProvider()->canCapture()
-        && $this->getVaultProvider()->getConfigData(static::CAN_CAPTURE);
+        return $this->vaultProvider->canCapture()
+        && $this->vaultProvider->getConfigData(static::CAN_CAPTURE);
     }
 
     /**
@@ -255,7 +256,7 @@ public function canCapturePartial()
      */
     public function canCaptureOnce()
     {
-        return $this->getVaultProvider()->canCaptureOnce();
+        return $this->vaultProvider->canCaptureOnce();
     }
 
     /**
@@ -294,7 +295,7 @@ public function canUseInternal()
         $isInternalAllowed = $this->getConfiguredValue('can_use_internal');
         // if config has't been specified for Vault, need to check payment provider option
         if ($isInternalAllowed === null) {
-            return $this->getVaultProvider()->canUseInternal();
+            return $this->vaultProvider->canUseInternal();
         }
         return (bool) $isInternalAllowed;
     }
@@ -305,7 +306,7 @@ public function canUseInternal()
      */
     public function canUseCheckout()
     {
-        return $this->getVaultProvider()->canUseCheckout();
+        return $this->vaultProvider->canUseCheckout();
     }
 
     /**
@@ -314,7 +315,7 @@ public function canUseCheckout()
      */
     public function canEdit()
     {
-        return $this->getVaultProvider()->canEdit();
+        return $this->vaultProvider->canEdit();
     }
 
     /**
@@ -341,7 +342,7 @@ public function fetchTransactionInfo(InfoInterface $payment, $transactionId)
      */
     public function isGateway()
     {
-        return $this->getVaultProvider()->isGateway();
+        return $this->vaultProvider->isGateway();
     }
 
     /**
@@ -350,7 +351,7 @@ public function isGateway()
      */
     public function isOffline()
     {
-        return $this->getVaultProvider()->isOffline();
+        return $this->vaultProvider->isOffline();
     }
 
     /**
@@ -359,7 +360,7 @@ public function isOffline()
      */
     public function isInitializeNeeded()
     {
-        return $this->getVaultProvider()->isInitializeNeeded();
+        return $this->vaultProvider->isInitializeNeeded();
     }
 
     /**
@@ -368,7 +369,7 @@ public function isInitializeNeeded()
      */
     public function canUseForCountry($country)
     {
-        return $this->getVaultProvider()->canUseForCountry($country);
+        return $this->vaultProvider->canUseForCountry($country);
     }
 
     /**
@@ -377,7 +378,7 @@ public function canUseForCountry($country)
      */
     public function canUseForCurrency($currencyCode)
     {
-        return $this->getVaultProvider()->canUseForCurrency($currencyCode);
+        return $this->vaultProvider->canUseForCurrency($currencyCode);
     }
 
     /**
@@ -386,7 +387,7 @@ public function canUseForCurrency($currencyCode)
      */
     public function getInfoBlockType()
     {
-        return $this->getVaultProvider()->getInfoBlockType();
+        return $this->vaultProvider->getInfoBlockType();
     }
 
     /**
@@ -395,7 +396,7 @@ public function getInfoBlockType()
      */
     public function getInfoInstance()
     {
-        return $this->getVaultProvider()->getInfoInstance();
+        return $this->vaultProvider->getInfoInstance();
     }
 
     /**
@@ -404,7 +405,7 @@ public function getInfoInstance()
      */
     public function setInfoInstance(InfoInterface $info)
     {
-        $this->getVaultProvider()->setInfoInstance($info);
+        $this->vaultProvider->setInfoInstance($info);
     }
 
     /**
@@ -413,7 +414,7 @@ public function setInfoInstance(InfoInterface $info)
      */
     public function validate()
     {
-        return $this->getVaultProvider()->validate();
+        return $this->vaultProvider->validate();
     }
 
     /**
@@ -437,9 +438,10 @@ public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount
         /** @var $payment OrderPaymentInterface */
 
         $this->attachTokenExtensionAttribute($payment);
+        $this->attachCreditCardInfo($payment);
 
         $commandExecutor = $this->commandManagerPool->get(
-            $this->getVaultProvider()->getCode()
+            $this->vaultProvider->getCode()
         );
 
         $commandExecutor->executeByCode(
@@ -450,7 +452,7 @@ public function authorize(\Magento\Payment\Model\InfoInterface $payment, $amount
             ]
         );
 
-        $payment->setMethod($this->getVaultProvider()->getCode());
+        $payment->setMethod($this->vaultProvider->getCode());
 
         return $this;
     }
@@ -473,7 +475,7 @@ public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
         $this->attachTokenExtensionAttribute($payment);
 
         $commandExecutor = $this->commandManagerPool->get(
-            $this->getVaultProvider()->getCode()
+            $this->vaultProvider->getCode()
         );
 
         $commandExecutor->executeByCode(
@@ -484,10 +486,12 @@ public function capture(\Magento\Payment\Model\InfoInterface $payment, $amount)
             ]
         );
 
-        $payment->setMethod($this->getVaultProvider()->getCode());
+        $payment->setMethod($this->vaultProvider->getCode());
     }
 
     /**
+     * Attaches token extension attribute.
+     *
      * @param OrderPaymentInterface $orderPayment
      * @return void
      */
@@ -514,6 +518,8 @@ private function attachTokenExtensionAttribute(OrderPaymentInterface $orderPayme
     }
 
     /**
+     * Returns Payment's extension attributes.
+     *
      * @param OrderPaymentInterface $payment
      * @return \Magento\Sales\Api\Data\OrderPaymentExtensionInterface
      */
@@ -528,6 +534,20 @@ private function getPaymentExtensionAttributes(OrderPaymentInterface $payment)
         return $extensionAttributes;
     }
 
+    /**
+     * Attaches credit card info.
+     *
+     * @param OrderPaymentInterface $payment
+     * @return void
+     */
+    private function attachCreditCardInfo(OrderPaymentInterface $payment): void
+    {
+        $paymentToken = $payment->getExtensionAttributes()
+            ->getVaultPaymentToken();
+        $tokenDetails = $this->jsonSerializer->unserialize($paymentToken->getTokenDetails());
+        $payment->addData($tokenDetails);
+    }
+
     /**
      * @inheritdoc
      * @since 100.1.0
@@ -615,7 +635,7 @@ public function assignData(\Magento\Framework\DataObject $data)
             ]
         );
 
-        return $this->getVaultProvider()->assignData($data);
+        return $this->vaultProvider->assignData($data);
     }
 
     /**
@@ -624,7 +644,7 @@ public function assignData(\Magento\Framework\DataObject $data)
      */
     public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
     {
-        return $this->getVaultProvider()->isAvailable($quote)
+        return $this->vaultProvider->isAvailable($quote)
             && $this->config->getValue(self::$activeKey, $this->getStore() ?: ($quote ? $quote->getStoreId() : null));
     }
 
@@ -634,7 +654,7 @@ public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
      */
     public function isActive($storeId = null)
     {
-        return $this->getVaultProvider()->isActive($storeId)
+        return $this->vaultProvider->isActive($storeId)
             && $this->config->getValue(self::$activeKey, $this->getStore() ?: $storeId);
     }
 
@@ -653,7 +673,7 @@ public function initialize($paymentAction, $stateObject)
      */
     public function getConfigPaymentAction()
     {
-        return $this->getVaultProvider()->getConfigPaymentAction();
+        return $this->vaultProvider->getConfigPaymentAction();
     }
 
     /**
@@ -662,6 +682,6 @@ public function getConfigPaymentAction()
      */
     public function getProviderCode()
     {
-        return $this->getVaultProvider()->getCode();
+        return $this->vaultProvider->getCode();
     }
 }

app/code/Magento/Vault/Test/Unit/Model/Method/VaultTest.php

@@ -23,6 +23,7 @@
 use Magento\Vault\Api\PaymentTokenManagementInterface;
 use Magento\Vault\Model\Method\Vault;
 use Magento\Vault\Model\VaultPaymentInterface;
+use Magento\Framework\Serialize\Serializer\Json;
 use PHPUnit_Framework_MockObject_MockObject as MockObject;
 
 /**
@@ -42,10 +43,19 @@ class VaultTest extends \PHPUnit\Framework\TestCase
      */
     private $vaultProvider;
 
+    /**
+     * @var Json|MockObject
+     */
+    private $jsonSerializer;
+
+    /**
+     * @inheritdoc
+     */
     public function setUp()
     {
         $this->objectManager = new ObjectManager($this);
         $this->vaultProvider = $this->createMock(MethodInterface::class);
+        $this->jsonSerializer = $this->createMock(Json::class);
     }
 
     /**
@@ -152,6 +162,19 @@ public function testAuthorize()
         $tokenManagement = $this->createMock(PaymentTokenManagementInterface::class);
         $token = $this->createMock(PaymentTokenInterface::class);
 
+        $tokenDetails = [
+            'cc_last4' => '1111',
+            'cc_type' => 'VI',
+            'cc_exp_year' => '2020',
+            'cc_exp_month' => '01',
+        ];
+
+        $extensionAttributes->method('getVaultPaymentToken')
+            ->willReturn($token);
+
+        $this->jsonSerializer->method('unserialize')
+            ->willReturn($tokenDetails);
+
         $paymentModel->expects(static::once())
             ->method('getAdditionalInformation')
             ->willReturn(
@@ -164,8 +187,7 @@ public function testAuthorize()
             ->method('getByPublicHash')
             ->with($publicHash, $customerId)
             ->willReturn($token);
-        $paymentModel->expects(static::once())
-            ->method('getExtensionAttributes')
+        $paymentModel->method('getExtensionAttributes')
             ->willReturn($extensionAttributes);
         $extensionAttributes->expects(static::once())
             ->method('setVaultPaymentToken')
@@ -198,7 +220,8 @@ public function testAuthorize()
             [
                 'tokenManagement' => $tokenManagement,
                 'commandManagerPool' => $commandManagerPool,
-                'vaultProvider' => $this->vaultProvider
+                'vaultProvider' => $this->vaultProvider,
+                'jsonSerializer' => $this->jsonSerializer,
             ]
         );
         $model->authorize($paymentModel, $amount);