Merge branch 'main' of github.com:magento-commerce/facebook-for-magento2 into 1.0.0-release

Author: omiroshnichenko

README.md

@@ -1,5 +1,5 @@
 
-# Meta Business Extension For Magento2
+# Meta Business Extension For Magento2 
 
 ## Facebook Connects Businesses with People
 

app/code/Meta/BusinessExtension/Block/Adminhtml/Setup.php

@@ -119,11 +119,16 @@ public function fetchPixelId($storeId)
      *
      * @param int $storeId
      * @return string|null
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
      */
     public function getExternalBusinessId($storeId)
     {
-        return $this->fbeHelper->getFBEExternalBusinessId($storeId);
+        $storedExternalId = $this->systemConfig->getExternalBusinessId($storeId);
+        if ($storedExternalId) {
+            return $storedExternalId;
+        }
+        $storeId = $this->fbeHelper->getStore()->getId();
+        $this->fbeHelper->log("Store id---" . $storeId);
+        return uniqid('fbe_magento_' . $storeId . '_');
     }
 
     /**
@@ -147,6 +152,8 @@ public function getCleanCacheAjaxRoute()
     }
 
     /**
+     * Get Delete Asset IDs Ajax Route
+     *
      * @return mixed
      */
     public function getDeleteAssetIdsAjaxRoute()

app/code/Meta/BusinessExtension/Block/Adminhtml/System/Config/ModuleInfo.php

@@ -67,6 +67,7 @@ public function render(AbstractElement $element)
      *
      * @param  AbstractElement $element
      * @return string
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     protected function _getElementHtml(AbstractElement $element)
     {
@@ -84,6 +85,8 @@ public function getModuleVersion()
     }
 
     /**
+     * Retrieve Store Id
+     *
      * @return mixed
      */
     private function getStoreId()
@@ -92,6 +95,8 @@ private function getStoreId()
     }
 
     /**
+     * Retrieve Commerce Account Id
+     *
      * @return string
      */
     public function getCommerceAccountId()
@@ -100,6 +105,8 @@ public function getCommerceAccountId()
     }
 
     /**
+     * Retrieve Page Id
+     *
      * @return string
      */
     public function getPageId()
@@ -108,6 +115,8 @@ public function getPageId()
     }
 
     /**
+     * Retrieve Catalog Id
+     *
      * @return string
      */
     public function getCatalogId()
@@ -116,6 +125,8 @@ public function getCatalogId()
     }
 
     /**
+     * Retrieve Commerce Manager Url
+     *
      * @return string
      */
     public function getCommerceManagerUrl()
@@ -124,6 +135,8 @@ public function getCommerceManagerUrl()
     }
 
     /**
+     * Retrieve Catalog Manager Url
+     *
      * @return string
      */
     public function getCatalogManagerUrl()
@@ -132,6 +145,8 @@ public function getCatalogManagerUrl()
     }
 
     /**
+     * Retrieve Support Url
+     *
      * @return string
      */
     public function getSupportUrl()

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/AbstractAjax.php

@@ -23,8 +23,10 @@
 use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\JsonFactory;
 use Magento\Security\Model\AdminSessionsManager;
+use Magento\Framework\Exception\LocalizedException;
+use Magento\Framework\App\Action\HttpPostActionInterface;
 
