MC-19282: Add Elasticsearch configuration parameters to web setup

Author: danielrenaud

setup/config/states.install.config.php

@@ -4,6 +4,7 @@
  * See COPYING.txt for license details.
  */
 
+//phpcs:ignore
 $base = basename($_SERVER['SCRIPT_FILENAME']);
 
 return [
@@ -101,6 +102,7 @@
             'header'      => 'Step 5: Configure Catalog Search',
             'controller'  => 'configureCatalogSearchController',
             'nav'         => true,
+            'validate'    => true,
             'order'       => 6,
             'type'        => 'install'
         ],

setup/pub/magento/setup/configure-catalog-search.js

@@ -76,5 +76,5 @@ angular.module('configure-catalog-search', ['ngStorage', 'ngSanitize'])
                         'An unknown error occurred. Please check configuration and try again.';
                     $scope.checking = false;
                 });
-        }
+        };
     }]);

setup/src/Magento/Setup/Model/RequestDataConverter.php

@@ -133,29 +133,46 @@ private function convertAdminUserForm(array $source)
     private function convertSearchConfigForm(array $source): array
     {
         $result = [];
+        if (!isset($source['search'])) {
+            return $result;
+        }
         $result[SearchConfigOptionsList::INPUT_KEY_SEARCH_ENGINE] =
-            isset($source['search']['engine']) ? $source['search']['engine'] : '';
+            $this->getValueFromArray($source['search'], 'engine', '');
 
         $esConfig = $source['search']['elasticsearch'];
         $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_HOST] =
-            isset($esConfig['hostname']) ? $esConfig['hostname'] : '';
+            $this->getValueFromArray($esConfig, 'hostname', '');
         $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_PORT] =
-            isset($esConfig['port']) ? $esConfig['port'] : '';
+            $this->getValueFromArray($esConfig, 'port', '');
         $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_INDEX_PREFIX] =
-            isset($esConfig['indexPrefix']) ? $esConfig['indexPrefix'] : '';
+            $this->getValueFromArray($esConfig, 'indexPrefix', '');
         $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_TIMEOUT] =
-            isset($esConfig['timeout']) ? $esConfig['timeout'] : '';
+            $this->getValueFromArray($esConfig, 'timeout', '');
+
         if (isset($esConfig['enableAuth']) && true === $esConfig['enableAuth']) {
             $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_ENABLE_AUTH] = $esConfig['enableAuth'];
             $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_USERNAME] =
-                isset($esConfig['username']) ? $esConfig['username'] : '';
+                $this->getValueFromArray($esConfig, 'username', '');
             $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_PASSWORD] =
-                isset($esConfig['password']) ? $esConfig['password'] : '';
+                $this->getValueFromArray($esConfig, 'password', '');
         } else {
             $result[SearchConfigOptionsList::INPUT_KEY_ELASTICSEARCH_ENABLE_AUTH] =
-                isset($esConfig['enableAuth']) ? $esConfig['enableAuth'] : false;
+                $this->getValueFromArray($esConfig, 'enableAuth', false);
         }
 
         return $result;
     }
+
+    /**
+     * Get value from array by key, or return default
+     *
+     * @param array $array
+     * @param string $key
+     * @param mixed $defaultValue
+     * @return mixed
+     */
+    private function getValueFromArray(array $array, string $key, $defaultValue = null)
+    {
+        return isset($array[$key]) ? $array[$key] : $defaultValue;
+    }
 }

setup/view/layout/layout.phtml

@@ -3,6 +3,9 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
+// @codingStandardsIgnoreFile
+
 ?>
 <?= $this->doctype() ?>
 <!--[if !IE]><!-->

setup/view/magento/setup/configure-catalog-search.phtml

@@ -83,10 +83,16 @@
                     tooltip-trigger="focus"
                     tooltip-append-to-body="true"
                     type="text"
+                    ng-class="{'invalid' : searchConfig.elasticsearchHost.$invalid && searchConfig.submitted}"
                     name="elasticsearchHost"
                     ng-model="search.config.elasticsearch.hostname"
                     required
                 >
+                <div class="error-container">
+                    <span ng-show="searchConfig.elasticsearchHost.$invalid">
+                        Hostname is required.
+                    </span>
+                </div>
             </div>
         </div>
         <div class="row form-row">
@@ -104,10 +110,17 @@
                     tooltip-trigger="focus"
                     tooltip-append-to-body="true"
                     type="text"
+                    ng-pattern="/^[0-9]+$/"
+                    ng-class="{'invalid' : searchConfig.elasticsearchPort.$invalid && searchConfig.submitted}"
                     name="elasticsearchPort"
                     ng-model="search.config.elasticsearch.port"
                     required
                 >
+                <div class="error-container">
+                    <span ng-show="searchConfig.elasticsearchPort.$invalid">
+                        Port is required and must be a numeric value.
+                    </span>
+                </div>
             </div>
         </div>
         <div class="row form-row">
@@ -187,7 +200,6 @@
                     type="text"
                     name="elasticsearchIndexPrefix"
                     ng-model="search.config.elasticsearch.indexPrefix"
-                    required
                 >
             </div>
         </div>
@@ -206,10 +218,17 @@
                     tooltip-trigger="focus"
                     tooltip-append-to-body="true"
                     type="text"
+                    ng-pattern="/^[0-9]+$/"
+                    ng-class="{'invalid' : searchConfig.elasticsearchTimeout.$invalid && searchConfig.submitted}"
                     name="elasticsearchTimeout"
                     ng-model="search.config.elasticsearch.timeout"
                     required
                 >
+                <div class="error-container">
+                    <span ng-show="searchConfig.elasticsearchTimeout.$invalid">
+                        Please enter a number greater than 0.
+                    </span>
+                </div>
             </div>
         </div>
         <div class="row form-row">