fixup! [Hash] Improve user hash change detection during request by comparing it at the end

Fix and add test coverage for the PR.

Author: andrerom

tests/Unit/EventListener/UserContextListenerTest.php

@@ -61,7 +61,7 @@ public function testOnKernelRequest()
 
         $requestMatcher = $this->getRequestMatcher($request, true);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
-        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
         $responseTagger = \Mockery::mock(ResponseTagger::class);
         $responseTagger->shouldReceive('addTags')->with(['fos_http_cache_hashlookup-hash']);
 
@@ -123,7 +123,7 @@ public function testOnKernelRequestCached()
 
         $requestMatcher = $this->getRequestMatcher($request, true);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
-        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
         $responseTagger = \Mockery::mock(ResponseTagger::class);
         $responseTagger->shouldReceive('addTags')->with(['fos_http_cache_hashlookup-hash']);
 
@@ -158,7 +158,7 @@ public function testOnKernelRequestNotMatched()
 
         $requestMatcher = $this->getRequestMatcher($request, false);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
-        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');
+        $hashGenerator->shouldReceive('generateHash')->never();
         $responseTagger = \Mockery::mock(ResponseTagger::class);
         $responseTagger->shouldReceive('addTags')->never();
 
@@ -181,6 +181,41 @@ public function testOnKernelRequestNotMatched()
         $this->assertNull($response);
     }
 
+    public function testOnKernelRequestNotMatchedHasHeader()
+    {
+        $request = new Request();
+        $request->setMethod('HEAD');
+        $request->headers->set('X-Hash', 'hash');
+
+        $requestMatcher = $this->getRequestMatcher($request, false);
+        $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->never();
+        $responseTagger = \Mockery::mock(ResponseTagger::class);
+        $responseTagger->shouldReceive('addTags')->never();
+
+        // TODO anonymousRequestMatcher
+        $anonymousRequestMatcher = \Mockery::mock(RequestMatcherInterface::class);
+        $anonymousRequestMatcher->shouldReceive('matches')->once()->andReturn(true);
+
+        $userContextListener = new UserContextListener(
+            $requestMatcher,
+            $hashGenerator,
+            $anonymousRequestMatcher,
+            $responseTagger,
+            [
+                'user_identifier_headers' => ['X-SessionId'],
+                'user_hash_header' => 'X-Hash',
+            ]
+        );
+        $event = $this->getKernelRequestEvent($request);
+
+        $userContextListener->onKernelRequest($event);
+
+        $response = $event->getResponse();
+
+        $this->assertNull($response);
+    }
+
     public function testOnKernelResponse()
     {
         $request = new Request();
@@ -189,6 +224,7 @@ public function testOnKernelResponse()
 
         $requestMatcher = $this->getRequestMatcher($request, false);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
         $responseTagger = \Mockery::mock(ResponseTagger::class);
         $responseTagger->shouldReceive('addTags')->never();
 
@@ -221,6 +257,7 @@ public function testOnKernelResponseSetsNoAutoCacheHeader()
         $request->headers->set('X-User-Context-Hash', 'hash');
 
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
 
         $userContextListener = new UserContextListener(
             $this->getRequestMatcher($request, false),
@@ -245,6 +282,7 @@ public function testOnKernelResponseDoesNotSetNoAutoCacheHeaderWhenNoSessionList
         $request->headers->set('X-User-Context-Hash', 'hash');
 
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
 
         $userContextListener = new UserContextListener(
             $this->getRequestMatcher($request, false),
@@ -273,6 +311,7 @@ public function testOnKernelResponseSetsNoAutoCacheHeaderWhenCustomHeader()
         $request->headers->set('X-User-Context-Hash', 'hash');
 
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
 
         $userContextListener = new UserContextListener(
             $this->getRequestMatcher($request, false),
@@ -296,6 +335,7 @@ public function testOnKernelResponseSetsNoAutoCacheHeaderWhenCustomHeaderAndNoAd
         $request->headers->set('X-User-Context-Hash', 'hash');
 
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
 
         $userContextListener = new UserContextListener(
             $this->getRequestMatcher($request, false),
@@ -324,6 +364,7 @@ public function testOnKernelResponseDoesNotSetNoAutoCacheHeaderWhenNoCustomHeade
         $request->headers->set('X-User-Context-Hash', 'hash');
 
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
 
         $userContextListener = new UserContextListener(
             $this->getRequestMatcher($request, false),
@@ -349,6 +390,7 @@ public function testOnKernelResponseNotMaster()
 
         $requestMatcher = $this->getRequestMatcher($request, false);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->never();
 
         $userContextListener = new UserContextListener(
             $requestMatcher,
@@ -377,6 +419,7 @@ public function testOnKernelResponseNotCached()
 
         $requestMatcher = $this->getRequestMatcher($request, false);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
+        $hashGenerator->shouldReceive('generateHash')->never();
 
         $userContextListener = new UserContextListener(
             $requestMatcher,
@@ -406,7 +449,7 @@ public function testFullRequestHashOk()
 
         $requestMatcher = $this->getRequestMatcher($request, false);
         $hashGenerator = \Mockery::mock(HashGenerator::class);
-        $hashGenerator->shouldReceive('generateHash')->andReturn('hash');
+        $hashGenerator->shouldReceive('generateHash')->once()->andReturn('hash');
         $responseTagger = \Mockery::mock(ResponseTagger::class);
         $responseTagger->shouldReceive('addTags')->with(['fos_http_cache_usercontext-hash']);