[BrowserKit] add $serverParameters to click and clickLink methods

syl20b · syl20b · commit f8e74a38d6ea · 2023-05-24T10:34:27.000+02:00
diff --git a/UPGRADE-6.3.md b/UPGRADE-6.3.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 6.2 to 6.3
 =======================
 
+BrowserKit
+----------
+
+ * Methods `AbstractBrowser::click()` and `AbstractBrowser::clickLink()` will have a new $serverParameters argument in version 6.3, not defining it is deprecated
+
 Console
 -------
 
diff --git a/src/Symfony/Component/BrowserKit/AbstractBrowser.php b/src/Symfony/Component/BrowserKit/AbstractBrowser.php
@@ -284,27 +284,28 @@ public function getRequest(): object
     /**
      * Clicks on a given link.
      */
-    public function click(Link $link): Crawler
+    public function click(Link $link, array $serverParameters = []): Crawler
     {
         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
     {
         if (null === $this->crawler) {
             throw new BadMethodCallException(sprintf('The "request()" method must be called before "%s()".', __METHOD__));
         }
 
-        return $this->click($this->crawler->selectLink($linkText)->link());
+        return $this->click($this->crawler->selectLink($linkText)->link(), $serverParameters);
     }
 
     /**
diff --git a/src/Symfony/Component/BrowserKit/CHANGELOG.md b/src/Symfony/Component/BrowserKit/CHANGELOG.md
@@ -5,6 +5,8 @@ CHANGELOG
 ---
 
  * Add `AbstractBrowser::useHtml5Parser()`
+ * Methods `AbstractBrowser::click()` and `AbstractBrowser::clickLink()` will have a new `$serverParameters` argument
+  in version 6.3, not defining it is deprecated
 
 6.1
 ---
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();

Original file line number	Diff line number	Diff line change
`@@ -284,27 +284,28 @@ public function getRequest(): object`
`284`	`284`	`/**`
`285`	`285`	`* Clicks on a given link.`
`286`	`286`	`*/`
`287`		`- public function click(Link $link): Crawler`
	`287`	`+ public function click(Link $link, array $serverParameters = []): Crawler`
`288`	`288`	`{`
`289`	`289`	`if ($link instanceof Form) {`
`290`		`- return $this->submit($link);`
	`290`	`+ return $this->submit($link, [], $serverParameters);`
`291`	`291`	`}`
`292`	`292`
`293`		`- return $this->request($link->getMethod(), $link->getUri());`
	`293`	`+ return $this->request($link->getMethod(), $link->getUri(), [], [], $serverParameters);`
`294`	`294`	`}`
`295`	`295`
`296`	`296`	`/**`
`297`	`297`	`* Clicks the first link (or clickable image) that contains the given text.`
`298`	`298`	`*`
`299`		`- * @param string $linkText The text of the link or the alt attribute of the clickable image`
	`299`	`+ * @param string $linkText The text of the link or the alt attribute of the clickable image`
	`300`	`+ * @param array $serverParameters An array of server parameters`
`300`	`301`	`*/`
`301`		`- public function clickLink(string $linkText): Crawler`
	`302`	`+ public function clickLink(string $linkText, array $serverParameters = []): Crawler`
`302`	`303`	`{`
`303`	`304`	`if (null === $this->crawler) {`
`304`	`305`	`throw new BadMethodCallException(sprintf('The "request()" method must be called before "%s()".', __METHOD__));`
`305`	`306`	`}`
`306`	`307`
`307`		`- return $this->click($this->crawler->selectLink($linkText)->link());`
	`308`	`+ return $this->click($this->crawler->selectLink($linkText)->link(), $serverParameters);`
`308`	`309`	`}`
`309`	`310`
`310`	`311`	`/**`