Support getting a service worker target.

- This allows the client to execute javascript in a Chrome extension context. - Bump the version

Author: JonathanWylie

browserdebuggertools/chrome/interface.py

@@ -10,7 +10,7 @@
 logging.basicConfig(format='%(levelname)s:%(message)s')
 
 
-class ChromeInterface(object):
+class ChromeInterface:
  """ The Chrome Interface communicates with the browser through the remote-debugging-port using
  the Chrome DevTools Protocol.
  For a thorough reference check: https://chromedevtools.github.io/devtools-protocol/
@@ -40,6 +40,7 @@ def __init__(
  :param attach: If set to true, the interface will attach to the first page target found.
  If there are no page targets, a new tab will be created.
  """
+ self._timeout = timeout
  self._targets_manager = TargetsManager(timeout, port, host=host, domains=domains)
  if attach:
  self.switch_target()
@@ -291,3 +292,12 @@ def get_all_events(self, domain, clear=False):
 
  def reload(self):
  return self.execute("Page", "reload")
+
+ @contextlib.contextmanager
+ def service_worker(self, service_script_name):
+ target = self._targets_manager.get_service_worker(service_script_name)
+ target.attach()
+ try:
+ yield target
+ finally:
+ target.detach()

browserdebuggertools/targets_manager.py

@@ -19,7 +19,7 @@
  DevToolsTimeoutException, DomainNotEnabledError,
  MethodNotFoundError, UnknownError, ResourceNotFoundError, MessagingThreadIsDeadError,
  InvalidParametersError, WebSocketBlockedException,
- TargetNotAttachedError
+ TargetNotAttachedError, TargetNotFoundError
 )
 
 
@@ -217,6 +217,12 @@ def detach(self):
  self.wsm.close()
 
 
+class ServiceWorkerTarget(_Target):
+
+ def __init__(self, info: dict, timeout):
+ super().__init__(info, timeout)
+
+
 class EventHandlers(NamedTuple):
  pageLoad: PageLoadEventHandler
  javascriptDialog: JavascriptDialogEventHandler
@@ -675,3 +681,19 @@ def _create_tab(self):
  return requests.put(
  f"http://{self._host}:{self._port}/json/new", timeout=self._connection_timeout
  )
+
+ def get_service_worker(self, service_script_name):
+
+ def find_target_info():
+ for target in self._get_targets():
+ if (
+ target["type"] == "service_worker"
+ and target["url"].endswith(service_script_name)
+ ):
+ return target
+
+ targetInfo = find_target_info()
+ if targetInfo:
+ return ServiceWorkerTarget(targetInfo, self._connection_timeout)
+ else:
+ raise TargetNotFoundError(service_script_name)

setup.py

@@ -11,7 +11,7 @@
 
 setup(
  name="browserdebuggertools",
- version="6.2.0",
+ version="6.2.1",
  python_requires='>=3.8',
  include_package_data=True,
  packages=PACKAGES,

tests/unittests/chrome/test_interface.py

@@ -74,3 +74,16 @@ def test_target_id_does_not_exist(self):
 
  with self.assertRaises(TargetNotFoundError):
  self.interface.switch_target("target_3")
+
+
+class Test_ChromeInterface_service_worker(ChromeInterfaceTest):
+
+ def test(self):
+ service_worker = MagicMock()
+ self.interface._targets_manager.get_service_worker.return_value = service_worker
+
+ with self.interface.service_worker("myExtension.json") as service_worker:
+ service_worker.attach.assert_called_once_with()
+ self.assertFalse(service_worker.detach.called)
+
+ service_worker.detach.assert_called_once_with()

tests/unittests/test_targets_manager.py

@@ -15,7 +15,7 @@
  DevToolsException,
  DomainNotEnabledError, DevToolsTimeoutException, MethodNotFoundError,
  InvalidParametersError, WebSocketBlockedException, MessagingThreadIsDeadError,
- MaxRetriesException, ResourceNotFoundError, TargetNotAttachedError
+ MaxRetriesException, ResourceNotFoundError, TargetNotAttachedError, TargetNotFoundError
 )
 from browserdebuggertools.targets_manager import (
  _WSSessionManager, _WSMessageProducer, TargetsManager, _Target, _DOMManager
@@ -1061,7 +1061,7 @@ def test(self, _targets_manager):
 
 
 @patch(MODULE_PATH + "requests")
-class Test_TargetsManager__create_tab(WSMessageProducerTest):
+class Test_TargetsManager__create_tab(unittest.TestCase):
 
  def setUp(self):
  self._targets_manager = TargetsManager(10, 9222)
@@ -1085,6 +1085,48 @@ def test_not_ok_response(self, requests):
  self._targets_manager._create_tab()
 
 
+class Test_TargetsManager_get_service_worker(unittest.TestCase):
+
+ def setUp(self):
+ self._targets_manager = TargetsManager(10, 9222)
+ self._targets_manager._get_targets = MagicMock()
+ self._targets_manager._get_targets.return_value = [
+ {
+ "description": "",
+ "devtoolsFrontendUrl":
+ "/devtools/inspector.html?ws=172.17.0.2:10000/devtools/page/extension-id",
+ "id": "extension-id",
+ "title": "Service Worker chrome-extension://..../service.js",
+ "type": "service_worker",
+ "url": "chrome-extension://..../service.js",
+ "webSocketDebuggerUrl": "ws://172.17.0.2:10000/devtools/page/extension-ID"
+ },
+ {
+ "description": "",
+ "devtoolsFrontendUrl":
+ "/devtools/inspector.html?ws=172.17.0.2:10001/devtools/page/other-extension-id",
+ "id": "other-extension-id",
+ "title": "Service Worker chrome-extension://ih...gi/other-service.js",
+ "type": "service_worker",
+ "url": "chrome-extension://ih...gi/other-service.js",
+ "webSocketDebuggerUrl": "ws://172.17.0.2:10000/devtools/page/other-extension-id"
+ }
+ ]
+
+ def test(self):
+ self.assertEqual(
+ "extension-id", self._targets_manager.get_service_worker("service.js").id
+ )
+ self.assertEqual(
+ "other-extension-id", self._targets_manager.get_service_worker("other-service.js").id
+ )
+
+ def test_target_not_found(self):
+ with self.assertRaises(TargetNotFoundError):
+ self._targets_manager.get_service_worker("not-installed")
+
+
+
 class DOMManagerTest(TestCase):
 
  def setUp(self):