Merge pull request #1967 from greg0ire/3.0.x

Merge 2.17.x up into 3.0.x

Author: greg0ire

UPGRADE-2.17.md

@@ -0,0 +1,10 @@
+UPGRADE FROM 2.16 to 2.17
+=========================
+
+Configuration
+-------------
+
+### The `doctrine.orm.entity_managers.some_em.report_fields_where_declared` configuration option is deprecated
+
+This option is a no-op when using `doctrine/orm` 3 and has been conditionally
+deprecated. You should stop using it as soon as you upgrade to Doctrine ORM 3.

src/DependencyInjection/Configuration.php

@@ -3,6 +3,7 @@
 namespace Doctrine\Bundle\DoctrineBundle\DependencyInjection;
 
 use Doctrine\DBAL\Schema\LegacySchemaManagerFactory;
+use Doctrine\Deprecations\Deprecation;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityRepository;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -670,6 +671,18 @@ private function getOrmEntityManagersNode(): ArrayNodeDefinition
                         ->prototype('scalar')->end()
                     ->end()
                     ->booleanNode('report_fields_where_declared')
+                        ->beforeNormalization()
+                            ->ifTrue(static fn ($v): bool => isset($v))
+                            ->then(static function ($v) {
+                                Deprecation::trigger(
+                                    'doctrine/doctrine-bundle',
+                                    'https://github.com/doctrine/DoctrineBundle/pull/1962',
+                                    'The "report_fields_where_declared" configuration option is deprecated and will be removed in DoctrineBundle 3.0. When using ORM 3, report_fields_where_declared will always be true.',
+                                );
+
+                                return $v;
+                            })
+                        ->end()
                         ->defaultValue(true)
                         ->info('Set to "true" to opt-in to the new mapping driver mode that was added in Doctrine ORM 2.16 and will be mandatory in ORM 3.0. See https://github.com/doctrine/orm/pull/10455.')
                         ->validate()

tests/DependencyInjection/AbstractDoctrineExtensionTestCase.php

@@ -12,6 +12,7 @@
 use Doctrine\DBAL\Connections\PrimaryReadReplicaConnection;
 use Doctrine\DBAL\Platforms\PostgreSQLPlatform;
 use Doctrine\DBAL\Schema\LegacySchemaManagerFactory;
+use Doctrine\Deprecations\PHPUnit\VerifyDeprecations;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -56,6 +57,8 @@
 
 abstract class AbstractDoctrineExtensionTestCase extends TestCase
 {
+    use VerifyDeprecations;
+
     abstract protected function loadFromFile(ContainerBuilder $container, string $file): void;
 
     public function testDbalLoadFromXmlMultipleConnections(): void
@@ -912,6 +915,7 @@ public function testDisablingLazyGhostOnOrm3Throws(): void
         $this->loadContainer('orm_no_lazy_ghost');
     }
 
+    /** @group legacy */
     public function testDisablingReportFieldsWhereDeclaredOnOrm3Throws(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {
@@ -923,6 +927,21 @@ public function testDisablingReportFieldsWhereDeclaredOnOrm3Throws(): void
         $this->loadContainer('orm_no_report_fields');
     }
 
+    /** @group legacy */
+    public function testEnablingReportFieldsWhereDeclaredOnOrm3IsDeprecated(): void
+    {
+        if (! interface_exists(EntityManagerInterface::class)) {
+            self::markTestSkipped('This test requires ORM');
+        }
+
+        if (class_exists(AnnotationDriver::class)) {
+            self::markTestSkipped('This test requires ORM 3.');
+        }
+
+        $this->expectDeprecationWithIdentifier('https://github.com/doctrine/DoctrineBundle/pull/1962');
+        $this->loadContainer('orm_report_fields');
+    }
+
     public function testResolveTargetEntity(): void
     {
         if (! interface_exists(EntityManagerInterface::class)) {

tests/DependencyInjection/Compiler/IdGeneratorPassTest.php

@@ -7,6 +7,7 @@
 use Doctrine\Bundle\DoctrineBundle\Tests\DependencyInjection\Fixtures\CustomIdGenerator;
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManagerInterface;
+use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Fixtures\Bundles\AttributesBundle\AttributesBundle;
 use Fixtures\Bundles\AttributesBundle\Entity\TestCustomIdGeneratorEntity as AttributeCustomIdGeneratorEntity;
 use PHPUnit\Framework\TestCase;
@@ -15,6 +16,7 @@
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 
 use function assert;
+use function class_exists;
 use function interface_exists;
 use function method_exists;
 use function sys_get_temp_dir;
@@ -88,11 +90,10 @@ public function testRepositoryServiceWiring(): void
                 ],
                 'orm' => [
                     'mappings' => $mappings,
-                    'report_fields_where_declared' => true,
                     'enable_lazy_ghost_objects' => true,
                     /** @phpstan-ignore function.alreadyNarrowedType */
                     'enable_native_lazy_objects' => PHP_VERSION_ID >= 80400 && method_exists(Configuration::class, 'enableNativeLazyObjects'),
-                ],
+                ] + (class_exists(AnnotationDriver::class) ? ['report_fields_where_declared' => true] : []),
             ],
         ], $container);
 

