magento · naydav · Aug 14, 2020 · Jul 23, 2020 · Aug 7, 2020 · Aug 7, 2020
diff --git a/ReCaptchaAdminUi/Model/ErrorMessageConfig.php b/ReCaptchaAdminUi/Model/ErrorMessageConfig.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReCaptchaAdminUi\Model;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\ReCaptchaUi\Model\ErrorMessageConfigInterface;
+use Magento\Store\Model\ScopeInterface;
+
+/**
+ * @inheritdoc
+ */
+class ErrorMessageConfig implements ErrorMessageConfigInterface
+{
+    private const XML_PATH_VALIDATION = 'recaptcha_backend/failure_messages/validation_failure_message';
+    private const XML_PATH_TECHNICAL = 'recaptcha_backend/failure_messages/technical_failure_message';
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(
+        ScopeConfigInterface $scopeConfig
+    ) {
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getTechnicalFailureMessage(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::XML_PATH_TECHNICAL,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getValidationFailureMessage(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::XML_PATH_VALIDATION,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+}
diff --git a/ReCaptchaAdminUi/composer.json b/ReCaptchaAdminUi/composer.json
@@ -5,7 +5,8 @@
         "php": "~7.3.0||~7.4.0",
         "magento/framework": "*",
         "magento/module-config": "*",
-        "magento/module-re-captcha-ui": "*"
+        "magento/module-re-captcha-ui": "*",
+        "magento/module-store": "*"
     },
     "type": "magento2-module",
     "license": "OSL-3.0",

diff --git a/ReCaptchaAdminUi/etc/adminhtml/di.xml b/ReCaptchaAdminUi/etc/adminhtml/di.xml
@@ -9,4 +9,6 @@
         xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
     <preference for="Magento\ReCaptchaUi\Model\CaptchaTypeResolverInterface"
                 type="Magento\ReCaptchaAdminUi\Model\CaptchaTypeResolver"/>
+    <preference for="Magento\ReCaptchaUi\Model\ErrorMessageConfigInterface"
+                type="Magento\ReCaptchaAdminUi\Model\ErrorMessageConfig"/>
 </config>
diff --git a/ReCaptchaAdminUi/etc/adminhtml/system.xml b/ReCaptchaAdminUi/etc/adminhtml/system.xml
@@ -27,6 +27,21 @@
                     <frontend_model>Magento\ReCaptchaAdminUi\Block\Adminhtml\System\Config\Form\Field\Notice</frontend_model>
                 </field>
             </group>
+
+            <group id="failure_messages" translate="label" type="text" sortOrder="950" showInDefault="1" showInWebsite="1"
+                   showInStore="1">
+                <label>reCAPTCHA Failure Messages</label>
+
+                <field id="validation_failure_message" translate="label" type="textarea" sortOrder="10" showInDefault="1"
+                       showInWebsite="0" showInStore="0" canRestore="1">
+                    <label>reCAPTCHA Validation Failure Message</label>
+                </field>
+
+                <field id="technical_failure_message" translate="label" type="textarea" sortOrder="20" showInDefault="1"
+                       showInWebsite="0" showInStore="0" canRestore="1">
+                    <label>reCAPTCHA Technical Failure Message</label>
+                </field>
+            </group>
         </section>
 
         <section id="recaptcha_frontend" translate="label" type="text" sortOrder="700" showInDefault="1"

diff --git a/ReCaptchaAdminUi/etc/config.xml b/ReCaptchaAdminUi/etc/config.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<!--
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+ -->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Store:etc/config.xsd">
+    <default>
+        <recaptcha_backend>
+            <failure_messages>
+                <validation_failure_message>reCAPTCHA verification failed.</validation_failure_message>
+                <technical_failure_message>Something went wrong with reCAPTCHA. Please contact the store owner.</technical_failure_message>
+            </failure_messages>
+        </recaptcha_backend>
+    </default>
+</config>
diff --git a/ReCaptchaContact/Test/Integration/ContactFormTest.php b/ReCaptchaContact/Test/Integration/ContactFormTest.php
@@ -210,7 +210,7 @@ private function checkFailedPostResponse(array $postValues = []): void
         $this->makePostRequest($postValues);
 
         $this->assertSessionMessages(
-            $this->equalTo(['reCAPTCHA verification failed']),
+            $this->equalTo(['Something went wrong with reCAPTCHA. Please contact the store owner.']),
             MessageInterface::TYPE_ERROR
         );
     }

diff --git a/ReCaptchaCustomer/Model/AjaxLogin/ErrorProcessor.php b/ReCaptchaCustomer/Model/AjaxLogin/ErrorProcessor.php
@@ -9,8 +9,12 @@
 
 use Magento\Framework\App\Action\Action;
 use Magento\Framework\App\ActionFlag;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Serialize\SerializerInterface;
+use Magento\ReCaptchaUi\Model\ErrorMessageConfigInterface;
+use Magento\ReCaptchaValidationApi\Model\ValidationErrorMessagesProvider;
+use Psr\Log\LoggerInterface;
 
 /**
  * Process error during ajax login
@@ -29,27 +33,73 @@ class ErrorProcessor
      */
     private $serializer;
 
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var ErrorMessageConfigInterface
+     */
+    private $errorMessageConfig;
+
+    /**
+     * @var ValidationErrorMessagesProvider
+     */
+    private $validationErrorMessagesProvider;
+
     /**
      * @param ActionFlag $actionFlag
      * @param SerializerInterface $serializer
+     * @param LoggerInterface|null $logger
+     * @param ErrorMessageConfigInterface|null $errorMessageConfig
+     * @param ValidationErrorMessagesProvider|null $validationErrorMessagesProvider
      */
     public function __construct(
         ActionFlag $actionFlag,
-        SerializerInterface $serializer
+        SerializerInterface $serializer,
+        ?LoggerInterface $logger = null,
+        ?ErrorMessageConfigInterface $errorMessageConfig = null,
+        ?ValidationErrorMessagesProvider $validationErrorMessagesProvider = null
     ) {
         $this->actionFlag = $actionFlag;
         $this->serializer = $serializer;
+        $this->logger = $logger
+            ?? ObjectManager::getInstance()->get(LoggerInterface::class);
+        $this->errorMessageConfig = $errorMessageConfig
+            ?? ObjectManager::getInstance()->get(ErrorMessageConfigInterface::class);
+        $this->validationErrorMessagesProvider = $validationErrorMessagesProvider
+            ?? ObjectManager::getInstance()->get(ValidationErrorMessagesProvider::class);
     }
 
     /**
      * Set "no dispatch" flag and error message to Response
      *
      * @param ResponseInterface $response
-     * @param string $message
+     * @param array $errorMessages
+     * @param string $sourceKey
      * @return void
      */
-    public function processError(ResponseInterface $response, string $message): void
+    public 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([
@@ -58,4 +108,15 @@ public function processError(ResponseInterface $response, string $message): void
         ]);
         $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);
