Merge pull request #7443 from magento-performance/MCP-903

adifucan · web-flow · commit f56e1d0c7965 · 2022-02-11T16:30:56.000-06:00
[Performance] MCP-903: Fix default connection = db setting after Magento installation
diff --git a/app/code/Magento/MessageQueue/Setup/ConfigOptionsList.php b/app/code/Magento/MessageQueue/Setup/ConfigOptionsList.php
@@ -62,8 +62,8 @@ public function getOptions()
                 self::INPUT_KEY_QUEUE_DEFAULT_CONNECTION,
                 TextConfigOption::FRONTEND_WIZARD_TEXT,
                 self::CONFIG_PATH_QUEUE_DEFAULT_CONNECTION,
-                'Message queues default connection. Can be db, amqp or a custom one.',
-                self::DEFAULT_QUEUE_CONNECTION
+                'Message queues default connection. Can be \'db\', \'amqp\' or a custom queue system.'
+                . 'The queue system must be installed and configured, otherwise messages won\'t be processed correctly.'
             ),
         ];
     }
diff --git a/dev/tests/api-functional/config/post-install-setup-command-config.php.dist b/dev/tests/api-functional/config/post-install-setup-command-config.php.dist
@@ -12,7 +12,7 @@ return [
         'config' => [
             '--remote-storage-driver' => 'aws-s3',
             '--remote-storage-bucket' => 'myBucket',
-            '--remote-storage-region' => 'us-east-1'
+            '--remote-storage-region' => 'us-east-1',
         ]
     ]
     */
diff --git a/dev/tests/integration/etc/post-install-setup-command-config.php.dist b/dev/tests/integration/etc/post-install-setup-command-config.php.dist
@@ -6,15 +6,15 @@
 
 // List of bin/magento setup CLI commands to run after setup:install
 return [
-    /*
     [
         'command' => 'setup:config:set',
         'config' => [
+            '--queue-default-connection' => 'db'
+            /*
             '--remote-storage-driver' => 'aws-s3',
             '--remote-storage-bucket' => 'myBucket',
-            '--remote-storage-region' => 'us-east-1',
-            '--queue-default-connection' => 'db'
+            '--remote-storage-region' => 'us-east-1'
+            */
         ]
     ]
-    */
 ];
diff --git a/setup/src/Magento/Setup/Model/ConfigOptionsList/Lock.php b/setup/src/Magento/Setup/Model/ConfigOptionsList/Lock.php
@@ -26,70 +26,70 @@ class Lock implements ConfigOptionsListInterface
      *
      * @const string
      */
-    const INPUT_KEY_LOCK_PROVIDER = 'lock-provider';
+    public const INPUT_KEY_LOCK_PROVIDER = 'lock-provider';
 
     /**
      * The name of an option to set DB prefix
      *
      * @const string
      */
-    const INPUT_KEY_LOCK_DB_PREFIX = 'lock-db-prefix';
+    public const INPUT_KEY_LOCK_DB_PREFIX = 'lock-db-prefix';
 
     /**
      * The name of an option to set Zookeeper host
      *
      * @const string
      */
-    const INPUT_KEY_LOCK_ZOOKEEPER_HOST = 'lock-zookeeper-host';
+    public const INPUT_KEY_LOCK_ZOOKEEPER_HOST = 'lock-zookeeper-host';
 
     /**
      * The name of an option to set Zookeeper path
      *
      * @const string
      */
-    const INPUT_KEY_LOCK_ZOOKEEPER_PATH = 'lock-zookeeper-path';
+    public const INPUT_KEY_LOCK_ZOOKEEPER_PATH = 'lock-zookeeper-path';
 
     /**
      * The name of an option to set File path
      *
      * @const string
      */
-    const INPUT_KEY_LOCK_FILE_PATH = 'lock-file-path';
+    public const INPUT_KEY_LOCK_FILE_PATH = 'lock-file-path';
 
     /**
      * The configuration path to save lock provider
      *
      * @const string
      */
-    const CONFIG_PATH_LOCK_PROVIDER = 'lock/provider';
+    public const CONFIG_PATH_LOCK_PROVIDER = 'lock/provider';
 
     /**
      * The configuration path to save DB prefix
      *
      * @const string
      */
-    const CONFIG_PATH_LOCK_DB_PREFIX = 'lock/config/prefix';
+    public const CONFIG_PATH_LOCK_DB_PREFIX = 'lock/config/prefix';
 
     /**
      * The configuration path to save Zookeeper host
      *
      * @const string
      */
-    const CONFIG_PATH_LOCK_ZOOKEEPER_HOST = 'lock/config/host';
+    public const CONFIG_PATH_LOCK_ZOOKEEPER_HOST = 'lock/config/host';
 
     /**
      * The configuration path to save Zookeeper path
      *
      * @const string
      */
-    const CONFIG_PATH_LOCK_ZOOKEEPER_PATH = 'lock/config/path';
+    public const CONFIG_PATH_LOCK_ZOOKEEPER_PATH = 'lock/config/path';
 
     /**
      * The configuration path to save locks directory path
      *
      * @const string
      */
