Force the replacement of the service

Author: Quetzacoalt91

classes/UpgradeContainer.php

@@ -57,6 +57,7 @@
 use PrestaShop\Module\AutoUpgrade\Twig\TransFilterExtension;
 use PrestaShop\Module\AutoUpgrade\Twig\TransFilterExtension3;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\CacheCleaner;
+use PrestaShop\Module\AutoUpgrade\UpgradeTools\CoreUpgrader\CoreServiceStub\CoreServiceStubRegistrar;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\FileFilter;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\FilesystemAdapter;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\Module\ModuleAdapter;
@@ -212,6 +213,9 @@ class UpgradeContainer
     /** @var ConfigurationValidator */
     private $configurationValidator;
 
+    /** @var CoreServiceStubRegistrar */
+    private $coreServiceStubRegistrar;
+
     /** @var LocalChannelConfigurationValidator */
     private $localChannelConfigurationValidator;
 
@@ -787,7 +791,7 @@ public function getPrestaShopConfiguration(): PrestashopConfiguration
     public function getSymfonyAdapter(): SymfonyAdapter
     {
         if (null === $this->symfonyAdapter) {
-            $this->symfonyAdapter = new SymfonyAdapter();
+            $this->symfonyAdapter = new SymfonyAdapter($this->getCoreServiceStubRegistrar());
         }
 
         return $this->symfonyAdapter;
@@ -990,6 +994,18 @@ public function getConfigurationValidator(): ConfigurationValidator
         return $this->configurationValidator;
     }
 
+    public function getCoreServiceStubRegistrar(): CoreServiceStubRegistrar
+    {
+        if (null === $this->coreServiceStubRegistrar) {
+            $this->coreServiceStubRegistrar = new CoreServiceStubRegistrar(
+                $this->getLogger(),
+                $this->getTranslator()
+            );
+        }
+
+        return $this->coreServiceStubRegistrar;
+    }
+
     /**
      * @return LocalChannelConfigurationValidator
      */

classes/UpgradeTools/CoreUpgrader/CoreServiceStub/CoreServiceStubRegistrar.php

@@ -24,6 +24,9 @@
 use PrestaShop\Module\AutoUpgrade\Log\LoggerInterface;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\CoreUpgrader\CoreServiceStub\Stubs\FaultTolerantExtraPropertyDefinitionRepository;
 use PrestaShop\Module\AutoUpgrade\UpgradeTools\Translator;
+use ReflectionObject;
+use RuntimeException;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Throwable;
 
@@ -35,16 +38,6 @@
  * an early upgrade step can therefore fail on a schema that is not complete yet. For each
  * such case we register a stub that tolerates the incomplete schema until the migration
  * catches up.
