Merge pull request #48 from magento-commerce/develop

MCLOUD-7868: Merge develop into 2002.1

Author: oshmyheliuk

.travis.yml

@@ -1,3 +1,4 @@
+# Critical errors
 !php/const Magento\MagentoCloud\App\Error::BUILD_ENV_PHP_IS_NOT_WRITABLE:
     title: 'Cannot write to the `./app/etc/env.php` file'
     suggestion: 'Deployment script cannot make required changes to the `/app/etc/env.php` file. Check your filesystem permissions.'
@@ -343,6 +344,12 @@
     suggestion: 'Check the SEARCH_CONFIGURATION variable for the `engine` option. If it is configured, remove the option, or set the value to "elasticsearch".'
     stage: deploy
     type: critical
+!php/const Magento\MagentoCloud\App\Error::DEPLOY_REMOVED_SPLIT_DB:
+    step: validate-config
+    title: 'Split Database was removed starting from Magento 2.5.0.'
+    suggestion: 'If you use split database you have to revert to or migrate to a single database or use an alternative approach.'
+    stage: deploy
+    type: critical
 !php/const Magento\MagentoCloud\App\Error::PD_DEPLOY_IS_FAILED:
     step: is-deploy-failed
     title: 'Deploy stage failed'
@@ -412,6 +419,7 @@
     suggestion: ''
     stage: general
     type: critical
+# Warning errors
 !php/const Magento\MagentoCloud\App\Error::WARN_CONFIG_PHP_NOT_EXISTS:
     title: 'File app/etc/config.php does not exist'
     stage: build
@@ -546,6 +554,12 @@
     stage: deploy
     step: validate-config
     type: warning
+!php/const Magento\MagentoCloud\App\Error::WARN_DEPRECATED_SPLIT_DB:
+    title: 'Split Database was deprecated in the Magento 2.4.2 and will be removed in 2.5.'
+    stage: deploy
+    suggestion: 'If you use split database you should start planning to revert to or migrate to a single database or use an alternative approach.'
+    step: validate-config
+    type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_ENV_PHP_MISSED:
     title: 'Magento installation completed, but the `app/etc/env.php` configuration file was missing or empty.'
     suggestion: 'Required data will be restored from environment configurations and from .magento.env.yaml file.'
@@ -589,6 +603,12 @@
     suggestion: 'Remove the MAGE_MODE environment variable, or change its value to "production". Magento Cloud supports "production" mode only.'
     step: 'validate-config:mage-mode-variable'
     type: warning
+!php/const Magento\MagentoCloud\App\Error::WARN_REMOTE_STORAGE_CANNOT_BE_ENABLED:
+    title: 'Remote storage could not be enabled.'
+    stage: deploy
+    suggestion: 'Verify remote storage credentials.'
+    step: remote-storage
+    type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_DEBUG_LOG_ENABLED:
     title: 'Debug logging is enabled in Magento'
     suggestion: 'To save disk space, do not enable debug logging for your production environments.'

config/schema.error.yaml

@@ -75,6 +75,7 @@ Critical errors indicate a problem with the Magento Commerce Cloud project confi
 | 133 | validate-config | Remove Magento Braintree module configuration which is no longer supported in Magento 2.4 and later versions. | Support for the Braintree module is no longer included with Magento 2.4.0 and later. Remove the CONFIG__STORES__DEFAULT__PAYMENT__BRAINTREE__CHANNEL variable from the variables section of the .magento.app.yaml file. For Braintree support, use an official Braintree Payments extension from the Magento Marketplace instead. |
 | 134 | validate-config | Magento 2.4.0 requires Elasticsearch service to be installed | Install Elasticsearch service |
 | 135 | validate-config | The search engine must be set to Elasticsearch for Magento >= 2.4.0 | Check the SEARCH_CONFIGURATION variable for the `engine` option. If it is configured, remove the option, or set the value to "elasticsearch". |
+| 136 | validate-config | Split Database was removed starting from Magento 2.5.0. | If you use split database you have to revert to or migrate to a single database or use an alternative approach. |
 
 ### Post-deploy stage
 
