Bug fix: how to translate Knockout templates in the app/code/Magento/Ui/view/base/web/templates folder

dmitry_fedyuk · September 4, 2015, 2:17pm

The templates in app/code/Magento/Ui/view/base/web/templates are not translatable despite of bind-attr i18n usage.
This is because of 2 Magento core bugs.

Bug №1

The templates resides in the templates folder, but Magento 2 core (the \Magento\Framework\App\Utility\Files::getStaticHtmlFiles() method) does not look into folders names templates folders, it looks into template folders:

github.com

magento/magento2/blob/c59d124fcd5a8d90ac6cc08995c27f75a57453ff/lib/internal/Magento/Framework/App/Utility/Files.php#L540-L547


$files = self::getFiles(
    [
        "{$this->_path}/app/code/{$namespace}/{$module}/view/{$area}/web/template",
        "{$this->_path}/app/design/{$area}/{$themePath}/web/template",
        "{$this->_path}/app/design/{$area}/{$themePath}/{$module}/web/template"
    ],
    '*.html'
);

To fix the first bug, just add a new globbing pattern:

"{$this->_path}/app/code/{$namespace}/{$module}/view/{$area}/web/templates",

Bug №2

There is the second bug: Magento 2 core (the \Magento\Translation\Model\Js\DataProvider::getData() method) does not look into base area folder:

github.com

magento/magento2/blob/c59d124fcd5a8d90ac6cc08995c27f75a57453ff/app/code/Magento/Translation/Model/Js/DataProvider.php#L73-L82


$areaCode = $this->appState->getAreaCode();


$files = $this->filesUtility->getJsFiles($areaCode, $themePath);
$staticHtmlFiles = $this->filesUtility->getStaticHtmlFiles($areaCode, $themePath);


if (is_array($staticHtmlFiles)) {
    foreach ($staticHtmlFiles as $staticFile) {
        $files[] = $staticFile;
    }
}

As you can see it looks only to the current design area: frontend or adminthml, but not base.
To fix it add the code:

$staticHtmlFilesFromBase = $this->filesUtility->getStaticHtmlFiles('base', $themePath);
if (is_array($staticHtmlFilesFromBase)) {
	$files = array_merge($files, $staticHtmlFilesFromBase);
}

Place it just after the line:

github.com

magento/magento2/blob/c59d124fcd5a8d90ac6cc08995c27f75a57453ff/app/code/Magento/Translation/Model/Js/DataProvider.php#L75


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


    $files = $this->filesUtility->getJsFiles($areaCode, $themePath);
    $staticHtmlFiles = $this->filesUtility->getStaticHtmlFiles($areaCode, $themePath);


    if (is_array($staticHtmlFiles)) {
        foreach ($staticHtmlFiles as $staticFile) {
            $files[] = $staticFile;
        }
    }


    foreach ($files as $filePath) {
        $content = $this->rootDirectory->readFile($this->rootDirectory->getRelativePath($filePath[0]));

GitHub issue 1791.

dmitry_fedyuk · October 21, 2015, 11:08pm

After 2 months the bug is not fixed yet, but the core code has been changed significantly so here is my new fix for the current core code:

Step 1

github.com

magento/magento2/blob/0be91a56d050791ac0b67a47185d79df31e79329/lib/internal/Magento/Framework/App/Utility/Files.php#L752


{
    $key = $area . $themePath . $namespace . $module . __METHOD__ . BP;
    if (isset(self::$_cache[$key])) {
        return self::$_cache[$key];
    }
    $moduleTemplatePaths = [];
    foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleName => $moduleDir) {
        $keyInfo = explode('_', $moduleName);
        if ($keyInfo[0] == $namespace || $namespace == '*') {
            if ($keyInfo[1] == $module || $module == '*') {
                $moduleTemplatePaths[] = $moduleDir . "/view/{$area}/web/template";
            }
        }
    }
    $themePaths = $this->getThemePaths($area, $namespace . '_' . $module, '/web/template');
    $files = self::getFiles(
        array_merge(
            $themePaths,
            $moduleTemplatePaths
        ),
        '*.html'

Add after:

$moduleTemplatePaths[] = $moduleDir . "/view/{$area}/web/templates";

Step 2

github.com

magento/magento2/blob/0be91a56d050791ac0b67a47185d79df31e79329/lib/internal/Magento/Framework/App/Utility/Files.php#L756


}
$moduleTemplatePaths = [];
foreach ($this->componentRegistrar->getPaths(ComponentRegistrar::MODULE) as $moduleName => $moduleDir) {
    $keyInfo = explode('_', $moduleName);
    if ($keyInfo[0] == $namespace || $namespace == '*') {
        if ($keyInfo[1] == $module || $module == '*') {
            $moduleTemplatePaths[] = $moduleDir . "/view/{$area}/web/template";
        }
    }
}
$themePaths = $this->getThemePaths($area, $namespace . '_' . $module, '/web/template');
$files = self::getFiles(
    array_merge(
        $themePaths,
        $moduleTemplatePaths
    ),
    '*.html'
);
$result = self::composeDataSets($files);
self::$_cache[$key] = $result;
return $result;

Replace the line with the following code:

$themePaths = array_merge(
	$this->getThemePaths($area, $namespace . '_' . $module, '/web/template')
	,$this->getThemePaths($area, $namespace . '_' . $module, '/web/templates')
);

nirgoldman · February 29, 2016, 8:48am

Is it fix?

dmitry_fedyuk · February 29, 2016, 1:48pm

My latest fix was for October 2015 pre-prelease code.
You can test it yourself whether the fix works with the latest code.