- *
- * To add a new stub:
- *  - create the stub class in the Stubs/ subfolder (a decorator implementing the core
- *    contract is the usual shape), exposing a static register(ContainerInterface) method;
- *  - add an entry below mapping the core symbol that must exist for the stub to be relevant
- *    to the callable installing it.
- *
- * The map is keyed by a core class/interface name kept as a literal string: the existence
- * check runs before the stub class is referenced, so stub classes that implement a core
- * contract are never autoloaded against a core version that does not ship it.
  */
 class CoreServiceStubRegistrar
 {
@@ -66,28 +59,62 @@ public function __construct(LoggerInterface $logger, Translator $translator)
 
     public function register(ContainerInterface $container): void
     {
-        foreach ($this->getStubs() as $requiredCoreSymbol => $register) {
+        foreach ($this->getStubs() as $requiredCoreSymbol => $stubClass) {
             if (!interface_exists($requiredCoreSymbol) && !class_exists($requiredCoreSymbol)) {
                 continue;
             }
 
+            if (!$container->has($requiredCoreSymbol)) {
+                continue;
+            }
+
             try {
-                $register($container);
+                $decorated = $container->get($requiredCoreSymbol);
+                $stub = new $stubClass($decorated);
+
+                try {
+                    $container->set($requiredCoreSymbol, $stub);
+                } catch (Throwable $e) {
+                    // Fetching $decorated just above already resolved and cached the service,
+                    // so the container now considers it initialized and refuses a plain set() on
+                    // it ("already initialized"). Force the swap directly on the container's
+                    // internal service cache instead, so later callers in this same request
+                    // (ObjectModel in particular) get our stub rather than the raw service.
+                    $this->forceReplace($container, $requiredCoreSymbol, $stub);
+                }
             } catch (Throwable $e) {
                 $this->logger->warning($this->translator->trans('Unable to register the core service stub for %s during the update: %s', [$requiredCoreSymbol, $e->getMessage()]));
             }
         }
     }
 
     /**
-     * @return array<string, callable(ContainerInterface):void> core symbol => stub installer
+     * @return array<string, class-string> core symbol => decorating stub class
      */
     private function getStubs(): array
     {
         return [
             // PrestaShop 9.2+: the extra_property_definition table is created late in the
             // migration, after PHP scripts that already make ObjectModel query it.
-            'PrestaShop\PrestaShop\Core\ExtraProperty\Definition\ExtraPropertyDefinitionRepositoryInterface' => [FaultTolerantExtraPropertyDefinitionRepository::class, 'register'],
+            'PrestaShop\PrestaShop\Core\ExtraProperty\Definition\ExtraPropertyDefinitionRepositoryInterface' => FaultTolerantExtraPropertyDefinitionRepository::class,
         ];
     }
+
+    private function forceReplace(ContainerInterface $container, string $id, object $service): void
+    {
+        $reflectionClass = new ReflectionObject($container);
+        while ($reflectionClass && !$reflectionClass->hasProperty('services')) {
+            $reflectionClass = $reflectionClass->getParentClass();
+        }
+
+        if (!$reflectionClass) {
+            throw new RuntimeException(sprintf('Cannot override the "%s" service: cound\'t reach the container "%s".', $id, get_class($container)));
+        }
+
+        $servicesProperty = $reflectionClass->getProperty('services');
+        $servicesProperty->setAccessible(true);
+        $services = $servicesProperty->getValue($container);
+        $services[$id] = $service;
+        $servicesProperty->setValue($container, $services);
+    }
 }

classes/UpgradeTools/CoreUpgrader/CoreServiceStub/Stubs/FaultTolerantExtraPropertyDefinitionRepository.php

@@ -47,11 +47,6 @@
  */
 class FaultTolerantExtraPropertyDefinitionRepository implements ExtraPropertyDefinitionRepositoryInterface
 {
-    /**
-     * Service id used by ObjectModel to resolve the repository from the container.
-     */
-    const SERVICE_ID = ExtraPropertyDefinitionRepositoryInterface::class;
-
     /**
      * @var ExtraPropertyDefinitionRepositoryInterface
      */
@@ -62,26 +57,6 @@ public function __construct(ExtraPropertyDefinitionRepositoryInterface $decorate
         $this->decorated = $decorated;
     }
 
-    /**
-     * Wraps the core repository service registered in the given container so it no longer
-     * fails when the extra_property_definition table does not exist yet.
-     */
-    public static function register(ContainerInterface $container): void
-    {
-        if (!$container->has(self::SERVICE_ID)) {
-            return;
-        }
-
-        $current = $container->get(self::SERVICE_ID);
-
-        // Avoid wrapping our own decorator again on subsequent update batches.
-        if ($current instanceof self) {
-            return;
-        }
-
-        $container->set(self::SERVICE_ID, new self($current));
-    }
-
     public function getAllDefinitions(): ExtraPropertyDefinitionCollection
     {
         try {

classes/UpgradeTools/CoreUpgrader/CoreUpgrader80.php

@@ -37,10 +37,7 @@ protected function initConstants(): void
         $this->forceRemovingFiles();
         parent::initConstants();
         // Container may be needed to run upgrade scripts
-        $kernel = $this->container->getSymfonyAdapter()->initKernel();
-        // The destination core files run against a database that is not fully migrated yet:
-        // replace the core services that would fail on the incomplete schema with stubs.
-        (new CoreServiceStubRegistrar($this->logger, $this->container->getTranslator()))->register($kernel->getContainer());
+        $this->container->getSymfonyAdapter()->initKernel();
     }
 
     /**

classes/UpgradeTools/SymfonyAdapter.php

@@ -21,13 +21,23 @@
 
 namespace PrestaShop\Module\AutoUpgrade\UpgradeTools;
 
+use PrestaShop\Module\AutoUpgrade\UpgradeTools\CoreUpgrader\CoreServiceStub\CoreServiceStubRegistrar;
 use ReflectionClass;
 
 /**
  * TODO: Create a class for 1.7 env and another one for 1.6 ?
  */
 class SymfonyAdapter
 {
+    /** @var CoreServiceStubRegistrar */
+    private $coreServiceStubRegistrar;
+
+    public function __construct(
+        CoreServiceStubRegistrar $coreServiceStubRegistrar
+    ) {
+        $this->coreServiceStubRegistrar = $coreServiceStubRegistrar;
+    }
+
     public function isKernelReachable(): bool
     {
         return defined('_PS_ROOT_DIR_') && class_exists('AppKernel', true);
@@ -61,6 +71,10 @@ public function initKernel()
             $kernel->boot();
             // Starting from PrestaShop 9, some parts of the new context are defined by event listeners on kernel.request.
             // We may have to trigger it with dummy data in the future.
+
+            // The destination core files run against a database that may be not fully migrated yet:
+            // replace the core services that would fail on the incomplete schema with stubs.
+            $this->coreServiceStubRegistrar->register($kernel->getContainer());
         }
 
         return $kernel;