Merge pull request #1751 from algolia/fix/MAGE-1201-recommend-model-validation-3.15

MAGE-1201 Recommend model validation fix → 3.15

Author: damcou

Model/RecommendManagement.php

@@ -75,7 +75,7 @@ public function getTrendingItemsRecommendation(): array
      */
     public function getLookingSimilarRecommendation(string $productId): array
     {
-        return $this->getRecommendations($productId, 'bought-together');
+        return $this->getRecommendations($productId, 'looking-similar');
     }
 
     /**

Observer/RecommendSettings.php

@@ -9,16 +9,21 @@
 use Magento\Catalog\Model\Product\Visibility;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\Config\Storage\WriterInterface;
+use Magento\Framework\App\State;
 use Magento\Framework\Event\Observer;
 use Magento\Framework\Event\ObserverInterface;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\Message\ManagerInterface as MessageManagerInterface;
+use Psr\Log\LoggerInterface;
 
 class RecommendSettings implements ObserverInterface
 {
     const QUANTITY_AND_STOCK_STATUS = 'quantity_and_stock_status';
     const STATUS = 'status';
     const VISIBILITY = 'visibility';
 
+    const ENFORCE_VALIDATION = 0;
+
     /**
      * @var string
      */
@@ -36,7 +41,10 @@ public function __construct(
         protected readonly WriterInterface              $configWriter,
         protected readonly ProductRepositoryInterface   $productRepository,
         protected readonly RecommendManagementInterface $recommendManagement,
-        protected readonly SearchCriteriaBuilder        $searchCriteriaBuilder
+        protected readonly SearchCriteriaBuilder        $searchCriteriaBuilder,
+        protected readonly State                        $appState,
+        protected readonly MessageManagerInterface      $messageManager,
+        protected readonly LoggerInterface              $logger
     ){}
 
     /**
@@ -143,24 +151,122 @@ protected function validateRecommendation(string $changedPath, string $recommend
     {
         try {
             $recommendations = $this->recommendManagement->$recommendationMethod($this->getProductId());
-            if (empty($recommendations['renderingContent'])) {
-                throw new LocalizedException(__(
-                    "It appears that there is no trained model available for Algolia application ID %1.",
-                    $this->configHelper->getApplicationID()
-                ));
-            }
+
+            $this->validateRecommendApiResponse($recommendations, $modelName);
         } catch (\Exception $e) {
-            $this->configWriter->save($changedPath, 0);
-            throw new LocalizedException(__(
-                "Unable to save %1 Recommend configuration due to the following error: %2",
+            $this->handleRecommendApiException($e, $modelName, $changedPath);
+        }
+    }
+
+    /**
+     * If API does not return a hits response the model may not be configured correctly.
+     * Do not hard fail but alert the end user.
+     *
+     * @throws LocalizedException
+     */
+    protected function validateRecommendApiResponse(array $recommendResponse, string $modelName): void
+    {
+        if (!array_key_exists('hits', $recommendResponse)) {
+            $msg = __(
+                "It appears that there is no trained %1 model available for Algolia application ID %2. "
+                . "Please verify your configuration in the Algolia Dashboard before continuing.",
+                $modelName,
+                $this->configHelper->getApplicationID()
+            );
+
+            if ($this->shouldDisplayWarning()) {
+                $this->messageManager->addWarningMessage($msg);
+            }
+            else {
+                $this->logger->warning($msg);
+            }
+        }
+    }
+
+    /**
+     * Handles exceptions on the test request against the Recommend API
+     *
+     * The goal is to warn the user of potential issues so they do not enable a model on the front end that has not been
+     * properly configured in Algolia
+     *
+     * TODO: Implement store scoped validation
+     *
+     * @throws LocalizedException
+     */
+    protected function handleRecommendApiException(\Exception $e, string $modelName, string $changedPath): void
+    {
+        $msg = $this->getUserFriendlyRecommendApiErrorMessage($e);
+
+        if (self::ENFORCE_VALIDATION) {
+            $this->rollBack($changedPath, __(
+                    "Unable to save %1 Recommend configuration due to the following error: %2",
                     $modelName,
-                    $e->getMessage()
+                    $msg
                 )
             );
         }
+
+        $msg = __(
+            "Error encountered while enabling %1 recommendations: %2",
+            $modelName,
+            $msg
+        );
+
+        if ($this->shouldDisplayWarning()) {
+            $this->messageManager->addWarningMessage(
+                $msg
+                . ' Please verify your configuration in the Algolia Dashboard before continuing.');
+        }
+        else {
+            $this->logger->warning($msg);
+        }
+    }
+
+    /*
+     * For hard fail only
+     */
+    protected function rollBack(string $changedPath, \Magento\Framework\Phrase $message): void
+    {
+        $this->configWriter->save($changedPath, 0);
+        throw new LocalizedException($message);
+    }
+
+    /**
+     * Warnings should only be displayed within the admin panel
+     * @throws LocalizedException
+     */
+    protected function shouldDisplayWarning(): bool
+    {
+        return $this->appState->getAreaCode() === \Magento\Framework\App\Area::AREA_ADMINHTML
+            && php_sapi_name() !== 'cli';
+    }
+
+    /**
+     * If there is no model on the index then a 404 error should be returned
+     * (which will cause the exception on the API call) because there is no model for that index
+     * However errors which say "Index does not exist" are cryptic
+     * This function serves to make this clearer to the user while also filtering out the possible
+     * "ObjectID does not exist" error which can occur if the model does not contain the test product
+     */
+    protected function getUserFriendlyRecommendApiErrorMessage(\Exception $e): string
+    {
+        $msg = $e->getMessage();
+        if ($e->getCode() === 404) {
+            if (!!preg_match('/index.*does not exist/i', $msg)) {
+                $msg = (string) __("A trained model could not be found.");
+            }
+            if (!!preg_match('/objectid does not exist/i', $msg)) {
+                $msg = (string) __("Could not find test product in trained model.");
+            }
+        }
+        return $msg;
     }
 
     /**
+     * Retrieve a test product for requests against the Recommend API
+     *
+     * TODO: Implement store scoping and independently address 404 where objectID is not found
+     *
      * @return string - Product ID string for use in API calls
      * @throws LocalizedException
      */

etc/di.xml

@@ -206,4 +206,10 @@
             <argument name="logger" xsi:type="object">Algolia\AlgoliaSearch\Logger\AlgoliaLogger</argument>
         </arguments>
     </type>
+
+    <type name="\Algolia\AlgoliaSearch\Observer\RecommendSettings">
+        <arguments>
+            <argument name="logger" xsi:type="object">Algolia\AlgoliaSearch\Logger\AlgoliaLogger</argument>
+        </arguments>
+    </type>
 </config>