MAGETWO-83340: [2.3] Provide possibility to customize error messages from payment methods

- GetErrorCodes method is introduced in ResultInterface

Author: viktym

app/code/Magento/Braintree/Gateway/Validator/ErrorCodeValidator.php renamed to app/code/Magento/Braintree/Gateway/Validator/ErrorCodeProvider.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Braintree\Gateway\Validator;
 
 use Braintree\Error\ErrorCollection;
@@ -13,32 +15,24 @@
 /**
  * Processes errors codes from Braintree response.
  */
-class ErrorCodeValidator
+class ErrorCodeProvider
 {
     /**
-     * Invokes validation.
+     * Retrieves list of error codes from Braintree response.
      *
      * @param Successful|Error $response
      * @return array
      */
-    public function __invoke($response)
+    public function getErrorCodes($response): array
     {
+        $result = [];
         if (!$response instanceof Error) {
-            return [true, [__('Transaction is successful.')]];
+            return $result;
         }
 
-        return [false, $this->getErrorCodes($response->errors)];
-    }
+        /** @var ErrorCollection $collection */
+        $collection = $response->errors;
 
-    /**
-     * Retrieves list of error codes from Braintree response.
-     *
-     * @param ErrorCollection $collection
-     * @return array
-     */
-    private function getErrorCodes(ErrorCollection $collection)
-    {
-        $result = [];
         /** @var Validation $error */
         foreach ($collection->deepAll() as $error) {
             $result[] = $error->code;

app/code/Magento/Braintree/Gateway/Validator/GeneralResponseValidator.php

@@ -19,25 +19,25 @@ class GeneralResponseValidator extends AbstractValidator
     protected $subjectReader;
 
     /**
-     * @var ErrorCodeValidator
+     * @var ErrorCodeProvider
      */
-    private $errorCodeValidator;
+    private $errorCodeProvider;
 
     /**
      * Constructor
      *
      * @param ResultInterfaceFactory $resultFactory
      * @param SubjectReader $subjectReader
-     * @param ErrorCodeValidator $errorCodeValidator
+     * @param ErrorCodeProvider $errorCodeProvider
      */
     public function __construct(
         ResultInterfaceFactory $resultFactory,
         SubjectReader $subjectReader,
-        ErrorCodeValidator $errorCodeValidator
+        ErrorCodeProvider $errorCodeProvider
     ) {
         parent::__construct($resultFactory);
         $this->subjectReader = $subjectReader;
-        $this->errorCodeValidator = $errorCodeValidator;
+        $this->errorCodeProvider = $errorCodeProvider;
     }
 
     /**
@@ -59,8 +59,9 @@ public function validate(array $validationSubject)
                 $errorMessages = array_merge($errorMessages, $validationResult[1]);
             }
         }
+        $errorCodes = $this->errorCodeProvider->getErrorCodes($response);
 
-        return $this->createResult($isValid, $errorMessages);
+        return $this->createResult($isValid, $errorMessages, $errorCodes);
     }
 
     /**
@@ -74,8 +75,7 @@ function ($response) {
                     property_exists($response, 'success') && $response->success === true,
                     [$response->message ?? __('Braintree error response.')]
                 ];
-            },
-            $this->errorCodeValidator
+            }
         ];
     }
 }

app/code/Magento/Braintree/Test/Unit/Gateway/Command/GetPaymentNonceCommandTest.php

@@ -99,7 +99,7 @@ protected function setUp()
             ->getMock();
 
         $this->validationResultMock = $this->getMockBuilder(ResultInterface::class)
-            ->setMethods(['isValid', 'getFailsDescription'])
+            ->setMethods(['isValid', 'getFailsDescription', 'getErrorCodes'])
             ->getMock();
 
         $this->responseValidatorMock = $this->getMockBuilder(PaymentNonceResponseValidator::class)

app/code/Magento/Braintree/Test/Unit/Gateway/Validator/GeneralResponseValidatorTest.php

@@ -7,7 +7,7 @@
 
 use Braintree\Result\Error;
 use Magento\Braintree\Gateway\SubjectReader;
-use Magento\Braintree\Gateway\Validator\ErrorCodeValidator;
+use Magento\Braintree\Gateway\Validator\ErrorCodeProvider;
 use Magento\Braintree\Gateway\Validator\GeneralResponseValidator;
 use Magento\Framework\Phrase;
 use Magento\Payment\Gateway\Validator\Result;
@@ -41,7 +41,7 @@ protected function setUp()
         $this->responseValidator = new GeneralResponseValidator(
             $this->resultInterfaceFactory,
             new SubjectReader(),
-            new ErrorCodeValidator()
+            new ErrorCodeProvider()
         );
     }
 
@@ -51,18 +51,20 @@ protected function setUp()
      * @param array $validationSubject
      * @param bool $isValid
      * @param Phrase[] $messages
+     * @param array $errorCodes
      * @return void
      *
      * @dataProvider dataProviderTestValidate
      */
-    public function testValidate(array $validationSubject, bool $isValid, $messages)
+    public function testValidate(array $validationSubject, bool $isValid, $messages, array $errorCodes)
     {
         $result = new Result($isValid, $messages);
 
         $this->resultInterfaceFactory->method('create')
             ->with([
                 'isValid' => $isValid,
-                'failsDescription' => $messages
+                'failsDescription' => $messages,
+                'errorCodes' => $errorCodes
             ])
             ->willReturn($result);
 
@@ -104,7 +106,8 @@ public function dataProviderTestValidate()
                     ],
                 ],
                 'isValid' => true,
-                []
+                [],
+                'errorCodes' => []
             ],
             [
                 'validationSubject' => [
@@ -115,7 +118,8 @@ public function dataProviderTestValidate()
                 'isValid' => false,
                 [
                     __('Transaction was failed.')
-                ]
+                ],
+                'errorCodes' => []
             ],
             [
                 'validationSubject' => [
@@ -125,9 +129,9 @@ public function dataProviderTestValidate()
                 ],
                 'isValid' => false,
                 [
-                    __('Braintree error response.'),
-                    81804
-                ]
+                    __('Braintree error response.')
+                ],
+                'errorCodes' => ['81804']
             ]
         ];
     }

