[HttpKernel] Deprecate StreamedResponseListener, it serves no purpose anymore

nicolas-grekas · nicolas-grekas · commit ee617748174d · 2022-02-18T16:56:00.000+01:00
diff --git a/UPGRADE-6.1.md b/UPGRADE-6.1.md
@@ -12,6 +12,11 @@ Console
 
  * Deprecate `Command::$defaultName` and `Command::$defaultDescription`, use the `AsCommand` attribute instead
 
+HttpKernel
+----------
+
+ * Deprecate StreamedResponseListener, it's not needed anymore
+
 Serializer
 ----------
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php
@@ -26,7 +26,6 @@
 use Symfony\Component\HttpKernel\EventListener\ErrorListener;
 use Symfony\Component\HttpKernel\EventListener\LocaleListener;
 use Symfony\Component\HttpKernel\EventListener\ResponseListener;
-use Symfony\Component\HttpKernel\EventListener\StreamedResponseListener;
 use Symfony\Component\HttpKernel\EventListener\ValidateRequestListener;
 
 return static function (ContainerConfigurator $container) {
@@ -79,9 +78,6 @@
             ])
             ->tag('kernel.event_subscriber')
 
-        ->set('streamed_response_listener', StreamedResponseListener::class)
-            ->tag('kernel.event_subscriber')
-
         ->set('locale_listener', LocaleListener::class)
             ->args([
                 service('request_stack'),
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 ---
 
  * Add `BackedEnumValueResolver` to resolve backed enum cases from request attributes in controller arguments
+ * Deprecate StreamedResponseListener, it's not needed anymore
 
 6.0
 ---
diff --git a/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php b/src/Symfony/Component/HttpKernel/EventListener/AbstractSessionListener.php
@@ -246,7 +246,7 @@ public static function getSubscribedEvents(): array
     {
         return [
             KernelEvents::REQUEST => ['onKernelRequest', 128],
-            // low priority to come after regular response listeners, but higher than StreamedResponseListener
+            // low priority to come after regular response listeners
             KernelEvents::RESPONSE => ['onKernelResponse', -1000],
         ];
     }
diff --git a/src/Symfony/Component/HttpKernel/EventListener/StreamedResponseListener.php b/src/Symfony/Component/HttpKernel/EventListener/StreamedResponseListener.php
@@ -16,13 +16,17 @@
 use Symfony\Component\HttpKernel\Event\ResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
+trigger_deprecation('symfony/http-kernel', '6.1', 'The "%s" class is deprecated.', StreamedResponseListener::class);
+
 /**
  * StreamedResponseListener is responsible for sending the Response
  * to the client.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @final
+ *
+ * @deprecated since Symfony 6.1
  */
 class StreamedResponseListener implements EventSubscriberInterface
 {

Original file line number	Diff line number	Diff line change
`@@ -246,7 +246,7 @@ public static function getSubscribedEvents(): array`
`246`	`246`	`{`
`247`	`247`	`return [`
`248`	`248`	`KernelEvents::REQUEST => ['onKernelRequest', 128],`
`249`		`- // low priority to come after regular response listeners, but higher than StreamedResponseListener`
	`249`	`+ // low priority to come after regular response listeners`
`250`	`250`	`KernelEvents::RESPONSE => ['onKernelResponse', -1000],`
`251`	`251`	`];`
`252`	`252`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,13 +16,17 @@`
`16`	`16`	`use Symfony\Component\HttpKernel\Event\ResponseEvent;`
`17`	`17`	`use Symfony\Component\HttpKernel\KernelEvents;`
`18`	`18`
	`19`	`+trigger_deprecation('symfony/http-kernel', '6.1', 'The "%s" class is deprecated.', StreamedResponseListener::class);`
	`20`	`+`
`19`	`21`	`/**`
`20`	`22`	`* StreamedResponseListener is responsible for sending the Response`
`21`	`23`	`* to the client.`
`22`	`24`	`*`
`23`	`25`	`* @author Fabien Potencier <fabien@symfony.com>`
`24`	`26`	`*`
`25`	`27`	`* @final`
	`28`	`+ *`
	`29`	`+ * @deprecated since Symfony 6.1`
`26`	`30`	`*/`
`27`	`31`	`class StreamedResponseListener implements EventSubscriberInterface`
`28`	`32`	`{`