Adding Shop info into Splash page's path paramters (#813)

jczhuoMeta · web-flow · commit 045290d6e906 · 2024-11-11T08:59:08.000-08:00
* 1. Update the time zone with fetching the real timezone instead of hard coded
2. Get country code for the store and pass it into splash page

* fix format: countryCode-&gt;country_code

* Pipe in extension version and store URL

* 1. Formatting the file to address linter
2. Remove unused method

* 1. Formatting the file to address linter
2. Remove unused method

* 1. Fix test file

* Address code review comment

* Cleanup linter wrong cleanup
diff --git a/app/code/Meta/BusinessExtension/Block/Adminhtml/Setup.php b/app/code/Meta/BusinessExtension/Block/Adminhtml/Setup.php
@@ -24,19 +24,27 @@
 use Magento\Backend\Block\Template\Context;
 use Magento\Framework\App\RequestInterface;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\UrlInterface;
+use Magento\Store\Api\Data\StoreInterface;
 use Magento\Store\Api\StoreRepositoryInterface;
+use Magento\Store\Model\StoreManagerInterface;
 use Meta\BusinessExtension\Api\AdobeCloudConfigInterface;
 use Meta\BusinessExtension\Helper\CommerceExtensionHelper;
 use Meta\BusinessExtension\Helper\FBEHelper;
 use Meta\BusinessExtension\Model\Api\CustomApiKey\ApiKeyService;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Store\Model\ScopeInterface;
 
 /**
  * @api
  * @SuppressWarnings(PHPMD.ExcessiveParameterList)
  */
 class Setup extends Template
 {
+    public const COUNTRY_CONFIG_PATH = 'general/country/default';
+    public const TIMEZONE_CONFIG_PATH = 'general/locale/timezone';
+
     /**
      * @var ApiKeyService
      */
@@ -61,6 +69,11 @@ class Setup extends Template
      */
     public StoreRepositoryInterface $storeRepo;
 
+    /**
+     * @var StoreManagerInterface
+     */
+    private StoreManagerInterface $storeManager;
+
     /**
      * @var CommerceExtensionHelper
      */
@@ -71,15 +84,22 @@ class Setup extends Template
      */
     private AdobeCloudConfigInterface $adobeConfig;
 
+    /**
+     * @var ScopeConfigInterface
+     */
+    private ScopeConfigInterface $scopeConfig;
+
     /**
      * @param Context                   $context
      * @param RequestInterface          $request
      * @param FBEHelper                 $fbeHelper
      * @param SystemConfig              $systemConfig
      * @param StoreRepositoryInterface  $storeRepo
+     * @param StoreManagerInterface     $storeManager
      * @param CommerceExtensionHelper   $commerceExtensionHelper
      * @param ApiKeyService             $apiKeyService
      * @param AdobeCloudConfigInterface $adobeConfig
+     * @param ScopeConfigInterface      $scopeConfig
      * @param array                     $data
      */
     public function __construct(
@@ -88,19 +108,23 @@ public function __construct(
         FBEHelper                 $fbeHelper,
         SystemConfig              $systemConfig,
         StoreRepositoryInterface  $storeRepo,
+        StoreManagerInterface     $storeManager,
         CommerceExtensionHelper   $commerceExtensionHelper,
         ApiKeyService             $apiKeyService,
         AdobeCloudConfigInterface $adobeConfig,
+        ScopeConfigInterface      $scopeConfig,
         array                     $data = []
     ) {
         $this->fbeHelper = $fbeHelper;
         parent::__construct($context, $data);
         $this->request = $request;
         $this->systemConfig = $systemConfig;
         $this->storeRepo = $storeRepo;
+        $this->storeManager = $storeManager;
         $this->commerceExtensionHelper = $commerceExtensionHelper;
         $this->apiKeyService = $apiKeyService;
         $this->adobeConfig = $adobeConfig;
+        $this->scopeConfig = $scopeConfig;
     }
 
     /**
@@ -121,7 +145,7 @@ public function getSelectedStoreId(): ?int
             try {
                 $this->storeRepo->getById($requestStoreId);
                 return $requestStoreId;
-            } catch (NoSuchEntityException $_ex) {
+            } catch (NoSuchEntityException) {
                 $this->fbeHelper->log("Store with requestStoreId $requestStoreId not found");
             }
         }
@@ -287,10 +311,9 @@ public function getDeleteAssetIdsAjaxRoute()
     /**
      * Get currency code
      *
-     * @return mixed
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return null|string
      */
-    public function getCurrencyCode()
+    public function getCurrencyCode(): ?string
     {
         return $this->fbeHelper->getStoreCurrencyCode();
     }
@@ -320,10 +343,10 @@ public function getCommerceExtensionIFrameURL($storeId)
     /**
      * Get a URL to use to render the CommerceExtension IFrame for an onboarded Store.
      *
-     * @param  int $storeId
-     * @return string
+     * @param int $storeId
+     * @return bool
      */
-    public function hasCommerceExtensionIFramePermissionError($storeId)
+    public function hasCommerceExtensionIFramePermissionError(int $storeId): bool
     {
         return $this->commerceExtensionHelper->hasCommerceExtensionPermissionError($storeId);
     }
@@ -341,7 +364,7 @@ public function getAppId()
     /**
      * Get stores that are selectable (not Admin).
      *
-     * @return \Magento\Store\Api\Data\StoreInterface[]
+     * @return StoreInterface[]
      * */
     public function getSelectableStores()
     {
@@ -462,4 +485,51 @@ public function getUpdateMBEConfigAjaxRoute()
     {
         return $this->fbeHelper->getUrl('fbeadmin/ajax/MBEUpdateInstalledConfig');
     }
+
+    /**
+     * Get Store's Timezone
+     *
+     * @return string
+     */
+    public function getStoreTimezone(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::TIMEZONE_CONFIG_PATH,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * Get Store's Country Code
+     *
+     * @return string
+     */
+    public function getStoreCountryCode(): string
+    {
+        return $this->scopeConfig->getValue(
+            self::COUNTRY_CONFIG_PATH,
+            ScopeInterface::SCOPE_STORE
+        );
+    }
+
+    /**
+     * Get Store's Base Url
+     *
+     * @return string
+     * @throws NoSuchEntityException
+     */
+    public function getStoreBaseUrl(): string
+    {
+        return $this->storeManager->getStore()->getBaseUrl(UrlInterface::URL_TYPE_WEB);
+    }
+
+    /**
+     * Get the extension version
+     *
+     * @return string
+     */
+    public function getExtensionVersion(): string
+    {
+        return $this->systemConfig->getModuleVersion();
+    }
 }
diff --git a/app/code/Meta/BusinessExtension/Test/Unit/Block/Adminhtml/SetupTest.php b/app/code/Meta/BusinessExtension/Test/Unit/Block/Adminhtml/SetupTest.php
@@ -3,8 +3,10 @@
 namespace Meta\BusinessExtension\Test\Unit\Block\Adminhtml;
 
 use Magento\Backend\Block\Template\Context;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\RequestInterface;
 use Magento\Store\Api\StoreRepositoryInterface;
+use Magento\Store\Model\StoreManagerInterface;
 use Meta\BusinessExtension\Api\AdobeCloudConfigInterface;
 use Meta\BusinessExtension\Block\Adminhtml\Setup;
 use Meta\BusinessExtension\Helper\CommerceExtensionHelper;
@@ -35,6 +37,10 @@ public function testGetApiKey()
             ->disableOriginalConstructor()
             ->getMock();
 
+        $storeManager = $this->getMockBuilder(StoreManagerInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $requestInterface = $this->getMockBuilder(RequestInterface::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -47,22 +53,28 @@ public function testGetApiKey()
             ->disableOriginalConstructor()
             ->getMock();
 
-        $apiKeyService->method('upsertApiKey')
-            ->willReturn($apiKey);
-
         $adobeCloudConfigInterface = $this->getMockBuilder(AdobeCloudConfigInterface::class)
             ->disableOriginalConstructor()
             ->getMock();
 
+        $scopeConfig = $this->getMockBuilder(ScopeConfigInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $apiKeyService->method('upsertApiKey')
+            ->willReturn($apiKey);
+
         $setup = new Setup(
             $context,
             $requestInterface,
             $fbeHelper,
             $systemConfig,
             $storeRepo,
+            $storeManager,
             $commerceExtensionHelper,
             $apiKeyService,
             $adobeCloudConfigInterface,
+            $scopeConfig,
             []
         );
 
diff --git a/app/code/Meta/BusinessExtension/view/adminhtml/templates/setup.phtml b/app/code/Meta/BusinessExtension/view/adminhtml/templates/setup.phtml
@@ -63,7 +63,10 @@
             setPixelId: '<?= $escaper->escapeHtml($block->getPixelAjaxRoute()) ?>',
             setProfilesData: '<?= $escaper->escapeHtml($block->getProfilesAjaxRoute()) ?>',
             storeId: '<?= $escaper->escapeHtml($block->getSelectedStoreId()) ?>',
-            timeZone: 'America/Los_Angeles'
+            timeZone: '<?= $escaper->escapeHtml($block->getStoreTimezone()) ?>',
+            countryCode: '<?= $escaper->escapeHtml($block->getStoreCountryCode()) ?>',
+            shopDomain: '<?= $escaper->escapeHtml($block->getStoreBaseUrl()) ?>',
+            extensionVersion: '<?= $escaper->escapeHtml($block->getExtensionVersion()) ?>',
         }
     </script>
     <?php if ($block->isCommerceExtensionEnabled() && $block->isFBEInstalled($block->getSelectedStoreId())): ?>
diff --git a/app/code/Meta/BusinessExtension/view/adminhtml/web/js/fbe_allinone.js b/app/code/Meta/BusinessExtension/view/adminhtml/web/js/fbe_allinone.js
@@ -34,7 +34,10 @@ const ajaxify = function (url) {
 const getAndEncodeExternalClientMetadata = function () {
     const metaData = {
         customer_token: window.facebookBusinessExtensionConfig.customApiKey,
-        commerce_partner_seller_platform_type: window.facebookBusinessExtensionConfig.commerce_partner_seller_platform_type
+        commerce_partner_seller_platform_type: window.facebookBusinessExtensionConfig.commerce_partner_seller_platform_type,
+        shop_domain: window.facebookBusinessExtensionConfig.shopDomain,
+        country_code: window.facebookBusinessExtensionConfig.countryCode,
+        client_version: window.facebookBusinessExtensionConfig.extensionVersion
     };
     return encodeURIComponent(JSON.stringify(metaData));
 }
diff --git a/app/code/Meta/BusinessExtension/view/adminhtml/web/js/lib/fbe.js b/app/code/Meta/BusinessExtension/view/adminhtml/web/js/lib/fbe.js
@@ -33,7 +33,10 @@ const ajaxify = function (url) {
 const getAndEncodeExternalClientMetadata = function () {
     const metaData = {
         customer_token: window.facebookBusinessExtensionConfig.customApiKey,
-        commerce_partner_seller_platform_type: window.facebookBusinessExtensionConfig.commerce_partner_seller_platform_type
+        commerce_partner_seller_platform_type: window.facebookBusinessExtensionConfig.commerce_partner_seller_platform_type,
+        shop_domain: window.facebookBusinessExtensionConfig.shopDomain,
+        country_code: window.facebookBusinessExtensionConfig.countryCode,
+        client_version: window.facebookBusinessExtensionConfig.extensionVersion
     };
     return encodeURIComponent(JSON.stringify(metaData));
 }