@@ -142,6 +143,7 @@ Warning errors indicate a problem with the Magento Commerce Cloud project config
 | 2017 | validate-config | The current configuration is not compatible with this version of Magento |  |
 | 2018 | validate-config | Some services have passed EOL |  |
 | 2019 | validate-config | The MySQL search configuration option is deprecated | Use Elasticsearch instead. |
+| 2029 | validate-config | Split Database was deprecated in the Magento 2.4.2 and will be removed in 2.5. | If you use split database you should start planning to revert to or migrate to a single database or use an alternative approach. |
 | 2020 | install-update | Magento installation completed, but the `app/etc/env.php` configuration file was missing or empty. | Required data will be restored from environment configurations and from .magento.env.yaml file. |
 | 2021 | install-update:db-connection | For split databases used custom connections |  |
 | 2022 | install-update:db-connection | You have changed to a database configuration that is not compatible with the slave connection. |  |
@@ -150,7 +152,7 @@ Warning errors indicate a problem with the Magento Commerce Cloud project config
 | 2025 | install-update:split-db | Slave connection not set. |  |
 | 2026 | pre-deploy:restore-writable-dirs | Failed to restore some data generated during the build phase to the mounted directories | Check the `cloud.log` for more information. |
 | 2027 | validate-config:mage-mode-variable | Mode value for MAGE_MODE environment variable not supported | Remove the MAGE_MODE environment variable, or change its value to "production". Magento Cloud supports "production" mode only. |
-| 2028 | remote-storage | Remote storage could not be enabled. | Verify remote storage credentials |
+| 2028 | remote-storage | Remote storage could not be enabled. | Verify remote storage credentials. |
 
 ### Post-deploy stage
 

dist/error-codes.md

@@ -32,6 +32,7 @@
                     <item name="session-configuration" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\SessionConfiguration</item>
                     <item name="elasticsearch-integrity" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\ElasticSearchIntegrity</item>
                     <item name="elasticsuite-integrity" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\ElasticSuiteIntegrity</item>
+                    <item name="removed-split-db" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\RemovedSplitDb</item>
                 </item>
                 <item name="warning" xsi:type="array">
                     <item name="mage-mode-variable" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\MageModeVariable</item>
@@ -50,6 +51,7 @@
                     <item name="service-version" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\ServiceVersion</item>
                     <item name="service-eol-warning" xsi:type="object">ServiceEol.Warnings</item>
                     <item name="deprecated-search-engine" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\DeprecatedSearchEngine</item>
+                    <item name="deprecated-split-db" xsi:type="object">Magento\MagentoCloud\Config\Validator\Deploy\DeprecatedSplitDb</item>
                 </item>
                 <item name="notice" xsi:type="array">
                     <item name="service-eol-notice" xsi:type="object">ServiceEol.Notices</item>
@@ -77,6 +79,7 @@
                 <item name="urls" xsi:type="object" priority="800">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\Urls</item>
                 <item name="document-root" xsi:type="object" priority="900">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\DocumentRoot</item>
                 <item name="lock" xsi:type="object" priority="1000">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\Lock</item>
+                <item name="remote-storage" xsi:type="object" priority="1100">Magento\MagentoCloud\Step\Deploy\RemoteStorage</item>
                 <!-- Config update end -->
                 <item name="config-import" xsi:type="object" priority="1100">Magento\MagentoCloud\Step\Deploy\InstallUpdate\Install\ConfigImport</item>
                 <item name="split-db" xsi:type="object" priority="1150">Magento\MagentoCloud\Step\Deploy\SplitDbConnection</item>
@@ -93,6 +96,7 @@
                 <item name="urls" xsi:type="object" priority="700">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\Urls</item>
                 <item name="document-root" xsi:type="object" priority="800">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\DocumentRoot</item>
                 <item name="lock" xsi:type="object" priority="900">Magento\MagentoCloud\Step\Deploy\InstallUpdate\ConfigUpdate\Lock</item>
+                <item name="remote-storage" xsi:type="object" priority="1000">Magento\MagentoCloud\Step\Deploy\RemoteStorage</item>
                 <!-- Config update end -->
                 <item name="set-admin-url" xsi:type="object" priority="1000">Magento\MagentoCloud\Step\Deploy\InstallUpdate\Update\SetAdminUrl</item>
                 <item name="setup" xsi:type="object" priority="1100">Magento\MagentoCloud\Step\Deploy\InstallUpdate\Update\Setup</item>
