[BrowserKit] Emulate back/forward browser navigation

e-moe · fabpot · commit 680da44789aa · 2017-07-06T10:09:09.000+03:00
diff --git a/src/Symfony/Component/BrowserKit/CHANGELOG.md b/src/Symfony/Component/BrowserKit/CHANGELOG.md
@@ -7,6 +7,9 @@ CHANGELOG
  * [BC BREAK] The request method is dropped from POST to GET when the response
    status code is 301.
 
+ * [BC BREAK] Client will skip redirects during history navigation
+   (back and forward calls) according to W3C Browsers recommendation
+
 3.2.0
 -----
 
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -42,6 +42,7 @@ abstract class Client
 
     private $maxRedirects = -1;
     private $redirectCount = 0;
+    private $redirects = array();
     private $isMainRequest = true;
 
     /**
@@ -328,6 +329,8 @@ public function request($method, $uri, array $parameters = array(), array $files
         }
 
         if ($this->followRedirects && $this->redirect) {
+            $this->redirects[serialize($this->history->current())] = true;
+
             return $this->crawler = $this->followRedirect();
         }
 
@@ -430,7 +433,11 @@ protected function createCrawlerFromContent($uri, $content, $type)
      */
     public function back()
     {
-        return $this->requestFromRequest($this->history->back(), false);
+        do {
+            $request = $this->history->back();
+        } while (array_key_exists(serialize($request), $this->redirects));
+
+        return $this->requestFromRequest($request, false);
     }
 
     /**
@@ -440,7 +447,11 @@ public function back()
      */
     public function forward()
     {
-        return $this->requestFromRequest($this->history->forward(), false);
+        do {
+            $request = $this->history->forward();
+        } while (array_key_exists(serialize($request), $this->redirects));
+
+        return $this->requestFromRequest($request, false);
     }
 
     /**
diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php
@@ -573,6 +573,25 @@ public function testForward()
         $this->assertEquals($content, $client->getRequest()->getContent(), '->forward() keeps content');
     }
 
+    public function testBackAndFrowardWithRedirects()
+    {
+        $client = new TestClient();
+
+        $client->request('GET', 'http://www.example.com/foo');
+        $client->setNextResponse(new Response('', 301, array('Location' => 'http://www.example.com/redirected')));
+        $client->request('GET', 'http://www.example.com/bar');
+
+        $this->assertEquals('http://www.example.com/redirected', $client->getRequest()->getUri(), 'client followed redirect');
+
+        $client->back();
+
+        $this->assertEquals('http://www.example.com/foo', $client->getRequest()->getUri(), '->back() goes back in the history skipping redirects');
+
+        $client->forward();
+
+        $this->assertEquals('http://www.example.com/redirected', $client->getRequest()->getUri(), '->forward() goes forward in the history skipping redirects');
+    }
+
     public function testReload()
     {
         $client = new TestClient();

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,7 @@ abstract class Client`
`42`	`42`
`43`	`43`	`private $maxRedirects = -1;`
`44`	`44`	`private $redirectCount = 0;`
	`45`	`+ private $redirects = array();`
`45`	`46`	`private $isMainRequest = true;`
`46`	`47`
`47`	`48`	`/**`
`@@ -328,6 +329,8 @@ public function request($method, $uri, array $parameters = array(), array $files`
`328`	`329`	`}`
`329`	`330`
`330`	`331`	`if ($this->followRedirects && $this->redirect) {`
	`332`	`+ $this->redirects[serialize($this->history->current())] = true;`
	`333`	`+`
`331`	`334`	`return $this->crawler = $this->followRedirect();`
`332`	`335`	`}`
`333`	`336`
`@@ -430,7 +433,11 @@ protected function createCrawlerFromContent($uri, $content, $type)`
`430`	`433`	`*/`
`431`	`434`	`public function back()`
`432`	`435`	`{`
`433`		`- return $this->requestFromRequest($this->history->back(), false);`
	`436`	`+ do {`
	`437`	`+ $request = $this->history->back();`
	`438`	`+ } while (array_key_exists(serialize($request), $this->redirects));`
	`439`	`+`
	`440`	`+ return $this->requestFromRequest($request, false);`
`434`	`441`	`}`
`435`	`442`
`436`	`443`	`/**`
`@@ -440,7 +447,11 @@ public function back()`
`440`	`447`	`*/`
`441`	`448`	`public function forward()`
`442`	`449`	`{`
`443`		`- return $this->requestFromRequest($this->history->forward(), false);`
	`450`	`+ do {`
	`451`	`+ $request = $this->history->forward();`
	`452`	`+ } while (array_key_exists(serialize($request), $this->redirects));`
	`453`	`+`
	`454`	`+ return $this->requestFromRequest($request, false);`
`444`	`455`	`}`
`445`	`456`
`446`	`457`	`/**`