feature: transform both switchToXHR and removeXhr to a xhrRequest

Amrouche Hamza · Amrouche Hamza · commit 00f26e280c5a · 2018-03-16T10:04:06.000+01:00
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -151,14 +151,15 @@ public function getServerParameter($key, $default = '')
         return isset($this->server[$key]) ? $this->server[$key] : $default;
     }
 
-    public function switchToXHR()
+    public function xmlHttpRequest(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true): Crawler
     {
         $this->setServerParameter('HTTP_X_REQUESTED_WITH', 'XMLHttpRequest');
-    }
 
-    public function removeXHR()
-    {
-        unset($this->server['HTTP_X_REQUESTED_WITH']);
+        try {
+            return $this->request($method, $uri, $parameters, $files, $server, $content, $changeHistory);
+        } finally {
+            unset($this->server['HTTP_X_REQUESTED_WITH']);
+        }
     }
 
     /**
diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php
@@ -25,6 +25,7 @@ class TestClient extends Client
 {
     protected $nextResponse = null;
     protected $nextScript = null;
+    protected $request = null;
 
     public function setNextResponse(Response $response)
     {
@@ -38,6 +39,8 @@ public function setNextScript($script)
 
     protected function doRequest($request)
     {
+        $this->request = $request;
+
         if (null === $this->nextResponse) {
             return new Response();
         }
@@ -48,6 +51,11 @@ protected function doRequest($request)
         return $response;
     }
 
+    public function getRequest()
+    {
+        return $this->request;
+    }
+
     protected function filterResponse($response)
     {
         if ($response instanceof SpecialResponse) {
@@ -104,13 +112,11 @@ public function testGetRequestNull()
         $this->assertNull($client->getRequest());
     }
 
-    public function testGetRequestWithXHR()
+    public function testXmlHttpRequest()
     {
         $client = new TestClient();
-        $client->switchToXHR();
-        $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);
+        $client->xmlHttpRequest('GET', 'http://example.com/', array(), array(), array(), null, true);
         $this->assertEquals($client->getRequest()->getServer()['HTTP_X_REQUESTED_WITH'], 'XMLHttpRequest');
-        $client->removeXHR();
         $this->assertFalse($client->getServerParameter('HTTP_X_REQUESTED_WITH', false));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -151,14 +151,15 @@ public function getServerParameter($key, $default = '')`
`151`	`151`	`return isset($this->server[$key]) ? $this->server[$key] : $default;`
`152`	`152`	`}`
`153`	`153`
`154`		`- public function switchToXHR()`
	`154`	`+ public function xmlHttpRequest(string $method, string $uri, array $parameters = array(), array $files = array(), array $server = array(), string $content = null, bool $changeHistory = true): Crawler`
`155`	`155`	`{`
`156`	`156`	`$this->setServerParameter('HTTP_X_REQUESTED_WITH', 'XMLHttpRequest');`
`157`		`- }`
`158`	`157`
`159`		`- public function removeXHR()`
`160`		`- {`
`161`		`- unset($this->server['HTTP_X_REQUESTED_WITH']);`
	`158`	`+ try {`
	`159`	`+ return $this->request($method, $uri, $parameters, $files, $server, $content, $changeHistory);`
	`160`	`+ } finally {`
	`161`	`+ unset($this->server['HTTP_X_REQUESTED_WITH']);`
	`162`	`+ }`
`162`	`163`	`}`
`163`	`164`
`164`	`165`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ class TestClient extends Client`
`25`	`25`	`{`
`26`	`26`	`protected $nextResponse = null;`
`27`	`27`	`protected $nextScript = null;`
	`28`	`+ protected $request = null;`
`28`	`29`
`29`	`30`	`public function setNextResponse(Response $response)`
`30`	`31`	`{`
`@@ -38,6 +39,8 @@ public function setNextScript($script)`
`38`	`39`
`39`	`40`	`protected function doRequest($request)`
`40`	`41`	`{`
	`42`	`+ $this->request = $request;`
	`43`	`+`
`41`	`44`	`if (null === $this->nextResponse) {`
`42`	`45`	`return new Response();`
`43`	`46`	`}`
`@@ -48,6 +51,11 @@ protected function doRequest($request)`
`48`	`51`	`return $response;`
`49`	`52`	`}`
`50`	`53`
	`54`	`+ public function getRequest()`
	`55`	`+ {`
	`56`	`+ return $this->request;`
	`57`	`+ }`
	`58`	`+`
`51`	`59`	`protected function filterResponse($response)`
`52`	`60`	`{`
`53`	`61`	`if ($response instanceof SpecialResponse) {`
`@@ -104,13 +112,11 @@ public function testGetRequestNull()`
`104`	`112`	`$this->assertNull($client->getRequest());`
`105`	`113`	`}`
`106`	`114`
`107`		`- public function testGetRequestWithXHR()`
	`115`	`+ public function testXmlHttpRequest()`
`108`	`116`	`{`
`109`	`117`	`$client = new TestClient();`
`110`		`- $client->switchToXHR();`
`111`		`- $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);`
	`118`	`+ $client->xmlHttpRequest('GET', 'http://example.com/', array(), array(), array(), null, true);`
`112`	`119`	`$this->assertEquals($client->getRequest()->getServer()['HTTP_X_REQUESTED_WITH'], 'XMLHttpRequest');`
`113`		`- $client->removeXHR();`
`114`	`120`	`$this->assertFalse($client->getServerParameter('HTTP_X_REQUESTED_WITH', false));`
`115`	`121`	`}`
`116`	`122`