ACP2E-1999: add possibility to translate config error messages by emulating default theme (backend) and locale (en_US).

Author: alzota

app/code/Magento/Config/Console/Command/ConfigShowCommand.php

@@ -93,13 +93,19 @@ class ConfigShowCommand extends Command
      */
     private $emulatedAreaProcessor;
 
+    /**
+     * @var LocaleEmulatorInterface|mixed
+     */
+    private mixed $localeEmulator;
+
     /**
      * @param ValidatorInterface $scopeValidator
      * @param ConfigSourceInterface $configSource
      * @param ConfigPathResolver $pathResolver
      * @param ValueProcessor $valueProcessor
      * @param PathValidatorFactory|null $pathValidatorFactory
      * @param EmulatedAdminhtmlAreaProcessor|null $emulatedAreaProcessor
+     * @param LocaleEmulatorInterface|null $localeEmulator
      * @internal param ScopeConfigInterface $appConfig
      */
     public function __construct(
@@ -108,7 +114,8 @@ public function __construct(
         ConfigPathResolver $pathResolver,
         ValueProcessor $valueProcessor,
         ?PathValidatorFactory $pathValidatorFactory = null,
-        ?EmulatedAdminhtmlAreaProcessor $emulatedAreaProcessor = null
+        ?EmulatedAdminhtmlAreaProcessor $emulatedAreaProcessor = null,
+        ?LocaleEmulatorInterface $localeEmulator = null
     ) {
         parent::__construct();
         $this->scopeValidator = $scopeValidator;
@@ -119,6 +126,8 @@ public function __construct(
             ?: ObjectManager::getInstance()->get(PathValidatorFactory::class);
         $this->emulatedAreaProcessor = $emulatedAreaProcessor
             ?: ObjectManager::getInstance()->get(EmulatedAdminhtmlAreaProcessor::class);
+        $this->localeEmulator = $localeEmulator
+            ?: ObjectManager::getInstance()->get(LocaleEmulatorInterface::class);
     }
 
     /**
@@ -194,7 +203,9 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->outputResult($output, $configValue, $this->inputPath);
             return Cli::RETURN_SUCCESS;
         } catch (\Exception $e) {
-            $output->writeln(sprintf('<error>%s</error>', $e->getMessage()));
+            $this->localeEmulator->emulate(
+                fn () => $output->writeln(sprintf('<error>%s</error>', __($e->getMessage()))),
+            );
             return Cli::RETURN_FAILURE;
         }
     }

app/code/Magento/Config/Console/Command/LocaleEmulator.php

@@ -0,0 +1,68 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Config\Console\Command;
+
+use Magento\Framework\Locale\ResolverInterface;
+use Magento\Framework\Phrase;
+use Magento\Framework\Phrase\RendererInterface;
+use Magento\Framework\TranslateInterface;
+use Magento\Theme\Model\View\Design;
+
+class LocaleEmulator implements LocaleEmulatorInterface
+{
+    /**
+     * @var bool
+     */
+    private bool $isEmulating = false;
+
+    /**
+     * @param TranslateInterface $translate
+     * @param RendererInterface $phraseRenderer
+     * @param ResolverInterface $localeResolver
+     * @param ResolverInterface $defaultLocaleResolver
+     */
+    public function __construct(
+        private readonly TranslateInterface $translate,
+        private readonly RendererInterface $phraseRenderer,
+        private readonly ResolverInterface $localeResolver,
+        private readonly ResolverInterface $defaultLocaleResolver,
+        private readonly Design $design
+    ) {
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function emulate(callable $callback, ?string $locale = null): mixed
+    {
+        if ($this->isEmulating) {
+            return $callback();
+        }
+        $this->isEmulating = true;
+        $locale ??= $this->defaultLocaleResolver->getLocale();
+        $initialLocale = $this->localeResolver->getLocale();
+        $initialPhraseRenderer = Phrase::getRenderer();
+        $initialTheme = $this->design->getDesignTheme();
+        Phrase::setRenderer($this->phraseRenderer);
+        $this->design->setDefaultDesignTheme();
+        $this->localeResolver->setLocale($locale);
+        $this->translate->setLocale($locale);
+        $this->translate->loadData();
+        try {
+            $result = $callback();
+        } finally {
+            Phrase::setRenderer($initialPhraseRenderer);
+            $this->design->setDesignTheme($initialTheme);
+            $this->localeResolver->setLocale($initialLocale);
+            $this->translate->setLocale($initialLocale);
+            $this->translate->loadData();
+            $this->isEmulating = false;
+        }
+        return $result;
+    }
+}

app/code/Magento/Config/Console/Command/LocaleEmulatorInterface.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Config\Console\Command;
+
+/**
+ * Locale emulator for import and export
+ */
+interface LocaleEmulatorInterface
+{
+    /**
+     * Emulates given $locale during execution of $callback
+     *
+     * @param callable $callback
+     * @param string|null $locale
+     * @return mixed
+     */
+    public function emulate(callable $callback, ?string $locale = null): mixed;
+}

app/code/Magento/Config/etc/di.xml

@@ -11,6 +11,7 @@
     <preference for="Magento\Framework\App\Config\ConfigResource\ConfigInterface" type="Magento\Config\Model\ResourceModel\Config" />
     <preference for="Magento\Framework\App\Config\CommentParserInterface" type="Magento\Config\Model\Config\Parser\Comment" />
     <preference for="Magento\Config\Model\Config\Structure\ElementVisibilityInterface" type="Magento\Config\Model\Config\Structure\ElementVisibilityComposite" />
+    <preference for="Magento\Config\Console\Command\LocaleEmulatorInterface" type="Magento\Config\Console\Command\LocaleEmulator\Proxy" />
     <type name="Magento\Config\Model\Config\Structure\ElementVisibilityComposite">
         <arguments>
             <argument name="visibility" xsi:type="array">