feature #43322 [MonologBridge] Deprecates ResetLoggersWorkerSubscriber (lyrixx)

nicolas-grekas · nicolas-grekas · commit 4868dd0504b1 · 2021-10-06T11:19:46.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [MonologBridge] Deprecates ResetLoggersWorkerSubscriber | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | yes | Deprecations? | yes | Tickets | Fix #43271 | License | MIT | Doc PR | Commits ------- 641e50a [MonologBridge] Deprecates ResetLoggersWorkerSubscriber
diff --git a/src/Symfony/Bridge/Monolog/CHANGELOG.md b/src/Symfony/Bridge/Monolog/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+5.4
+---
+
+ * Deprecate `ResetLoggersWorkerSubscriber` to reset buffered logs in messenger
+   workers, use "reset_on_message" option in messenger configuration instead.
+
 5.3
 ---
 
diff --git a/src/Symfony/Bridge/Monolog/Messenger/ResetLoggersWorkerSubscriber.php b/src/Symfony/Bridge/Monolog/Messenger/ResetLoggersWorkerSubscriber.php
@@ -16,10 +16,14 @@
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
 
+trigger_deprecation('symfony/monolog-bridge', '5.4', 'The "%s" class is deprecated, use "reset_on_message" option in messenger configuration instead.', ResetLoggersWorkerSubscriber::class);
+
 /**
  * Reset loggers between messages being handled to release buffered handler logs.
  *
  * @author Laurent VOULLEMIER <laurent.voullemier@gmail.com>
+ *
+ * @deprecated since Symfony 5.4, use "reset_on_message" option in messenger configuration instead.
  */
 class ResetLoggersWorkerSubscriber implements EventSubscriberInterface
 {
diff --git a/src/Symfony/Bridge/Monolog/Tests/Messenger/ResetLoggersWorkerSubscriberTest.php b/src/Symfony/Bridge/Monolog/Tests/Messenger/ResetLoggersWorkerSubscriberTest.php
@@ -25,6 +25,7 @@
 use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;
 use Symfony\Component\Messenger\Worker;
 
+/** @group legacy */
 class ResetLoggersWorkerSubscriberTest extends TestCase
 {
     public function testLogsAreFlushed()

Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,14 @@`
`16`	`16`	`use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;`
`17`	`17`	`use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;`
`18`	`18`
	`19`	`+trigger_deprecation('symfony/monolog-bridge', '5.4', 'The "%s" class is deprecated, use "reset_on_message" option in messenger configuration instead.', ResetLoggersWorkerSubscriber::class);`
	`20`	`+`
`19`	`21`	`/**`
`20`	`22`	`* Reset loggers between messages being handled to release buffered handler logs.`
`21`	`23`	`*`
`22`	`24`	`* @author Laurent VOULLEMIER <laurent.voullemier@gmail.com>`
	`25`	`+ *`
	`26`	`+ * @deprecated since Symfony 5.4, use "reset_on_message" option in messenger configuration instead.`
`23`	`27`	`*/`
`24`	`28`	`class ResetLoggersWorkerSubscriber implements EventSubscriberInterface`
`25`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@`
`25`	`25`	`use Symfony\Component\Messenger\Transport\Receiver\ReceiverInterface;`
`26`	`26`	`use Symfony\Component\Messenger\Worker;`
`27`	`27`
	`28`	`+/** @group legacy */`
`28`	`29`	`class ResetLoggersWorkerSubscriberTest extends TestCase`
`29`	`30`	`{`
`30`	`31`	`public function testLogsAreFlushed()`