bug #27714 [HttpFoundation] fix session tracking counter (nicolas-grekas, dmaicher)

nicolas-grekas · nicolas-grekas · commit b9a3c870d91c · 2018-06-28T08:32:50.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- [HttpFoundation] fix session tracking counter | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | no | Fixed tickets | - | License | MIT | Doc PR | - As just discussed with @nicolas-grekas I found this issue today while upgrading my app to 3.4.12. Somehow its not possible anymore to set caching headers correctly since this commit: 146e01c#diff-5350dc763df30ada9d00563c115f6652 Commits ------- 89ed756 failing test to reproduce session problem 26fc4e6 [HttpFoundation] fix session tracking counter
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SessionController.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Controller/SessionController.php
@@ -43,6 +43,14 @@ public function welcomeAction(Request $request, $name = null)
         return new Response(sprintf('Welcome back %s, nice to meet you.', $name));
     }
 
+    public function cacheableAction()
+    {
+        $response = new Response('all good');
+        $response->setSharedMaxAge(100);
+
+        return $response;
+    }
+
     public function logoutAction(Request $request)
     {
         $request->getSession()->invalidate();
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/Bundle/TestBundle/Resources/config/routing.yml
@@ -2,6 +2,10 @@ session_welcome:
     path:     /session
     defaults: { _controller: TestBundle:Session:welcome }
 
+session_cacheable:
+    path:     /cacheable
+    defaults: { _controller: Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\Controller\SessionController::cacheableAction }
+
 session_welcome_name:
     path:     /session/{name}
     defaults: { _controller: TestBundle:Session:welcome }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SessionTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/SessionTest.php
@@ -126,6 +126,22 @@ public function testTwoClients($config, $insulate)
         $this->assertContains('Welcome back client2, nice to meet you.', $crawler2->text());
     }
 
+    /**
+     * @dataProvider getConfigs
+     */
+    public function testCorrectCacheControlHeadersForCacheableAction($config, $insulate)
+    {
+        $client = $this->createClient(array('test_case' => 'Session', 'root_config' => $config));
+        if ($insulate) {
+            $client->insulate();
+        }
+
+        $client->request('GET', '/cacheable');
+
+        $response = $client->getResponse();
+        $this->assertSame('public, s-maxage=100', $response->headers->get('cache-control'));
+    }
+
     public function getConfigs()
     {
         return array(
diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php
@@ -54,8 +54,6 @@ public function __construct(SessionStorageInterface $storage = null, AttributeBa
      */
     public function start()
     {
-        ++$this->usageIndex;
-
         return $this->storage->start();
     }
 
@@ -160,7 +158,9 @@ public function getUsageIndex()
      */
     public function isEmpty()
     {
-        ++$this->usageIndex;
+        if ($this->isStarted()) {
+            ++$this->usageIndex;
+        }
         foreach ($this->data as &$data) {
             if (!empty($data)) {
                 return false;
@@ -185,8 +185,6 @@ public function invalidate($lifetime = null)
      */
     public function migrate($destroy = false, $lifetime = null)
     {
-        ++$this->usageIndex;
-
         return $this->storage->regenerate($destroy, $lifetime);
     }
 
@@ -195,8 +193,6 @@ public function migrate($destroy = false, $lifetime = null)
      */
     public function save()
     {
-        ++$this->usageIndex;
-
         $this->storage->save();
     }
 
diff --git a/src/Symfony/Component/HttpFoundation/Session/SessionBagProxy.php b/src/Symfony/Component/HttpFoundation/Session/SessionBagProxy.php
@@ -44,6 +44,9 @@ public function getBag()
      */
     public function isEmpty()
     {
+        if (!isset($this->data[$this->bag->getStorageKey()])) {
+            return true;
+        }
         ++$this->usageIndex;
 
         return empty($this->data[$this->bag->getStorageKey()]);
@@ -81,8 +84,6 @@ public function getStorageKey()
      */
     public function clear()
     {
-        ++$this->usageIndex;
-
         return $this->bag->clear();
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,14 @@ public function welcomeAction(Request $request, $name = null)`
`43`	`43`	`return new Response(sprintf('Welcome back %s, nice to meet you.', $name));`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ public function cacheableAction()`
	`47`	`+ {`
	`48`	`+ $response = new Response('all good');`
	`49`	`+ $response->setSharedMaxAge(100);`
	`50`	`+`
	`51`	`+ return $response;`
	`52`	`+ }`
	`53`	`+`
`46`	`54`	`public function logoutAction(Request $request)`
`47`	`55`	`{`
`48`	`56`	`$request->getSession()->invalidate();`
Original file line number	Diff line number	Diff line change
`@@ -54,8 +54,6 @@ public function __construct(SessionStorageInterface $storage = null, AttributeBa`
`54`	`54`	`*/`
`55`	`55`	`public function start()`
`56`	`56`	`{`
`57`		`- ++$this->usageIndex;`
`58`		`-`
`59`	`57`	`return $this->storage->start();`
`60`	`58`	`}`
`61`	`59`
`@@ -160,7 +158,9 @@ public function getUsageIndex()`
`160`	`158`	`*/`
`161`	`159`	`public function isEmpty()`
`162`	`160`	`{`
`163`		`- ++$this->usageIndex;`
	`161`	`+ if ($this->isStarted()) {`
	`162`	`+ ++$this->usageIndex;`
	`163`	`+ }`
`164`	`164`	`foreach ($this->data as &$data) {`
`165`	`165`	`if (!empty($data)) {`
`166`	`166`	`return false;`
`@@ -185,8 +185,6 @@ public function invalidate($lifetime = null)`
`185`	`185`	`*/`
`186`	`186`	`public function migrate($destroy = false, $lifetime = null)`
`187`	`187`	`{`
`188`		`- ++$this->usageIndex;`
`189`		`-`
`190`	`188`	`return $this->storage->regenerate($destroy, $lifetime);`
`191`	`189`	`}`
`192`	`190`
`@@ -195,8 +193,6 @@ public function migrate($destroy = false, $lifetime = null)`
`195`	`193`	`*/`
`196`	`194`	`public function save()`
`197`	`195`	`{`
`198`		`- ++$this->usageIndex;`
`199`		`-`
`200`	`196`	`$this->storage->save();`
`201`	`197`	`}`
`202`	`198`
Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,9 @@ public function getBag()`
`44`	`44`	`*/`
`45`	`45`	`public function isEmpty()`
`46`	`46`	`{`
	`47`	`+ if (!isset($this->data[$this->bag->getStorageKey()])) {`
	`48`	`+ return true;`
	`49`	`+ }`
`47`	`50`	`++$this->usageIndex;`
`48`	`51`
`49`	`52`	`return empty($this->data[$this->bag->getStorageKey()]);`
`@@ -81,8 +84,6 @@ public function getStorageKey()`
`81`	`84`	`*/`
`82`	`85`	`public function clear()`
`83`	`86`	`{`
`84`		`- ++$this->usageIndex;`
`85`		`-`
`86`	`87`	`return $this->bag->clear();`
`87`	`88`	`}`
`88`	`89`	`}`