[BrowserKit] add serverParameters to click and clickLink method

syl20b · nicolas-grekas · commit 69e29ae90ec1 · 2023-07-31T15:47:42.000+02:00
diff --git a/UPGRADE-6.4.md b/UPGRADE-6.4.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 6.3 to 6.4
 =======================
 
+BrowserKit
+----------
+
+* Methods `AbstractBrowser::click()` and `AbstractBrowser::clickLink()` will have a new $serverParameters argument in version 6.4, not defining it is deprecated
+
 Cache
 -----
 
diff --git a/src/Symfony/Component/BrowserKit/AbstractBrowser.php b/src/Symfony/Component/BrowserKit/AbstractBrowser.php
@@ -263,26 +263,33 @@ public function getRequest(): object
 
     /**
      * Clicks on a given link.
+     *
+     * @param array $serverParameters An array of server parameters
      */
-    public function click(Link $link): Crawler
+    public function click(Link $link/* , array $serverParameters = [] */): Crawler
     {
+        $serverParameters = 2 === \func_num_args() ? func_get_arg(1) : [];
+
         if ($link instanceof Form) {
-            return $this->submit($link);
+            return $this->submit($link, [], $serverParameters);
         }
 
-        return $this->request($link->getMethod(), $link->getUri());
+        return $this->request($link->getMethod(), $link->getUri(), [], [], $serverParameters);
     }
 
     /**
      * Clicks the first link (or clickable image) that contains the given text.
      *
-     * @param string $linkText The text of the link or the alt attribute of the clickable image
+     * @param string $linkText         The text of the link or the alt attribute of the clickable image
+     * @param array  $serverParameters An array of server parameters
      */
-    public function clickLink(string $linkText): Crawler
+    public function clickLink(string $linkText/* , array $serverParameters = [] */): Crawler
     {
         $crawler = $this->crawler ?? throw new BadMethodCallException(sprintf('The "request()" method must be called before "%s()".', __METHOD__));
 
-        return $this->click($crawler->selectLink($linkText)->link());
+        $serverParameters = 2 === \func_num_args() ? func_get_arg(1) : [];
+
+        return $this->click($crawler->selectLink($linkText)->link(), $serverParameters);
     }
 
     /**
diff --git a/src/Symfony/Component/BrowserKit/CHANGELOG.md b/src/Symfony/Component/BrowserKit/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.4
+---
+
+* Added `$serverParameters` argument to `AbstractBrowser::click()` and `AbstractBrowser::clickLink()` methods
+
 6.3
 ---
 
diff --git a/src/Symfony/Component/BrowserKit/Tests/AbstractBrowserTest.php b/src/Symfony/Component/BrowserKit/Tests/AbstractBrowserTest.php
@@ -279,6 +279,19 @@ public function testClick()
         $this->assertSame('http://www.example.com/foo', $client->getRequest()->getUri(), '->click() clicks on links');
     }
 
+    public function testClickPreserveHeaders()
+    {
+        $client = $this->getBrowser();
+        $client->setNextResponse(new Response('<html><a href="/foo">foo</a></html>'));
+        $crawler = $client->request('GET', 'http://www.example.com/foo/foobar');
+
+        $client->click($crawler->filter('a')->link(), ['X-Special-Header' => 'Special Header Value']);
+
+        $server = $client->getRequest()->getServer();
+        $this->assertArrayHasKey('X-Special-Header', $server);
+        $this->assertSame('Special Header Value', $server['X-Special-Header']);
+    }
+
     public function testClickLink()
     {
         $client = $this->getBrowser();
@@ -299,6 +312,18 @@ public function testClickLinkNotFound()
         $client->clickLink('foo');
     }
 
+    public function testClickLinkPreserveHeaders()
+    {
+        $client = $this->getBrowser();
+        $client->setNextResponse(new Response('<html><a href="/foo">foo</a></html>'));
+        $client->request('GET', 'http://www.example.com/foo/foobar');
+        $client->clickLink('foo', ['X-Special-Header' => 'Special Header Value']);
+
+        $server = $client->getRequest()->getServer();
+        $this->assertArrayHasKey('X-Special-Header', $server);
+        $this->assertSame('Special Header Value', $server['X-Special-Header']);
+    }
+
     public function testClickForm()
     {
         $client = $this->getBrowser();
@@ -310,6 +335,19 @@ public function testClickForm()
         $this->assertSame('http://www.example.com/foo', $client->getRequest()->getUri(), '->click() Form submit forms');
     }
 
+    public function testClickFormPreserveHeaders()
+    {
+        $client = $this->getBrowser();
+        $client->setNextResponse(new Response('<html><form action="/foo"><input type="submit" /></form></html>'));
+        $crawler = $client->request('GET', 'http://www.example.com/foo/foobar');
+
+        $client->click($crawler->filter('input')->form(), ['X-Special-Header' => 'Special Header Value']);
+
+        $server = $client->getRequest()->getServer();
+        $this->assertArrayHasKey('X-Special-Header', $server);
+        $this->assertSame('Special Header Value', $server['X-Special-Header']);
+    }
+
     public function testSubmit()
     {
         $client = $this->getBrowser();
