fix(driver): crash with VSCode debug terminal (microsoft#405)

mxschmitt · web-flow · commit 0b4a980fed36 · 2020-12-28T18:50:37.000-08:00
diff --git a/playwright/__main__.py b/playwright/__main__.py
@@ -20,5 +20,7 @@
 
 driver_executable = compute_driver_executable()
 my_env = os.environ.copy()
+# VSCode's JavaScript Debug Terminal provides it but driver/pkg does not support it
+my_env.pop("NODE_OPTIONS", None)
 my_env["PW_CLI_TARGET_LANG"] = "python"
 subprocess.run([str(driver_executable), *sys.argv[1:]], env=my_env)
diff --git a/playwright/_impl/_browser_context.py b/playwright/_impl/_browser_context.py
@@ -215,7 +215,7 @@ async def waitForEvent(
             timeout = self._timeout_settings.timeout()
         wait_helper = WaitHelper(self._loop)
         wait_helper.reject_on_timeout(
-            timeout, f'Timeout while waiting for event "${event}"'
+            timeout, f'Timeout while waiting for event "{event}"'
         )
         if event != BrowserContext.Events.Close:
             wait_helper.reject_on_event(
diff --git a/playwright/_impl/_network.py b/playwright/_impl/_network.py
@@ -301,7 +301,7 @@ async def waitForEvent(
             timeout = cast(Any, self._parent)._timeout_settings.timeout()
         wait_helper = WaitHelper(self._loop)
         wait_helper.reject_on_timeout(
-            timeout, f'Timeout while waiting for event "${event}"'
+            timeout, f'Timeout while waiting for event "{event}"'
         )
         if event != WebSocket.Events.Close:
             wait_helper.reject_on_event(
diff --git a/playwright/_impl/_page.py b/playwright/_impl/_page.py
@@ -537,7 +537,7 @@ async def waitForEvent(
             timeout = self._timeout_settings.timeout()
         wait_helper = WaitHelper(self._loop)
         wait_helper.reject_on_timeout(
-            timeout, f'Timeout while waiting for event "${event}"'
+            timeout, f'Timeout while waiting for event "{event}"'
         )
         if event != Page.Events.Crash:
             wait_helper.reject_on_event(self, Page.Events.Crash, Error("Page crashed"))
diff --git a/playwright/_impl/_transport.py b/playwright/_impl/_transport.py
@@ -48,11 +48,15 @@ def stop(self) -> None:
 
     async def run(self) -> None:
         self._loop = asyncio.get_running_loop()
-        driver_executable = self._driver_executable
+
+        driver_env = os.environ.copy()
+        # VSCode's JavaScript Debug Terminal provides it but driver/pkg does not support it
+        driver_env.pop("NODE_OPTIONS", None)
 
         proc = await asyncio.create_subprocess_exec(
-            str(driver_executable),
+            str(self._driver_executable),
             "run-driver",
+            env=driver_env,
             stdin=asyncio.subprocess.PIPE,
             stdout=asyncio.subprocess.PIPE,
             stderr=_get_stderr_fileno(),
diff --git a/tests/async/test_har.py b/tests/async/test_har.py
@@ -57,7 +57,6 @@ async def test_should_include_content(browser, server, tmpdir):
         log = data["log"]
 
         content1 = log["entries"][0]["response"]["content"]
-        print(content1)
         assert content1["encoding"] == "base64"
         assert content1["mimeType"] == "text/html"
         s = base64.b64decode(content1["text"]).decode()
diff --git a/tests/async/test_headful.py b/tests/async/test_headful.py
@@ -89,7 +89,7 @@ async def test_should_click_background_tab(browser_type, launch_arguments, serve
     browser = await browser_type.launch(**{**launch_arguments, "headless": False})
     page = await browser.new_page()
     await page.set_content(
-        '<button>Hello</button><a target=_blank href="${server.EMPTY_PAGE}">empty.html</a>'
+        f'<button>Hello</button><a target=_blank href="{server.EMPTY_PAGE}">empty.html</a>'
     )
     await page.click("a")
     await page.click("button")
diff --git a/tests/async/test_page.py b/tests/async/test_page.py
@@ -478,7 +478,7 @@ async def test_set_content_should_respect_timeout(page, server):
     server.set_route(img_path, lambda request: None)
     with pytest.raises(Error) as exc_info:
         await page.set_content(
-            '<img src="${server.PREFIX + img_path}"></img>', timeout=1
+            f'<img src="{server.PREFIX + img_path}"></img>', timeout=1
         )
     assert exc_info.type is TimeoutError
 

Original file line number	Diff line number	Diff line change
`@@ -215,7 +215,7 @@ async def waitForEvent(`
`215`	`215`	`timeout = self._timeout_settings.timeout()`
`216`	`216`	`wait_helper = WaitHelper(self._loop)`
`217`	`217`	`wait_helper.reject_on_timeout(`
`218`		`- timeout, f'Timeout while waiting for event "${event}"'`
	`218`	`+ timeout, f'Timeout while waiting for event "{event}"'`
`219`	`219`	`)`
`220`	`220`	`if event != BrowserContext.Events.Close:`
`221`	`221`	`wait_helper.reject_on_event(`
Original file line number	Diff line number	Diff line change
`@@ -301,7 +301,7 @@ async def waitForEvent(`
`301`	`301`	`timeout = cast(Any, self._parent)._timeout_settings.timeout()`
`302`	`302`	`wait_helper = WaitHelper(self._loop)`
`303`	`303`	`wait_helper.reject_on_timeout(`
`304`		`- timeout, f'Timeout while waiting for event "${event}"'`
	`304`	`+ timeout, f'Timeout while waiting for event "{event}"'`
`305`	`305`	`)`
`306`	`306`	`if event != WebSocket.Events.Close:`
`307`	`307`	`wait_helper.reject_on_event(`
Original file line number	Diff line number	Diff line change
`@@ -537,7 +537,7 @@ async def waitForEvent(`
`537`	`537`	`timeout = self._timeout_settings.timeout()`
`538`	`538`	`wait_helper = WaitHelper(self._loop)`
`539`	`539`	`wait_helper.reject_on_timeout(`
`540`		`- timeout, f'Timeout while waiting for event "${event}"'`
	`540`	`+ timeout, f'Timeout while waiting for event "{event}"'`
`541`	`541`	`)`
`542`	`542`	`if event != Page.Events.Crash:`
`543`	`543`	`wait_helper.reject_on_event(self, Page.Events.Crash, Error("Page crashed"))`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ async def test_should_click_background_tab(browser_type, launch_arguments, serve`
`89`	`89`	`browser = await browser_type.launch({launch_arguments, "headless": False})`
`90`	`90`	`page = await browser.new_page()`
`91`	`91`	`await page.set_content(`
`92`		`- '<button>Hello</button><a target=_blank href="${server.EMPTY_PAGE}">empty.html</a>'`
	`92`	`+ f'<button>Hello</button><a target=_blank href="{server.EMPTY_PAGE}">empty.html</a>'`
`93`	`93`	`)`
`94`	`94`	`await page.click("a")`
`95`	`95`	`await page.click("button")`
Original file line number	Diff line number	Diff line change
`@@ -478,7 +478,7 @@ async def test_set_content_should_respect_timeout(page, server):`
`478`	`478`	`server.set_route(img_path, lambda request: None)`
`479`	`479`	`with pytest.raises(Error) as exc_info:`
`480`	`480`	`await page.set_content(`
`481`		`- '<img src="${server.PREFIX + img_path}"></img>', timeout=1`
	`481`	`+ f'<img src="{server.PREFIX + img_path}"></img>', timeout=1`
`482`	`482`	`)`
`483`	`483`	`assert exc_info.type is TimeoutError`
`484`	`484`