Use LanguageContext in ModuleRepository for better stability

jolelievre · Oct 22, 2024 · 914e290 · 914e290
1 parent 53d2b70
commit 914e290
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 23 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -2,7 +2,12 @@ parameters:
 	ignoreErrors:
 		-
 			message: "#^Namespace Context is forbidden, No legacy calls inside the prestashop bundle\\. Please create an interface and an adapter if you need to\\.$#"
-			count: 4
+			count: 5
+			path: src/Core/Addon/Module/ModuleManagerBuilder.php
+
+		-
+			message: "#^Namespace Language is forbidden, No legacy calls inside the prestashop bundle\\. Please create an interface and an adapter if you need to\\.$#"
+			count: 1
 			path: src/Core/Addon/Module/ModuleManagerBuilder.php
 
 		-
@@ -1050,16 +1055,6 @@ parameters:
 			count: 2
 			path: src/PrestaShopBundle/Controller/Admin/Improve/Design/MailThemeController.php
 
-		-
-			message: "#^Class Hook is forbidden, No legacy calls inside the prestashop bundle\\. Please create an interface and an adapter if you need to\\.$#"
-			count: 1
-			path: src/PrestaShopBundle/Controller/Admin/Improve/Design/PositionsController.php
-
-		-
-			message: "#^Namespace Hook is forbidden, No legacy calls inside the prestashop bundle\\. Please create an interface and an adapter if you need to\\.$#"
-			count: 1
-			path: src/PrestaShopBundle/Controller/Admin/Improve/Design/PositionsController.php
-
 		-
 			message: "#^Namespace Db is forbidden, No legacy calls inside the prestashop bundle\\. Please create an interface and an adapter if you need to\\.$#"
 			count: 2

diff --git a/src/Core/Addon/Module/ModuleManagerBuilder.php b/src/Core/Addon/Module/ModuleManagerBuilder.php
@@ -28,13 +28,15 @@
 
 use Context;
 use Doctrine\Common\Cache\Psr6\DoctrineProvider;
+use Language;
 use PrestaShop\PrestaShop\Adapter\HookManager;
 use PrestaShop\PrestaShop\Adapter\LegacyLogger;
 use PrestaShop\PrestaShop\Adapter\Module\AdminModuleDataProvider;
 use PrestaShop\PrestaShop\Adapter\Module\ModuleDataProvider;
 use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
 use PrestaShop\PrestaShop\Adapter\Tools;
 use PrestaShop\PrestaShop\Core\Context\ApiClientContext;
+use PrestaShop\PrestaShop\Core\Context\LanguageContext;
 use PrestaShop\PrestaShop\Core\Module\ModuleManager;
 use PrestaShop\PrestaShop\Core\Module\ModuleRepository;
 use PrestaShop\PrestaShop\Core\Module\SourceHandler\SourceHandlerFactory;
@@ -64,7 +66,14 @@ class ModuleManagerBuilder
     protected static $translator = null;
     protected static $instance = null;
     protected static $cacheProvider = null;
+    /**
+     * @var ApiClientContext
+     */
     protected static $apiClientContext;