app/code/Magento/Braintree/Test/Unit/Gateway/Validator/PaymentNonceResponseValidatorTest.php

@@ -6,7 +6,7 @@
 namespace Magento\Braintree\Test\Unit\Gateway\Validator;
 
 use Magento\Braintree\Gateway\SubjectReader;
-use Magento\Braintree\Gateway\Validator\ErrorCodeValidator;
+use Magento\Braintree\Gateway\Validator\ErrorCodeProvider;
 use Magento\Braintree\Gateway\Validator\PaymentNonceResponseValidator;
 use Magento\Payment\Gateway\Validator\Result;
 use Magento\Payment\Gateway\Validator\ResultInterfaceFactory;
@@ -34,7 +34,7 @@ protected function setUp()
         $this->validator = new PaymentNonceResponseValidator(
             $this->resultInterfaceFactory,
             new SubjectReader(),
-            new ErrorCodeValidator()
+            new ErrorCodeProvider()
         );
     }
 

app/code/Magento/Braintree/Test/Unit/Gateway/Validator/ResponseValidatorTest.php

@@ -8,7 +8,7 @@
 use Braintree\Result\Successful;
 use Braintree\Transaction;
 use Magento\Braintree\Gateway\SubjectReader;
-use Magento\Braintree\Gateway\Validator\ErrorCodeValidator;
+use Magento\Braintree\Gateway\Validator\ErrorCodeProvider;
 use Magento\Braintree\Gateway\Validator\ResponseValidator;
 use Magento\Framework\Phrase;
 use Magento\Payment\Gateway\Validator\Result;
@@ -46,7 +46,7 @@ protected function setUp()
         $this->responseValidator = new ResponseValidator(
             $this->resultInterfaceFactory,
             new SubjectReader(),
-            new ErrorCodeValidator()
+            new ErrorCodeProvider()
         );
     }
 

app/code/Magento/Payment/Gateway/Command/GatewayCommand.php

@@ -7,7 +7,9 @@
 
 use Magento\Payment\Gateway\CommandInterface;
 use Magento\Payment\Gateway\ErrorMapper\ErrorMessageMapperInterface;
+use Magento\Payment\Gateway\Http\ClientException;
 use Magento\Payment\Gateway\Http\ClientInterface;
+use Magento\Payment\Gateway\Http\ConverterException;
 use Magento\Payment\Gateway\Http\TransferFactoryInterface;
 use Magento\Payment\Gateway\Request\BuilderInterface;
 use Magento\Payment\Gateway\Response\HandlerInterface;
@@ -91,6 +93,8 @@ public function __construct(
      * @param array $commandSubject
      * @return void
      * @throws CommandException
+     * @throws ClientException
+     * @throws ConverterException
      */
     public function execute(array $commandSubject)
     {
@@ -127,18 +131,19 @@ public function execute(array $commandSubject)
     private function processErrors(ResultInterface $result)
     {
         $messages = [];
-        foreach ($result->getFailsDescription() as $failPhrase) {
-            $message = (string) $failPhrase;
+        $errorsSource = array_merge($result->getErrorCodes(), $result->getFailsDescription());
+        foreach ($errorsSource as $errorCodeOrMessage) {
+            $errorCodeOrMessage = (string) $errorCodeOrMessage;
 
             // error messages mapper can be not configured if payment method doesn't have custom error messages.
             if ($this->errorMessageMapper !== null) {
-                $mapped = (string) $this->errorMessageMapper->getMessage($message);
+                $mapped = (string) $this->errorMessageMapper->getMessage($errorCodeOrMessage);
                 if (!empty($mapped)) {
                     $messages[] = $mapped;
-                    $message = $mapped;
+                    $errorCodeOrMessage = $mapped;
                 }
             }
-            $this->logger->critical('Payment Error: ' . $message);
+            $this->logger->critical('Payment Error: ' . $errorCodeOrMessage);
         }
 
         throw new CommandException(

app/code/Magento/Payment/Gateway/ErrorMapper/ErrorMessageMapper.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Payment\Gateway\ErrorMapper;
 
 use Magento\Framework\Config\DataInterface;
@@ -13,6 +15,8 @@
  * For example, during authorization payment operation the payment integration can validate error messages
  * related to credit card details and customer address data.
  * In that case, this implementation can be extended via di.xml and configured with appropriate mappers.
+ *
+ * @api
  */
 class ErrorMessageMapper implements ErrorMessageMapperInterface
 {

app/code/Magento/Payment/Gateway/ErrorMapper/ErrorMessageMapperInterface.php

@@ -3,12 +3,16 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Payment\Gateway\ErrorMapper;
 
 use Magento\Framework\Phrase;
 
 /**
  * Interface to provide customization for payment validation errors.
+ *
+ * @api
  */
 interface ErrorMessageMapperInterface
 {

app/code/Magento/Payment/Gateway/ErrorMapper/MappingData.php

@@ -3,6 +3,8 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Payment\Gateway\ErrorMapper;
 
 use Magento\Framework\Config\Data\Scoped;