merged branch fabpot/kernel-refactor (PR symfony#6459)

This PR was merged into the master branch. Commits ------- 76fefe3 updated CHANGELOG and UPGRADE files f7da1f0 added some unit tests (and fixed some bugs) f17f586 moved the container aware HTTP kernel to the HttpKernel component 2eea768 moved the deprecation logic calls outside the new HttpContentRenderer class bd102c5 made the content renderer work even when ESI is disabled or when no templating engine is available (the latter being mostly useful when testing) a8ea4e4 [FrameworkBundle] deprecated HttpKernel::forward() (it is only used once now and not part of any interface anyway) 1240690 [HttpKernel] made the strategy a regular parameter in HttpContentRenderer::render() adc067e [FrameworkBundle] made some services private 1f1392d [HttpKernel] simplified and enhanced code managing the hinclude strategy 403bb06 [HttpKernel] added missing phpdoc and tweaked existing ones 892f00f [HttpKernel] added a URL signer mechanism for hincludes a0c49c3 [TwigBridge] added a render_* function to ease usage of custom rendering strategies 9aaceb1 moved the logic from HttpKernel in FrameworkBundle to the HttpKernel component Discussion ---------- [WIP] Kernel refactor Currently, the handling of sub-requests (including ESI and hinclude) is mostly done in FrameworkBundle. It makes these important features harder to implement for people using only HttpKernel (like Drupal and Silex for instance). This PR moves the code to HttpKernel instead. The code has also been refactored to allow easier integration of other rendering strategies (refs symfony#6108). The internal route has been re-introduced but it can only be used for trusted IPs (so for the internal rendering which is managed by Symfony itself, or by a trusted reverse proxy like Varnish for ESI handling). For the hinclude strategy, when using a controller, the URL is automatically signed (see symfony#6463). The usage of a listener instead of a controller to handle internal sub-requests speeds up things quite a lot as it saves one sub-request handling. In Symfony 2.0 and 2.1, the handling of a sub-request actually creates two sub-requests. Rendering a sub-request from a controller can be done with the following code: ```jinja {# default strategy #} {{ render(path("partial")) }} {{ render(controller("SomeBundle:Controller:partial")) }} {# ESI strategy #} {{ render(path("partial"), { strategy: 'esi' }) }} {{ render(controller("SomeBundle:Controller:partial"), { strategy: 'esi' }) }} {# hinclude strategy #} {{ render(path("default1"), { strategy: 'hinclude' }) }} ``` The second commit allows to simplify the calls a little bit thanks to some nice syntactic sugar: ```jinja {# default strategy #} {{ render(path("partial")) }} {{ render(controller("SomeBundle:Controller:partial")) }} {# ESI strategy #} {{ render_esi(path("partial")) }} {{ render_esi(controller("SomeBundle:Controller:partial")) }} {# hinclude strategy #} {{ render_hinclude(path("default1")) }} ``` --------------------------------------------------------------------------- by fabpot at 2013-01-03T17:58:49Z I've just pushed a new version of the code that actually works in my browser (but I've not yet written any unit tests). I've updated the PR description accordingly. All comments welcome! --------------------------------------------------------------------------- by Koc at 2013-01-03T20:11:43Z what about `render(controller="SomeBundle:Controller:partial", strategy="esi")`? --------------------------------------------------------------------------- by stof at 2013-01-04T09:01:01Z shouldn't we have interfaces for the UriSigner and the HttpContentRenderer ? --------------------------------------------------------------------------- by lsmith77 at 2013-01-04T19:28:09Z btw .. as mentioned in symfony#6213 i think it would make sense to refactor the HttpCache to use a cache layer to allow more flexibility in where to cache the data (including clustering) and better invalidation. as such if you are refactoring HttpKernel .. it might also make sense to explore splitting off HttpCache. --------------------------------------------------------------------------- by fabpot at 2013-01-04T19:30:07Z @lsmith77 This is a totally different topic. This PR is just about moving things from FrameworkBundle to HttpKernel to make them more reusable outside of the full-stack framework. --------------------------------------------------------------------------- by fabpot at 2013-01-05T09:39:52Z I think this PR is almost ready now. I still need to update the docs and add some unit tests. Any other comments on the whole approach? The class names? The `controller` function thingy? The URI signer mechanism? The proxy protection for the internal controller? The proxy to handle internal routes? --------------------------------------------------------------------------- by sstok at 2013-01-05T10:08:25Z Looks good to me :+1: --------------------------------------------------------------------------- by sdboyer at 2013-01-07T18:17:08Z @Crell asked me to weigh in, since i'm one of the Drupal folks who's likely to work most with this. i think i've grokked about 60% of the big picture here, and i'm generally happy with what i see. the assumption that the HInclude strategy makes about working with templates probably isn't one that we'll be able to use (and so, would need to write our own), but that's not a big deal since the whole goal here is to make strategies pluggable. so, yeah. +1. --------------------------------------------------------------------------- by winzou at 2013-01-09T20:21:44Z Just for my information: will this PR be merged for 2.2 version? Thanks. --------------------------------------------------------------------------- by stof at 2013-01-09T20:41:04Z @winzou according to the blog post announcing the beta 1 release, yes. It is explicitly listed as being one of the reason to make it a beta instead of the first RC. --------------------------------------------------------------------------- by winzou at 2013-01-09T20:49:36Z OK thanks, I've totally skipped this blog post. --------------------------------------------------------------------------- by fabpot at 2013-01-10T15:26:15Z I've just added a bunch of unit tests and fix some bugs I found while writing the tests.
kcsampson · Jan 11, 2013 · b58e8ce · b58e8ce
2 parents 2aba3aa + 76fefe3
commit b58e8ce
Show file tree

Hide file tree

Showing 40 changed files with 1,825 additions and 255 deletions.
diff --git a/UPGRADE-2.2.md b/UPGRADE-2.2.md
@@ -14,11 +14,9 @@
    After:
 
    ```
-   {% render url('post_list', { 'limit': 2 }), { 'alt': 'BlogBundle:Post:error' } %}
+   {% render controller('BlogBundle:Post:list', { 'limit': 2 }), { 'alt': 'BlogBundle:Post:error' } %}
    ```
 
-   where `post_list` is the route name for the `BlogBundle:Post:list` controller.
-
 ### HttpFoundation
 
  * The MongoDbSessionHandler default field names and timestamp type have changed.
@@ -537,7 +535,12 @@
    <?php echo $view['actions']->render($view['router']->generate('post_list', array('limit' => 2)), array('alt' => 'BlogBundle:Post:error')) ?>
    ```
 
-   where `post_list` is the route name for the `BlogBundle:Post:list` controller.
+   where `post_list` is the route name for the `BlogBundle:Post:list`
+   controller, or if you don't want to create a route:
+
+   ```
+   <?php echo $view['actions']->render(new ControllerReference('BlogBundle:Post:list', array('limit' => 2)), array('alt' => 'BlogBundle:Post:error')) ?>
+   ```
 
 #### Configuration
 

diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -4,8 +4,10 @@ CHANGELOG
 2.2.0
 -----
 
- * [BC BREAK] restricted the `render` tag to only accept URIs as reference (the signature changed)
- * added a render function to render a request
+ * added a `controller` function to help generating controller references
+ * added a `render_esi` and a `render_hinclude` function
+ * [BC BREAK] restricted the `render` tag to only accept URIs or ControllerReference instances (the signature changed)
+ * added a `render` function to render a request
  * The `app` global variable is now injected even when using the twig service directly.
  * Added an optional parameter to the `path` and `url` function which allows to generate
    relative paths (e.g. "../parent-file") and scheme-relative URLs (e.g. "//example.com/dir/file").

diff --git a/src/Symfony/Bridge/Twig/Extension/HttpKernelExtension.php b/src/Symfony/Bridge/Twig/Extension/HttpKernelExtension.php
@@ -11,83 +11,65 @@
 
 namespace Symfony\Bridge\Twig\Extension;
 
-use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\HttpKernel\KernelEvents;
-use Symfony\Component\HttpKernel\HttpKernelInterface;
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\HttpContentRenderer;
+use Symfony\Component\HttpKernel\Controller\ControllerReference;
 
 /**
  * Provides integration with the HttpKernel component.
  *
  * @author Fabien Potencier <[email protected]>
  */
-class HttpKernelExtension extends \Twig_Extension implements EventSubscriberInterface
+class HttpKernelExtension extends \Twig_Extension
 {
-    private $kernel;
-    private $request;
+    private $renderer;
 
     /**
      * Constructor.
      *
-     * @param HttpKernelInterface $kernel A HttpKernelInterface install
+     * @param HttpContentRenderer $kernel A HttpContentRenderer instance
      */
-    public function __construct(HttpKernelInterface $kernel)
+    public function __construct(HttpContentRenderer $renderer)
     {
-        $this->kernel = $kernel;
+        $this->renderer = $renderer;
     }
 
     public function getFunctions()
     {
         return array(
-            'render' => new \Twig_Function_Method($this, 'render', array('needs_environment' => true, 'is_safe' => array('html'))),
+            'render' => new \Twig_Function_Method($this, 'render', array('is_safe' => array('html'))),
+            'render_*' => new \Twig_Function_Method($this, 'renderStrategy', array('is_safe' => array('html'))),
+            'controller' => new \Twig_Function_Method($this, 'controller'),
         );
     }
 
     /**
      * Renders a URI.
      *
-     * @param \Twig_Environment $twig A \Twig_Environment instance
-     * @param string            $uri  The URI to render
+     * @param string $uri     A URI
+     * @param array  $options An array of options
      *
      * @return string The Response content
      *
-     * @throws \RuntimeException
+     * @see Symfony\Component\HttpKernel\HttpContentRenderer::render()
      */
-    public function render(\Twig_Environment $twig, $uri)
+    public function render($uri, $options = array())
     {
-        if (null !== $this->request) {
-            $cookies = $this->request->cookies->all();
-            $server = $this->request->server->all();
-        } else {
-            $cookies = array();
-            $server = array();
-        }
+        $options = $this->renderer->fixOptions($options);
 
-        $subRequest = Request::create($uri, 'get', array(), $cookies, array(), $server);
-        if (null !== $this->request && $this->request->getSession()) {
-            $subRequest->setSession($this->request->getSession());
-        }
+        $strategy = isset($options['strategy']) ? $options['strategy'] : 'default';
+        unset($options['strategy']);
 
-        $response = $this->kernel->handle($subRequest, HttpKernelInterface::SUB_REQUEST, false);
-
-        if (!$response->isSuccessful()) {
-            throw new \RuntimeException(sprintf('Error when rendering "%s" (Status code is %s).', $subRequest->getUri(), $response->getStatusCode()));
-        }
-
-        return $response->getContent();
+        return $this->renderer->render($uri, $strategy, $options);
     }
 
-    public function onKernelRequest(GetResponseEvent $event)
+    public function renderStrategy($strategy, $uri, $options = array())
     {
-        $this->request = $event->getRequest();
+        return $this->renderer->render($uri, $strategy, $options);
     }
 
-    public static function getSubscribedEvents()
+    public function controller($controller, $attributes = array(), $query = array())
     {
-        return array(
-            KernelEvents::REQUEST => array('onKernelRequest'),
-        );
+        return new ControllerReference($controller, $attributes, $query);
     }
 
     public function getName()

diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php
@@ -13,8 +13,7 @@
 
 use Symfony\Bridge\Twig\Extension\HttpKernelExtension;
 use Symfony\Bridge\Twig\Tests\TestCase;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\HttpKernelInterface;
+use Symfony\Component\HttpKernel\HttpContentRenderer;
 
 class HttpKernelExtensionTest extends TestCase
 {
@@ -31,7 +30,7 @@ protected function setUp()
 
     public function testRenderWithoutMasterRequest()
     {
-        $kernel = $this->getKernel($this->returnValue(new Response('foo')));
+        $kernel = $this->getHttpContentRenderer($this->returnValue('foo'));
 
         $this->assertEquals('foo', $this->renderTemplate($kernel));
     }
@@ -41,7 +40,7 @@ public function testRenderWithoutMasterRequest()
      */
     public function testRenderWithError()
     {
-        $kernel = $this->getKernel($this->throwException(new \Exception('foo')));
+        $kernel = $this->getHttpContentRenderer($this->throwException(new \Exception('foo')));
 
         $loader = new \Twig_Loader_Array(array('index' => '{{ render("foo") }}'));
         $twig = new \Twig_Environment($loader, array('debug' => true, 'cache' => false));
@@ -50,23 +49,20 @@ public function testRenderWithError()
         $this->renderTemplate($kernel);
     }
 
-    protected function getKernel($return)
+    protected function getHttpContentRenderer($return)
     {
-        $kernel = $this->getMock('Symfony\Component\HttpKernel\HttpKernelInterface');
-        $kernel
-            ->expects($this->once())
-            ->method('handle')
-            ->will($return)
-        ;
+        $strategy = $this->getMock('Symfony\\Component\\HttpKernel\\RenderingStrategy\\RenderingStrategyInterface');
+        $strategy->expects($this->once())->method('getName')->will($this->returnValue('default'));
+        $strategy->expects($this->once())->method('render')->will($return);
 
-        return $kernel;
+        return new HttpContentRenderer(array($strategy));
     }
 
-    protected function renderTemplate(HttpKernelInterface $kernel, $template = '{{ render("foo") }}')
+    protected function renderTemplate(HttpContentRenderer $renderer, $template = '{{ render("foo") }}')
     {
         $loader = new \Twig_Loader_Array(array('index' => $template));
         $twig = new \Twig_Environment($loader, array('debug' => true, 'cache' => false));
-        $twig->addExtension(new HttpKernelExtension($kernel));
+        $twig->addExtension(new HttpKernelExtension($renderer));
 
         return $twig->render('index');
     }

diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -4,11 +4,16 @@ CHANGELOG
 2.2.0
 -----
 
- * [BC BREAK] restricted the `Symfony\Bundle\FrameworkBundle\HttpKernel::render()` method to only accept URIs as reference
+ * added a new `uri_signer` service to help sign URIs
+ * deprecated `Symfony\Bundle\FrameworkBundle\HttpKernel::render()` and `Symfony\Bundle\FrameworkBundle\HttpKernel::forward()`
+ * deprecated the `Symfony\Bundle\FrameworkBundle\HttpKernel` class in favor of `Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel`
+ * added support for adding new HTTP content rendering strategies (like ESI and Hinclude)
+   in the DIC via the `kernel.content_renderer_strategy` tag
+ * [BC BREAK] restricted the `Symfony\Bundle\FrameworkBundle\HttpKernel::render()` method to only accept URIs or ControllerReference instances
    * `Symfony\Bundle\FrameworkBundle\HttpKernel::render()` method signature changed and the first argument
-     must now be a URI (the `generateInternalUri()` method was removed)
-   * The internal routes have been removed (`Resources/config/routing/internal.xml`)
-   * The `render` method of the `actions` templating helper signature and arguments changed:
+     must now be a URI or a ControllerReference instance (the `generateInternalUri()` method was removed)
+   * The internal routes (`Resources/config/routing/internal.xml`) have been replaced with a new proxy route (`Resources/config/routing/proxy.xml`)
+   * The `render` method of the `actions` templating helper signature and arguments changed
  * replaced Symfony\Bundle\FrameworkBundle\Controller\TraceableControllerResolver by Symfony\Component\HttpKernel\Controller\TraceableControllerResolver
  * replaced Symfony\Component\HttpKernel\Debug\ContainerAwareTraceableEventDispatcher by Symfony\Component\HttpKernel\Debug\TraceableEventDispatcher
  * added Client::enableProfiler()

diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php b/src/Symfony/Bundle/FrameworkBundle/Controller/Controller.php
@@ -59,7 +59,10 @@ public function generateUrl($route, $parameters = array(), $referenceType = UrlG
      */
     public function forward($controller, array $path = array(), array $query = array())
     {
-        return $this->container->get('http_kernel')->forward($controller, $path, $query);
+        $path['_controller'] = $controller;
+        $subRequest = $this->container->get('request')->duplicate($query, null, $path);
+
+        return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
     }
 
     /**

diff --git a/...Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/HttpRenderingStrategyPass.php b/...Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/HttpRenderingStrategyPass.php
@@ -0,0 +1,45 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+ * Adds services tagged kernel.content_renderer_strategy as HTTP content rendering strategies.
+ *
+ * @author Fabien Potencier <[email protected]>
+ */
+class HttpRenderingStrategyPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (false === $container->hasDefinition('http_content_renderer')) {
+            return;
+        }
+
+        $definition = $container->getDefinition('http_content_renderer');
+        foreach (array_keys($container->findTaggedServiceIds('kernel.content_renderer_strategy')) as $id) {
+            // We must assume that the class value has been correctly filled, even if the service is created by a factory
+            $class = $container->getDefinition($id)->getClass();
+
+            $refClass = new \ReflectionClass($class);
+            $interface = 'Symfony\Component\HttpKernel\RenderingStrategy\RenderingStrategyInterface';
+            if (!$refClass->implementsInterface($interface)) {
+                throw new \InvalidArgumentException(sprintf('Service "%s" must implement interface "%s".', $id, $interface));
+            }
+
+            $definition->addMethodCall('addStrategy', array(new Reference($id)));
+        }
+    }
+}
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php
@@ -41,6 +41,7 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('web.xml');
         $loader->load('services.xml');
+        $loader->load('content_generator.xml');
 
         // A translator must always be registered (as support is included by
         // default in the Form component). If disabled, an identity translator

diff --git a/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php b/src/Symfony/Bundle/FrameworkBundle/FrameworkBundle.php
@@ -25,6 +25,7 @@
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\CompilerDebugDumpPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationExtractorPass;
 use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\TranslationDumperPass;
+use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\HttpRenderingStrategyPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\Scope;
@@ -65,6 +66,7 @@ public function build(ContainerBuilder $container)
         $container->addCompilerPass(new AddCacheClearerPass());
         $container->addCompilerPass(new TranslationExtractorPass());
         $container->addCompilerPass(new TranslationDumperPass());
+        $container->addCompilerPass(new HttpRenderingStrategyPass(), PassConfig::TYPE_AFTER_REMOVING);
 
         if ($container->getParameter('kernel.debug')) {
             $container->addCompilerPass(new ContainerBuilderDebugDumpPass(), PassConfig::TYPE_AFTER_REMOVING);