How is a JavaScript translation dictionary («js-translation.json») generated on the static assets deployment («bin/magento setup:static-content:deploy»)?

dmitry_fedyuk (Dmitrii Fediuk) September 17, 2017, 5:07am 1

1. Magento\Setup\Console\Command\DeployStaticContentCommand::execute()

github.com

magento/magento2/blob/2.2.0-rc3.0/setup/src/Magento/Setup/Console/Command/DeployStaticContentCommand.php#L140-L140


$deployService->deploy($options);

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/setup/src/Magento/Setup/Console/Command/DeployStaticContentCommand.php#L98-L147


/**
 * {@inheritdoc}
 * @throws \InvalidArgumentException
 * @throws LocalizedException
 */
protected function execute(InputInterface $input, OutputInterface $output)
{
    $time = microtime(true);


    if (!$input->getOption(Options::FORCE_RUN) && $this->getAppState()->getMode() !== State::MODE_PRODUCTION) {
        throw new LocalizedException(
            __(
                'NOTE: Manual static content deployment is not required in "default" and "developer" modes.'
                . PHP_EOL . 'In "default" and "developer" modes static contents are being deployed '
                . 'automatically on demand.'
                . PHP_EOL . 'If you still want to deploy in these modes, use -f option: '
                . "'bin/magento setup:static-content:deploy -f'"
            )
        );
    }


    $this->inputValidator->validate($input);


    $options = $input->getOptions();
    $options[Options::LANGUAGE] = $input->getArgument(Options::LANGUAGES_ARGUMENT) ?: ['all'];
    $refreshOnly = isset($options[Options::REFRESH_CONTENT_VERSION_ONLY])
        && $options[Options::REFRESH_CONTENT_VERSION_ONLY];


    $verbose = $output->getVerbosity() > 1 ? $output->getVerbosity() : OutputInterface::VERBOSITY_VERBOSE;


    $logger = $this->consoleLoggerFactory->getLogger($output, $verbose);
    if (!$refreshOnly) {
        $logger->alert(PHP_EOL . "Deploy using {$options[Options::STRATEGY]} strategy");
    }


    $this->mockCache();


    /** @var DeployStaticContent $deployService */
    $deployService = $this->objectManager->create(DeployStaticContent::class, [
        'logger' => $logger
    ]);


    $deployService->deploy($options);


    if (!$refreshOnly) {
        $logger->alert(PHP_EOL . "Execution time: " . (microtime(true) - $time));
    }


    return \Magento\Framework\Console\Cli::RETURN_SUCCESS;
}

2. Magento\Deploy\Service\DeployStaticContent::deploy()

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployStaticContent.php#L124-L124


$deployI18n->deploy($package->getArea(), $package->getTheme(), $package->getLocale());

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployStaticContent.php#L70-L133


/**
 * Run deploy procedure
 *
 * @param array $options
 * @return void
 */
public function deploy(array $options)
{
    $version = !empty($options[Options::CONTENT_VERSION]) && is_string($options[Options::CONTENT_VERSION])
        ? $options[Options::CONTENT_VERSION]
        : (new \DateTime())->getTimestamp();
    $this->versionStorage->save($version);


    if ($this->isRefreshContentVersionOnly($options)) {
        $this->logger->warning("New content version: " . $version);
        return;
    }


    $queue = $this->queueFactory->create(
        [
            'logger' => $this->logger,
            'options' => $options,
            'maxProcesses' => $this->getProcessesAmount($options),
            'deployPackageService' => $this->objectManager->create(
                \Magento\Deploy\Service\DeployPackage::class,
                [
                    'logger' => $this->logger
                ]
            )
        ]
    );


    $deployStrategy = $this->deployStrategyFactory->create(
        $options[Options::STRATEGY],
        [
            'queue' => $queue
        ]
    );


    $packages = $deployStrategy->deploy($options);


    if ($options[Options::NO_JAVASCRIPT] !== true) {
        $deployRjsConfig = $this->objectManager->create(DeployRequireJsConfig::class, [
            'logger' => $this->logger
        ]);
        $deployI18n = $this->objectManager->create(DeployTranslationsDictionary::class, [
            'logger' => $this->logger
        ]);
        $deployBundle = $this->objectManager->create(Bundle::class, [
            'logger' => $this->logger
        ]);
        foreach ($packages as $package) {
            if (!$package->isVirtual()) {
                $deployRjsConfig->deploy($package->getArea(), $package->getTheme(), $package->getLocale());
                $deployI18n->deploy($package->getArea(), $package->getTheme(), $package->getLocale());
                $deployBundle->deploy($package->getArea(), $package->getTheme(), $package->getLocale());
            }
        }
    }


    if ($options[Options::NO_HTML_MINIFY] !== true) {
        $this->objectManager->get(MinifyTemplates::class)->minifyTemplates();
    }
}

3. Magento\Deploy\Service\DeployTranslationsDictionary::deploy()

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployTranslationsDictionary.php#L64-L74


