Merge pull request #179 from magento-commerce/develop

MCLOUD-13444: Release ece-tools 2002.2.2

Author: andriyShevtsov

src/Test/Functional/Acceptance/SplitDb82Cest.php renamed to SplitDb82Cest.php

@@ -9,7 +9,6 @@ settings:
 extensions:
   enabled:
     - Codeception\Extension\RunFailed
-    - Codeception\Extension\FailedInfo
 params:
   - vendor/magento/magento-cloud-docker/tests/functional/configuration.dist.yml
   - env

src/Test/Functional/Acceptance/SplitDbCest.php renamed to SplitDbCest.php

@@ -2,7 +2,7 @@
   "name": "magento/ece-tools",
   "description": "Provides tools to build and deploy Magento 2 Enterprise Edition",
   "type": "magento2-component",
-  "version": "2002.2.1",
+  "version": "2002.2.2",
   "license": "OSL-3.0",
   "repositories": {
     "repo.magento.com": {
@@ -16,17 +16,17 @@
     "ext-json": "*",
     "ext-sockets": "*",
     "colinmollenhour/credis": "^1.6.0 || ^1.13",
-    "composer/composer": "^1.9 || ^2.0 || !=2.2.16",
+    "composer/composer": "^1.9 || ^2.8 || !=2.2.16",
     "composer/semver": "@stable",
     "graylog2/gelf-php": "^2.0.1",
     "guzzlehttp/guzzle": "^7.3 || ^7.5",
-    "illuminate/config": "^5.5||^8.77",
+    "illuminate/config": "^10.0 || ^11.0",
     "magento/magento-cloud-components": "^1.0.8",
-    "magento/magento-cloud-docker": "^1.0.0",
+    "magento/magento-cloud-docker": "^1.4.0",
     "magento/magento-cloud-patches": "^1.0.20",
     "magento/quality-patches": "^1.1.0",
     "monolog/monolog": "^2.3 || ^2.7 || ^3.6",
-    "nesbot/carbon": "^1.0 || ^2.0",
+    "nesbot/carbon": "^1.0 || ^2.0 || ^3.8",
     "psr/container": "^1.0",
     "psr/log": "^1.0 || ^2.0 || ^3.0",
     "symfony/config": "^4.4 || ^5.1 || ^5.4 || ^6.4",
@@ -45,9 +45,9 @@
     "consolidation/robo": "^3.0",
     "php-mock/php-mock-phpunit": "^2.0",
     "phpmd/phpmd": "@stable",
-    "phpstan/phpstan": "~1.2.0",
-    "phpunit/php-code-coverage": "^9.2",
-    "phpunit/phpunit": "^9.5",
+    "phpstan/phpstan": "1.2.0 || ^2.0",
+    "phpunit/php-code-coverage": "^10.0",
+    "phpunit/phpunit": "^10.0",
     "squizlabs/php_codesniffer": "^3.0",
     "funkjedi/composer-include-files": "^1.0"
   },

codeception.dist.yml

@@ -78,3 +78,6 @@ redis:
     eol: 2023-08-15
   - version: '7.2'
     eol: 2025-08-31
+valkey:
+  - version: '8.0'
+    eol: 2029-04-16

composer.json

@@ -179,6 +179,12 @@
     step: 'pre-deploy: clean-redis-cache'
     stage: deploy
     type: critical
+!php/const Magento\MagentoCloud\App\Error::DEPLOY_VALKEY_CACHE_CLEAN_FAILED:
+    title: 'Failed to clean the Valkey cache'
+    suggestion: 'Failed to clean the Valkey cache. Check that the Valkey cache configuration is correct and that the Valkey service is available. See [Setup Valkey service](https://experienceleague.adobe.com/docs/commerce-cloud-service/user-guide/configure/service/valkey.html).'
+    step: 'pre-deploy: clean-valkey-cache'
+    stage: deploy
+    type: critical
 !php/const Magento\MagentoCloud\App\Error::DEPLOY_MAINTENANCE_MODE_ENABLING_FAILED:
     step: 'pre-deploy: set-production-mode'
     title: 'Command `/bin/magento maintenance:enable` failed'
@@ -491,6 +497,11 @@
     stage: deploy
     step: 'pre-deploy:cache'
     type: warning
+!php/const Magento\MagentoCloud\App\Error::WARN_VALKEY_SERVICE_NOT_AVAILABLE:
+    title: 'Cache is configured for a Valkey service that is not available. Configuration will be ignored.'
+    stage: deploy
+    step: 'pre-deploy:cache'
+    type: warning
 !php/const Magento\MagentoCloud\App\Error::WARN_WRONG_SPLIT_DB_CONFIG:
     title: 'The configured state is not ideal'
     stage: deploy

config/eol.yaml

@@ -270,6 +270,20 @@ variables:
       - stage:
           deploy:
             REDIS_USE_SLAVE_CONNECTION: true
+  VALKEY_USE_SLAVE_CONNECTION:
+    description: Set to true to automatically use a read-only connection to a Valkey instance to receive read-only
+      traffic on a non-master node. This improves performance through load balancing because only one node needs to
+      handle read-write traffic.
+    type: boolean
+    stages:
+      - global
+      - deploy
+    default:
+      deploy: false
+    examples:
+      - stage:
+          deploy:
+            VALKEY_USE_SLAVE_CONNECTION: true
   MYSQL_USE_SLAVE_CONNECTION:
     description: Set to true to automatically use a read-only connection to the database to receive read-only traffic on
       a non-master node. This improves performance through load balancing, because only one node needs to
@@ -446,6 +460,21 @@ variables:
       - stage:
           deploy:
             REDIS_BACKEND: '\Magento\Framework\Cache\Backend\Redis'
+  VALKEY_BACKEND:
+    description: "Configuration the backend model for valkey cache."
+    type: string
+    allowed:
+      - 'Cm_Cache_Backend_Redis'
+      - '\Magento\Framework\Cache\Backend\Valkey'
+      - '\Magento\Framework\Cache\Backend\RemoteSynchronizedCache'
+    stages:
+      - deploy
+    default:
+      deploy: 'Cm_Cache_Backend_Redis'
+    examples:
+      - stage:
+          deploy:
+            VALKEY_BACKEND: '\Magento\Framework\Cache\Backend\Valkey'
   CACHE_CONFIGURATION:
     description: "Replace or modify the Magento cache configuration generated during the deployment process.
       To replace the existing configuration, specify values for each configuration option required for your environment.

config/schema.error.yaml

@@ -15,6 +15,7 @@
                 <item name="clean-file-cache" xsi:type="object" priority="500">Magento\MagentoCloud\Step\Deploy\PreDeploy\CleanFileCache</item>
                 <item name="restore-writable-dirs" xsi:type="object" priority="600">Magento\MagentoCloud\Step\Deploy\PreDeploy\RestoreWritableDirectories</item>
                 <item name="set-production-mode" xsi:type="object" priority="700">Magento\MagentoCloud\Step\SetProductionMode</item>
+                <item name="clean-valkey-cache" xsi:type="object" priority="800">Magento\MagentoCloud\Step\Deploy\PreDeploy\CleanValkeyCache</item>
             </argument>
         </arguments>
     </step>

config/schema.yaml

@@ -21,7 +21,7 @@
 /**
  * @inheritdoc
  * @codeCoverageIgnore
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class Container implements ContainerInterface
 {

scenario/deploy.xml

@@ -79,6 +79,7 @@ class Error
     public const DEPLOY_OS_CANNOT_CONNECT = 137;
     public const DEPLOY_OS_SERVICE_NOT_INSTALLED = 138;
     public const DEPLOY_MAGENTO_VERSION_DOES_NOT_SUPPORT_OS = 139;
+    public const DEPLOY_VALKEY_CACHE_CLEAN_FAILED = 140;
 
     public const PD_DEPLOY_IS_FAILED = 201;
     public const PD_ENV_PHP_IS_NOT_WRITABLE = 202;
@@ -145,6 +146,7 @@ class Error
     public const WARN_DEPRECATED_SPLIT_DB = 2029;
     public const WARN_OS_ES_SERVICES_BOTH_INSTALLED = 2030;
     public const WARN_REMOTE_STORAGE_CANNOT_BE_DISABLED = 2031;
+    public const WARN_VALKEY_SERVICE_NOT_AVAILABLE = 2032;
 
     /**
      * Post-deploy

src/App/Container.php

@@ -31,7 +31,6 @@ class ErrorHandler
         E_USER_ERROR => 'User Error',
         E_USER_WARNING => 'User Warning',
         E_USER_NOTICE => 'User Notice',
-        E_STRICT => 'Strict Notice',
         E_RECOVERABLE_ERROR => 'Recoverable Error',
         E_DEPRECATED => 'Deprecated Functionality',
         E_USER_DEPRECATED => 'User Deprecated Functionality',

src/App/Error.php

@@ -12,14 +12,14 @@
 /**
  * Base exception for general purposes.
  *
- * @SuppressWarnings(PHPMD.NumberOfChildren)
+ * @SuppressWarnings("PHPMD.NumberOfChildren")
  */
 class GenericException extends \Exception
 {
     /**
      * @inheritDoc
      */
-    public function __construct(string $message, int $code = 0, Throwable $previous = null)
+    public function __construct(string $message, int $code = 0, Throwable | null $previous = null)
     {
         parent::__construct($message, $code, $previous);
     }

src/App/ErrorHandler.php

@@ -19,7 +19,7 @@
 /**
  * @inheritdoc
  */
-class Logger extends \Monolog\Logger
+class Logger extends \Monolog\Logger // @phpstan-ignore-line
 {
     /**
      * @var File

src/App/GenericException.php

@@ -53,6 +53,7 @@ public function __construct(
     public function format(\Monolog\LogRecord|array $record): string
     {
         // Monolog version 3 or higher.
+        /** @phpstan-ignore-next-line */
         if (\Monolog\Logger::API == 3) {
             try {
                 /** @phpstan-ignore-next-line */
@@ -81,7 +82,7 @@ public function format(\Monolog\LogRecord|array $record): string
                 if (isset($loggedErrors[$record['context']['errorCode']])) {
                     return '';
                 }
-    
+                /** @phpstan-ignore-next-line */
                 return parent::format($this->formatLog($record));
             } catch (\Exception $exception) {
                 return '';

src/App/Logger.php

@@ -23,7 +23,7 @@
 /**
  * The handler factory.
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class HandlerFactory
 {
@@ -73,7 +73,7 @@ public function __construct(
      * @return AbstractProcessingHandler
      * @throws LoggerException
      *
-     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings("PHPMD.CyclomaticComplexity")
      */
     public function create(string $handler): AbstractProcessingHandler
     {
@@ -104,12 +104,9 @@ public function create(string $handler): AbstractProcessingHandler
                     );
                     break;
                 case static::HANDLER_STREAM:
-                    $defaultLevelStream = !empty($levelOverride) ?
-                        $this->normalizeLevel($levelOverride)
-                        : Logger::INFO;
                     $handlerInstance = new StreamHandler(
                         $configuration->get('stream'),
-                        $minLevel ?: $defaultLevelStream
+                        $minLevel ?: Logger::INFO
                     );
                     break;
                 case static::HANDLER_EMAIL:
@@ -172,6 +169,7 @@ private function normalizeLevel(string $level): int
         /** @phpstan-ignore-next-line */
         $normalizedLevel = Logger::toMonologLevel($level);
 
+        /** @phpstan-ignore-next-line */
         if (\Monolog\Logger::API == 3) {
             /** @phpstan-ignore-next-line */
             $normalizedLevel =  $normalizedLevel->value;

src/App/Logger/Formatter/JsonErrorFormatter.php

@@ -33,7 +33,7 @@ public function __construct(Sanitizer $sanitizer)
     public function __invoke(\Monolog\LogRecord|array $record)
     {
         // Monolog version 3 or higher.
-        if (\Monolog\Logger::API == 3) {
+        if (\Monolog\Logger::API == 3) { // @phpstan-ignore-line
             $message = $this->sanitizer->sanitize($record->message); // @phpstan-ignore-line
             // Create new LogRecord from existing and update the message,
             // since message is read only

src/App/Logger/HandlerFactory.php

@@ -15,7 +15,7 @@
 /**
  * @inheritdoc
  *
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class Application extends \Symfony\Component\Console\Application
 {

src/App/Logger/Processor/SanitizeProcessor.php

@@ -58,7 +58,7 @@ protected function configure(): void
         $this->setName(static::NAME)
             ->setDescription(
                 'Creates a `.magento.env.yaml` file with the specified build, deploy, and post-deploy variable ' .
-                'configuration. Overwrites any existing `.magento,.env.yaml` file.'
+                'configuration. Overwrites any existing `.magento.env.yaml` file.'
             )
             ->addArgument(
                 self::ARG_CONFIGURATION,

src/Application.php

@@ -114,7 +114,7 @@ protected function renderTable(OutputInterface $output, string $title, array $he
         $table = new Table($output);
         $table->setHeaders($header)
             ->setRows($rows);
-        if (method_exists($table, 'setColumnWidth')) {
+        if (method_exists($table, 'setColumnWidth')) { // @phpstan-ignore-line
             $table->setColumnWidth(0, 40);
             $table->setColumnWidth(1, 60);
         }

src/Command/ConfigCreate.php

@@ -53,7 +53,7 @@ protected function configure(): void
      * @param OutputInterface $output
      * @return int
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     public function execute(InputInterface $input, OutputInterface $output)
     {

src/Command/ConfigShow/Renderer.php

@@ -17,7 +17,7 @@
 
 /**
  * @codeCoverageIgnore
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 class GenerateSchemaError extends Command
 {
@@ -60,7 +60,7 @@ protected function configure(): void
     /**
      * @inheritdoc
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {

src/Command/ConfigValidate.php

@@ -102,7 +102,7 @@ protected function configure(): void
      * @throws ConfigException
      * @throws FileSystemException
      *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @SuppressWarnings("PHPMD.UnusedFormalParameter")
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {

src/Command/Dev/GenerateSchemaError.php

@@ -69,6 +69,9 @@ public function execute(InputInterface $input, OutputInterface $output): int
             $errors[] = 'Redis slave connection is not configured';
         }
 
+        if (!$this->deployConfig->get(DeployInterface::VAR_VALKEY_USE_SLAVE_CONNECTION)) {
+            $errors[] = 'Valkey slave connection is not configured';
+        }
         foreach ($errors as $error) {
             $this->outputFormatter->writeItem($output, $error);
         }