ENGCOM-8243: Fix URL generation for new store when it created with setup:config:import #30023

gabrieldagama · web-flow · commit f42499022520 · 2020-10-15T10:14:08.000+01:00
diff --git a/app/code/Magento/Deploy/Console/Command/App/ConfigImportCommand.php b/app/code/Magento/Deploy/Console/Command/App/ConfigImportCommand.php
@@ -3,14 +3,21 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Deploy\Console\Command\App;
 
+use Magento\Config\Console\Command\EmulatedAdminhtmlAreaProcessor;
+use Magento\Deploy\Console\Command\App\ConfigImport\Processor;
+use Magento\Framework\App\Area;
+use Magento\Framework\App\AreaList;
+use Magento\Framework\App\DeploymentConfig;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Console\Cli;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Exception\RuntimeException;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
-use Magento\Framework\Console\Cli;
-use Magento\Deploy\Console\Command\App\ConfigImport\Processor;
 
 /**
  * Runs the process of importing configuration data from shared source to appropriate application sources
@@ -21,9 +28,6 @@
  */
 class ConfigImportCommand extends Command
 {
-    /**
-     * Command name.
-     */
     const COMMAND_NAME = 'app:config:import';
 
     /**
@@ -33,12 +37,40 @@ class ConfigImportCommand extends Command
      */
     private $processor;
 
+    /**
+     * @var EmulatedAdminhtmlAreaProcessor
+     */
+    private $adminhtmlAreaProcessor;
+
+    /**
+     * @var DeploymentConfig
+     */
+    private $deploymentConfig;
+
+    /**
+     * @var AreaList
+     */
+    private $areaList;
+
     /**
      * @param Processor $processor the configuration importer
+     * @param DeploymentConfig|null $deploymentConfig
+     * @param EmulatedAdminhtmlAreaProcessor|null $adminhtmlAreaProcessor
+     * @param AreaList|null $areaList
      */
-    public function __construct(Processor $processor)
-    {
+    public function __construct(
+        Processor $processor,
+        DeploymentConfig $deploymentConfig = null,
+        EmulatedAdminhtmlAreaProcessor $adminhtmlAreaProcessor = null,
+        AreaList $areaList = null
+    ) {
         $this->processor = $processor;
+        $this->deploymentConfig = $deploymentConfig
+            ?? ObjectManager::getInstance()->get(DeploymentConfig::class);
+        $this->adminhtmlAreaProcessor = $adminhtmlAreaProcessor
+            ?? ObjectManager::getInstance()->get(EmulatedAdminhtmlAreaProcessor::class);
+        $this->areaList = $areaList
+            ?? ObjectManager::getInstance()->get(AreaList::class);
 
         parent::__construct();
     }
@@ -55,12 +87,26 @@ protected function configure()
     }
 
     /**
-     * Imports data from deployment configuration files to the DB. {@inheritdoc}
+     * Imports data from deployment configuration files to the DB.
+     * {@inheritdoc}
+     *
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int
+     * @throws \Exception
      */
     protected function execute(InputInterface $input, OutputInterface $output)
     {
         try {
-            $this->processor->execute($input, $output);
+            if ($this->canEmulateAdminhtmlArea()) {
+                // Emulate adminhtml area in order to execute all needed plugins declared only for this area
+                // For instance URL rewrite generation during creating store view
+                $this->adminhtmlAreaProcessor->process(function () use ($input, $output) {
+                    $this->processor->execute($input, $output);
+                });
+            } else {
+                $this->processor->execute($input, $output);
+            }
         } catch (RuntimeException $e) {
             $output->writeln('<error>' . $e->getMessage() . '</error>');
 
@@ -69,4 +115,19 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         return Cli::RETURN_SUCCESS;
     }
+
+    /**
+     * Detects if we can emulate adminhtml area
+     *
+     * This area could be not available for instance during setup:install
+     *
+     * @return bool
+     * @throws RuntimeException
+     * @throws FileSystemException
+     */
+    private function canEmulateAdminhtmlArea(): bool
+    {
+        return $this->deploymentConfig->isAvailable()
+            && in_array(Area::AREA_ADMINHTML, $this->areaList->getCodes());
+    }
 }
diff --git a/app/code/Magento/Deploy/Test/Unit/Console/Command/App/ConfigImportCommandTest.php b/app/code/Magento/Deploy/Test/Unit/Console/Command/App/ConfigImportCommandTest.php
@@ -7,8 +7,11 @@
 
 namespace Magento\Deploy\Test\Unit\Console\Command\App;
 
+use Magento\Config\Console\Command\EmulatedAdminhtmlAreaProcessor;
 use Magento\Deploy\Console\Command\App\ConfigImport\Processor;
 use Magento\Deploy\Console\Command\App\ConfigImportCommand;
+use Magento\Framework\App\AreaList;
+use Magento\Framework\App\DeploymentConfig;
 use Magento\Framework\Console\Cli;
 use Magento\Framework\Exception\RuntimeException;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -27,16 +30,37 @@ class ConfigImportCommandTest extends TestCase
      */
     private $commandTester;
 
+    /**
+     * @var DeploymentConfig|MockObject
+     */
+    private $deploymentConfigMock;
+
+    /**
+     * @var EmulatedAdminhtmlAreaProcessor|MockObject
+     */
+    private $adminhtmlAreaProcessorMock;
+
+    /**
+     * @var AreaList|MockObject
+     */
+    private $areaListMock;
+
     /**
      * @return void
      */
     protected function setUp(): void
     {
-        $this->processorMock = $this->getMockBuilder(Processor::class)
-            ->disableOriginalConstructor()
-            ->getMock();
+        $this->processorMock = $this->createMock(Processor::class);
+        $this->deploymentConfigMock = $this->createMock(DeploymentConfig::class);
+        $this->adminhtmlAreaProcessorMock = $this->createMock(EmulatedAdminhtmlAreaProcessor::class);
+        $this->areaListMock = $this->createMock(AreaList::class);
 
-        $configImportCommand = new ConfigImportCommand($this->processorMock);
+        $configImportCommand = new ConfigImportCommand(
+            $this->processorMock,
+            $this->deploymentConfigMock,
+            $this->adminhtmlAreaProcessorMock,
+            $this->areaListMock
+        );
 
         $this->commandTester = new CommandTester($configImportCommand);
     }
@@ -46,6 +70,13 @@ protected function setUp(): void
      */
     public function testExecute()
     {
+        $this->deploymentConfigMock->expects($this->once())->method('isAvailable')->willReturn(true);
+        $this->adminhtmlAreaProcessorMock->expects($this->once())
+            ->method('process')->willReturnCallback(function (callable $callback, array $params = []) {
+                return $callback(...$params);
+            });
+        $this->areaListMock->expects($this->once())->method('getCodes')->willReturn(['adminhtml']);
+
         $this->processorMock->expects($this->once())
             ->method('execute');
 
@@ -57,11 +88,48 @@ public function testExecute()
      */
     public function testExecuteWithException()
     {
+        $this->deploymentConfigMock->expects($this->once())->method('isAvailable')->willReturn(true);
+        $this->adminhtmlAreaProcessorMock->expects($this->once())
+            ->method('process')->willReturnCallback(function (callable $callback, array $params = []) {
+                return $callback(...$params);
+            });
+        $this->areaListMock->expects($this->once())->method('getCodes')->willReturn(['adminhtml']);
+
         $this->processorMock->expects($this->once())
             ->method('execute')
             ->willThrowException(new RuntimeException(__('Some error')));
 
         $this->assertSame(Cli::RETURN_FAILURE, $this->commandTester->execute([]));
         $this->assertStringContainsString('Some error', $this->commandTester->getDisplay());
     }
+
+    /**
+     * @return void
+     */
+    public function testExecuteWithDeploymentConfigNotAvailable()
+    {
+        $this->deploymentConfigMock->expects($this->once())->method('isAvailable')->willReturn(false);
+        $this->adminhtmlAreaProcessorMock->expects($this->never())->method('process');
+        $this->areaListMock->expects($this->never())->method('getCodes');
+
+        $this->processorMock->expects($this->once())
+            ->method('execute');
+
+        $this->assertSame(Cli::RETURN_SUCCESS, $this->commandTester->execute([]));
+    }
+
+    /**
+     * @return void
+     */
+    public function testExecuteWithMissingAdminhtmlLocale()
+    {
+        $this->deploymentConfigMock->expects($this->once())->method('isAvailable')->willReturn(true);
+        $this->adminhtmlAreaProcessorMock->expects($this->never())->method('process');
+        $this->areaListMock->expects($this->once())->method('getCodes')->willReturn([]);
+
+        $this->processorMock->expects($this->once())
+            ->method('execute');
+
+        $this->assertSame(Cli::RETURN_SUCCESS, $this->commandTester->execute([]));
+    }
 }
diff --git a/app/code/Magento/Deploy/etc/di.xml b/app/code/Magento/Deploy/etc/di.xml
@@ -35,6 +35,12 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Deploy\Console\Command\App\ConfigImportCommand">
+        <arguments>
+            <argument name="adminhtmlAreaProcessor" xsi:type="object">Magento\Config\Console\Command\EmulatedAdminhtmlAreaProcessor\Proxy</argument>
+            <argument name="areaList" xsi:type="object">Magento\Framework\App\AreaList\Proxy</argument>
+        </arguments>
+    </type>
     <type name="Magento\Deploy\Model\Filesystem">
         <arguments>
             <argument name="shell" xsi:type="object">Magento\Framework\App\Shell</argument>
