Merge branch 'develop' into MCLOUD-6235

Author: BaDos

composer.json

@@ -2,7 +2,7 @@
   "name": "magento/ece-tools",
   "description": "Provides tools to build and deploy Magento 2 Enterprise Edition",
   "type": "magento2-component",
-  "version": "2002.1.0",
+  "version": "2002.1.1",
   "license": "OSL-3.0",
   "repositories": {
     "repo.magento.com": {

config/schema.error.yaml

@@ -439,7 +439,7 @@
     step: validate-config
     type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_NOT_CORRECT_LOCAL_XML_FILE:
-    title: 'Invalid file config ./pub/errors/local.xml'
+    title: 'Invalid configuration in the ./pub/errors/local.xml file.'
     stage: deploy
     step: validate-config
     type: warning
@@ -544,7 +544,7 @@
     step: 'install-update:split-db'
     type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_NOT_ENOUGH_DATA_SPLIT_DB_VAR:
-    title: 'The SPLIT_DB variable does not have data which were already split.'
+    title: 'The SPLIT_DB variable is missing the configuration for split connection types.'
     stage: deploy
     step: 'install-update:split-db'
     type: warning

config/schema.yaml

@@ -643,6 +643,20 @@ variables:
       - stage:
           global:
             X_FRAME_CONFIGURATION: SAMEORIGIN
+  QUALITY_PATCHES:
+    description: Specify a list of Magento quality patches that will be applied during deployment.
+    type: array
+    stages:
+      - build
+    default:
+      build: []
+    examples:
+      - stage:
+          build:
+            QUALITY_PATCHES:
+              - MC-31387
+              - MDVA-4567
+              - MC-45634
 
   # Environment variables
   ENV_RELATIONSHIPS:

dist/error-codes.md

@@ -121,7 +121,7 @@
 | 2001 | pre-deploy:cache | Cache is configured for a Redis service that is not available. Configuration will be ignored. |  |
 | 2002 | validate-config | The configured state is not ideal |  |
 | 2003 | validate-config | The directory nesting level value for error reporting has not been configured |  |
-| 2004 | validate-config | Invalid file config ./pub/errors/local.xml |  |
+| 2004 | validate-config | Invalid configuration in the ./pub/errors/local.xml file. |  |
 | 2005 | validate-config | Admin data is used to create an admin user during initial installation only. Any changes to Admin data are ignored during the upgrade process. | After the initial installation, you can remove admin data from the configuration. |
 | 2006 | validate-config | Admin user was not created as admin email was not set | After installation, you can create an admin user manually:  Use ssh to connect to your environment. Then, run the `bin/magento admin:user:create` command. |
 | 2007 | validate-config | Update php version to recommended version |  |
@@ -141,7 +141,7 @@
 | 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. |  |
 | 2023 | install-update:split-db | Enabling a split database will be skipped. |  |
-| 2024 | install-update:split-db | The SPLIT_DB variable does not have data which were already split. |  |
+| 2024 | install-update:split-db | The SPLIT_DB variable is missing the configuration for split connection types. |  |
 | 2025 | install-update:split-db | Slave connection not set. |  |
 
 ### Post-deploy stage

scenario/deploy.xml

@@ -5,6 +5,7 @@
         <arguments>
             <argument name="logger" xsi:type="object">Psr\Log\LoggerInterface</argument>
             <argument name="steps" xsi:type="array">
+                <item name="restore-patch-log" xsi:type="object" priority="25">Magento\MagentoCloud\Step\Deploy\PreDeploy\RestorePatchLog</item>
                 <item name="check-state" xsi:type="object" priority="50">Magento\MagentoCloud\Step\Deploy\PreDeploy\CheckState</item>
                 <item name="cache" xsi:type="object" priority="100">Magento\MagentoCloud\Step\Deploy\PreDeploy\ConfigUpdate\Cache</item>
                 <item name="clean-static-content" xsi:type="object" priority="200">Magento\MagentoCloud\Step\Deploy\PreDeploy\CleanStaticContent</item>

src/Command/Dev/UpdateComposer/ComposerGenerator.php

@@ -17,6 +17,16 @@
  */
 class ComposerGenerator
 {
+    /**
+     * Types of supported Magento component packages
+     */
+    private const COMPONENT_PACKAGE_TYPES = [
+        'magento2-module',
+        'magento2-theme',
+        'magento2-language',
+        'magento2-library'
+    ];
+
     /**
      * @var DirectoryList
      */
@@ -81,10 +91,13 @@ public function generate(array $repoOptions): array
             $baseRepoFolder = $this->directoryList->getMagentoRoot() . '/' . $repoDir;
 
             $dirComposerJson = $baseRepoFolder . '/composer.json';
+            $isModuleRoot = false;
             if ($this->file->isExists($dirComposerJson)) {
                 $dirPackageInfo = json_decode($this->file->fileGetContents($dirComposerJson), true);
-                if (isset($dirPackageInfo['type']) && $dirPackageInfo['type'] == 'project') {
+                if ($this->isProjectPackage($dirPackageInfo)) {
                     $composer['require'] = array_merge($composer['require'], $dirPackageInfo['require']);
+                } elseif ($this->isComponentPackage($dirPackageInfo)) {
+                    $isModuleRoot = true;
                 }
             }
 
@@ -99,12 +112,16 @@ public function generate(array $repoOptions): array
                 ];
                 $composer['require'][$packageName] = '*@dev';
             }
-            $excludeRepoStr = empty($repoPackages) ? '' : "--exclude='" . join("' --exclude='", $repoPackages) . "' ";
-            $preparePackagesScripts[] = sprintf(
-                "rsync -azhm --stats $excludeRepoStr--exclude='dev/tests' --exclude='.git' " .
-                "--exclude='composer.json' --exclude='composer.lock' ./%s/ ./",
-                $repoDir
-            );
+            if (!$isModuleRoot) {
+                $excludeRepoStr = empty($repoPackages)
+                    ? ''
+                    : "--exclude='" . join("' --exclude='", $repoPackages) . "' ";
+                $preparePackagesScripts[] = sprintf(
+                    "rsync -azhm --stats $excludeRepoStr--exclude='dev/tests' --exclude='.git' " .
+                    "--exclude='composer.json' --exclude='composer.lock' ./%s/ ./",
+                    $repoDir
+                );
+            }
         }
         $composer['scripts']['prepare-packages'] = $preparePackagesScripts;
         $composer['scripts']['post-install-cmd'] = ['@prepare-packages'];
@@ -208,7 +225,6 @@ private function getBaseComposer(array $repoOptions): array
     private function findPackages(string $path)
     {
         $path = rtrim($path, '\\/');
-        $packageTypes = ['magento2-module', 'magento2-theme', 'magento2-language', 'magento2-library'];
         $pathLength = strlen($path . '/');
 
         $dirIterator = $this->file->getRecursiveFileIterator(
@@ -219,11 +235,33 @@ private function findPackages(string $path)
         $packages = [];
         foreach ($dirIterator as $currentFileInfo) {
             $packageInfo = json_decode($this->file->fileGetContents($currentFileInfo->getPathName()), true);
-            if (isset($packageInfo['type']) && in_array($packageInfo['type'], $packageTypes)) {
+            if ($this->isComponentPackage($packageInfo)) {
                 $packages[$packageInfo['name']] = substr($currentFileInfo->getPath(), $pathLength);
             }
         }
 
         return $packages;
     }
+
+    /**
+     * Check if provided package info belongs to a Magento component package
+     *
+     * @param array $packageInfo
+     * @return bool
+     */
+    private function isComponentPackage(array $packageInfo): bool
+    {
+        return isset($packageInfo['type']) && in_array($packageInfo['type'], self::COMPONENT_PACKAGE_TYPES);
+    }
+
+    /**
+     * Check if provided package info belongs to a Magento project package
+     *
+     * @param array $packageInfo
+     * @return bool
+     */
+    private function isProjectPackage(array $packageInfo): bool
+    {
+        return isset($packageInfo['type']) && $packageInfo['type'] == 'project';
+    }
 }

src/Command/ErrorShow.php

@@ -87,7 +87,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
         } else {
             $errors = $this->reader->read();
             if (empty($errors)) {
-                $output->writeln('The error log is empty or doesn\'t exist');
+                $output->writeln('The error log is empty or does not exist');
 
                 return 1;
             }

src/Config/Schema/Validator/SplitDb.php

@@ -37,7 +37,7 @@ public function validate(string $key, $value): ResultInterface
         if (array_diff($value, DeployInterface::SPLIT_DB_VALUES)) {
             return $this->resultFactory->error(sprintf(
                 'The %s variable contains the invalid value. '
-                . 'It should be array with next available values: [%s].',
+                . 'It should be an array with following values: [%s].',
                 $key,
                 implode(', ', DeployInterface::SPLIT_DB_VALUES)
             ));

src/Config/Stage/BuildInterface.php

@@ -22,7 +22,12 @@ interface BuildInterface extends StageConfigInterface
     public const VAR_ERROR_REPORT_DIR_NESTING_LEVEL = 'ERROR_REPORT_DIR_NESTING_LEVEL';
 
     /**
-     * Perfom Baler JS bundling
+     * Perform Baler JS bundling
      */
     public const VAR_SCD_USE_BALER = 'SCD_USE_BALER';
+
+    /**
+     * Magento quality patches list
+     */
+    public const VAR_QUALITY_PATCHES = 'QUALITY_PATCHES';
 }

src/Config/Validator/Deploy/DebugLogging.php

@@ -66,8 +66,7 @@ public function validate(): ResultInterface
 
         return $this->resultFactory->error(
             'Debug logging is enabled in Magento',
-            'To save space in Magento Cloud, '
-            . 'debug logging should not be enabled for your production environments.',
+            'To save space in Magento Cloud, disable debug logging for your production environments.',
             Error::WARN_DEBUG_LOG_ENABLED
         );
     }