feature #50579 [DoctrineBridge] Deprecate using the old DBAL logger system (derrabus)

nicolas-grekas · nicolas-grekas · commit 265184e44be9 · 2023-06-08T23:45:33.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [DoctrineBridge] Deprecate using the old DBAL logger system | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | yes | Tickets | Backport from #50571 | License | MIT | Doc PR | N/A Commits ------- a8f6243 Deprecate using the old DBAL logger system
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -1,6 +1,13 @@
 UPGRADE FROM 6.3 to 6.4
 =======================
 
+DoctrineBridge
+--------------
+
+ * Deprecate `DbalLogger`, use a middleware instead
+ * Deprecate not constructing `DoctrineDataCollector` with an instance of `DebugDataHolder`
+ * Deprecate `DoctrineDataCollector::addLogger()`, use a `DebugDataHolder` instead
+
 HttpFoundation
 --------------
 
diff --git a/src/Symfony/Bridge/Doctrine/CHANGELOG.md b/src/Symfony/Bridge/Doctrine/CHANGELOG.md
@@ -1,6 +1,13 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+ * Deprecate `DbalLogger`, use a middleware instead
+ * Deprecate not constructing `DoctrineDataCollector` with an instance of `DebugDataHolder`
+ * Deprecate `DoctrineDataCollector::addLogger()`, use a `DebugDataHolder` instead
+
 6.3
 ---
 
diff --git a/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php b/src/Symfony/Bridge/Doctrine/DataCollector/DoctrineDataCollector.php
@@ -43,15 +43,23 @@ public function __construct(
     ) {
         $this->connections = $registry->getConnectionNames();
         $this->managers = $registry->getManagerNames();
+
+        if (null === $debugDataHolder) {
+            trigger_deprecation('symfony/doctrine-bridge', '6.4', 'Not passing an instance of "%s" as "$debugDataHolder" to "%s()" is deprecated.', DebugDataHolder::class, __METHOD__);
+        }
     }
 
     /**
      * Adds the stack logger for a connection.
      *
      * @return void
+     *
+     * @deprecated since Symfony 6.4, use a DebugDataHolder instead.
      */
     public function addLogger(string $name, DebugStack $logger)
     {
+        trigger_deprecation('symfony/doctrine-bridge', '6.4', '"%s()" is deprecated. Pass an instance of "%s" to the constructor instead.', __METHOD__, DebugDataHolder::class);
+
         $this->loggers[$name] = $logger;
     }
 
diff --git a/src/Symfony/Bridge/Doctrine/Logger/DbalLogger.php b/src/Symfony/Bridge/Doctrine/Logger/DbalLogger.php
@@ -15,8 +15,12 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Stopwatch\Stopwatch;
 
+trigger_deprecation('symfony/doctrine-bridge', '6.4', '"%s" is deprecated, use a middleware instead.', DbalLogger::class);
+
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @deprecated since Symfony 6.4, use a middleware instead.
  */
 class DbalLogger implements SQLLogger
 {
diff --git a/src/Symfony/Bridge/Doctrine/Tests/DataCollector/DoctrineDataCollectorWithDebugStackTest.php b/src/Symfony/Bridge/Doctrine/Tests/DataCollector/DoctrineDataCollectorWithDebugStackTest.php
@@ -17,6 +17,7 @@
 use Doctrine\Persistence\ManagerRegistry;
 use PHPUnit\Framework\TestCase;
 use Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector;
+use Symfony\Bridge\PhpUnit\ExpectDeprecationTrait;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\VarDumper\Cloner\Data;
@@ -31,6 +32,7 @@ class_exists(\Doctrine\DBAL\Platforms\MySqlPlatform::class);
 class DoctrineDataCollectorWithDebugStackTest extends TestCase
 {
     use DoctrineDataCollectorTestTrait;
+    use ExpectDeprecationTrait;
 
     public function testReset()
     {
@@ -178,9 +180,12 @@ private function createCollector(array $queries): DoctrineDataCollector
             ->method('getConnection')
             ->willReturn($connection);
 
+        $this->expectDeprecation('Since symfony/doctrine-bridge 6.4: Not passing an instance of "Symfony\Bridge\Doctrine\Middleware\Debug\DebugDataHolder" as "$debugDataHolder" to "Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector::__construct()" is deprecated.');
         $collector = new DoctrineDataCollector($registry);
         $logger = $this->createMock(DebugStack::class);
         $logger->queries = $queries;
+
+        $this->expectDeprecation('Since symfony/doctrine-bridge 6.4: "Symfony\Bridge\Doctrine\DataCollector\DoctrineDataCollector::addLogger()" is deprecated. Pass an instance of "Symfony\Bridge\Doctrine\Middleware\Debug\DebugDataHolder" to the constructor instead.');
         $collector->addLogger('default', $logger);
 
         return $collector;

Original file line number	Diff line number	Diff line change
`@@ -43,15 +43,23 @@ public function __construct(`
`43`	`43`	`) {`
`44`	`44`	`$this->connections = $registry->getConnectionNames();`
`45`	`45`	`$this->managers = $registry->getManagerNames();`
	`46`	`+`
	`47`	`+ if (null === $debugDataHolder) {`
	`48`	`+ trigger_deprecation('symfony/doctrine-bridge', '6.4', 'Not passing an instance of "%s" as "$debugDataHolder" to "%s()" is deprecated.', DebugDataHolder::class, __METHOD__);`
	`49`	`+ }`
`46`	`50`	`}`
`47`	`51`
`48`	`52`	`/**`
`49`	`53`	`* Adds the stack logger for a connection.`
`50`	`54`	`*`
`51`	`55`	`* @return void`
	`56`	`+ *`
	`57`	`+ * @deprecated since Symfony 6.4, use a DebugDataHolder instead.`
`52`	`58`	`*/`
`53`	`59`	`public function addLogger(string $name, DebugStack $logger)`
`54`	`60`	`{`
	`61`	`+ trigger_deprecation('symfony/doctrine-bridge', '6.4', '"%s()" is deprecated. Pass an instance of "%s" to the constructor instead.', __METHOD__, DebugDataHolder::class);`
	`62`	`+`
`55`	`63`	`$this->loggers[$name] = $logger;`
`56`	`64`	`}`
`57`	`65`