+    }
 }
diff --git a/ReCaptchaCustomer/Observer/AjaxLoginObserver.php b/ReCaptchaCustomer/Observer/AjaxLoginObserver.php
@@ -20,7 +20,7 @@
 use Psr\Log\LoggerInterface;
 
 /**
- * AjaxLoginObserver
+ * Observer of ajax login.
  */
 class AjaxLoginObserver implements ObserverInterface
 {
@@ -79,8 +79,8 @@ public function __construct(
     }
 
     /**
-     * @param Observer $observer
-     * @return void
+     * @inheritdoc
+     *
      * @throws LocalizedException
      */
     public function execute(Observer $observer): void
@@ -100,7 +100,8 @@ public function execute(Observer $observer): void
                 $this->logger->error($e);
                 $this->errorProcessor->processError(
                     $response,
-                    $validationConfig->getValidationFailureMessage()
+                    [],
+                    $key
                 );
                 return;
             }
@@ -109,7 +110,8 @@ public function execute(Observer $observer): void
             if (false === $validationResult->isValid()) {
                 $this->errorProcessor->processError(
                     $response,
-                    $validationConfig->getValidationFailureMessage()
+                    $validationResult->getErrors(),
+                    $key
                 );
             }
         }

diff --git a/ReCaptchaCustomer/Test/Integration/AjaxLoginFormTest.php b/ReCaptchaCustomer/Test/Integration/AjaxLoginFormTest.php
@@ -218,7 +218,12 @@ private function checkFailedPostResponse(array $postValues = []): void
     {
         $this->makePostRequest($postValues);
 
-        $expected = json_encode(['errors' => true, 'message' => 'reCAPTCHA verification failed']);
+        $expected = json_encode(
+            [
+                'errors' => true,
+                'message' => 'Something went wrong with reCAPTCHA. Please contact the store owner.'
+            ]
+        );
 
         $this->assertEquals(
             $expected,

diff --git a/ReCaptchaCustomer/Test/Integration/CreateCustomerFormTest.php b/ReCaptchaCustomer/Test/Integration/CreateCustomerFormTest.php
@@ -238,7 +238,7 @@ private function checkFailedPostResponse(array $postValues = []): void
             // Customer should not be created
         }
         $this->assertSessionMessages(
-            self::equalTo(['reCAPTCHA verification failed']),
+            self::equalTo(['Something went wrong with reCAPTCHA. Please contact the store owner.']),
             MessageInterface::TYPE_ERROR
         );
     }

