Merge pull request #1802 from jifer/typed-field-mapper-option

ostrolucky · web-flow · commit 794cb9e576cb · 2024-05-21T09:46:59.000+02:00
diff --git a/.doctrine-project.json b/.doctrine-project.json
@@ -4,16 +4,22 @@
   "slug": "doctrine-bundle",
   "versions": [
     {
-      "name": "2.12",
-      "branchName": "2.12.x",
+      "name": "2.13",
+      "branchName": "2.13.x",
       "slug": "latest",
       "upcoming": true
     },
+    {
+      "name": "2.12",
+      "branchName": "2.12.x",
+      "slug": "2.12",
+      "current": true
+    },
     {
       "name": "2.11",
       "branchName": "2.11.x",
       "slug": "2.11",
-      "current": true
+      "maintained": false
     },
     {
       "name": "2.10",
diff --git a/.gitattributes b/.gitattributes
@@ -5,5 +5,6 @@
 phpunit.xml.dist       export-ignore
 phpcs.xml.dist         export-ignore
 psalm.xml.dist         export-ignore
-/Resources/doc         export-ignore
-/Tests                 export-ignore
+/docs                  export-ignore
+/tests                 export-ignore
+.symfony.bundle.yaml   export-ignore
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    labels:
+      - "CI"
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -12,6 +12,6 @@ on:
 jobs:
   coding-standards:
     name: "Coding Standards"
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@3.1.0"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@5.0.1"
     with:
       composer-options: "--prefer-dist --prefer-stable"
diff --git a/.github/workflows/composer-lint.yml b/.github/workflows/composer-lint.yml
@@ -15,4 +15,4 @@ on:
 jobs:
   composer-lint:
     name: "Composer Lint"
-    uses: "doctrine/.github/.github/workflows/composer-lint.yml@3.1.0"
+    uses: "doctrine/.github/.github/workflows/composer-lint.yml@5.0.1"
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -24,6 +24,7 @@ jobs:
           - "7.4"
           - "8.0"
           - "8.1"
+          - "8.2"
         dependencies:
           - "highest"
         stability:
@@ -46,22 +47,22 @@ jobs:
           # Test last supported minor version
           - symfony-require: "6.*"
             dependencies: "highest"
-            php-version: "8.2"
+            php-version: "8.3"
 
           # DBAL only without ORM
-          - php-version: "8.2"
+          - php-version: "8.3"
             dependencies: "highest"
             stability: "stable"
             remove-orm: true
 
           # DBAL 4
-          - php-version: "8.2"
+          - php-version: "8.3"
             dependencies: "highest"
             stability: "dev"
             remove-orm: true
 
           # Bleeding edge
-          - php-version: "8.2"
+          - php-version: "8.3"
             dependencies: "highest"
             stability: "dev"
 
@@ -93,7 +94,7 @@ jobs:
         if: "${{ matrix.remove-orm }}"
 
       - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v2"
+        uses: "ramsey/composer-install@v3"
         with:
           dependency-versions: "${{ matrix.dependencies }}"
           composer-options: "--prefer-dist"
@@ -102,7 +103,7 @@ jobs:
         run: "vendor/bin/phpunit --coverage-clover=coverage.xml"
 
       - name: "Upload coverage file"
-        uses: "actions/upload-artifact@v3"
+        uses: "actions/upload-artifact@v4"
         with:
           name: "phpunit-${{ matrix.php-version }}-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}.coverage"
           path: "coverage.xml"
@@ -120,11 +121,13 @@ jobs:
           fetch-depth: 2
 
       - name: "Download coverage files"
-        uses: "actions/download-artifact@v3"
+        uses: "actions/download-artifact@v4"
         with:
           path: "reports"
 
       - name: "Upload to Codecov"
-        uses: "codecov/codecov-action@v3"
+        uses: "codecov/codecov-action@v4"
         with:
           directory: reports
+        env:
+          CODECOV_TOKEN: "${{ secrets.CODECOV_TOKEN }}"
diff --git a/.github/workflows/release-on-milestone-closed.yml b/.github/workflows/release-on-milestone-closed.yml
@@ -8,7 +8,7 @@ on:
 jobs:
   release:
     name: "Git tag, release & create merge-up PR"
-    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@3.1.0"
+    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@5.0.1"
     secrets:
       GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
       GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -28,7 +28,7 @@ jobs:
         run: "composer config minimum-stability stable"
 
       - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v2"
+        uses: "ramsey/composer-install@v3"
 
       - name: "Run a static analysis with vimeo/psalm"
         run: "vendor/bin/psalm --show-info=false --stats --output-format=github --find-unused-psalm-suppress"
diff --git a/.github/workflows/test-dev-stability.yml b/.github/workflows/test-dev-stability.yml
@@ -44,7 +44,7 @@ jobs:
         if: "${{ startsWith(matrix.symfony-require, '4.') }}"
 
       - name: "Install dependencies with Composer"
-        uses: "ramsey/composer-install@v2"
+        uses: "ramsey/composer-install@v3"
         with:
           dependency-versions: "${{ matrix.dependencies }}"
           composer-options: "--prefer-dist"
diff --git a/.symfony.bundle.yaml b/.symfony.bundle.yaml
@@ -7,9 +7,10 @@ branches:
     - "2.10.x"
     - "2.11.x"
     - "2.12.x"
+    - "2.13.x"
 maintained_branches:
-    - "2.11.x"
     - "2.12.x"
-doc_dir: { "2.11.x": "Resources/doc/", "2.12.x": "docs/" }
-current_branch: "2.11.x"
-dev_branch: "2.12.x"
+    - "2.13.x"
+doc_dir: "docs/"
+current_branch: "2.12.x"
+dev_branch: "2.13.x"
diff --git a/config/orm.xml b/config/orm.xml
@@ -62,6 +62,9 @@
         <parameter key="doctrine.orm.quote_strategy.default.class">Doctrine\ORM\Mapping\DefaultQuoteStrategy</parameter>
         <parameter key="doctrine.orm.quote_strategy.ansi.class">Doctrine\ORM\Mapping\AnsiQuoteStrategy</parameter>
 
+        <!-- typed field mapper -->
+        <parameter key="doctrine.orm.typed_field_mapper.default.class">Doctrine\ORM\Mapping\DefaultTypedFieldMapper</parameter>
+
         <!-- entity listener resolver -->
         <parameter key="doctrine.orm.entity_listener_resolver.class">Doctrine\Bundle\DoctrineBundle\Mapping\ContainerEntityListenerResolver</parameter>
 
@@ -173,6 +176,9 @@
         <service id="doctrine.orm.quote_strategy.default" class="%doctrine.orm.quote_strategy.default.class%" public="false" />
         <service id="doctrine.orm.quote_strategy.ansi" class="%doctrine.orm.quote_strategy.ansi.class%" public="false" />
 
+        <!-- typed field mapper -->
+        <service id="doctrine.orm.typed_field_mapper.default" class="%doctrine.orm.typed_field_mapper.default.class%" public="false" />
+
         <!-- custom id generators -->
         <service id="doctrine.ulid_generator" class="Symfony\Bridge\Doctrine\IdGenerator\UlidGenerator">
             <argument type="service" id="ulid.factory" on-invalid="ignore" />
diff --git a/config/schema/doctrine-1.0.xsd b/config/schema/doctrine-1.0.xsd
@@ -228,6 +228,7 @@
         <xsd:attribute name="class-metadata-factory-name" type="xsd:string" />
         <xsd:attribute name="naming-strategy" type="xsd:string" />
         <xsd:attribute name="quote-strategy" type="xsd:string" />
+        <xsd:attribute name="typed-field-mapper" type="xsd:string" />
         <xsd:attribute name="entity-listener-resolver" type="xsd:string" />
         <xsd:attribute name="repository-factory" type="xsd:string" />
         <xsd:attribute name="report-fields-where-declared" type="xsd:boolean" />
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -262,6 +262,7 @@ Configuration Reference
                         validate_xml_mapping: false
                         naming_strategy:              doctrine.orm.naming_strategy.default
                         quote_strategy:               doctrine.orm.quote_strategy.default
+                        typed_field_mapper:           doctrine.orm.typed_field_mapper.default
                         entity_listener_resolver:     ~
                         repository_factory:           ~
                         second_level_cache:
@@ -514,6 +515,7 @@ Configuration Reference
                         report-fields-where-declared="false"
                         naming-strategy="doctrine.orm.naming_strategy.default"
                         quote-strategy="doctrine.orm.quote_strategy.default"
+                        typed-field-mapper="doctrine.orm.typed_field_mapper.default"
                         entity-listener-resolver="null"
                         repository-factory="null"
                     >
@@ -883,7 +885,7 @@ can configure. The following block shows all possible configuration keys:
                 logging:                  "%kernel.debug%"
                 platform_service:         MyOwnDatabasePlatformService
                 auto_commit:              false
-                schema_filter:            ^sf2_
+                schema_filter:            /^sf2_/
                 mapping_types:
                     enum: string
                 types:
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -12,6 +12,7 @@
     <config name="php_version" value="70400"/>
 
     <file>src</file>
+    <file>tests</file>
 
     <rule ref="Doctrine">
         <exclude name="SlevomatCodingStandard.TypeHints.DeclareStrictTypes"/>
@@ -22,11 +23,11 @@
     </rule>
 
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
-        <exclude-pattern>Tests/*</exclude-pattern>
-        <exclude-pattern>Repository/RepositoryFactoryCompatibility.php</exclude-pattern>
-        <exclude-pattern>Repository/ServiceEntityRepository.php</exclude-pattern>
+        <exclude-pattern>tests/*</exclude-pattern>
+        <exclude-pattern>src/Repository/RepositoryFactoryCompatibility.php</exclude-pattern>
+        <exclude-pattern>src/Repository/ServiceEntityRepository.php</exclude-pattern>
     </rule>
     <rule ref="Squiz.Classes.ClassFileName.NoMatch">
-        <exclude-pattern>Tests/*</exclude-pattern>
+        <exclude-pattern>tests/*</exclude-pattern>
     </rule>
 </ruleset>
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,17 +1,24 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
-<phpunit colors="true" bootstrap="tests/bootstrap.php">
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         colors="true"
+         bootstrap="tests/bootstrap.php"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd"
+>
     <testsuites>
         <testsuite name="DoctrineBundle for the Symfony Framework">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
 
-    <filter>
-        <whitelist>
+    <php>
+        <env name="SYMFONY_DEPRECATIONS_HELPER" value="ignoreFile=./tests/baseline-ignore"/>
+    </php>
+
+    <coverage>
+        <include>
             <directory>src</directory>
-        </whitelist>
-    </filter>
+        </include>
+    </coverage>
 
     <listeners>
         <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
diff --git a/src/Command/CreateDatabaseDoctrineCommand.php b/src/Command/CreateDatabaseDoctrineCommand.php
@@ -66,7 +66,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         unset($params['dbname'], $params['path'], $params['url']);
 
         if ($connection->getDatabasePlatform() instanceof PostgreSQLPlatform) {
-            $params['dbname'] = 'postgres';
+            /** @psalm-suppress InvalidArrayOffset It's still available in DBAL 3.x that we need to support */
+            $params['dbname'] = $params['default_dbname'] ?? 'postgres';
         }
 
         $tmpConnection           = DriverManager::getConnection($params, $connection->getConfiguration());
diff --git a/src/Command/DropDatabaseDoctrineCommand.php b/src/Command/DropDatabaseDoctrineCommand.php
@@ -77,7 +77,8 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         unset($params['dbname'], $params['url']);
 
         if ($connection->getDatabasePlatform() instanceof PostgreSQLPlatform) {
-            $params['dbname'] = 'postgres';
+            /** @psalm-suppress InvalidArrayOffset It's still available in DBAL 3.x that we need to support */
+            $params['dbname'] = $params['default_dbname'] ?? 'postgres';
         }
 
         if (! $input->getOption('force')) {
diff --git a/src/ConnectionFactory.php b/src/ConnectionFactory.php
@@ -120,7 +120,10 @@ public function createConnection(array $params, ?Configuration $config = null, ?
             $driver     = $connection->getDriver();
             /** @psalm-suppress InvalidScalarArgument Bogus error, StaticServerVersionProvider implements Doctrine\DBAL\ServerVersionProvider  */
             $platform = $driver->getDatabasePlatform(
-                ...(class_exists(StaticServerVersionProvider::class) ? [new StaticServerVersionProvider($params['serverVersion'] ?? '')] : []),
+                ...(class_exists(StaticServerVersionProvider::class)
+                    ? [new StaticServerVersionProvider($params['serverVersion'] ?? $params['primary']['serverVersion'] ?? '')]
+                    : []
+                ),
             );
 
             if (! isset($params['charset'])) {
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -660,6 +660,7 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
                     ->scalarNode('auto_mapping')->defaultFalse()->end()
                     ->scalarNode('naming_strategy')->defaultValue('doctrine.orm.naming_strategy.default')->end()
                     ->scalarNode('quote_strategy')->defaultValue('doctrine.orm.quote_strategy.default')->end()
+                    ->scalarNode('typed_field_mapper')->defaultValue('doctrine.orm.typed_field_mapper.default')->end()
                     ->scalarNode('entity_listener_resolver')->defaultNull()->end()
                     ->scalarNode('repository_factory')->defaultValue('doctrine.orm.container_repository_factory')->end()
                     ->arrayNode('schema_ignore_classes')
diff --git a/src/DependencyInjection/DoctrineExtension.php b/src/DependencyInjection/DoctrineExtension.php
@@ -712,6 +712,7 @@ protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $
             'setDefaultRepositoryClassName' => $entityManager['default_repository_class'],
             'setNamingStrategy' => new Reference($entityManager['naming_strategy']),
             'setQuoteStrategy' => new Reference($entityManager['quote_strategy']),
+            '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%',
         ];
diff --git a/tests/ConnectionFactoryTest.php b/tests/ConnectionFactoryTest.php
@@ -43,7 +43,7 @@ public function testDefaultCharsetNonMySql(): void
     public function testDefaultCharsetMySql(): void
     {
         $factory = new ConnectionFactory([]);
-        $params  = ['driver' => 'pdo_mysql'];
+        $params  = ['driver' => 'pdo_mysql', 'serverVersion' => '8.0.31'];
 
         $connection = $factory->createConnection($params, $this->configuration);
 
@@ -53,7 +53,7 @@ public function testDefaultCharsetMySql(): void
     public function testDefaultCollationMySql(): void
     {
         $factory    = new ConnectionFactory([]);
-        $connection = $factory->createConnection(['driver' => 'pdo_mysql'], $this->configuration);
+        $connection = $factory->createConnection(['driver' => 'pdo_mysql', 'serverVersion' => '8.0.31'], $this->configuration);
 
         $this->assertSame(
             'utf8mb4_unicode_ci',
diff --git a/tests/DependencyInjection/AbstractDoctrineExtensionTest.php b/tests/DependencyInjection/AbstractDoctrineExtensionTest.php
@@ -241,7 +241,7 @@ public function testDbalLoadSinglePrimaryReplicaConnection(): void
 
     public function testDbalLoadSavepointsForNestedTransactions(): void
     {
-        if (!method_exists(Connection::class, 'getEventManager')) {
+        if (! method_exists(Connection::class, 'getEventManager')) {
             self::markTestSkipped('This test requires DBAL < 4');
         }
 
@@ -729,6 +729,19 @@ public function testSetQuoteStrategy(): void
         $this->assertDICDefinitionMethodCallOnce($def2, 'setQuoteStrategy', [0 => new Reference('doctrine.orm.quote_strategy.ansi')]);
     }
 
+    public function testSetTypedFieldMapper(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        $container = $this->loadContainer('orm_typedfieldmapper');
+
+        $definition = $container->getDefinition('doctrine.orm.default_configuration');
+
+        $this->assertDICDefinitionMethodCallOnce($definition, 'setTypedFieldMapper', [0 => new Reference('doctrine.orm.typed_field_mapper.default')]);
+    }
+
     /**
      * @dataProvider cacheConfigProvider
      * @group legacy
diff --git a/tests/DependencyInjection/DoctrineExtensionTest.php b/tests/DependencyInjection/DoctrineExtensionTest.php
diff --git a/tests/DependencyInjection/Fixtures/config/xml/dbal_schema_filter.xml b/tests/DependencyInjection/Fixtures/config/xml/dbal_schema_filter.xml
diff --git a/tests/DependencyInjection/Fixtures/config/xml/orm_filters.xml b/tests/DependencyInjection/Fixtures/config/xml/orm_filters.xml
diff --git a/tests/DependencyInjection/Fixtures/config/xml/orm_typedfieldmapper.xml b/tests/DependencyInjection/Fixtures/config/xml/orm_typedfieldmapper.xml
diff --git a/tests/DependencyInjection/Fixtures/config/yml/dbal_schema_filter.yml b/tests/DependencyInjection/Fixtures/config/yml/dbal_schema_filter.yml
diff --git a/tests/DependencyInjection/Fixtures/config/yml/orm_filters.yml b/tests/DependencyInjection/Fixtures/config/yml/orm_filters.yml
diff --git a/tests/DependencyInjection/Fixtures/config/yml/orm_typedfieldmapper.yml b/tests/DependencyInjection/Fixtures/config/yml/orm_typedfieldmapper.yml
diff --git a/tests/ProfilerTest.php b/tests/ProfilerTest.php
diff --git a/tests/baseline-ignore b/tests/baseline-ignore
