#222: Add validation for error message - PayPal fix.

Author: engcom-Foxtrot

ReCaptchaPaypal/Observer/PayPalObserver.php

@@ -9,16 +9,19 @@
 
 use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\ActionFlag;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\InputException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Serialize\SerializerInterface;
 use Magento\ReCaptchaUi\Model\CaptchaResponseResolverInterface;
+use Magento\ReCaptchaUi\Model\ErrorMessageConfigInterface;
 use Magento\ReCaptchaUi\Model\IsCaptchaEnabledInterface;
 use Magento\ReCaptchaUi\Model\ValidationConfigResolverInterface;
 use Magento\ReCaptchaValidationApi\Api\ValidatorInterface;
+use Magento\ReCaptchaValidationApi\Model\ValidationErrorMessagesProvider;
 use Psr\Log\LoggerInterface;
 
 /**
@@ -61,6 +64,16 @@ class PayPalObserver implements ObserverInterface
      */
     private $logger;
 
+    /**
+     * @var ErrorMessageConfigInterface
+     */
+    private $errorMessageConfig;
+
+    /**
+     * @var ValidationErrorMessagesProvider
+     */
+    private $validationErrorMessagesProvider;
+
     /**
      * @param CaptchaResponseResolverInterface $captchaResponseResolver
      * @param ValidationConfigResolverInterface $validationConfigResolver
@@ -69,6 +82,8 @@ class PayPalObserver implements ObserverInterface
      * @param SerializerInterface $serializer
      * @param IsCaptchaEnabledInterface $isCaptchaEnabled
      * @param LoggerInterface $logger
+     * @param ErrorMessageConfigInterface|null $errorMessageConfig
+     * @param ValidationErrorMessagesProvider|null $validationErrorMessagesProvider
      */
     public function __construct(
         CaptchaResponseResolverInterface $captchaResponseResolver,
@@ -77,7 +92,9 @@ public function __construct(
         ActionFlag $actionFlag,
         SerializerInterface $serializer,
         IsCaptchaEnabledInterface $isCaptchaEnabled,
-        LoggerInterface $logger
+        LoggerInterface $logger,
+        ?ErrorMessageConfigInterface $errorMessageConfig = null,
+        ?ValidationErrorMessagesProvider $validationErrorMessagesProvider = null
     ) {
         $this->captchaResponseResolver = $captchaResponseResolver;
         $this->validationConfigResolver = $validationConfigResolver;
@@ -86,6 +103,10 @@ public function __construct(
         $this->serializer = $serializer;
         $this->isCaptchaEnabled = $isCaptchaEnabled;
         $this->logger = $logger;
+        $this->errorMessageConfig = $errorMessageConfig
+            ?? ObjectManager::getInstance()->get(ErrorMessageConfigInterface::class);
+        $this->validationErrorMessagesProvider = $validationErrorMessagesProvider
+            ?? ObjectManager::getInstance()->get(ValidationErrorMessagesProvider::class);
     }
 
     /**
@@ -110,24 +131,53 @@ public function execute(Observer $observer): void
                 $reCaptchaResponse = $this->captchaResponseResolver->resolve($request);
             } catch (InputException $e) {
                 $this->logger->error($e);
-                $this->processError($response, $validationConfig->getValidationFailureMessage());
+                $this->processError(
+                    $response,
+                    [],
+                    $key
+                );
                 return;
             }
 
             $validationResult = $this->captchaValidator->isValid($reCaptchaResponse, $validationConfig);
             if (false === $validationResult->isValid()) {
-                $this->processError($response, $validationConfig->getValidationFailureMessage());
+                $this->processError(
+                    $response,
+                    $validationResult->getErrors(),
+                    $key
+                );
             }
         }
     }
 
     /**
+     * Process errors from reCAPTCHA response.
+     *
      * @param ResponseInterface $response
-     * @param string $message
+     * @param array $errorMessages
+     * @param string $sourceKey
      * @return void
      */
-    private function processError(ResponseInterface $response, string $message): void
+    private function processError(ResponseInterface $response, array $errorMessages, string $sourceKey): void
     {
+        $validationErrorText = $this->errorMessageConfig->getValidationFailureMessage();
+        $technicalErrorText = $this->errorMessageConfig->getTechnicalFailureMessage();
+
+        $message = $errorMessages ? $validationErrorText : $technicalErrorText;
+
+        foreach ($errorMessages as $errorMessageCode => $errorMessageText) {
+            if (!$this->isValidationError($errorMessageCode)) {
+                $message = $technicalErrorText;
+                $this->logger->error(
+                    __(
+                        'reCAPTCHA \'%1\' form error: %2',
+                        $sourceKey,
+                        $errorMessageText
+                    )
+                );
+            }
+        }
+
         $this->actionFlag->set('', Action::FLAG_NO_DISPATCH, true);
 
         $jsonPayload = $this->serializer->serialize([
@@ -137,4 +187,15 @@ private function processError(ResponseInterface $response, string $message): voi
         ]);
         $response->representJson($jsonPayload);
     }
+
+    /**
+     * Check if error code present in validation errors list.
+     *
+     * @param string $errorMessageCode
+     * @return bool
+     */
+    private function isValidationError(string $errorMessageCode): bool
+    {
+        return $errorMessageCode !== $this->validationErrorMessagesProvider->getErrorMessage($errorMessageCode);
+    }
 }