$this->state->emulateAreaCode($area, function () use ($area, $theme, $locale) {
    $this->deployStaticFile->deployFile(
        $this->jsTranslationConfig->getDictionaryFileName(),
        [
            'fileName' => $this->jsTranslationConfig->getDictionaryFileName(),
            'area' => $area,
            'theme' => $theme,
            'locale' => $locale
        ]
    );
});

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployTranslationsDictionary.php#L55-L78


/**
 * @param string $area
 * @param string $theme
 * @param string $locale
 * @return void
 */
public function deploy($area, $theme, $locale)
{
    try {
        $this->state->emulateAreaCode($area, function () use ($area, $theme, $locale) {
            $this->deployStaticFile->deployFile(
                $this->jsTranslationConfig->getDictionaryFileName(),
                [
                    'fileName' => $this->jsTranslationConfig->getDictionaryFileName(),
                    'area' => $area,
                    'theme' => $theme,
                    'locale' => $locale
                ]
            );
        });
    } catch (\Exception $e) {
        $this->logger->error($e->getMessage());
    }
}

4. Magento\Framework\App\State::emulateAreaCode()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/App/State.php#L169-L195


/**
 * Emulate callback inside some area code
 *
 * @param string $areaCode
 * @param callable $callback
 * @param array $params
 * @return mixed
 * @throws \Exception
 */
public function emulateAreaCode($areaCode, $callback, $params = [])
{
    $this->checkAreaCode($areaCode);


    $currentArea = $this->_areaCode;
    $this->_areaCode = $areaCode;
    $this->_isAreaCodeEmulated = true;
    try {
        $result = call_user_func_array($callback, $params);
    } catch (\Exception $e) {
        $this->_areaCode = $currentArea;
        $this->_isAreaCodeEmulated = false;
        throw $e;
    }
    $this->_areaCode = $currentArea;
    $this->_isAreaCodeEmulated = false;
    return $result;
}

5. Magento\Deploy\Service\DeployTranslationsDictionary::deploy()

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployTranslationsDictionary.php#L65-L73


$this->deployStaticFile->deployFile(
    $this->jsTranslationConfig->getDictionaryFileName(),
    [
        'fileName' => $this->jsTranslationConfig->getDictionaryFileName(),
        'area' => $area,
        'theme' => $theme,
        'locale' => $locale
    ]
);

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployTranslationsDictionary.php#L55-L78


/**
 * @param string $area
 * @param string $theme
 * @param string $locale
 * @return void
 */
public function deploy($area, $theme, $locale)
{
    try {
        $this->state->emulateAreaCode($area, function () use ($area, $theme, $locale) {
            $this->deployStaticFile->deployFile(
                $this->jsTranslationConfig->getDictionaryFileName(),
                [
                    'fileName' => $this->jsTranslationConfig->getDictionaryFileName(),
                    'area' => $area,
                    'theme' => $theme,
                    'locale' => $locale
                ]
            );
        });
    } catch (\Exception $e) {
        $this->logger->error($e->getMessage());
    }
}

6. Magento\Deploy\Service\DeployStaticFile::deployFile()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Deploy/Service/DeployStaticFile.php#L79-L92


/**
 * @param string $fileName
 * @param array $params ['area' =>, 'theme' =>, 'locale' =>, 'module' =>]
 * @return string
 */
public function deployFile($fileName, array $params = [])
{
    $params['publish'] = true;
    $asset = $this->assetRepo->createAsset($this->resolveFile($fileName), $params);


    $this->assetPublisher->publish($asset);


    return $asset->getPath();
}

7. Magento\Framework\App\View\Asset\Publisher::publish()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/App/View/Asset/Publisher.php#L50-L62


/**
 * @param Asset\LocalInterface $asset
 * @return bool
 */
public function publish(Asset\LocalInterface $asset)
{
    $dir = $this->filesystem->getDirectoryRead(DirectoryList::STATIC_VIEW);
    if ($dir->isExist($asset->getPath())) {
        return true;
    }


    return $this->publishAsset($asset);
}

8. Magento\Framework\App\View\Asset\Publisher::publishAsset()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/App/View/Asset/Publisher.php#L64-L79


/**
 * Publish the asset
 *
 * @param Asset\LocalInterface $asset
 * @return bool
 */
private function publishAsset(Asset\LocalInterface $asset)
{
    $targetDir = $this->filesystem->getDirectoryWrite(DirectoryList::STATIC_VIEW);
    $fullSource = $asset->getSourceFile();
    $source = basename($fullSource);
    $sourceDir = $this->writeFactory->create(dirname($fullSource));
    $destination = $asset->getPath();
    $strategy = $this->materializationStrategyFactory->create($asset);
    return $strategy->publishFile($sourceDir, $targetDir, $source, $destination);
}

9. Magento\Framework\View\Asset\File::getSourceFile()

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/View/Asset/File.php#L157-L157


$this->resolvedFile = $this->source->getFile($this);

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/View/Asset/File.php#L150-L163


/**
 * {@inheritdoc}
 * @throws File\NotFoundException if file cannot be resolved
 */
public function getSourceFile()
{
    if (null === $this->resolvedFile) {
        $this->resolvedFile = $this->source->getFile($this);
        if (false === $this->resolvedFile) {
            throw new File\NotFoundException("Unable to resolve the source file for '{$this->getPath()}'");
        }
    }
    return $this->resolvedFile;
}

