[BrowserKit] Adds option to follow meta refresh.

jhedstrom · jhedstrom · commit e2f175ed25bb · 2018-05-16T13:26:43.000-07:00
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -40,6 +40,7 @@ abstract class Client
     protected $insulated = false;
     protected $redirect;
     protected $followRedirects = true;
+    protected $followMetaRefresh = false;
 
     private $maxRedirects = -1;
     private $redirectCount = 0;
@@ -68,6 +69,16 @@ public function followRedirects($followRedirect = true)
         $this->followRedirects = (bool) $followRedirect;
     }
 
+    /**
+     * Sets whether to automatically follow meta refresh redirects or not.
+     *
+     * @param bool $followMetaRefresh
+     */
+    public function followMetaRefresh(bool $followMetaRefresh = true)
+    {
+        $this->followMetaRefresh = $followMetaRefresh;
+    }
+
     /**
      * Returns whether client automatically follows redirects or not.
      *
@@ -370,7 +381,7 @@ public function request(string $method, string $uri, array $parameters = array()
         $this->crawler = $this->createCrawlerFromContent($this->internalRequest->getUri(), $this->internalResponse->getContent(), $this->internalResponse->getHeader('Content-Type'));
 
         // Check for meta refresh redirect.
-        if ($this->followRedirects && null !== $redirect = $this->getMetaRefreshUrl()) {
+        if ($this->followMetaRefresh && null !== $redirect = $this->getMetaRefreshUrl()) {
             $this->redirect = $redirect;
             $this->crawler = $this->followRedirect();
         }
diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php
@@ -597,9 +597,10 @@ public function testFollowRedirectDropPostMethod()
     /**
      * @dataProvider getTestsForMetaRefresh
      */
-    public function testFollowMetaRefresh(string $content, string $expectedEndingUrl)
+    public function testFollowMetaRefresh(string $content, string $expectedEndingUrl, bool $followMetaRefresh = true)
     {
         $client = new TestClient();
+        $client->followMetaRefresh($followMetaRefresh);
         $client->setNextResponse(new Response($content));
         $client->request('GET', 'http://www.example.com/foo/foobar');
         $this->assertEquals($expectedEndingUrl, $client->getRequest()->getUri());
@@ -621,6 +622,8 @@ public function getTestsForMetaRefresh()
             array('<html><body></body></html>', 'http://www.example.com/foo/foobar'),
             // Invalid meta tag placement should not result in a redirect.
             array('<html><body><meta http-equiv="refresh" content="0;url=http://www.example.com/redirected"/></body></html>', 'http://www.example.com/foo/foobar'),
+            // Valid meta refresh should not be followed if disabled.
+            array('<html><head><meta http-equiv="refresh" content="0;URL=http://www.example.com/redirected"/></head></html>', 'http://www.example.com/foo/foobar', false),
         );
     }
 
