Add support for configuring the identity generation preferences

doctrine · Aug 5, 2024 · 9926a4a · 9926a4a
1 parent 568affa
commit 9926a4a
Show file tree

Hide file tree

Showing 6 changed files with 89 additions and 1 deletion.
diff --git a/config/schema/doctrine-1.0.xsd b/config/schema/doctrine-1.0.xsd
@@ -218,6 +218,7 @@
             <xsd:element name="entity-listeners" type="entity_listeners" minOccurs="0" maxOccurs="1" />
             <xsd:element name="second-level-cache" type="second-level-cache" minOccurs="0" maxOccurs="1" />
             <xsd:element name="schema-ignore-class" type="xsd:string" minOccurs="0" maxOccurs="unbounded" />
+            <xsd:element name="identity-generation-preference" type="identity_generation_preference" minOccurs="0" maxOccurs="unbounded" />
         </xsd:choice>
     </xsd:group>
 
@@ -282,4 +283,12 @@
             <xsd:element name="datetime-function" type="named_scalar" />
         </xsd:choice>
     </xsd:complexType>
+
+    <xsd:complexType name="identity_generation_preference">
+        <xsd:simpleContent>
+            <xsd:extension base="xsd:string">
+                <xsd:attribute name="platform" type="xsd:string" use="required" />
+            </xsd:extension>
+        </xsd:simpleContent>
+    </xsd:complexType>
 </xsd:schema>
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -5,6 +5,7 @@
 use Doctrine\DBAL\Schema\LegacySchemaManagerFactory;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\ClassMetadataFactory;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\Proxy\ProxyFactory;
@@ -804,13 +805,28 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
                         ->end()
                     ->end()
                 ->end()
+                ->fixXmlConfig('identity_generation_preference')
+                ->children()
+                    ->arrayNode('identity_generation_preferences')
+                        ->info('Configures the preferences for identity generation when using the AUTO strategy. Valid values are "SEQUENCE" or "IDENTITY".')
+                        ->useAttributeAsKey('platform')
+                        ->prototype('scalar')
+                            ->beforeNormalization()
+                                ->ifString()
+                                ->then(static function ($v) {
+                                    return constant(ClassMetadata::class . '::GENERATOR_TYPE_' . strtoupper($v));
+                                })
+                            ->end()
+                        ->end()
+                    ->end()
+                ->end()
             ->end();
 
         return $node;
     }
 
     /**
-     * Return a ORM cache driver node for an given entity manager
+     * Return an ORM cache driver node for a given entity manager
      */
     private function getOrmCacheDriverNode(string $name): ArrayNodeDefinition
     {

diff --git a/src/DependencyInjection/DoctrineExtension.php b/src/DependencyInjection/DoctrineExtension.php
@@ -719,6 +719,7 @@ protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $
             'setTypedFieldMapper' => new Reference($entityManager['typed_field_mapper']),
             'setEntityListenerResolver' => new Reference(sprintf('doctrine.orm.%s_entity_listener_resolver', $entityManager['name'])),
             'setLazyGhostObjectEnabled' => '%doctrine.orm.enable_lazy_ghost_objects%',
+            'setIdentityGenerationPreferences' => $entityManager['identity_generation_preferences'],
         ];
 
         if (! method_exists(OrmConfiguration::class, 'setLazyGhostObjectEnabled')) {

diff --git a/tests/DependencyInjection/AbstractDoctrineExtensionTest.php b/tests/DependencyInjection/AbstractDoctrineExtensionTest.php
@@ -13,10 +13,12 @@
 use Doctrine\DBAL\Configuration;
 use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
+use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\DBAL\Schema\LegacySchemaManagerFactory;
 use Doctrine\ORM\Configuration as OrmConfiguration;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\Mapping\Driver\SimplifiedXmlDriver;
 use Doctrine\ORM\Proxy\ProxyFactory;
@@ -714,6 +716,21 @@ public function testSetNamingStrategy(): void
         $this->assertDICDefinitionMethodCallOnce($def2, 'setNamingStrategy', [0 => new Reference('doctrine.orm.naming_strategy.underscore')]);
     }
 
+    public function testSetIdentityGenerationPreferences(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        $container = $this->loadContainer('orm_identity_generation_preferences');
+
+        $def1 = $container->getDefinition('doctrine.orm.em1_configuration');
+        $def2 = $container->getDefinition('doctrine.orm.em2_configuration');
+
+        $this->assertDICDefinitionMethodCallOnce($def1, 'setIdentityGenerationPreferences', [0 => [PostgreSQLPlatform::class => ClassMetadata::GENERATOR_TYPE_IDENTITY]]);
+        $this->assertDICDefinitionMethodCallOnce($def2, 'setIdentityGenerationPreferences', [0 => [PostgreSQLPlatform::class => ClassMetadata::GENERATOR_TYPE_SEQUENCE]]);
+    }
+
     public function testSetQuoteStrategy(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {

diff --git a/tests/DependencyInjection/Fixtures/config/xml/orm_identity_generation_preferences.xml b/tests/DependencyInjection/Fixtures/config/xml/orm_identity_generation_preferences.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" ?>
+
+<srv:container xmlns="http://symfony.com/schema/dic/doctrine"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:srv="http://symfony.com/schema/dic/services"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd
+                        http://symfony.com/schema/dic/doctrine http://symfony.com/schema/dic/doctrine/doctrine-1.0.xsd">
+
+    <config>
+        <dbal default-connection="default">
+            <connection name="default" dbname="db" />
+        </dbal>
+
+        <orm default-entity-manager="em1">
+            <entity-manager name="em1">
+                <mapping name="YamlBundle" />
+                <identity-generation-preference platform="Doctrine\DBAL\Platforms\PostgreSQLPlatform">identity</identity-generation-preference>
+            </entity-manager>
+            <entity-manager name="em2">
+                <identity-generation-preference platform="Doctrine\DBAL\Platforms\PostgreSQLPlatform">sequence</identity-generation-preference>
+                <mapping name="YamlBundle" />
+            </entity-manager>
+        </orm>
+    </config>
+</srv:container>
diff --git a/tests/DependencyInjection/Fixtures/config/yml/orm_identity_generation_preferences.yml b/tests/DependencyInjection/Fixtures/config/yml/orm_identity_generation_preferences.yml
@@ -0,0 +1,20 @@
+doctrine:
+    dbal:
+        default_connection: default
+        connections:
+            default:
+                dbname: db
+
+    orm:
+        default_entity_manager: em1
+        entity_managers:
+            em1:
+                mappings:
+                    YamlBundle: ~
+                identity_generation_preferences:
+                    Doctrine\DBAL\Platforms\PostgreSQLPlatform: identity
+            em2:
+                mappings:
+                    YamlBundle: ~
+                identity_generation_preferences:
+                    Doctrine\DBAL\Platforms\PostgreSQLPlatform: sequence