Merge pull request #803 from magento-tango/MAGETWO-62660

magicbunneh · web-flow · commit 24cd0c3b2330 · 2017-02-08T17:34:13.000+02:00
Bug fixes: * MAGETWO-62660: [GitHub] Overly aggressive performance optimizations of the static content deployment #7862
diff --git a/app/code/Magento/Deploy/Model/Deploy/JsDictionaryDeploy.php b/app/code/Magento/Deploy/Model/Deploy/JsDictionaryDeploy.php
@@ -0,0 +1,89 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Deploy\Model\Deploy;
+
+use Magento\Framework\App\View\Asset\Publisher;
+use Magento\Framework\View\Asset\Repository;
+use Magento\Framework\Translate\Js\Config as TranslationJsConfig;
+use Magento\Framework\TranslateInterface;
+use Magento\Framework\Console\Cli;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Deploy class for js dictionary
+ */
+class JsDictionaryDeploy implements DeployInterface
+{
+    /**
+     * @var Repository
+     */
+    private $assetRepo;
+
+    /**
+     * @var Publisher
+     */
+    private $assetPublisher;
+
+    /**
+     * @var TranslationJsConfig
+     */
+    private $translationJsConfig;
+
+    /**
+     * @var TranslateInterface
+     */
+    private $translator;
+
+    /**
+     * @var OutputInterface
+     */
+    private $output;
+
+    /**
+     * @param Repository $assetRepo
+     * @param Publisher $assetPublisher
+     * @param TranslationJsConfig $translationJsConfig
+     * @param TranslateInterface $translator
+     * @param OutputInterface $output
+     */
+    public function __construct(
+        Repository $assetRepo,
+        Publisher $assetPublisher,
+        TranslationJsConfig $translationJsConfig,
+        TranslateInterface $translator,
+        OutputInterface $output
+    ) {
+        $this->assetRepo = $assetRepo;
+        $this->assetPublisher = $assetPublisher;
+        $this->translationJsConfig = $translationJsConfig;
+        $this->translator = $translator;
+        $this->output = $output;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function deploy($area, $themePath, $locale)
+    {
+        $this->translator->setLocale($locale);
+        $this->translator->loadData($area, true);
+
+        $asset = $this->assetRepo->createAsset(
+            $this->translationJsConfig->getDictionaryFileName(),
+            ['area' => $area, 'theme' => $themePath, 'locale' => $locale]
+        );
+        if ($this->output->isVeryVerbose()) {
+            $this->output->writeln("\tDeploying the file to '{$asset->getPath()}'");
+        } else {
+            $this->output->write('.');
+        }
+
+        $this->assetPublisher->publish($asset);
+
+        return Cli::RETURN_SUCCESS;
+    }
+}
diff --git a/app/code/Magento/Deploy/Model/Deploy/LocaleQuickDeploy.php b/app/code/Magento/Deploy/Model/Deploy/LocaleQuickDeploy.php
@@ -6,16 +6,21 @@
 
 namespace Magento\Deploy\Model\Deploy;
 
-use Magento\Deploy\Model\DeployManager;
 use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\App\Utility\Files;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 use Magento\Framework\Console\Cli;
 use Magento\Deploy\Console\Command\DeployStaticOptionsInterface as Options;
-use \Magento\Framework\RequireJs\Config as RequireJsConfig;
+use Magento\Framework\RequireJs\Config as RequireJsConfig;
+use Magento\Framework\Translate\Js\Config as TranslationJsConfig;
+use Magento\Framework\App\ObjectManager;
+use Magento\Deploy\Model\DeployStrategyFactory;
 
+/**
+ * To avoid duplication of deploying of all static content per each theme/local, this class uses copying/symlinking
+ * of default static files to other locales, separately calls deploy for js dictionary per each locale
+ */
 class LocaleQuickDeploy implements DeployInterface
 {
     /**
@@ -38,16 +43,42 @@ class LocaleQuickDeploy implements DeployInterface
      */
     private $options = [];
 
+    /**
+     * @var TranslationJsConfig
+     */
+    private $translationJsConfig;
+
+    /**
+     * @var DeployStrategyFactory
+     */
+    private $deployStrategyFactory;
+
+    /**
+     * @var DeployInterface[]
+     */
+    private $deploys;
+
     /**
      * @param Filesystem $filesystem
      * @param OutputInterface $output
      * @param array $options
+     * @param TranslationJsConfig $translationJsConfig
+     * @param DeployStrategyFactory $deployStrategyFactory
      */
-    public function __construct(\Magento\Framework\Filesystem $filesystem, OutputInterface $output, $options = [])
-    {
+    public function __construct(
+        Filesystem $filesystem,
+        OutputInterface $output,
+        $options = [],
+        TranslationJsConfig $translationJsConfig = null,
+        DeployStrategyFactory $deployStrategyFactory = null
+    ) {
         $this->filesystem = $filesystem;
         $this->output = $output;
         $this->options = $options;
+        $this->translationJsConfig = $translationJsConfig
+            ?: ObjectManager::getInstance()->get(TranslationJsConfig::class);
+        $this->deployStrategyFactory = $deployStrategyFactory
+            ?: ObjectManager::getInstance()->get(DeployStrategyFactory::class);
     }
 
     /**
@@ -67,13 +98,13 @@ private function getStaticDirectory()
      */
     public function deploy($area, $themePath, $locale)
     {
-        if (isset($this->options[Options::DRY_RUN]) && $this->options[Options::DRY_RUN]) {
+        if (!empty($this->options[Options::DRY_RUN])) {
             return Cli::RETURN_SUCCESS;
         }
 
         $this->output->writeln("=== {$area} -> {$themePath} -> {$locale} ===");
 
-        if (!isset($this->options[self::DEPLOY_BASE_LOCALE])) {
+        if (empty($this->options[self::DEPLOY_BASE_LOCALE])) {
             throw new \InvalidArgumentException('Deploy base locale must be set for Quick Deploy');
         }
         $processedFiles = 0;
@@ -88,7 +119,7 @@ public function deploy($area, $themePath, $locale)
         $this->deleteLocaleResource($newLocalePath);
         $this->deleteLocaleResource($newRequireJsPath);
 
-        if (isset($this->options[Options::SYMLINK_LOCALE]) && $this->options[Options::SYMLINK_LOCALE]) {
+        if (!empty($this->options[Options::SYMLINK_LOCALE])) {
             $this->getStaticDirectory()->createSymlink($baseLocalePath, $newLocalePath);
             $this->getStaticDirectory()->createSymlink($baseRequireJsPath, $newRequireJsPath);
 
@@ -98,20 +129,61 @@ public function deploy($area, $themePath, $locale)
                 $this->getStaticDirectory()->readRecursively($baseLocalePath),
                 $this->getStaticDirectory()->readRecursively($baseRequireJsPath)
             );
+            $jsDictionaryEnabled = $this->translationJsConfig->dictionaryEnabled();
             foreach ($localeFiles as $path) {
                 if ($this->getStaticDirectory()->isFile($path)) {
-                    $destination = $this->replaceLocaleInPath($path, $baseLocale, $locale);
-                    $this->getStaticDirectory()->copyFile($path, $destination);
-                    $processedFiles++;
+                    if (!$jsDictionaryEnabled || !$this->isJsDictionary($path)) {
+                        $destination = $this->replaceLocaleInPath($path, $baseLocale, $locale);
+                        $this->getStaticDirectory()->copyFile($path, $destination);
+                        $processedFiles++;
+                    }
                 }
             }
 
+            if ($jsDictionaryEnabled) {
+                $this->getDeploy(
+                    DeployStrategyFactory::DEPLOY_STRATEGY_JS_DICTIONARY,
+                    [
+                        'output' => $this->output,
+                        'translationJsConfig' => $this->translationJsConfig
+                    ]
+                )
+                ->deploy($area, $themePath, $locale);
+                $processedFiles++;
+            }
+
             $this->output->writeln("\nSuccessful copied: {$processedFiles} files; errors: {$errorAmount}\n---\n");
         }
 
         return Cli::RETURN_SUCCESS;
     }
 
+    /**
+     * Get deploy strategy according to required strategy
+     *
+     * @param string $strategy
+     * @param array $params
+     * @return DeployInterface
+     */
+    private function getDeploy($strategy, $params)
+    {
+        if (empty($this->deploys[$strategy])) {
+            $this->deploys[$strategy] = $this->deployStrategyFactory->create($strategy, $params);
+        }
+        return $this->deploys[$strategy];
+    }
+
+    /**
+     * Define if provided path is js dictionary
+     *
+     * @param string $path
+     * @return bool
+     */
+    private function isJsDictionary($path)
+    {
+        return strpos($path, $this->translationJsConfig->getDictionaryFileName()) !== false;
+    }
+
     /**
      * @param string $path
      * @return void
diff --git a/app/code/Magento/Deploy/Model/DeployStrategyFactory.php b/app/code/Magento/Deploy/Model/DeployStrategyFactory.php
@@ -22,6 +22,11 @@ class DeployStrategyFactory
      */
     const DEPLOY_STRATEGY_QUICK = 'quick';
 
+    /**
+     * Strategy for deploying js dictionary
+     */
+    const DEPLOY_STRATEGY_JS_DICTIONARY = 'js-dictionary';
+
     /**
      * @param ObjectManagerInterface $objectManager
      */
@@ -41,6 +46,7 @@ public function create($type, array $arguments = [])
         $strategyMap = [
             self::DEPLOY_STRATEGY_STANDARD => Deploy\LocaleDeploy::class,
             self::DEPLOY_STRATEGY_QUICK => Deploy\LocaleQuickDeploy::class,
+            self::DEPLOY_STRATEGY_JS_DICTIONARY => Deploy\JsDictionaryDeploy::class
         ];
 
         if (!isset($strategyMap[$type])) {
diff --git a/app/code/Magento/Deploy/Test/Unit/Model/Deploy/JsDictionaryDeployTest.php b/app/code/Magento/Deploy/Test/Unit/Model/Deploy/JsDictionaryDeployTest.php
@@ -0,0 +1,103 @@
+<?php
+/**
+ * Copyright © 2013-2017 Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+namespace Magento\Deploy\Test\Unit\Model\Deploy;
+
+use Symfony\Component\Console\Output\OutputInterface;
+use Magento\Framework\Translate\Js\Config as TranslationJsConfig;
+use Magento\Framework\TranslateInterface;
+use Magento\Framework\View\Asset\Repository;
+use Magento\Framework\View\Asset\LocalInterface as Asset;
+use Magento\Framework\App\View\Asset\Publisher;
+use Magento\Deploy\Model\Deploy\JsDictionaryDeploy;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+
+class JsDictionaryDeployTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var TranslationJsConfig|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $translationJsConfig;
+
+    /**
+     * @var TranslateInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $translator;
+
+    /**
+     * @var Repository|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $assetRepo;
+
+    /**
+     * @var Asset|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $asset;
+
+    /**
+     * @var Publisher|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $assetPublisher;
+
+    /**
+     * @var JsDictionaryDeploy
+     */
+    private $model;
+
+    /**
+     * @var OutputInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $output;
+
+    protected function setUp()
+    {
+        $this->output = $this->getMockBuilder(OutputInterface::class)
+            ->setMethods(['writeln', 'isVeryVerbose'])
+            ->getMockForAbstractClass();
+
+        $this->translationJsConfig = $this->getMock(TranslationJsConfig::class, [], [], '', false);
+        $this->translator = $this->getMockForAbstractClass(TranslateInterface::class, [], '', false, false, true);
+        $this->assetRepo = $this->getMock(Repository::class, [], [], '', false);
+        $this->asset = $this->getMockForAbstractClass(Asset::class, [], '', false, false, true);
+        $this->assetPublisher = $this->getMock(Publisher::class, [], [], '', false);
+
+        $this->model = (new ObjectManager($this))->getObject(
+            JsDictionaryDeploy::class,
+            [
+                'translationJsConfig' => $this->translationJsConfig,
+                'translator' => $this->translator,
+                'assetRepo' => $this->assetRepo,
+                'assetPublisher' => $this->assetPublisher,
+                'output' => $this->output
+            ]
+        );
+    }
+
+    public function testDeploy()
+    {
+        $area = 'adminhtml';
+        $themePath = 'Magento/backend';
+        $locale = 'uk_UA';
+
+        $dictionary = 'js-translation.json';
+
+        $this->translationJsConfig->expects(self::once())->method('getDictionaryFileName')
+            ->willReturn($dictionary);
+
+        $this->translator->expects($this->once())->method('setLocale')->with($locale);
+        $this->translator->expects($this->once())->method('loadData')->with($area, true);
+
+        $this->assetRepo->expects($this->once())->method('createAsset')
+            ->with(
+                $dictionary,
+                ['area' => $area, 'theme' => $themePath, 'locale' => $locale]
+            )
+            ->willReturn($this->asset);
+
+        $this->assetPublisher->expects($this->once())->method('publish');
+
+        $this->model->deploy($area, $themePath, $locale);
+    }
+}
diff --git a/app/code/Magento/Deploy/Test/Unit/Model/Deploy/LocaleQuickDeployTest.php b/app/code/Magento/Deploy/Test/Unit/Model/Deploy/LocaleQuickDeployTest.php