tests/DependencyInjection/DoctrineExtensionTest.php

@@ -808,11 +808,10 @@ public function testAttributesBundleMappingDetection(): void
                 'default_entity_manager' => 'default',
                 'entity_managers' => [
                     'default' => [
-                        'report_fields_where_declared' => true,
                         'mappings' => [
                             'AttributesBundle' => ['type' => 'attribute'],
                         ],
-                    ],
+                    ] + (class_exists(AnnotationDriver::class) ? ['report_fields_where_declared' => true] : []),
                 ],
             ])
             ->build();

tests/DependencyInjection/Fixtures/TestKernel.php

@@ -4,13 +4,15 @@
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Doctrine\ORM\Configuration;
+use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Psr\Log\NullLogger;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\Kernel;
 
+use function class_exists;
 use function md5;
 use function method_exists;
 use function mt_rand;
@@ -51,7 +53,6 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
                     'schema_manager_factory' => 'doctrine.dbal.default_schema_manager_factory',
                 ],
                 'orm' => [
-                    'report_fields_where_declared' => true,
                     'auto_generate_proxy_classes' => true,
                     'enable_lazy_ghost_objects' => true,
                     /** @phpstan-ignore function.alreadyNarrowedType */
@@ -63,7 +64,7 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
                             'prefix' => 'Fixtures\Bundles\RepositoryServiceBundle\Entity',
                         ],
                     ],
-                ],
+                ] + (class_exists(AnnotationDriver::class) ? ['report_fields_where_declared' => true] : []),
             ]);
 
             // Register a NullLogger to avoid getting the stderr default logger of FrameworkBundle

tests/DependencyInjection/Fixtures/config/xml/orm_report_fields.xml

@@ -0,0 +1,16 @@
+<?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 report-fields-where-declared="true" />
+    </config>
+</srv:container>

tests/DependencyInjection/Fixtures/config/yml/orm_report_fields.yml

@@ -0,0 +1,9 @@
+doctrine:
+    dbal:
+        default_connection: default
+        connections:
+            default:
+                dbname: db
+
+    orm:
+        report_fields_where_declared: true

tests/ServiceRepositoryTest.php

@@ -7,6 +7,7 @@
 use Doctrine\ORM\Configuration;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\EntityRepository;
+use Doctrine\ORM\Mapping\Driver\AnnotationDriver;
 use Doctrine\ORM\QueryBuilder;
 use Fixtures\Bundles\RepositoryServiceBundle\Entity\TestCustomClassRepoEntity;
 use Fixtures\Bundles\RepositoryServiceBundle\Entity\TestCustomServiceRepoEntity;
@@ -19,6 +20,7 @@
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 
+use function class_exists;
 use function interface_exists;
 use function method_exists;
 use function sys_get_temp_dir;
@@ -81,7 +83,6 @@ public function testRepositoryServiceWiring(): void
                     'schema_manager_factory' => 'doctrine.dbal.default_schema_manager_factory',
                 ],
                 'orm' => [
-                    'report_fields_where_declared' => true,
                     'enable_lazy_ghost_objects' => true,
                     /** @phpstan-ignore function.alreadyNarrowedType */
                     'enable_native_lazy_objects' => PHP_VERSION_ID >= 80400 && method_exists(Configuration::class, 'enableNativeLazyObjects'),
@@ -92,7 +93,7 @@ public function testRepositoryServiceWiring(): void
                             'prefix' => 'Fixtures\Bundles\RepositoryServiceBundle\Entity',
                         ],
                     ],
-                ],
+                ] + (class_exists(AnnotationDriver::class) ? ['report_fields_where_declared' => true] : []),
             ],
         ], $container);