10. Magento\Framework\View\Asset\Source::getFile()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/View/Asset/Source.php#L97-L111


/**
 * Get absolute path to the asset file
 *
 * @param LocalInterface $asset
 * @return bool|string
 */
public function getFile(LocalInterface $asset)
{
    $result = $this->preProcess($asset);
    if (!$result) {
        return false;
    }
    list($dir, $path) = $result;
    return $this->readFactory->create($dir)->getAbsolutePath($path);
}

11. Magento\Framework\View\Asset\Source::preProcess()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/View/Asset/Source.php#L129-L165


/**
 * Perform necessary preprocessing and materialization when the specified asset is requested
 *
 * Returns an array of two elements:
 * - directory where the file is supposed to be found
 * - relative path to the file
 *
 * returns false if source file was not found
 *
 * @param LocalInterface $asset
 * @return array|bool
 */
private function preProcess(LocalInterface $asset)
{
    $sourceFile = $this->findSourceFile($asset);
    $dir = $this->rootDir->getAbsolutePath();
    $path = '';
    if ($sourceFile) {
        $path = basename($sourceFile);
        $dir = dirname($sourceFile);
    }


    $chain = $this->createChain($asset, $dir, $path);
    $this->preProcessorPool->process($chain);
    $chain->assertValid();
    if ($chain->isChanged()) {
        $dir = $this->tmpDir->getAbsolutePath();
        $path = $chain->getTargetAssetPath();
        $this->tmpDir->writeFile($path, $chain->getContent());
    }
    if (empty($path)) {
        $result = false;
    } else {
        $result = [$dir, $path, $chain->getContentType()];
    }
    return $result;
}

12. Magento\Framework\View\Asset\PreProcessor\Pool::process()

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/lib/internal/Magento/Framework/View/Asset/PreProcessor/Pool.php#L67-L79


/**
 * Execute preprocessors instances suitable to convert source content type into a destination one
 *
 * @param Chain $chain
 * @return void
 */
public function process(Chain $chain)
{
    $type = $chain->getTargetContentType();
    foreach ($this->getPreProcessors($type) as $preProcessor) {
        $preProcessor->process($chain);
    }
}

13. Magento\Translation\Model\Json\PreProcessor::process()

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Translation/Model/Json/PreProcessor.php#LL86-L86


$chain->setContent(json_encode($this->dataProvider->getData($themePath)));

Context:

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Translation/Model/Json/PreProcessor.php#L63-L89


/**
 * Transform content and/or content type for the specified preprocessing chain object
 *
 * @param Chain $chain
 * @return void
 */
public function process(Chain $chain)
{
    if ($this->isDictionaryPath($chain->getTargetAssetPath())) {
        $context = $chain->getAsset()->getContext();


        $themePath = '*/*';
        $areaCode = \Magento\Backend\App\Area\FrontNameResolver::AREA_CODE;


        if ($context instanceof FallbackContext) {
            $themePath = $context->getThemePath();
            $areaCode = $context->getAreaCode();
            $this->translate->setLocale($context->getLocale());
        }


        $area = $this->areaList->getArea($areaCode);
        $area->load(\Magento\Framework\App\Area::PART_TRANSLATE);


        $chain->setContent(json_encode($this->dataProvider->getData($themePath)));
        $chain->setContentType('json');
    }
}

14. Magento\Translation\Model\Js\DataProvider::getData()

github.com

magento/magento2/blob/2.2.0-rc3.0/app/code/Magento/Translation/Model/Js/DataProvider.php#L85-L123


/**
 * Get translation data
 *
 * @param string $themePath
 * @return array
 * @throws \Exception
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function getData($themePath)
{
    $areaCode = $this->appState->getAreaCode();


    $files = array_merge(
        $this->filesUtility->getJsFiles('base', $themePath),
        $this->filesUtility->getJsFiles($areaCode, $themePath),
        $this->filesUtility->getStaticHtmlFiles('base', $themePath),
        $this->filesUtility->getStaticHtmlFiles($areaCode, $themePath)
    );


    $dictionary = [];
    foreach ($files as $filePath) {
        /** @var \Magento\Framework\Filesystem\File\Read $read */
        $read = $this->fileReadFactory->create($filePath[0], \Magento\Framework\Filesystem\DriverPool::FILE);
        $content = $read->readAll();
        foreach ($this->getPhrases($content) as $phrase) {
            try {
                $translatedPhrase = $this->translate->render([$phrase], []);
                if ($phrase != $translatedPhrase) {
                    $dictionary[$phrase] = $translatedPhrase;
                }
            } catch (\Exception $e) {
                throw new LocalizedException(
                    sprintf(__('Error while translating phrase "%s" in file %s.'), $phrase, $filePath[0])
                );
            }
        }
    }


    return $dictionary;

How is js-translation.json file generated?

dmitry_fedyuk (Dmitrii Fediuk) September 17, 2017, 5:13am 2

The previous analysis (written 2 years ago): How is js-translation.json file generated?

See also: