Skip to content

Commit d8bef45

Browse files
authored
browser seletion (#19)
* browser seletion * ci * ci
1 parent e62620e commit d8bef45

7 files changed

Lines changed: 178 additions & 105 deletions

File tree

‎.github/workflows/main.yaml‎

Lines changed: 28 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,28 @@ defaults:
1414
jobs:
1515
test_with_conda:
1616
runs-on: ubuntu-latest
17+
strategy:
18+
fail-fast: false
19+
matrix:
20+
browser: [chromium, firefox, webkit]
21+
env:
22+
PYJS_CODE_RUNNER_TEST_BROWSERS: ${{ matrix.browser }}
1723
steps:
18-
- uses: actions/checkout@v2
24+
- uses: actions/checkout@v4
1925

20-
21-
- name: Get number of CPU cores
22-
uses: SimenB/github-actions-cpu-cores@v1
23-
24-
- name: apt-install
25-
run: |
26-
sudo apt-get update -y && sudo apt-get install -y \
27-
libwoff1 libvpx9 libevent-2.1-7t64 libopus0 libgstreamer-plugins-base1.0-0 \
28-
libgstreamer-gl1.0-0 \
29-
libgstreamer-plugins-bad1.0-0 \
30-
libflite1 \
31-
libavif16 \
32-
libharfbuzz-icu0 \
33-
libsecret-1-0 \
34-
libhyphen0 \
35-
libmanette-0.2-0 \
36-
libgles2 \
37-
gstreamer1.0-libav
38-
3926
- name: Install mamba
4027
uses: mamba-org/setup-micromamba@v2
4128
with:
4229
environment-file: dev-env.yml
4330
environment-name: dev-env
4431
init-shell: >-
45-
bash
46-
47-
- name: Install Playwright
32+
bash
33+
34+
# installs the browser and the system libraries it needs (via apt)
35+
- name: Install Playwright browser
4836
shell: bash -el {0}
4937
run: |
50-
playwright install
38+
playwright install --with-deps ${{ matrix.browser }}
5139
5240
- name: Install pyjs-code-runner
5341
shell: bash -el {0}
@@ -57,31 +45,19 @@ jobs:
5745
- name: Run Tests
5846
shell: bash -el {0}
5947
run: |
60-
pytest -s -vvvvv
48+
pytest -s -vvvvv
6149
6250
6351
test_with_pip:
6452
runs-on: ubuntu-latest
53+
strategy:
54+
fail-fast: false
55+
matrix:
56+
browser: [chromium, firefox, webkit]
57+
env:
58+
PYJS_CODE_RUNNER_TEST_BROWSERS: ${{ matrix.browser }}
6559
steps:
66-
- uses: actions/checkout@v2
67-
68-
- name: Get number of CPU cores
69-
uses: SimenB/github-actions-cpu-cores@v1
70-
71-
- name: apt-install
72-
run: |
73-
sudo apt-get update -y && sudo apt-get install -y \
74-
libwoff1 libvpx9 libevent-2.1-7t64 libopus0 libgstreamer-plugins-base1.0-0 \
75-
libgstreamer-gl1.0-0 \
76-
libgstreamer-plugins-bad1.0-0 \
77-
libflite1 \
78-
libavif16 \
79-
libharfbuzz-icu0 \
80-
libsecret-1-0 \
81-
libhyphen0 \
82-
libmanette-0.2-0 \
83-
libgles2 \
84-
gstreamer1.0-libav
60+
- uses: actions/checkout@v4
8561

8662
- name: Install mamba
8763
uses: mamba-org/setup-micromamba@v2
@@ -93,9 +69,14 @@ jobs:
9369
shell: bash -el {0}
9470
run: |
9571
python -m pip install .
96-
playwright install
97-
72+
73+
# installs the browser and the system libraries it needs (via apt)
74+
- name: Install Playwright browser
75+
shell: bash -el {0}
76+
run: |
77+
playwright install --with-deps ${{ matrix.browser }}
78+
9879
- name: Run Tests
9980
shell: bash -el {0}
10081
run: |
101-
pytest -s -vvvvv
82+
pytest -s -vvvvv

‎dev-env.yml‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ dependencies:
99
- typer
1010
- appdirs
1111
- empack >=3,<4
12-
- microsoft::playwright
12+
- playwright
13+
- playwright-python
1314
- emsdk
1415
- rich

‎pyjs_code_runner/backend/backend.py‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,35 @@ class BackendType(str, Enum):
1313
node = "node"
1414

1515

16+
class BrowserType(str, Enum):
17+
"""Browser engines available via playwright.
18+
19+
`webkit` is playwright's build of WebKit, the engine behind Safari.
20+
"""
21+
22+
chromium = "chromium"
23+
firefox = "firefox"
24+
webkit = "webkit"
25+
26+
27+
async def launch_browser(playwright, browser, headless, slow_mo=None):
28+
"""Launch `browser` (a BrowserType or its name) with playwright."""
29+
browser = BrowserType(browser)
30+
launcher = getattr(playwright, browser.value)
31+
kwargs = dict(headless=headless)
32+
if slow_mo is not None:
33+
kwargs["slow_mo"] = slow_mo
34+
try:
35+
return await launcher.launch(**kwargs)
36+
except Exception as e:
37+
if "Executable doesn't exist" in str(e):
38+
raise RuntimeError(
39+
f"playwright browser `{browser.value}` is not installed, "
40+
f"install it with:\n\n playwright install {browser.value}\n"
41+
) from e
42+
raise
43+
44+
1645
def get_backend_type_family(backend):
1746
if backend == BackendType.node:
1847
return BackendFamilyType.node

‎pyjs_code_runner/backend/browser_main/browser_main.py‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import os
22
import asyncio
33
from ..backend_base import BackendBase
4+
from ..backend import BrowserType, launch_browser
45
from ...constants import JS_DIR, HTML_DIR
56
from .server import server_context, find_free_port
67
from playwright.async_api import async_playwright
@@ -13,7 +14,15 @@
1314

1415
class BrowserMainBackend(BackendBase):
1516
def __init__(
16-
self, host_work_dir, work_dir, script, async_main, port, headless, slow_mo
17+
self,
18+
host_work_dir,
19+
work_dir,
20+
script,
21+
async_main,
22+
port,
23+
headless,
24+
slow_mo,
25+
browser=BrowserType.chromium,
1726
):
1827
super().__init__(
1928
host_work_dir=host_work_dir,
@@ -26,6 +35,7 @@ def __init__(
2635
self.port = port
2736
self.headless = headless
2837
self.slow_mo = slow_mo
38+
self.browser = BrowserType(browser)
2939

3040
def run(self):
3141
browser_main_html = "browser_main.html"
@@ -43,12 +53,9 @@ def run(self):
4353

4454
async def playwright_run_in_main_thread(self, page_url):
4555
async with async_playwright() as p:
46-
if self.slow_mo is None:
47-
browser = await p.chromium.launch(headless=self.headless)
48-
else:
49-
browser = await p.chromium.launch(
50-
headless=self.headless, slow_mo=self.slow_mo
51-
)
56+
browser = await launch_browser(
57+
p, self.browser, headless=self.headless, slow_mo=self.slow_mo
58+
)
5259
page = await browser.new_page()
5360
await page.goto(page_url)
5461
# n min = n_min * 60 * 1000 ms

‎pyjs_code_runner/backend/browser_worker/browser_worker.py‎

Lines changed: 70 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,38 @@
11
import os
22
import asyncio
33
from ..backend_base import BackendBase
4+
from ..backend import BrowserType, launch_browser
45
from ...constants import JS_DIR, HTML_DIR
56
from ..browser_main.server import server_context, find_free_port
67
from playwright.async_api import async_playwright
8+
from playwright.async_api import Error as PlaywrightError
79
from pathlib import Path
810
import shutil
911

1012

13+
def _is_target_closed_error(e):
14+
# TargetClosedError is not part of playwright's public api (and older
15+
# versions raise a plain Error with a "Target closed" message)
16+
msg = str(e)
17+
return (
18+
type(e).__name__ == "TargetClosedError"
19+
or "Target closed" in msg
20+
or "has been closed" in msg
21+
)
22+
23+
1124
class BrowserWorkerBackend(BackendBase):
1225
def __init__(
13-
self, host_work_dir, work_dir, script, async_main, port, headless, slow_mo, preload_shared_libs=True
26+
self,
27+
host_work_dir,
28+
work_dir,
29+
script,
30+
async_main,
31+
port,
32+
headless,
33+
slow_mo,
34+
preload_shared_libs=True,
35+
browser=BrowserType.chromium,
1436
):
1537
super().__init__(
1638
host_work_dir=host_work_dir,
@@ -23,6 +45,7 @@ def __init__(
2345
self.port = port
2446
self.headless = headless
2547
self.slow_mo = slow_mo
48+
self.browser = BrowserType(browser)
2649
self.preload_shared_libs = preload_shared_libs
2750

2851
def run(self):
@@ -47,50 +70,26 @@ def run(self):
4770

4871
async def playwright_run_in_worker_thread(self, page_url):
4972
async with async_playwright() as p:
50-
if self.slow_mo is None:
51-
browser = await p.chromium.launch(headless=self.headless)
52-
else:
53-
browser = await p.chromium.launch(
54-
headless=self.headless, slow_mo=self.slow_mo
55-
)
73+
browser = await launch_browser(
74+
p, self.browser, headless=self.headless, slow_mo=self.slow_mo
75+
)
5676
page = await browser.new_page()
5777

5878
# n min = n_min * 60 * 1000 ms
5979
n_min = 4
6080
page.set_default_timeout(n_min * 60 * 1000)
6181

6282
async def handle_worker(worker):
63-
test_output = await worker.evaluate_handle(
64-
f"""async () =>
65-
{{
66-
67-
{self.js_utils()}
68-
69-
var collected_prints = ""
70-
const print = (text) => {{
71-
console.log(text)
72-
collected_prints += text;
73-
collected_prints += "\\n";
74-
}}
75-
76-
77-
var pyjs = await make_pyjs(print, print, {str(self.preload_shared_libs).lower()});
78-
79-
var r = eval_main_script(pyjs, "{self.work_dir}","{self.script}");
80-
if({int(self.async_main)}){{
81-
r = r || await run_async_python_main(pyjs);
82-
}}
83-
84-
msg = {{
85-
return_code : r,
86-
collected_prints : collected_prints
87-
}}
88-
self.postMessage(msg)
89-
return r
90-
}}"""
91-
)
92-
if int(str(test_output)) != 0:
93-
raise RuntimeError(f"tests failed with return code: {test_output}")
83+
try:
84+
await self._run_in_worker(worker)
85+
except PlaywrightError as e:
86+
if not _is_target_closed_error(e):
87+
raise
88+
# the page terminates the worker as soon as the worker has
89+
# posted its result (see browser_worker.html), which may
90+
# happen before playwright receives the evaluate result.
91+
# The return code is read from the page below.
92+
pass
9493

9594
page.on("worker", handle_worker)
9695

@@ -117,3 +116,36 @@ async def handle_console(msg):
117116
)
118117
return_code = int(str(await test_output.get_property("return_code")))
119118
return return_code
119+
120+
async def _run_in_worker(self, worker):
121+
test_output = await worker.evaluate_handle(
122+
f"""async () =>
123+
{{
124+
125+
{self.js_utils()}
126+
127+
var collected_prints = ""
128+
const print = (text) => {{
129+
console.log(text)
130+
collected_prints += text;
131+
collected_prints += "\\n";
132+
}}
133+
134+
135+
var pyjs = await make_pyjs(print, print, {str(self.preload_shared_libs).lower()});
136+
137+
var r = eval_main_script(pyjs, "{self.work_dir}","{self.script}");
138+
if({int(self.async_main)}){{
139+
r = r || await run_async_python_main(pyjs);
140+
}}
141+
142+
msg = {{
143+
return_code : r,
144+
collected_prints : collected_prints
145+
}}
146+
self.postMessage(msg)
147+
return r
148+
}}"""
149+
)
150+
if int(str(test_output)) != 0:
151+
raise RuntimeError(f"tests failed with return code: {test_output}")

0 commit comments

Comments
 (0)