diff --git a/ReCaptchaCustomer/Test/Integration/EditFromTest.php b/ReCaptchaCustomer/Test/Integration/EditFromTest.php
@@ -236,7 +236,7 @@ private function checkFailedPostResponse(array $postValues = []): void
 
         $this->assertRedirect(self::stringStartsWith($this->url->getRouteUrl('customer/account/edit')));
         $this->assertSessionMessages(
-            self::equalTo(['reCAPTCHA verification failed']),
+            self::equalTo(['Something went wrong with reCAPTCHA. Please contact the store owner.']),
             MessageInterface::TYPE_ERROR
         );
 

diff --git a/ReCaptchaCustomer/Test/Integration/ForgotPasswordFormTest.php b/ReCaptchaCustomer/Test/Integration/ForgotPasswordFormTest.php
@@ -227,7 +227,7 @@ private function checkFailedPostResponse(array $postValues = []): void
 
         $this->assertRedirect(self::equalTo($this->url->getRouteUrl('customer/account/forgotpassword')));
         $this->assertSessionMessages(
-            self::equalTo(['reCAPTCHA verification failed']),
+            self::equalTo(['Something went wrong with reCAPTCHA. Please contact the store owner.']),
             MessageInterface::TYPE_ERROR
         );
 

diff --git a/ReCaptchaCustomer/Test/Integration/LoginFromTest.php b/ReCaptchaCustomer/Test/Integration/LoginFromTest.php
@@ -227,7 +227,7 @@ private function checkFailedPostResponse(array $postValues = []): void
 
         $this->assertRedirect(self::stringStartsWith($this->url->getRouteUrl('customer/account/login')));
         $this->assertSessionMessages(
-            self::equalTo(['reCAPTCHA verification failed']),
+            self::equalTo(['Something went wrong with reCAPTCHA. Please contact the store owner.']),
             MessageInterface::TYPE_ERROR
         );
 

diff --git a/ReCaptchaFrontendUi/Model/ErrorMessageConfig.php b/ReCaptchaFrontendUi/Model/ErrorMessageConfig.php
@@ -0,0 +1,57 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\ReCaptchaFrontendUi\Model;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\ReCaptchaUi\Model\ErrorMessageConfigInterface;
+use Magento\Store\Model\ScopeInterface;
+
+/**
+ * @inheritdoc
+ */
+class ErrorMessageConfig implements ErrorMessageConfigInterface
+{
+    private const XML_PATH_VALIDATION = 'recaptcha_frontend/failure_messages/validation_failure_message';
+    private const XML_PATH_TECHNICAL = 'recaptcha_frontend/failure_messages/technical_failure_message';
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(
+        ScopeConfigInterface $scopeConfig
+    ) {
+        $this->scopeConfig = $scopeConfig;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getTechnicalFailureMessage(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::XML_PATH_TECHNICAL,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getValidationFailureMessage(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::XML_PATH_VALIDATION,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+}