merged branch fabpot/contagious-services (PR #7007)

fabpot · fabpot · commit 4b56e49ebb11 · 2013-03-23T14:07:03.000+01:00
This PR was merged into the master branch. Discussion ---------- [2.3] [WIP] Synchronized services... | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #5300, #6756 | License | MIT | Doc PR | symfony/symfony-docs#2343 Todo: - [x] update documentation - [x] find a better name than contagious (synchronized)? refs #6932, refs #5012 This PR is a proof of concept that tries to find a solution for some problems we have with scopes and services depending on scoped services (mostly the request service in Symfony). Basically, whenever you want to inject the Request into a service, you have two possibilities: * put your own service into the request scope (a new service will be created whenever a sub-request is run, and the service is not available outside the request scope); * set the request service reference as non-strict (your service is always available but the request you have depends on when the service is created the first time). This PR addresses this issue by allowing to use the second option but you service still always has the right Request service (see below for a longer explanation on how it works). There is another issue that this PR fixes: edge cases and weird behaviors. There are several bug reports about some weird behaviors, and most of the time, this is related to the sub-requests. That's because the Request is injected into several Symfony objects without being updated correctly when leaving the request scope. Let me explain that: when a listener for instance needs the Request object, it can listen to the `kernel.request` event and store the request somewhere. So, whenever you enter a sub-request, the listener will get the new one. But when the sub-request ends, the listener has no way to know that it needs to reset the request to the master one. In practice, that's not really an issue, but let me show you an example of this issue in practice: * You have a controller that is called with the English locale; * The controller (probably via a template) renders a sub-request that uses the French locale; * After the rendering, and from the controller, you try to generate a URL. Which locale the router will use? Yes, the French locale, which is wrong. To fix these issues, this PR introduces a new notion in the DIC: synchronized services. When a service is marked as synchronized, all method calls involving this service will be called each time this service is set. When in a scope, methods are also called to restore the previous version of the service when the scope leaves. If you have a look at the router or the locale listener, you will see that there is now a `setRequest` method that will called whenever the request service changes (because the `Container::set()` method is called or because the service is changed by a scope change). Commits ------- 17269e1 [DependencyInjection] fixed management of scoped services with an invalid behavior set to null bb83b3e [HttpKernel] added a safeguard for when a fragment is rendered outside the context of a master request 5d7b835 [FrameworkBundle] added some functional tests ff9d688 fixed Request management for FragmentHandler 1b98ad3 fixed Request management for LocaleListener a7b2b7e fixed Request management for RequestListener 0892135 [HttpKernel] ensured that the Request is null when outside of the Request scope 2ffcfb9 [FrameworkBundle] made the Request service synchronized ec1e7ca [DependencyInjection] added a way to automatically update scoped services
diff --git a/Resources/config/fragment_renderer.xml b/Resources/config/fragment_renderer.xml
@@ -14,9 +14,9 @@
 
     <services>
         <service id="fragment.handler" class="%fragment.handler.class%">
-            <tag name="kernel.event_subscriber" />
             <argument type="collection" />
             <argument>%kernel.debug%</argument>
+            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
         </service>
 
         <service id="fragment.renderer.inline" class="%fragment.renderer.inline.class%">
diff --git a/Resources/config/routing.xml b/Resources/config/routing.xml
@@ -94,6 +94,7 @@
             <argument type="service" id="router" />
             <argument type="service" id="router.request_context" on-invalid="ignore" />
             <argument type="service" id="logger" on-invalid="ignore" />
+            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
         </service>
     </services>
 </container>
diff --git a/Resources/config/services.xml b/Resources/config/services.xml
@@ -40,7 +40,7 @@
             This service definition only defines the scope of the request.
             It is used to check references scope.
         -->
-        <service id="request" scope="request" synthetic="true" />
+        <service id="request" scope="request" synthetic="true" synchronized="true" />
 
         <service id="service_container" synthetic="true" />
 
diff --git a/Resources/config/web.xml b/Resources/config/web.xml
@@ -38,6 +38,7 @@
             <tag name="kernel.event_subscriber" />
             <argument>%kernel.default_locale%</argument>
             <argument type="service" id="router" on-invalid="ignore" />
+            <call method="setRequest"><argument type="service" id="request" on-invalid="null" strict="false" /></call>
         </service>
     </services>
 </container>
diff --git a/Tests/Functional/Bundle/TestBundle/Controller/SubRequestController.php b/Tests/Functional/Bundle/TestBundle/Controller/SubRequestController.php
@@ -0,0 +1,66 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\DependencyInjection\ContainerAware;
+use Symfony\Component\HttpKernel\Controller\ControllerReference;
+
+class SubRequestController extends ContainerAware
+{
+    public function indexAction()
+    {
+        $handler = $this->container->get('fragment.handler');
+
+        $errorUrl = $this->generateUrl('subrequest_fragment_error', array('_locale' => 'fr', '_format' => 'json'));
+        $altUrl = $this->generateUrl('subrequest_fragment', array('_locale' => 'fr', '_format' => 'json'));
+
+        // simulates a failure during the rendering of a fragment...
+        // should render fr/json
+        $content  = $handler->render($errorUrl, 'inline', array('alt' => $altUrl));
+
+        // ...to check that the FragmentListener still references the right Request
+        // when rendering another fragment after the error occured
+        // should render en/html instead of fr/json
+        $content .= $handler->render(new ControllerReference('TestBundle:SubRequest:fragment'));
+
+        // forces the LocaleListener to set fr for the locale...
+        // should render fr/json
+        $content .= $handler->render($altUrl);
+
+        // ...and check that after the rendering, the original Request is back
+        // and en is used as a locale
+        // should use en/html instead of fr/json
+        $content .= '--'.$this->generateUrl('subrequest_fragment');
+
+        // The RouterListener is also tested as if it does not keep the right
+        // Request in the context, a 301 would be generated
+
+        return new Response($content);
+    }
+
+    public function fragmentAction(Request $request)
+    {
+        return new Response('--'.$request->getLocale().'/'.$request->getRequestFormat());
+    }
+
+    public function fragmentErrorAction()
+    {
+        throw new \RuntimeException('error');
+    }
+
+    protected function generateUrl($name, $arguments = array())
+    {
+        return $this->container->get('router')->generate($name, $arguments);
+    }
+}
diff --git a/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml b/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml
@@ -21,3 +21,18 @@ session_showflash:
 profiler:
     path:     /profiler
     defaults: { _controller: TestBundle:Profiler:index }
+
+subrequest_index:
+    path:     /subrequest/{_locale}.{_format}
+    defaults: { _controller: TestBundle:SubRequest:index, _format: "html" }
+    schemes:  [https]
+
+subrequest_fragment_error:
+    path:     /subrequest/fragment/error/{_locale}.{_format}
+    defaults: { _controller: TestBundle:SubRequest:fragmentError, _format: "html" }
+    schemes:  [http]
+
+subrequest_fragment:
+    path:     /subrequest/fragment/{_locale}.{_format}
+    defaults: { _controller: TestBundle:SubRequest:fragment, _format: "html" }
+    schemes:  [http]
diff --git a/Tests/Functional/SubRequestsTest.php b/Tests/Functional/SubRequestsTest.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\FrameworkBundle\Tests\Functional;
+
+/**
+ * @group functional
+ */
+class SubRequestsTest extends WebTestCase
+{
+    public function testStateAfterSubRequest()
+    {
+        $client = $this->createClient(array('test_case' => 'Session', 'root_config' => 'config.yml'));
+        $client->request('GET', 'https://localhost/subrequest/en');
+
+        $this->assertEquals('--fr/json--en/html--fr/json--http://localhost/subrequest/fragment/en', $client->getResponse()->getContent());
+    }
+}