@@ -127,7 +131,6 @@
             </argument>
         </arguments>
     </step>
-    <step name="remote-storage" type="Magento\MagentoCloud\Step\Deploy\RemoteStorage" priority="1250"/>
     <step name="disable-maintenance-mode" type="Magento\MagentoCloud\Step\DisableMaintenanceMode" priority="1300"/>
     <onFail>
         <action name="create-deploy-failed-flag" type="Magento\MagentoCloud\OnFail\Action\CreateDeployFailedFlag" priority="100"/>

scenario/deploy.xml

@@ -75,6 +75,7 @@ class Error
     public const DEPLOY_WRONG_BRAINTREE_VARIABLE = 133;
     public const DEPLOY_ES_SERVICE_NOT_INSTALLED = 134;
     public const DEPLOY_WRONG_SEARCH_ENGINE = 135;
+    public const DEPLOY_REMOVED_SPLIT_DB = 136;
 
     public const PD_DEPLOY_IS_FAILED = 201;
     public const PD_ENV_PHP_IS_NOT_WRITABLE = 202;
@@ -133,6 +134,7 @@ class Error
     public const WARN_COPY_MOUNTED_DIRS_FAILED = 2026;
     public const WARN_NOT_SUPPORTED_MAGE_MODE = 2027;
     public const WARN_REMOTE_STORAGE_CANNOT_BE_ENABLED = 2028;
