Merge pull request #184 from magento-obsessive-owls/cms-team-1-delivery

[Owls] Beta Release #3

Author: davemacaulay

app/code/Magento/PageBuilder/Block/GoogleMapsApi.php

@@ -7,7 +7,11 @@
 
 namespace Magento\PageBuilder\Block;
 
+use Magento\Framework\View\Element\Template;
+
 /**
+ * Google Maps API Block
+ *
  * @api
  */
 class GoogleMapsApi extends \Magento\Framework\View\Element\Template
@@ -16,16 +20,24 @@ class GoogleMapsApi extends \Magento\Framework\View\Element\Template
     const GOOGLE_MAPS_LIBRARY_URL = 'https://maps.googleapis.com/maps/api/js?v=3&key=%s';
     const GOOGLE_MAPS_STYLE_PATH = 'cms/pagebuilder/google_maps_style';
 
+    /**
+     * Retrieve the Google Maps API key
+     *
+     * @return string
+     */
+    public function getApiKey(): ?string
+    {
+        return $this->_scopeConfig->getValue(self::GOOGLE_MAPS_API_KEY_PATH);
+    }
+
     /**
      * Generate URL for retrieving Google Maps Javascript API
      *
      * @return string
      */
     public function getLibraryUrl(): string
     {
-        $apiKey = $this->_scopeConfig->getValue(self::GOOGLE_MAPS_API_KEY_PATH);
-        $libraryUrlWithKey = sprintf(self::GOOGLE_MAPS_LIBRARY_URL, $apiKey);
-        return $libraryUrlWithKey;
+        return sprintf(self::GOOGLE_MAPS_LIBRARY_URL, $this->getApiKey());
     }
 
     /**
@@ -37,4 +49,32 @@ public function getStyle(): ?string
     {
         return $this->_scopeConfig->getValue(self::GOOGLE_MAPS_STYLE_PATH);
     }
+
+    /**
+     * Return the translated message for an invalid API key.
+     *
+     * @return \Magento\Framework\Phrase
+     */
+    public function getInvalidApiKeyMessage(): \Magento\Framework\Phrase
+    {
+        return __(
+            "You must provide a valid <a href='%1'>Google Maps API key</a> to use a map.",
+            $this->_urlBuilder->getUrl('adminhtml/system_config/edit/section/cms', ['_fragment' => 'cms_pagebuilder'])
+        );
+    }
+
+    /**
+     * Include the Google Maps library within the admin only if the API key is set
+     *
+     * @return bool
+     */
+    public function shouldIncludeGoogleMapsLibrary(): bool
+    {
+        try {
+            return $this->_appState->getAreaCode() !== \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE ||
+                $this->getApiKey();
+        } catch (\Magento\Framework\Exception\LocalizedException $e) {
+            return false;
+        }
+    }
 }

app/code/Magento/PageBuilder/Component/GoogleMapsApiKeyValidationContainer.php

@@ -14,6 +14,8 @@
 use Magento\PageBuilder\Model\GoogleMaps\ApiKeyValidator;
 
 /**
+ * Google Maps API Key Validation Container for UI Component Form
+ *
  * @api
  */
 class GoogleMapsApiKeyValidationContainer extends \Magento\Ui\Component\Container
@@ -30,26 +32,19 @@ class GoogleMapsApiKeyValidationContainer extends \Magento\Ui\Component\Containe
      */
     private $scopeConfig;
 
-    /**
-     * @var ApiKeyValidator
-     */
-    private $apiKeyValidator;
-
     /**
      * Constructor
      *
      * @param ContextInterface $context
      * @param UrlInterface $url
      * @param ScopeConfigInterface $scopeConfig
-     * @param ApiKeyValidator $apiKeyValidator
      * @param array $components
      * @param array $data
      */
     public function __construct(
         ContextInterface $context,
         UrlInterface $url,
         ScopeConfigInterface $scopeConfig,
-        ApiKeyValidator $apiKeyValidator,
         array $components = [],
         array $data = []
     ) {
@@ -60,7 +55,6 @@ public function __construct(
         );
         $this->url = $url;
         $this->scopeConfig = $scopeConfig;
-        $this->apiKeyValidator = $apiKeyValidator;
     }
 
     /**
@@ -73,13 +67,15 @@ public function prepare()
         parent::prepare();
         $config = $this->getData('config');
         $apiKey = $this->scopeConfig->getValue(self::GOOGLE_MAPS_API_KEY_PATH) ?: "";
-        $response = $this->apiKeyValidator->validate($apiKey);
-        if (!$response['success']) {
+        if (trim($apiKey) == "") {
             $config['visible'] = true;
         }
 
         if (isset($config['map_configuration_url'])) {
-            $config['map_configuration_url'] = $this->url->getUrl($config['map_configuration_url']);
+            $config['map_configuration_url'] = $this->url->getUrl(
+                $config['map_configuration_url'],
+                ['_fragment' => 'cms_pagebuilder']
+            );
         }
         if (isset($config['content'])) {
             $config['content'] = sprintf($config['content'], $config['map_configuration_url']);

app/code/Magento/PageBuilder/Controller/Adminhtml/GoogleMaps/ValidateApi.php

@@ -9,7 +9,10 @@
 
 use Magento\Framework\Controller\ResultFactory;
 
-class ValidateApi extends \Magento\Backend\App\Action
+/**
+ * Class ValidateApi
+ */
+class ValidateApi extends \Magento\Backend\App\Action implements \Magento\Framework\App\Action\HttpPostActionInterface
 {
     const ADMIN_RESOURCE = 'Magento_Backend::content';
 
@@ -39,7 +42,7 @@ public function __construct(
      */
     public function execute()
     {
-        $apiKey = $this->getRequest()->getParam('key');
+        $apiKey = $this->getRequest()->getParam('googleMapsApiKey');
         $validationResult = $this->apiKeyValidator->validate($apiKey);
         return $this->resultFactory->create(ResultFactory::TYPE_JSON)->setData($validationResult);
     }

app/code/Magento/PageBuilder/Test/Mftf/ActionGroup/ContentTypeBlockActionGroup.xml

@@ -44,14 +44,11 @@
             <argument name="minHeight"/>
             <argument name="padding"/>
             <argument name="index" defaultValue="1" type="string"/>
-            <!-- Remove storefrontBugOffset when MC-5079 is resolved -->
-            <argument name="storefrontBugOffset" defaultValue="0" type="string"/>
         </arguments>
         <executeJS function="return document.querySelectorAll('{{block.baseCSS}} {{container.baseCSS}}')[{{index}}-1].clientHeight;" stepKey="containerHeight"/>
-        <executeJS function="return {$containerHeight}-{{storefrontBugOffset}}" stepKey="minusBugOffset"/>
         <assertGreaterThanOrEqual stepKey="assertContainerHeightGreaterThanOrEqualMinHeight">
             <expectedResult type="string">{{minHeight}}</expectedResult>
-            <actualResult type="variable">minusBugOffset</actualResult>
+            <actualResult type="variable">containerHeight</actualResult>
         </assertGreaterThanOrEqual>
         <executeJS function="return document.querySelectorAll('{{block.baseCSS}} {{container.baseCSS}}')[{{index}}-1].getBoundingClientRect().bottom-{{padding.paddingBottom}}" stepKey="containerBottomPositionMinusPadding"/>
         <executeJS function="return document.querySelectorAll('{{block.baseCSS}} {{content.baseCSS}}')[{{index}}-1].getBoundingClientRect().bottom" stepKey="contentBottomPosition"/>