+    /**
+     * @var LanguageContext|null
+     */
+    protected static $languageContext = null;
 
     /**
      * @var bool
@@ -128,7 +137,7 @@ public function buildRepository()
                     self::$cacheProvider,
                     new HookManager(),
                     _PS_MODULE_DIR_,
-                    Context::getContext()->language->id
+                    $this->getLanguageContext(),
                 );
             }
         }
@@ -197,6 +206,29 @@ private function getSymfonyRouter()
         return new Router($loader, $routeFileName);
     }
 
+    private function getLanguageContext(): LanguageContext
+    {
+        if (self::$languageContext) {
+            return self::$languageContext;
+        }
+
+        /** @var Language $language */
+        $language = Context::getContext()->language;
+        self::$languageContext = new LanguageContext(
+            $language->id,
+            $language->name,
+            $language->iso_code,
+            $language->locale,
+            $language->locale_code,
+            $language->is_rtl,
+            $language->date_format,
+            $language->date_format_full,
+            Context::getContext()->getCurrentLocale(),
+        );
+
+        return self::$languageContext;
+    }
+
     protected function getConfigDir()
     {
         return _PS_ROOT_DIR_ . '/app/config';

diff --git a/src/Core/Module/ModuleRepository.php b/src/Core/Module/ModuleRepository.php
@@ -35,6 +35,7 @@
 use PrestaShop\PrestaShop\Adapter\Module\AdminModuleDataProvider;
 use PrestaShop\PrestaShop\Adapter\Module\Module;
 use PrestaShop\PrestaShop\Adapter\Module\ModuleDataProvider;
+use PrestaShop\PrestaShop\Core\Context\LanguageContext;
 use PrestaShop\PrestaShop\Core\Domain\Module\Exception\ModuleNotFoundException;
 use Symfony\Component\Finder\Finder;
 use Throwable;
@@ -75,25 +76,19 @@ class ModuleRepository implements ModuleRepositoryInterface
     /** @var Module[] */
     private $modulesFromHook;
 
-    /**
-     * @var int
-     */
-    private $contextLangId;
-
     public function __construct(
         ModuleDataProvider $moduleDataProvider,
         AdminModuleDataProvider $adminModuleDataProvider,
         CacheProvider $cacheProvider,
         HookManager $hookManager,
         string $modulePath,
-        int $contextLangId
+        private LanguageContext $languageContext,
     ) {
         $this->moduleDataProvider = $moduleDataProvider;
         $this->adminModuleDataProvider = $adminModuleDataProvider;
         $this->cacheProvider = $cacheProvider;
         $this->hookManager = $hookManager;
         $this->modulePath = $modulePath;
-        $this->contextLangId = $contextLangId;
     }
 
     public function getList(): ModuleCollection
@@ -246,7 +241,7 @@ protected function getCacheKey(string $moduleName, ?int $shopId = null): string
     {
         $shop = $shopId ? [$shopId] : Shop::getContextListShopID();
 
-        return $moduleName . implode('-', $shop) . $this->contextLangId;
+        return $moduleName . implode('-', $shop) . $this->languageContext->getId();
     }
 
     private function getModuleAttributes(string $moduleName, bool $isValid): array

diff --git a/src/PrestaShopBundle/Install/Install.php b/src/PrestaShopBundle/Install/Install.php
@@ -56,8 +56,10 @@
 use PrestaShop\PrestaShop\Adapter\Entity\Tools;
 use PrestaShop\PrestaShop\Adapter\Entity\Validate;
 use PrestaShop\PrestaShop\Adapter\Module\Module;
+use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
 use PrestaShop\PrestaShop\Core\Addon\Module\ModuleManagerBuilder;
 use PrestaShop\PrestaShop\Core\Addon\Theme\ThemeManagerBuilder;
+use PrestaShop\PrestaShop\Core\Context\LanguageContextBuilder;
 use PrestaShop\PrestaShop\Core\Module\ConfigReader as ModuleConfigReader;
 use PrestaShop\PrestaShop\Core\Theme\ConfigReader as ThemeConfigReader;
 use PrestaShop\PrestaShop\Core\Version;
@@ -461,6 +463,13 @@ public function installDefaultData($shop_name, $iso_country = false, $all_langua
 
         Context::getContext()->language = new LanguageLegacy($id_lang);
 
+        // Init LanguageContext
+        $container = SymfonyContainer::getInstance();
+        if ($container && $container->has(LanguageContextBuilder::class)) {
+            $builder = $container->get(LanguageContextBuilder::class);
+            $builder->setLanguageId((int) $id_lang);
+        }
+
         return true;
     }
 

diff --git a/src/PrestaShopBundle/Resources/config/services/core/context.yml b/src/PrestaShopBundle/Resources/config/services/core/context.yml
@@ -17,7 +17,9 @@ services:
     lazy: true
     factory: [ '@PrestaShop\PrestaShop\Core\Context\EmployeeContextBuilder', 'build' ]
 
-  PrestaShop\PrestaShop\Core\Context\LanguageContextBuilder: ~
+  PrestaShop\PrestaShop\Core\Context\LanguageContextBuilder:
+    # Only public to make it available in Install process
+    public: true
   PrestaShop\PrestaShop\Core\Context\LanguageContext:
     lazy: true
     factory: [ '@PrestaShop\PrestaShop\Core\Context\LanguageContextBuilder', 'build' ]

diff --git a/src/PrestaShopBundle/Resources/config/services/core/module.yml b/src/PrestaShopBundle/Resources/config/services/core/module.yml
@@ -12,13 +12,13 @@ services:
 
   PrestaShop\PrestaShop\Core\Module\ModuleRepository:
     lazy: true
+    autowire: true
     arguments:
       - '@prestashop.adapter.data_provider.module'
       - '@prestashop.adapter.admin.data_provider.module'
       - '@doctrine.cache.provider'
       - '@PrestaShop\PrestaShop\Adapter\HookManager'
       - "@=service('prestashop.adapter.legacy.configuration').get('_PS_MODULE_DIR_')"
-      - '@=service("prestashop.adapter.legacy.context").getContext().language.id'
 
   prestashop.core.admin.module.repository.eventsubscriber:
     class: PrestaShop\PrestaShop\Core\Module\EventSubscriber

diff --git a/tests/Integration/Core/Module/ModuleRepositoryTest.php b/tests/Integration/Core/Module/ModuleRepositoryTest.php
@@ -34,6 +34,8 @@
 use PrestaShop\PrestaShop\Adapter\HookManager;
 use PrestaShop\PrestaShop\Adapter\Module\AdminModuleDataProvider;
 use PrestaShop\PrestaShop\Adapter\Module\ModuleDataProvider;
+use PrestaShop\PrestaShop\Core\Context\LanguageContext;
+use PrestaShop\PrestaShop\Core\Localization\LocaleInterface;
 use PrestaShop\PrestaShop\Core\Module\ModuleRepository;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 use Symfony\Component\Translation\Translator;
@@ -99,7 +101,17 @@ protected function setUp(): void
             $cacheProvider,
             $hookManager,
             dirname(__DIR__, 3) . '/Resources/modules/',
-            1
+            new LanguageContext(
+                1,
+                'English',
+                'en',
+                'en-US',
+                'en-us',
+                false,
+                'm/d/Y',
+                'm/d/Y H:i:s',
+                $this->createMock(LocaleInterface::class),
+            ),
         );
     }