Make the preload manager independant of HTTP Foundation

symfony · dunglas · Jan 31, 2017 · Jan 31, 2017 · Jan 31, 2017 · Jan 31, 2017
commit 9c11a0fd25fc25774867b0c1e4d0fe357cccd262
diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/AssetExtensionTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/AssetExtensionTest.php
@@ -13,7 +13,7 @@
 
 use Symfony\Bridge\Twig\Extension\AssetExtension;
 use Symfony\Component\Asset\Packages;
-use Symfony\Component\Asset\Preload\HttpFoundationPreloadManager;
+use Symfony\Component\Asset\Preload\PreloadManager;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
@@ -22,7 +22,7 @@ class AssetExtensionTest extends \PHPUnit_Framework_TestCase
 {
     public function testGetAndPreloadAssetUrl()
     {
-        $preloadManager = new HttpFoundationPreloadManager();
+        $preloadManager = new PreloadManager();
         $extension = new AssetExtension(new Packages(), $preloadManager);
 
         $this->assertEquals('/foo.css', $extension->preload('/foo.css', 'style', true));

diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -14,7 +14,7 @@
 use Doctrine\Common\Annotations\Reader;
 use Symfony\Bridge\Monolog\Processor\DebugProcessor;
 use Symfony\Component\Asset\EventListener\PreloadListener;
-use Symfony\Component\Asset\Preload\HttpFoundationPreloadManager;
+use Symfony\Component\Asset\Preload\PreloadManager;
 use Symfony\Component\Cache\Adapter\AdapterInterface;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\Alias;
@@ -766,8 +766,8 @@ private function registerAssetsConfiguration(array $config, ContainerBuilder $co
             $defaultVersion = $this->createVersion($container, $config['version'], $config['version_format'], '_default');
         }
 
-        if (class_exists(HttpFoundationPreloadManager::class)) {
-            $preloadManagerDefinition = $container->register('assets.preload_manager', HttpFoundationPreloadManager::class);
+        if (class_exists(PreloadManager::class)) {
+            $preloadManagerDefinition = $container->register('assets.preload_manager', PreloadManager::class);
             $preloadManagerDefinition->setPublic(false);
 
             $preloadListener = $container->register('asset.preload_listener', PreloadListener::class);

diff --git a/src/Symfony/Component/Asset/EventListener/PreloadListener.php b/src/Symfony/Component/Asset/EventListener/PreloadListener.php
@@ -11,28 +11,28 @@
 
 namespace Symfony\Component\Asset\EventListener;
 
-use Symfony\Component\Asset\Preload\HttpFoundationPreloadManager;
+use Symfony\Component\Asset\Preload\PreloadManager;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 
 /**
- * Adds preload's Link HTTP headers to the response.
+ * Adds the preload Link HTTP header to the response.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
 class PreloadListener implements EventSubscriberInterface
 {
     private $preloadManager;
 
-    public function __construct(HttpFoundationPreloadManager $preloadManager)
+    public function __construct(PreloadManager $preloadManager)
     {
         $this->preloadManager = $preloadManager;
     }
 
     public function onKernelResponse(FilterResponseEvent $event)
     {
-        $this->preloadManager->setLinkHeader($event->getResponse());
+        $event->getResponse()->headers->set('Link', $this->preloadManager->getLinkValue());
 
         // Free memory
         $this->preloadManager->setResources(array());

diff --git a/.../Preload/HttpFoundationPreloadManager.php → ...omponent/Asset/Preload/PreloadManager.php b/.../Preload/HttpFoundationPreloadManager.php → ...omponent/Asset/Preload/PreloadManager.php
@@ -12,14 +12,13 @@
 namespace Symfony\Component\Asset\Preload;
 
 use Symfony\Component\Asset\Exception\InvalidArgumentException;
-use Symfony\Component\HttpFoundation\Response;
 
 /**
- * Preload manager for the HttpFoundation component.
+ * Manages preload HTTP headers.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class HttpFoundationPreloadManager implements PreloadManagerInterface
+class PreloadManager implements PreloadManagerInterface
 {
     private $resources = array();
 
@@ -62,14 +61,12 @@ public function setResources(array $resources)
     }
 
     /**
-     * Sets preload Link HTTP header.
-     *
-     * @param Response $response
+     * {@inheritdoc}
      */
-    public function setLinkHeader(Response $response)
+    public function getLinkValue()
     {
         if (!$this->resources) {
-            return;
+            return null;
         }
 
         $parts = array();
@@ -86,6 +83,6 @@ public function setLinkHeader(Response $response)
             $parts[] = $part;
         }
 
-        $response->headers->set('Link', implode(',', $parts));
+        return implode(',', $parts);
     }
 }
diff --git a/src/Symfony/Component/Asset/Preload/PreloadManagerInterface.php b/src/Symfony/Component/Asset/Preload/PreloadManagerInterface.php
@@ -42,4 +42,11 @@ public function getResources();
      * @param array $resources
      */
     public function setResources(array $resources);
+
+    /**
+     * Gets the value of the preload Link HTTP header.
+     *
+     * @return string|null
+     */
+    public function getLinkValue();
 }
diff --git a/src/Symfony/Component/Asset/Tests/EventListener/PreloadListenerTest.php b/src/Symfony/Component/Asset/Tests/EventListener/PreloadListenerTest.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Asset\Tests\EventListener;
 
 use Symfony\Component\Asset\EventListener\PreloadListener;
-use Symfony\Component\Asset\Preload\HttpFoundationPreloadManager;
+use Symfony\Component\Asset\Preload\PreloadManager;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
@@ -25,7 +25,7 @@ class PreloadListenerTest extends \PHPUnit_Framework_TestCase
 {
     public function testOnKernelResponse()
     {
-        $manager = new HttpFoundationPreloadManager();
+        $manager = new PreloadManager();
         $manager->addResource('/foo');
 
         $subscriber = new PreloadListener($manager);

diff --git a/...load/HttpFoundationPreloadManagerTest.php → ...sset/Tests/Preload/PreloadManagerTest.php b/...load/HttpFoundationPreloadManagerTest.php → ...sset/Tests/Preload/PreloadManagerTest.php
@@ -16,11 +16,11 @@
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class HttpFoundationPreloadManagerTest extends \PHPUnit_Framework_TestCase
+class PreloadManagerTest extends \PHPUnit_Framework_TestCase
 {
     public function testManageResources()
     {
-        $manager = new HttpFoundationPreloadManager();
+        $manager = new PreloadManager();
         $this->assertInstanceOf(PreloadManagerInterface::class, $manager);
 
         $manager->setResources(array('/foo/bar.js' => array('as' => 'script', 'nopush' => false)));
@@ -33,10 +33,7 @@ public function testManageResources()
                 '/foo/bat.png' => array('as' => 'image', 'nopush' => true),
         ), $manager->getResources());
 
-        $response = new Response();
-        $manager->setLinkHeader($response);
-
-        $this->assertEquals('</foo/bar.js>; rel=preload; as=script,</foo/baz.css>; rel=preload,</foo/bat.png>; rel=preload; as=image; nopush', $response->headers->get('Link'));
+        $this->assertEquals('</foo/bar.js>; rel=preload; as=script,</foo/baz.css>; rel=preload,</foo/bat.png>; rel=preload; as=image; nopush', $manager->getLinkValue());
     }
 
     /**
@@ -45,7 +42,7 @@ public function testManageResources()
      */
     public function testInvalidResources($resources)
     {
-        $manager = new HttpFoundationPreloadManager();
+        $manager = new PreloadManager();
         $manager->setResources($resources);
     }