[BrowserKit] add a way to switch to ajax for one request

Amrouche Hamza · Amrouche Hamza · commit 5d2f196ec8d2 · 2017-11-01T09:08:44.000+01:00
diff --git a/src/Symfony/Component/BrowserKit/Client.php b/src/Symfony/Component/BrowserKit/Client.php
@@ -150,6 +150,16 @@ public function getServerParameter($key, $default = '')
         return isset($this->server[$key]) ? $this->server[$key] : $default;
     }
 
+    public function switchToXMLHttpRequest()
+    {
+        $this->setServerParameter('HTTP_X-Requested-With', 'XMLHttpRequest');
+    }
+
+    public function removeXMLHttpRequest()
+    {
+        unset($this->server['HTTP_X-Requested-With']);
+    }
+
     /**
      * Returns the History instance.
      *
@@ -249,14 +259,15 @@ public function click(Link $link)
      *
      * @param Form  $form   A Form instance
      * @param array $values An array of form field values
+     * @param bool  $isAjax Whether it's ajax or not
      *
      * @return Crawler
      */
-    public function submit(Form $form, array $values = array())
+    public function submit(Form $form, array $values = array(), $isAjax = false)
     {
         $form->setValues($values);
 
-        return $this->request($form->getMethod(), $form->getUri(), $form->getPhpValues(), $form->getPhpFiles());
+        return $this->request($form->getMethod(), $form->getUri(), $form->getPhpValues(), $form->getPhpFiles(), array(), null, true, $isAjax);
     }
 
     /**
@@ -269,17 +280,22 @@ public function submit(Form $form, array $values = array())
      * @param array  $server        The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
      * @param string $content       The raw body data
      * @param bool   $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
+     * @param bool   $isAjax        Whether it's a ajax request or not
      *
      * @return Crawler
      */
-    public function request($method, $uri, array $parameters = array(), array $files = array(), array $server = array(), $content = null, $changeHistory = true)
+    public function request($method, $uri, array $parameters = array(), array $files = array(), array $server = array(), $content = null, $changeHistory = true, $isAjax = false)
     {
         if ($this->isMainRequest) {
             $this->redirectCount = 0;
         } else {
             ++$this->redirectCount;
         }
 
+        if (true === $isAjax) {
+            $this->switchToXMLHttpRequest();
+        }
+
         $uri = $this->getAbsoluteUri($uri);
 
         $server = array_merge($this->server, $server);
@@ -324,6 +340,10 @@ public function request($method, $uri, array $parameters = array(), array $files
             $this->redirect = null;
         }
 
+        if (true === $isAjax) {
+            $this->removeXMLHttpRequest();
+        }
+
         if ($this->followRedirects && $this->redirect) {
             $this->redirects[serialize($this->history->current())] = true;
 
@@ -354,7 +374,7 @@ protected function doRequestInProcess($request)
             unlink($deprecationsFile);
             foreach ($deprecations ? unserialize($deprecations) : array() as $deprecation) {
                 if ($deprecation[0]) {
-                    trigger_error($deprecation[1], E_USER_DEPRECATED);
+                    @trigger_error($deprecation[1], E_USER_DEPRECATED);
                 } else {
                     @trigger_error($deprecation[1], E_USER_DEPRECATED);
                 }
diff --git a/src/Symfony/Component/BrowserKit/Tests/ClientTest.php b/src/Symfony/Component/BrowserKit/Tests/ClientTest.php
@@ -94,6 +94,14 @@ public function testGetRequest()
         $this->assertEquals('http://example.com/', $client->getRequest()->getUri(), '->getCrawler() returns the Request of the last request');
     }
 
+    public function testGetRequestWithAjax()
+    {
+        $client = new TestClient();
+        $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);
+        $this->assertEquals($client->getRequest()->getServer()['HTTP_X-Requested-With'], 'XMLHttpRequest');
+        $this->assertEquals('http://example.com/', $client->getRequest()->getUri(), '->getCrawler() returns the Request of the last request');
+    }
+
     public function testGetRequestWithIpAsHttpHost()
     {
         $client = new TestClient();

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,14 @@ public function testGetRequest()`
`94`	`94`	`$this->assertEquals('http://example.com/', $client->getRequest()->getUri(), '->getCrawler() returns the Request of the last request');`
`95`	`95`	`}`
`96`	`96`
	`97`	`+ public function testGetRequestWithAjax()`
	`98`	`+ {`
	`99`	`+ $client = new TestClient();`
	`100`	`+ $client->request('GET', 'http://example.com/', array(), array(), array(), null, true, true);`
	`101`	`+ $this->assertEquals($client->getRequest()->getServer()['HTTP_X-Requested-With'], 'XMLHttpRequest');`
	`102`	`+ $this->assertEquals('http://example.com/', $client->getRequest()->getUri(), '->getCrawler() returns the Request of the last request');`
	`103`	`+ }`
	`104`	`+`
`97`	`105`	`public function testGetRequestWithIpAsHttpHost()`
`98`	`106`	`{`
`99`	`107`	`$client = new TestClient();`