When failing to find products by SKU, Meta will try to find Products by Retailer ID (#550)

* When failing to find products by SKU, Meta will try to find Products by Retailer ID

* Adding helpful comment

* Class instance also updates when identifier is incorrect

Author: sol-loup

app/code/Meta/BusinessExtension/Model/System/Config.php

@@ -30,6 +30,7 @@
 use Magento\Store\Model\ScopeInterface;
 use Magento\Store\Model\StoreManagerInterface;
 use Meta\BusinessExtension\Model\ResourceModel\FacebookInstalledFeature;
+use Meta\Catalog\Model\Config\Source\Product\Identifier as IdentifierConfig;
 
 /**
  * @SuppressWarnings(PHPMD.ExcessivePublicCount)
@@ -182,7 +183,8 @@ public function __construct(
         CacheInterface           $cache,
         ComposerInformation      $composerInformation,
         FacebookInstalledFeature $fbeInstalledFeatureResource
-    ) {
+    )
+    {
         $this->storeManager = $storeManager;
         $this->scopeConfig = $scopeConfig;
         $this->resourceConfig = $resourceConfig;
@@ -906,6 +908,20 @@ public function getProductIdentifierAttr($scopeId = null, $scope = null)
         return $this->getConfig(self::XML_PATH_FACEBOOK_PRODUCT_IDENTIFIER, $scopeId, $scope);
     }
 
+    /**
+     * Set product identifier attr
+     *
+     * @param string $attr
+     * @return void
+     */
+    public function setProductIdentifierAttr(string $attr)
+    {
+        if ($attr !== IdentifierConfig::PRODUCT_IDENTIFIER_ID && $attr !== IdentifierConfig::PRODUCT_IDENTIFIER_SKU) {
+            throw new \InvalidArgumentException('Invalid product identifier attribute');
+        }
+        $this->saveConfig(self::XML_PATH_FACEBOOK_PRODUCT_IDENTIFIER, $attr);
+    }
+
     /**
      * Is all categories sync enabled or not
      *

app/code/Meta/Catalog/Helper/Product/Identifier.php

@@ -32,20 +32,26 @@ class Identifier
     /**
      * @var ProductRepository
      */
-    private $productRepository;
+    private ProductRepository $productRepository;
 
     /**
      * @var string
      */
     private $identifierAttr;
 
+    /**
+     * @var SystemConfig
+     */
+    private $systemConfig;
+
     /**
      * @param SystemConfig $systemConfig
      * @param ProductRepository $productRepository
      */
     public function __construct(SystemConfig $systemConfig, ProductRepository $productRepository)
     {
         $this->identifierAttr = $systemConfig->getProductIdentifierAttr();
+        $this->systemConfig = $systemConfig;
         $this->productRepository = $productRepository;
     }
 
@@ -128,20 +134,56 @@ public function getProductIDOtherThanRetailerId(ProductInterface $product)
      * @throws LocalizedException
      */
     public function getProductByFacebookRetailerId($retailerId)
+    {
+        // Sometimes (without realizing), seller catalogs will be set up so that the Retailer ID they pass to Meta is
+        // the entity ID of their magento product, not the SKU. There are legitimate reasons for sellers to do this,
+        // but if they don't update their extension settings, calls to fetch magento products will fail.
+        // This logic catches the product load failure, and makes an attempt to load by the inverted identifier instead
+        // (Sku -> Entity Id, Entity Id -> Sku). If the config was misset, it will gracefully flip to the correct value.
+        $product = $this->fetchProduct($retailerId, $this->identifierAttr);
+
+        if (!$product) {
+            // Switch identifier attribute
+            $newIdentifierAttr = $this->identifierAttr === IdentifierConfig::PRODUCT_IDENTIFIER_SKU
+                ? IdentifierConfig::PRODUCT_IDENTIFIER_ID
+                : IdentifierConfig::PRODUCT_IDENTIFIER_SKU;
+
+            $product = $this->fetchProduct($retailerId, $newIdentifierAttr);
+
+            if ($product) {
+                $this->systemConfig->setProductIdentifierAttr($newIdentifierAttr);
+                $this->identifierAttr = $newIdentifierAttr;
+            } else {
+                throw new LocalizedException(__(sprintf(
+                    'Product with %s %s does not exist in Magento catalog',
+                    strtoupper($this->identifierAttr),
+                    $retailerId
+                )));
+            }
+        }
+
+        return $product;
+    }
+
+    /**
+     * Fetch product by retailer id and identifier attribute
+     *
+     * @param string|int $retailerId
+     * @param string $identifierAttr
+     * @return ProductInterface|bool
+     */
+    private function fetchProduct($retailerId, string $identifierAttr)
     {
         try {
-            if ($this->identifierAttr === IdentifierConfig::PRODUCT_IDENTIFIER_SKU) {
+            if ($identifierAttr === IdentifierConfig::PRODUCT_IDENTIFIER_SKU) {
                 return $this->productRepository->get($retailerId);
-            } elseif ($this->identifierAttr === IdentifierConfig::PRODUCT_IDENTIFIER_ID) {
+            } elseif ($identifierAttr === IdentifierConfig::PRODUCT_IDENTIFIER_ID) {
                 return $this->productRepository->getById($retailerId);
             }
-            throw new LocalizedException(__('Invalid FB product identifier configuration'));
         } catch (NoSuchEntityException $e) {
-            throw new LocalizedException(__(sprintf(
-                'Product with %s %s does not exist in Magento catalog',
-                strtoupper($this->identifierAttr),
-                $retailerId
-            )));
+            // Product not found
+            return false;
         }
+        return false;
     }
 }