-abstract class AbstractAjax extends Action
+abstract class AbstractAjax extends Action implements HttpPostActionInterface
 {
     /**
      * @var JsonFactory
@@ -37,6 +39,8 @@ abstract class AbstractAjax extends Action
     private $fbeHelper;
 
     /**
+     * Construct
+     *
      * @param Context $context
      * @param JsonFactory $resultJsonFactory
      * @param FBEHelper $fbeHelper
@@ -51,9 +55,16 @@ public function __construct(
         $this->fbeHelper = $fbeHelper;
     }
 
+    /**
+     * Execute for json
+     *
+     * @return array
+     */
     abstract public function executeForJson();
 
     /**
+     * Execute function
+     *
      * @throws Exception
      */
     public function execute()
@@ -64,16 +75,16 @@ public function execute()
             ->createObject(AdminSessionsManager::class)
             ->getCurrentSession();
         if (!$adminSession && $adminSession->getStatus() != 1) {
-            throw new Exception('Oops, this endpoint is for logged in admin and ajax only!');
+            throw new LocalizedException(__('Oops, this endpoint is for logged in admin and ajax only!'));
         } else {
             try {
                 $json = $this->executeForJson();
                 return $result->setData($json);
             } catch (Exception $e) {
                 $this->fbeHelper->logCritical($e->getMessage());
-                throw new Exception(
-                    'Oops, there was error while processing your request.' .
-                    ' Please contact admin for more details.'
+                throw new LocalizedException(
+                    __('Oops, there was error while processing your request.' .
+                    ' Please contact admin for more details.')
                 );
             }
         }

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/CleanCache.php

@@ -53,6 +53,9 @@ public function __construct(
         $this->systemConfig = $systemConfig;
     }
 
+    /**
+     * @inheritDoc
+     */
     public function executeForJson()
     {
         try {

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/Fbaamsettings.php

@@ -21,9 +21,6 @@
 use Magento\Framework\Controller\Result\JsonFactory;
 use Meta\BusinessExtension\Helper\FBEHelper;
 
-/**
- * @SuppressWarnings(PHPMD)
- */
 class Fbaamsettings extends AbstractAjax
 {
     /**

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/Fbdeleteasset.php

@@ -17,66 +17,163 @@
 
 namespace Meta\BusinessExtension\Controller\Adminhtml\Ajax;
 
-use Magento\Backend\App\Action\Context;
 use Magento\Framework\Controller\Result\JsonFactory;
+use Magento\Framework\Exception\LocalizedException;
 use Meta\BusinessExtension\Helper\FBEHelper;
+use Magento\Framework\App\Action\HttpDeleteActionInterface;
+use Magento\Framework\App\RequestInterface;
+use Magento\Security\Model\AdminSessionsManager;
+use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+use Magento\Framework\App\ResourceConnection;
 
-class Fbdeleteasset extends AbstractAjax
+class Fbdeleteasset implements HttpDeleteActionInterface
 {
-    public const DELETE_SUCCESS_MESSAGE = "You have successfully deleted Meta Business Extension.
-    The pixel installed on your website is now deleted.";
+    public const DELETE_SUCCESS_MESSAGE = "You have successfully deleted Meta Business Extension." .
+      " The pixel installed on your website is now deleted.";
 
     private const DELETE_FAILURE_MESSAGE = "There was a problem deleting the connection.
-      Please try again.";
+        Please try again.";
+
+    /**
+     * @var JsonFactory
+     */
+    private $resultJsonFactory;
 
     /**
      * @var FBEHelper
      */
     private $fbeHelper;
 
     /**
-     * Construct
-     *
-     * @param Context $context
+     * @var AdminSessionsManager
+     */
+    private $adminSessionManager;
+
+    /**
+     * @var ResourceConnection
+     */
+    private $resourceConnection;
+
+    /**
+     * @var SystemConfig
+     */
+    private $systemConfig;
+
+    /**
+     * @var RequestInterface
+     */
+    private RequestInterface $request;
+
+    /**
      * @param JsonFactory $resultJsonFactory
      * @param FBEHelper $fbeHelper
+     * @param AdminSessionsManager $adminSessionManager
+     * @param ResourceConnection $resourceConnection
+     * @param SystemConfig $systemConfig
+     * @param RequestInterface $request
      */
     public function __construct(
-        Context $context,
         JsonFactory $resultJsonFactory,
-        FBEHelper $fbeHelper
+        FBEHelper $fbeHelper,
+        AdminSessionsManager $adminSessionManager,
+        ResourceConnection $resourceConnection,
+        SystemConfig $systemConfig,
+        RequestInterface $request
     ) {
-        parent::__construct($context, $resultJsonFactory, $fbeHelper);
+        $this->resultJsonFactory = $resultJsonFactory;
         $this->fbeHelper = $fbeHelper;
+        $this->adminSessionManager = $adminSessionManager;
+        $this->resourceConnection = $resourceConnection;
+        $this->systemConfig = $systemConfig;
+        $this->request = $request;
+    }
+
+    /**
+     * Execute
+     *
+     * @throws LocalizedException
+     */
+    public function execute()
+    {
+        $result = $this->resultJsonFactory->create();
+        // TODO : Move all String objects to constants.
+        $adminSession = $this->adminSessionManager->getCurrentSession();
+        if (!$adminSession && $adminSession->getStatus() != 1) {
+            throw new LocalizedException('Oops, this endpoint is for logged in admin and ajax only!');
+        } else {
+            try {
+                $json = $this->executeForJson();
+                return $result->setData($json);
+            } catch (\Exception $e) {
+                $this->fbeHelper->logCritical($e->getMessage());
+                throw new LocalizedException(
+                    'Oops, there was error while processing your request.' .
+                    ' Please contact admin for more details.'
+                );
+            }
+        }
     }
 
     /**
      * Execute for json
      *
-     * @return array
+     * Run actual processing after request validation.
+     * Only public to allow for more direct unit testing.
+     *
+     * @inheritdoc
      */
     public function executeForJson()
     {
-        $storeId = $this->getRequest()->getParam('storeId');
+        $storeId = $this->request->getParam('storeId');
         if ($storeId === null) {
             return [
                 'success' => false,
-                'error_message' => __(self::DELETE_FAILURE_MESSAGE)
+                'error_message' => __('' . self::DELETE_FAILURE_MESSAGE)
             ];
         }
         try {
-            $this->fbeHelper->deleteConfigKeys($storeId);
+            $this->deleteConfigKeys($storeId);
             $response = [
                 'success' => true,
-                'message' => __(self::DELETE_SUCCESS_MESSAGE),
+                'message' => __('' . self::DELETE_SUCCESS_MESSAGE),
             ];
         } catch (\Exception $e) {
             $this->fbeHelper->log($e->getMessage());
             $response = [
                 'success' => false,
-                'error_message' => __(self::DELETE_FAILURE_MESSAGE),
+                'error_message' => __(
+                    "There was a problem deleting the connection. Please try again."
+                ),
             ];
         }
         return $response;
     }
+
+    /**
+     * Delete config keys
+     *
+     * @param string|int|null $storeId Store ID to delete from.
+     * @return array
+     */
+    private function deleteConfigKeys($storeId)
+    {
+        $this->systemConfig->deleteConfig(
+            SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_EXTERNAL_BUSINESS_ID,
+            $storeId
+        )
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_INSTALLED, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_ACCESS_TOKEN, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PAGE_ID, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PAGE_ACCESS_TOKEN, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_COMMERCE_ACCOUNT_ID, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PIXEL_ID, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PIXEL_AAM_SETTINGS, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_PROFILES, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_CATALOG_ID, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_FEED_ID, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_API_VERSION, $storeId)
+            ->deleteConfig(SystemConfig::XML_PATH_FACEBOOK_BUSINESS_EXTENSION_API_VERSION_LAST_UPDATE, $storeId);
+
+        return $this;
+    }
 }

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/Fbpixel.php

@@ -23,9 +23,6 @@
 use Magento\Store\Model\ScopeInterface;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 
-/**
- * @SuppressWarnings(PHPMD)
- */
 class Fbpixel extends AbstractAjax
 {
     /**

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/Fbprofiles.php

@@ -23,9 +23,6 @@
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Magento\Store\Model\ScopeInterface;
 
-/**
- * @SuppressWarnings(PHPMD)
- */
 class Fbprofiles extends AbstractAjax
 {
     /**

app/code/Meta/BusinessExtension/Controller/Adminhtml/Ajax/Fbtoken.php

@@ -23,9 +23,6 @@
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 use Magento\Store\Model\ScopeInterface;
 
-/**
- * @SuppressWarnings(PHPMD)
- */
 class Fbtoken extends AbstractAjax
 {
     /**