[1.7] Fix extra http headers (#413)

Co-authored-by: Graham Campbell <GrahamCampbell@users.noreply.github.com>

Author: enricodias

src/Browser.php

@@ -82,10 +82,6 @@ public function __construct(Connection $connection)
 
         // enable target discovery
         $connection->sendMessageSync(new Message('Target.setDiscoverTargets', ['discover' => true]));
-
-        // set up http headers
-        $headers = $connection->getConnectionHttpHeaders();
-        $connection->sendMessageSync(new Message('Network.setExtraHTTPHeaders', $headers));
     }
 
     /**
@@ -188,6 +184,8 @@ public function getTargets()
     /**
      * @param string $targetId
      *
+     * @throws CommunicationException
+     *
      * @return Page|null
      */
     public function getPage($targetId)
@@ -225,6 +223,13 @@ public function getPage($targetId)
         // Page.setLifecycleEventsEnabled
         $page->getSession()->sendMessageSync(new Message('Page.setLifecycleEventsEnabled', ['enabled' => true]));
 
+        // set up http headers
+        $headers = $this->connection->getConnectionHttpHeaders();
+
+        if (\count($headers) > 0) {
+            $page->setExtraHTTPHeaders($headers);
+        }
+
         // add prescript
         if ($this->pagePreScript) {
             $page->addPreScript($this->pagePreScript);

src/Page.php

@@ -176,21 +176,27 @@ public function setDownloadPath(string $path): void
      * @see https://chromedevtools.github.io/devtools-protocol/1-2/Network/#method-setExtraHTTPHeaders
      *
      * @param array<string, string> $headers
+     *
+     * @throws CommunicationException
      */
     public function setExtraHTTPHeaders(array $headers = []): void
     {
-        $this->getSession()->sendMessage(new Message(
+        $response = $this->getSession()->sendMessage(new Message(
             'Network.setExtraHTTPHeaders',
-            $headers
-        ));
+            ['headers' => $headers]
+        ))->waitForResponse();
+
+        if (false === $response->isSuccessful()) {
+            throw new CommunicationException($response->getErrorMessage());
+        }
     }
 
     /**
      * @param string $url
      * @param array  $options
      *                        - strict: make waitForNAvigation to fail if a new navigation is initiated. Default: false
      *
-     * @throws Exception\CommunicationException
+     * @throws CommunicationException
      *
      * @return PageNavigation
      */
@@ -213,7 +219,7 @@ public function navigate(string $url, array $options = [])
      *
      * @param string $expression
      *
-     * @throws Exception\CommunicationException
+     * @throws CommunicationException
      *
      * @return PageEvaluation
      */
@@ -849,7 +855,7 @@ public function getCurrentUrl()
     /**
      * Sets the raw html of the current page.
      *
-     * @throws Exception\CommunicationException
+     * @throws CommunicationException
      */
     public function setHtml(string $html, int $timeout = 3000): void
     {
@@ -869,7 +875,7 @@ public function setHtml(string $html, int $timeout = 3000): void
     /**
      * Gets the raw html of the current page.
      *
-     * @throws Exception\CommunicationException
+     * @throws CommunicationException
      */
     public function getHtml(?int $timeout = null): string
     {

tests/BrowserFactoryTest.php

@@ -65,6 +65,7 @@ public function testAddHeaders(): void
 
         $factory->addHeader('header_name', 'header_value');
         $factory->addHeaders(['header_name2' => 'header_value2']);
+        $factory->createBrowser()->createPage();
 
         $expected = [
             'header_name' => 'header_value',
@@ -84,24 +85,28 @@ public function testOptions(): void
 
         $factory->addHeaders($headers);
         $factory->addOptions($options);
+        $factory->createBrowser()->createPage();
 
         $expected = \array_merge(['headers' => $headers], $options);
 
         $this->assertSame($expected, $factory->getOptions());
 
         // test overwriting
         $factory->addOptions($modifiedOptions);
+        $factory->createBrowser()->createPage();
 
         $expected['userAgent'] = 'foo bar';
 
         $this->assertSame($expected, $factory->getOptions());
 
         // test removing options
         $factory->setOptions($modifiedOptions);
+        $factory->createBrowser()->createPage();
 
         $this->assertSame($modifiedOptions, $factory->getOptions());
 
         $factory->setOptions([]);
+        $factory->createBrowser()->createPage();
 
         $this->assertSame([], $factory->getOptions());
     }

tests/PageTest.php

@@ -439,4 +439,14 @@ public function testWaitUntilContainsElement(): void
 
         $this->assertStringContainsString('<div data-name="el"></div>', $page->getHtml());
     }
+
+    public function testSetExtraHTTPHeaders(): void
+    {
+        $factory = new BrowserFactory();
+
+        $page = $factory->createBrowser()->createPage();
+        $page->setExtraHTTPHeaders(['test' => 'test']);
+
+        $this->expectNotToPerformAssertions();
+    }
 }