Apply suggestions from code review

michal-izewski · gsteel · web-flow · commit e571fe6e584b · 2024-05-07T16:54:11.000+02:00
Co-authored-by: George Steel &lt;george@netglue.uk&gt;
Signed-off-by: Michał Iżewski &lt;50335909+michal-izewski@users.noreply.github.com&gt;
diff --git a/src/CacheSessionPersistence.php b/src/CacheSessionPersistence.php
@@ -145,7 +145,7 @@ public function persistSession(SessionInterface $session, ResponseInterface $res
         // Regenerate the session if:
         // - we have no session identifier
         // - the session is marked as regenerated
-        // - the session has changed (data is different) and autoRegenerate is turned off in the configuration
+        // - the session has changed (data is different) and autoRegenerate is turned on (default) in the configuration
         if ('' === $id || $session->isRegenerated() || ($this->autoRegenerate && $session->hasChanged())) {
             $id = $this->regenerateSession($id);
         }
diff --git a/test/CacheSessionPersistenceIntegrationTest.php b/test/CacheSessionPersistenceIntegrationTest.php
@@ -112,7 +112,7 @@ public function testThatAChangedSessionWillCauseRegenerationAndASetCookieHeader(
         self::assertNull($value, 'The previous session data should have been deleted');
     }
 
-    public function testThatAChangedSessionWillNotCauseRegenerationAndASetCookieHeader(): void
+    public function testThatAChangedSessionWillNotCauseRegenerationWhenAutoRegenerateIsFalse(): void
     {
         $this->storage = new CacheSessionPersistence(
             $this->cache,

Original file line number	Diff line number	Diff line change
`@@ -145,7 +145,7 @@ public function persistSession(SessionInterface $session, ResponseInterface $res`
`145`	`145`	`// Regenerate the session if:`
`146`	`146`	`// - we have no session identifier`
`147`	`147`	`// - the session is marked as regenerated`
`148`		`- // - the session has changed (data is different) and autoRegenerate is turned off in the configuration`
	`148`	`+ // - the session has changed (data is different) and autoRegenerate is turned on (default) in the configuration`
`149`	`149`	`if ('' === $id \|\| $session->isRegenerated() \|\| ($this->autoRegenerate && $session->hasChanged())) {`
`150`	`150`	`$id = $this->regenerateSession($id);`
`151`	`151`	`}`
Original file line number	Diff line number	Diff line change
`@@ -112,7 +112,7 @@ public function testThatAChangedSessionWillCauseRegenerationAndASetCookieHeader(`
`112`	`112`	`self::assertNull($value, 'The previous session data should have been deleted');`
`113`	`113`	`}`
`114`	`114`
`115`		`- public function testThatAChangedSessionWillNotCauseRegenerationAndASetCookieHeader(): void`
	`115`	`+ public function testThatAChangedSessionWillNotCauseRegenerationWhenAutoRegenerateIsFalse(): void`
`116`	`116`	`{`
`117`	`117`	`$this->storage = new CacheSessionPersistence(`
`118`	`118`	`$this->cache,`