fix: make it possible to send connect_over_cdp headers (microsoft#1912)

mxschmitt · web-flow · commit 572a78a0e86f · 2023-05-11T08:52:05.000-07:00
diff --git a/playwright/_impl/_browser_type.py b/playwright/_impl/_browser_type.py
@@ -44,6 +44,7 @@
     locals_to_params,
 )
 from playwright._impl._json_pipe import JsonPipeTransport
+from playwright._impl._network import serialize_headers
 from playwright._impl._wait_helper import throw_on_timeout
 
 if TYPE_CHECKING:
@@ -166,6 +167,8 @@ async def connect_over_cdp(
         headers: Dict[str, str] = None,
     ) -> Browser:
         params = locals_to_params(locals())
+        if params.get("headers"):
+            params["headers"] = serialize_headers(params["headers"])
         response = await self._channel.send_return_as_dict("connectOverCDP", params)
         browser = cast(Browser, from_channel(response["browser"]))
         self._did_launch_browser(browser)
diff --git a/tests/async/test_browsertype_connect_cdp.py b/tests/async/test_browsertype_connect_cdp.py
@@ -12,12 +12,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import asyncio
 from typing import Dict
 
 import pytest
 import requests
 
-from playwright.async_api import BrowserType
+from playwright.async_api import BrowserType, Error
 from tests.server import Server, find_free_port
 
 pytestmark = pytest.mark.only_browser("chromium")
@@ -86,3 +87,14 @@ async def test_conect_over_a_ws_endpoint(
     assert len(cdp_browser2.contexts) == 1
     await cdp_browser2.close()
     await browser_server.close()
+
+
+async def test_connect_over_cdp_passing_header_works(
+    launch_arguments: Dict, browser_type: BrowserType, server: Server
+):
+    request = asyncio.create_task(server.wait_for_request("/ws"))
+    with pytest.raises(Error):
+        await browser_type.connect_over_cdp(
+            f"ws://127.0.0.1:{server.PORT}/ws", headers={"foo": "bar"}
+        )
+    assert (await request).getHeader("foo") == "bar"