-    const CONFIG_PATH_LOCK_FILE_PATH = 'lock/config/path';
+    public const CONFIG_PATH_LOCK_FILE_PATH = 'lock/config/path';
 
     /**
      * The list of lock providers
@@ -134,7 +134,6 @@ class Lock implements ConfigOptionsListInterface
      */
     private $defaultConfigValues = [
         self::INPUT_KEY_LOCK_PROVIDER => LockBackendFactory::LOCK_DB,
-        self::INPUT_KEY_LOCK_DB_PREFIX => null,
         self::INPUT_KEY_LOCK_ZOOKEEPER_PATH => ZookeeperLock::DEFAULT_PATH,
     ];
 
@@ -317,7 +316,10 @@ private function setDefaultConfiguration(
         string $lockProvider
     ) {
         foreach ($this->mappingInputKeyToConfigPath[$lockProvider] as $input => $path) {
-            $configData->set($path, $deploymentConfig->get($path, $this->getDefaultValue($input)));
+            // do not set default value null for lock db prefix
+            if ($input !== self::INPUT_KEY_LOCK_DB_PREFIX) {
+                $configData->set($path, $deploymentConfig->get($path, $this->getDefaultValue($input)));
+            }
         }
 
         return $configData;
@@ -333,10 +335,6 @@ private function setDefaultConfiguration(
      */
     private function getDefaultValue(string $inputKey)
     {
-        if (isset($this->defaultConfigValues[$inputKey])) {
-            return $this->defaultConfigValues[$inputKey];
-        } else {
-            return null;
-        }
+        return $this->defaultConfigValues[$inputKey] ?? null;
     }
 }
diff --git a/setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsList/LockTest.php b/setup/src/Magento/Setup/Test/Unit/Model/ConfigOptionsList/LockTest.php
@@ -85,6 +85,7 @@ public function testCreateConfig(array $options, array $expectedResult)
 
     /**
      * @return array
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function createConfigDataProvider(): array
     {
@@ -93,10 +94,7 @@ public function createConfigDataProvider(): array
                 'options' => [],
                 'expectedResult' => [
                     'lock' => [
-                        'provider' => LockBackendFactory::LOCK_DB,
-                        'config' => [
-                            'prefix' => null,
-                        ],
+                        'provider' => LockBackendFactory::LOCK_DB
                     ],
                 ],
             ],
@@ -168,6 +166,31 @@ public function createConfigDataProvider(): array
                     ],
                 ],
             ],
+            'Check specific db lock prefix null options' => [
+                'options' => [
+                    LockConfigOptionsList::INPUT_KEY_LOCK_PROVIDER => LockBackendFactory::LOCK_DB,
+                    LockConfigOptionsList::INPUT_KEY_LOCK_DB_PREFIX => null
+                ],
+                'expectedResult' => [
+                    'lock' => [
+                        'provider' => LockBackendFactory::LOCK_DB
+                    ],
+                ],
+            ],
+            'Check specific db lock prefix empty options' => [
+                'options' => [
+                    LockConfigOptionsList::INPUT_KEY_LOCK_PROVIDER => LockBackendFactory::LOCK_DB,
+                    LockConfigOptionsList::INPUT_KEY_LOCK_DB_PREFIX => ''
+                ],
+                'expectedResult' => [
+                    'lock' => [
+                        'provider' => LockBackendFactory::LOCK_DB,
+                        'config' => [
+                            'prefix' => '',
+                        ],
+                    ],
+                ],
+            ],
         ];
     }
 

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ return [`
`12`	`12`	`'config' => [`
`13`	`13`	`'--remote-storage-driver' => 'aws-s3',`
`14`	`14`	`'--remote-storage-bucket' => 'myBucket',`
`15`		`- '--remote-storage-region' => 'us-east-1'`
	`15`	`+ '--remote-storage-region' => 'us-east-1',`
`16`	`16`	`]`
`17`	`17`	`]`
`18`	`18`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -6,15 +6,15 @@`
`6`	`6`
`7`	`7`	`// List of bin/magento setup CLI commands to run after setup:install`
`8`	`8`	`return [`
`9`		`- /*`
`10`	`9`	`[`
`11`	`10`	`'command' => 'setup:config:set',`
`12`	`11`	`'config' => [`
	`12`	`+ '--queue-default-connection' => 'db'`
	`13`	`+ /*`
`13`	`14`	`'--remote-storage-driver' => 'aws-s3',`
`14`	`15`	`'--remote-storage-bucket' => 'myBucket',`
`15`		`- '--remote-storage-region' => 'us-east-1',`
`16`		`- '--queue-default-connection' => 'db'`
	`16`	`+ '--remote-storage-region' => 'us-east-1'`
	`17`	`+ */`
`17`	`18`	`]`
`18`	`19`	`]`
`19`		`- */`
`20`	`20`	`];`