+    public const WARN_DEPRECATED_SPLIT_DB = 2029;
 
     /**
      * Post-deploy

src/App/Error.php

@@ -22,6 +22,7 @@
  * Verifies whether DB was split or not
  *
  * @api
+ * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
  */
 class SplitDbState extends Command
 {

src/Command/Wizard/SplitDbState.php

@@ -7,6 +7,7 @@
 
 namespace Magento\MagentoCloud\Config\Factory;
 
+use Magento\MagentoCloud\Config\ConfigException;
 use Magento\MagentoCloud\Config\ConfigMerger;
 use Magento\MagentoCloud\Config\Stage\DeployInterface;
 use Magento\MagentoCloud\Service\Redis;
@@ -20,18 +21,18 @@ class Cache
     /**
      * Redis database to store default cache data
      */
-    const REDIS_DATABASE_DEFAULT = 1;
+    public const REDIS_DATABASE_DEFAULT = 1;
 
     /**
      * Redis database to store page cache data
      */
-    const REDIS_DATABASE_PAGE_CACHE = 2;
+    public const REDIS_DATABASE_PAGE_CACHE = 2;
 
-    const REDIS_BACKEND_CM_CACHE = 'Cm_Cache_Backend_Redis';
-    const REDIS_BACKEND_REDIS_CACHE = '\Magento\Framework\Cache\Backend\Redis';
-    const REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE = '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache';
+    public const REDIS_BACKEND_CM_CACHE = 'Cm_Cache_Backend_Redis';
+    public const REDIS_BACKEND_REDIS_CACHE = '\Magento\Framework\Cache\Backend\Redis';
+    public const REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE = '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache';
 
-    const AVAILABLE_REDIS_BACKEND = [
+    public const AVAILABLE_REDIS_BACKEND = [
         self::REDIS_BACKEND_CM_CACHE,
         self::REDIS_BACKEND_REDIS_CACHE,
         self::REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE
@@ -83,7 +84,7 @@ public function __construct(
      * Returns an empty array in other case.
      *
      * @return array
-     * @throws \Magento\MagentoCloud\Config\ConfigException
+     * @throws ConfigException
      */
     public function get(): array
     {
@@ -162,7 +163,7 @@ public function get(): array
      * @param array $envCacheConfiguration
      * @param array $redisConfig
      * @return array
-     * @throws \Magento\MagentoCloud\Config\ConfigException
+     * @throws ConfigException
      */
     private function getSlaveConnection(array $envCacheConfiguration, array $redisConfig): array
     {
@@ -176,6 +177,11 @@ private function getSlaveConnection(array $envCacheConfiguration, array $redisCo
                 $config['load_from_slave']['port'] = $redisSlaveConfig['port'] ?? '';
                 $config['read_timeout'] = 1;
                 $config['retry_reads_on_master'] = 1;
+
+                if (!empty($redisSlaveConfig['password'])) {
+                    $config['load_from_slave']['password'] = $redisSlaveConfig['password'];
+                }
+
                 $this->logger->info('Set Redis slave connection');
             } else {
                 $this->logger->notice(
@@ -211,7 +217,7 @@ private function isCacheConfigurationValid(array $cacheConfiguration): bool
      * @param array $envCacheConfig
      * @param array $redisConfig
      * @return bool
-     * @throws \Magento\MagentoCloud\Config\ConfigException
+     * @throws ConfigException
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
     private function isConfigurationCompatibleWithSlaveConnection(
@@ -253,13 +259,19 @@ private function isConfigurationCompatibleWithSlaveConnection(
      */
     private function getUnsyncedConfigStructure(string $envCacheBackendModel, array $redisConfig): array
     {
-        return [
+        $config = [
             'backend' => $envCacheBackendModel,
             'backend_options' => [
                 'server' => $redisConfig['host'],
                 'port' => $redisConfig['port'],
             ]
         ];
+
+        if (!empty($redisConfig['password'])) {
+            $config['backend_options']['password'] = (string)$redisConfig['password'];
+        }
+
+        return $config;
     }
 
     /**
@@ -271,7 +283,7 @@ private function getUnsyncedConfigStructure(string $envCacheBackendModel, array
      */
     private function getSynchronizedConfigStructure(string $envCacheBackendModel, array $redisConfig): array
     {
-        return [
+        $config = [
             'backend' => $envCacheBackendModel,
             'backend_options' => [
                 'remote_backend' => '\Magento\Framework\Cache\Backend\Redis',
@@ -292,17 +304,24 @@ private function getSynchronizedConfigStructure(string $envCacheBackendModel, ar
                 'write_control' => false,
             ]
         ];
+
+        if (!empty($redisConfig['password'])) {
+            $config['backend_options']['remote_backend_options']['password'] = (string)$redisConfig['password'];
+        }
+
+        return $config;
     }
 
     /**
      * Checks that config contains synchronized cache model and need to use synchronized config structure.
      *
      * @return bool
-     * @throws \Magento\MagentoCloud\Config\ConfigException
+     * @throws ConfigException
      */
     private function isSynchronizedConfigStructure(): bool
     {
         $model = (string)$this->stageConfig->get(DeployInterface::VAR_CACHE_REDIS_BACKEND);
+
         return $model === self::REDIS_BACKEND_REMOTE_SYNCHRONIZED_CACHE;
     }
 }

src/Config/Factory/Cache.php

@@ -193,6 +193,12 @@ private function getElasticSearchConfiguration(array $config): array
             "{$engine}_server_port" => $config['port'],
         ];
 
+        if ($this->elasticSearch->isAuthEnabled()) {
+            $elasticSearchConfig["{$engine}_enable_auth"] = 1;
+            $elasticSearchConfig["{$engine}_username"] = $config['username'];
+            $elasticSearchConfig["{$engine}_password"] = $config['password'];
+        }
+
         if (isset($config['query']['index'])) {
             $elasticSearchConfig["{$engine}_index_prefix"] = $config['query']['index'];
         }

src/Config/SearchEngine.php

@@ -48,21 +48,29 @@ interface DeployInterface extends StageConfigInterface
 
     /**
      * The variable responsible to use split database.
+     *
+     * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
      */
     const VAR_SPLIT_DB = 'SPLIT_DB';
 
     /**
      * The value of the variable SPLIT_DB
+     *
+     * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
      */
     const SPLIT_DB_VALUE_QUOTE = 'quote';
 
     /**
      * The value of the variable SPLIT_DB
+     *
+     * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
      */
     const SPLIT_DB_VALUE_SALES = 'sales';
 
     /**
      * Values for variable SPLIT_DB
+     *
+     * @deprecated started from Magento 2.4.2 and will be removed in 2.5.0
      */
     const SPLIT_DB_VALUES = [
         self::SPLIT_DB_VALUE_QUOTE,