migrate component properties to json string

nio-dtp · nio-dtp · commit de5e19adcccf · 2026-03-06T08:26:00.000+01:00
diff --git a/DependencyInjection/Compiler/AddComponentDataResolver.php b/DependencyInjection/Compiler/AddComponentDataResolver.php
@@ -13,7 +13,7 @@ class AddComponentDataResolver implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $actionManager = $container->findDefinition('spy_timeline.action_manager');
         $componentDataResolver = $container->findDefinition('spy_timeline.resolve_component.resolver');
diff --git a/DependencyInjection/Compiler/AddDeliveryMethodCompilerPass.php b/DependencyInjection/Compiler/AddDeliveryMethodCompilerPass.php
@@ -10,7 +10,7 @@ class AddDeliveryMethodCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         // we only do a call if the delivery method is immediate.
         if ($container->getParameter('spy_timeline.spread.deployer.delivery') !== "immediate") {
diff --git a/DependencyInjection/Compiler/AddFilterCompilerPass.php b/DependencyInjection/Compiler/AddFilterCompilerPass.php
@@ -10,7 +10,7 @@ class AddFilterCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $filterManager = $container->getDefinition('spy_timeline.filter.manager');
 
diff --git a/DependencyInjection/Compiler/AddLocatorCompilerPass.php b/DependencyInjection/Compiler/AddLocatorCompilerPass.php
@@ -16,7 +16,7 @@ class AddLocatorCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $parameterDefinitions = $this->getLocatorDefinitionsFromParameter($container);
         $taggedServiceDefinitions = $this->getLocatorDefinitionsFromTaggedServices($container);
diff --git a/DependencyInjection/Compiler/AddRegistryCompilerPass.php b/DependencyInjection/Compiler/AddRegistryCompilerPass.php
@@ -10,7 +10,7 @@ class AddRegistryCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasParameter('spy_timeline.resolve_component.doctrine_registries')) {
             return;
diff --git a/DependencyInjection/Compiler/AddSpreadCompilerPass.php b/DependencyInjection/Compiler/AddSpreadCompilerPass.php
@@ -10,7 +10,7 @@ class AddSpreadCompilerPass implements CompilerPassInterface
     /**
      * {@inheritdoc}
      */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         $alias            = $container->getAlias('spy_timeline.spread.deployer');
         $spreadDeployer   = $container->getDefinition((string) $alias);
diff --git a/Driver/Doctrine/ODM/PostLoadListener.php b/Driver/Doctrine/ODM/PostLoadListener.php
@@ -25,7 +25,7 @@ public function postLoad(LifecycleEventArgs $eventArgs)
             $entity->setData(
                 $eventArgs->getDocumentManager()->getReference(
                     $entity->getModel(),
-                    $entity->getIdentifier()
+                    $entity->getIdentifierMigrated() ?? $entity->getIdentifier()
                 )
             );
         } catch (DocumentNotFoundException $e) {
diff --git a/Driver/Doctrine/ORM/PostLoadListener.php b/Driver/Doctrine/ORM/PostLoadListener.php
@@ -25,7 +25,7 @@ public function postLoad(PostLoadEventArgs $eventArgs)
             $entity->setData(
                 $eventArgs->getObjectManager()->getReference(
                     $entity->getModel(),
-                    $entity->getIdentifier()
+                    $entity->getIdentifierMigrated() ?? $entity->getIdentifier()
                 )
             );
         } catch (EntityNotFoundException $e) {
diff --git a/Driver/ODM/ActionManager.php b/Driver/ODM/ActionManager.php
@@ -75,7 +75,7 @@ public function findOrCreateComponent($model, $identifier = null, $flush = true)
         $component = $this->objectManager
             ->createQueryBuilder($this->componentClass)
             ->field('model')->equals($resolvedComponentData->getModel())
-            ->field('identifier')->equals($resolvedComponentData->getIdentifier())
+            ->field('identifier')->equals($resolvedComponentData->getIdentifierMigrated() ?? $resolvedComponentData->getIdentifier())
             ->getQuery()
             ->getSingleResult()
         ;
diff --git a/Driver/ORM/ActionManager.php b/Driver/ORM/ActionManager.php
@@ -78,13 +78,7 @@ public function findOrCreateComponent($model, $identifier = null, $flush = true)
     {
         $resolvedComponentData = $this->resolveModelAndIdentifier($model, $identifier);
 
-        $component = $this->getComponentRepository()
-            ->createQueryBuilder('c')
-            ->where('c.hash = :hash')
-            ->setParameter('hash', $resolvedComponentData->getHash())
-            ->getQuery()
-            ->getOneOrNullResult()
-        ;
+        $component = $this->findComponentWithHash($resolvedComponentData->getHash());
 
         if ($component) {
             $component->setData($resolvedComponentData->getData());
@@ -100,13 +94,23 @@ public function findOrCreateComponent($model, $identifier = null, $flush = true)
      */
     public function findComponentWithHash($hash)
     {
+        $component = $this->getComponentRepository()
+            ->createQueryBuilder('c')
+            ->where('c.hashMigrated = :hash')
+            ->setParameter('hash', $hash)
+            ->getQuery()
+            ->getOneOrNullResult();
+
+        if (null !== $component) {
+            return $component;
+        }
+
         return $this->getComponentRepository()
             ->createQueryBuilder('c')
             ->where('c.hash = :hash')
             ->setParameter('hash', $hash)
             ->getQuery()
-            ->getOneOrNullResult()
-        ;
+            ->getOneOrNullResult();
     }
 
     /**
@@ -120,12 +124,16 @@ public function findComponents(array $hashes)
 
         $qb = $this->getComponentRepository()->createQueryBuilder('c');
 
-        return $qb->where(
-            $qb->expr()->in('c.hash', $hashes)
-            )
+        $components = $qb->where($qb->expr()->in('c.hashMigrated', $hashes))
             ->getQuery()
-            ->getResult()
-        ;
+            ->getResult();
+        if (!empty($components)) {
+            return $components;
+        }
+
+        return $qb->where($qb->expr()->in('c.hash', $hashes))
+            ->getQuery()
+            ->getResult();
     }
 
     protected function getQueryBuilderForSubject(ComponentInterface $subject)
diff --git a/Filter/DataHydrator/Locator/DoctrineODM.php b/Filter/DataHydrator/Locator/DoctrineODM.php
@@ -53,7 +53,7 @@ public function locate($model, array $components)
 
         $oids = [];
         foreach ($components as $component) {
-            $oids[] = $component->getIdentifier();
+            $oids[] = $component->getIdentifierMigrated() ?? $component->getIdentifier();
         }
 
         $qb    = $objectManager->getRepository($model)
diff --git a/Filter/DataHydrator/Locator/DoctrineORM.php b/Filter/DataHydrator/Locator/DoctrineORM.php
@@ -56,7 +56,7 @@ public function locate($model, array $components)
 
         $oids = [];
         foreach ($components as $component) {
-            $oids[] = $component->getIdentifier();
+            $oids[] = $component->getIdentifierMigrated() ?? $component->getIdentifier();
         }
 
         if (count($fields) > 1) {
diff --git a/ResolveComponent/DoctrineComponentDataResolver.php b/ResolveComponent/DoctrineComponentDataResolver.php
@@ -32,7 +32,7 @@ class DoctrineComponentDataResolver implements ComponentDataResolverInterface
     public function resolveComponentData(ResolveComponentModelIdentifier $resolve)
     {
         $model = $resolve->getModel();
-        $identifier = $resolve->getIdentifier();
+        $identifier = $resolve->getIdentifierMigrated() ?? $resolve->getIdentifier();
         $data = null;
 
         if (is_object($model)) {
diff --git a/Resources/config/doctrine/Component.mongodb.xml b/Resources/config/doctrine/Component.mongodb.xml
@@ -8,6 +8,8 @@
         <field name="model" fieldName="model" type="string" />
         <field name="identifier" fieldName="identifier" type="string" />
         <field name="hash" fieldName="hash" type="string" />
+        <field name="identifierMigrated" fieldName="identifier_migrated" type="string" length="255" nullable="true" />
+        <field name="hashMigrated" fieldName="hash_migrated" type="string" length="255" nullable="true" unique="true" />
         <indexes>
             <index>
                 <key name="model" order="asc" />
diff --git a/Resources/config/doctrine/Component.orm.xml b/Resources/config/doctrine/Component.orm.xml
@@ -8,5 +8,7 @@
         <field name="model" column="model" type="string" length="255" />
         <field name="identifier" column="identifier" type="array" />
         <field name="hash" column="hash" type="string" unique="true" />
+        <field name="identifierMigrated" column="identifier_migrated" type="string" length="255" nullable="true" />
+        <field name="hashMigrated" column="hash_migrated" type="string" length="255" nullable="true" unique="true" />
     </mapped-superclass>
 </doctrine-mapping>
diff --git a/SpyTimelineBundle.php b/SpyTimelineBundle.php
@@ -16,7 +16,7 @@ class SpyTimelineBundle extends Bundle
     /**
      * @param ContainerBuilder $container
      */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         $container->addCompilerPass(new AddSpreadCompilerPass());
         $container->addCompilerPass(new AddFilterCompilerPass());
diff --git a/Tests/Units/Command/DeployActionCommandTest.php b/Tests/Units/Command/DeployActionCommandTest.php
@@ -20,7 +20,7 @@ public function testNoTimeline()
         $command = new DeployActionCommand($actionManager, $deployer, $logger);
 
         $application = new Application();
-        $application->add($command);
+        $application->addCommand($command);
 
         $command = $application->find('spy_timeline:deploy');
 
@@ -43,7 +43,7 @@ public function testOneTimeline()
         $command = new DeployActionCommand($actionManager, $deployer, $logger);
 
         $application = new Application();
-        $application->add($command);
+        $application->addCommand($command);
 
         $command = $application->find('spy_timeline:deploy');
 
diff --git a/Tests/Units/Command/SpreadListCommandTest.php b/Tests/Units/Command/SpreadListCommandTest.php
@@ -17,7 +17,7 @@ public function testExecuteWithNoSpread()
         $command = new SpreadListCommand($deployer);
 
         $application = new Application();
-        $application->add($command);
+        $application->addCommand($command);
 
         $command = $application->find('spy_timeline:spreads');
 
@@ -38,7 +38,7 @@ public function testExecuteWithOneSpread()
         $command = new SpreadListCommand($deployer);
 
         $application = new Application();
-        $application->add($command);
+        $application->addCommand($command);
 
         $command = $application->find('spy_timeline:spreads');
 
diff --git a/Tests/Units/Driver/ORM/ActionManagerTest.php b/Tests/Units/Driver/ORM/ActionManagerTest.php
@@ -36,6 +36,7 @@ public function testCreateComponent()
         $result = $actionManager->createComponent($model, $identifier);
 
         $this->assertEquals($identifier, $result->getIdentifier());
+        $this->assertEquals($identifier, $result->getIdentifierMigrated());
         $this->assertEquals($model, $result->getModel());
         $this->assertNull($result->getData());
     }
diff --git a/Tests/Units/ResolveComponent/DoctrineComponentDataResolverTest.php b/Tests/Units/ResolveComponent/DoctrineComponentDataResolverTest.php
@@ -68,6 +68,7 @@ public function testStringModelAndIdentifierGiven()
     {
         $model = 'foo';
         $identifier = array('foo' => 'bar');
+        $expectedIdentifier = 'bar';
         $resolve = new ResolveComponentModelIdentifier($model, $identifier);
 
         $managerRegistry = $this->createMock(\Doctrine\Persistence\ManagerRegistry::class);
@@ -78,6 +79,26 @@ public function testStringModelAndIdentifierGiven()
         $result = $resolver->resolveComponentData($resolve);
 
         $this->assertEquals($model, $result->getModel());
-        $this->assertEquals($identifier, $result->getIdentifier());
+        $this->assertEquals($expectedIdentifier, $result->getIdentifier());
+        $this->assertEquals($expectedIdentifier, $result->getIdentifierMigrated());
+    }
+
+    public function testStringModelAndIdentifierMigratedGiven()
+    {
+        $model = 'foo';
+        $identifier = 'bar';
+        $expectedIdentifier = 'bar';
+        $resolve = new ResolveComponentModelIdentifier($model, $identifier);
+
+        $managerRegistry = $this->createMock(\Doctrine\Persistence\ManagerRegistry::class);
+
+        $resolver = new TestedModel();
+        $resolver->addRegistry($managerRegistry);
+
+        $result = $resolver->resolveComponentData($resolve);
+
+        $this->assertEquals($model, $result->getModel());
+        $this->assertEquals($expectedIdentifier, $result->getIdentifier());
+        $this->assertEquals($expectedIdentifier, $result->getIdentifierMigrated());
     }
 }
diff --git a/Twig/Extension/TimelineExtension.php b/Twig/Extension/TimelineExtension.php
@@ -152,7 +152,7 @@ public function getComponentVariables($action, $component)
 
         $values['value'] = $isComponent ? $component->getData() : $component;
         $values['model'] = $isComponent ? $component->getModel() : null;
-        $values['id']    = $isComponent ? $component->getIdentifier() : null;
+        $values['id']    = $isComponent ? ($component->getIdentifierMigrated() ?? $component->getIdentifier()) : null;
         $values['text']  = $isComponent ? null : $component;
 
         if (!empty($values['model'])) {
diff --git a/composer.json b/composer.json
@@ -11,7 +11,7 @@
     }],
     "require": {
         "php": ">=8.3",
-        "stephpy/timeline": "^1.0",
+        "stephpy/timeline": "dev-maintenance-629-migrate-component-properties-to-json-string as 1.1.1",
         "symfony/framework-bundle": ">=5.4",
         "symfony/options-resolver": ">=5.4",
         "twig/twig": ">=3.0"

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class AddComponentDataResolver implements CompilerPassInterface`
`13`	`13`	`/**`
`14`	`14`	`* {@inheritdoc}`
`15`	`15`	`*/`
`16`		`- public function process(ContainerBuilder $container)`
	`16`	`+ public function process(ContainerBuilder $container): void`
`17`	`17`	`{`
`18`	`18`	`$actionManager = $container->findDefinition('spy_timeline.action_manager');`
`19`	`19`	`$componentDataResolver = $container->findDefinition('spy_timeline.resolve_component.resolver');`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class AddDeliveryMethodCompilerPass implements CompilerPassInterface`
`10`	`10`	`/**`
`11`	`11`	`* {@inheritdoc}`
`12`	`12`	`*/`
`13`		`- public function process(ContainerBuilder $container)`
	`13`	`+ public function process(ContainerBuilder $container): void`
`14`	`14`	`{`
`15`	`15`	`// we only do a call if the delivery method is immediate.`
`16`	`16`	`if ($container->getParameter('spy_timeline.spread.deployer.delivery') !== "immediate") {`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class AddFilterCompilerPass implements CompilerPassInterface`
`10`	`10`	`/**`
`11`	`11`	`* {@inheritdoc}`
`12`	`12`	`*/`
`13`		`- public function process(ContainerBuilder $container)`
	`13`	`+ public function process(ContainerBuilder $container): void`
`14`	`14`	`{`
`15`	`15`	`$filterManager = $container->getDefinition('spy_timeline.filter.manager');`
`16`	`16`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ class AddLocatorCompilerPass implements CompilerPassInterface`
`16`	`16`	`/**`
`17`	`17`	`* {@inheritdoc}`
`18`	`18`	`*/`
`19`		`- public function process(ContainerBuilder $container)`
	`19`	`+ public function process(ContainerBuilder $container): void`
`20`	`20`	`{`
`21`	`21`	`$parameterDefinitions = $this->getLocatorDefinitionsFromParameter($container);`
`22`	`22`	`$taggedServiceDefinitions = $this->getLocatorDefinitionsFromTaggedServices($container);`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class AddRegistryCompilerPass implements CompilerPassInterface`
`10`	`10`	`/**`
`11`	`11`	`* {@inheritdoc}`
`12`	`12`	`*/`
`13`		`- public function process(ContainerBuilder $container)`
	`13`	`+ public function process(ContainerBuilder $container): void`
`14`	`14`	`{`
`15`	`15`	`if (!$container->hasParameter('spy_timeline.resolve_component.doctrine_registries')) {`
`16`	`16`	`return;`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ class AddSpreadCompilerPass implements CompilerPassInterface`
`10`	`10`	`/**`
`11`	`11`	`* {@inheritdoc}`
`12`	`12`	`*/`
`13`		`- public function process(ContainerBuilder $container)`
	`13`	`+ public function process(ContainerBuilder $container): void`
`14`	`14`	`{`
`15`	`15`	`$alias = $container->getAlias('spy_timeline.spread.deployer');`
`16`	`16`	`$spreadDeployer = $container->getDefinition((string) $alias);`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public function postLoad(LifecycleEventArgs $eventArgs)`
`25`	`25`	`$entity->setData(`
`26`	`26`	`$eventArgs->getDocumentManager()->getReference(`
`27`	`27`	`$entity->getModel(),`
`28`		`- $entity->getIdentifier()`
	`28`	`+ $entity->getIdentifierMigrated() ?? $entity->getIdentifier()`
`29`	`29`	`)`
`30`	`30`	`);`
`31`	`31`	`} catch (DocumentNotFoundException $e) {`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ public function findOrCreateComponent($model, $identifier = null, $flush = true)`
`75`	`75`	`$component = $this->objectManager`
`76`	`76`	`->createQueryBuilder($this->componentClass)`
`77`	`77`	`->field('model')->equals($resolvedComponentData->getModel())`
`78`		`- ->field('identifier')->equals($resolvedComponentData->getIdentifier())`
	`78`	`+ ->field('identifier')->equals($resolvedComponentData->getIdentifierMigrated() ?? $resolvedComponentData->getIdentifier())`
`79`	`79`	`->getQuery()`
`80`	`80`	`->getSingleResult()`
`81`	`81`	`;`