Den 331 Add browserless implementation (#64)

Author: coffecup25

dendrite_sdk/async_api/_core/_impl_mapping.py

@@ -3,17 +3,21 @@
 from dendrite_sdk.async_api._core._impl_browser import ImplBrowser, LocalImpl
 
 from dendrite_sdk.async_api._ext_impl.browserbase._impl import BrowserBaseImpl
+from dendrite_sdk.async_api._ext_impl.browserless._impl import BrowserlessImpl
+from dendrite_sdk.async_api._ext_impl.browserless._settings import BrowserlessConfig
 from dendrite_sdk.remote import Providers
 from dendrite_sdk.remote.browserbase_config import BrowserbaseConfig
 
 
 IMPL_MAPPING: Dict[Type[Providers], Type[ImplBrowser]] = {
     BrowserbaseConfig: BrowserBaseImpl,
+    BrowserlessConfig: BrowserlessImpl,
     # BFloatProviderConfig: ,
 }
 
-SETTINGS_CLASSES: Dict[str, Type[BrowserbaseConfig]] = {
+SETTINGS_CLASSES: Dict[str, Type[Providers]] = {
     "browserbase": BrowserbaseConfig,
+    "browserless": BrowserlessConfig,
 }
 
 

dendrite_sdk/async_api/_ext_impl/browserbase/_impl.py

@@ -13,7 +13,6 @@
 from dendrite_sdk.async_api._ext_impl.browserbase._download import (
     AsyncBrowserbaseDownload,
 )
-from dendrite_sdk.async_api._ext_impl.browserbase._settings import BrowserBaseSettings
 
 
 class BrowserBaseImpl(ImplBrowser):

dendrite_sdk/async_api/_ext_impl/browserbase/_settings.py

@@ -0,0 +1 @@
+

dendrite_sdk/async_api/_ext_impl/browserless/__init__.py

@@ -0,0 +1,57 @@
+import json
+from typing import TYPE_CHECKING, Optional
+from dendrite_sdk._common._exceptions.dendrite_exception import BrowserNotLaunchedError
+from dendrite_sdk.async_api._core._impl_browser import ImplBrowser
+from dendrite_sdk.async_api._core._type_spec import PlaywrightPage
+from dendrite_sdk.async_api._ext_impl.browserless._settings import BrowserlessConfig
+
+if TYPE_CHECKING:
+    from dendrite_sdk.async_api._core.dendrite_browser import AsyncDendrite
+from dendrite_sdk.async_api._ext_impl.browserbase._client import BrowserbaseClient
+from playwright.async_api import Playwright
+from loguru import logger
+import urllib.parse
+
+from dendrite_sdk.async_api._ext_impl.browserbase._download import (
+    AsyncBrowserbaseDownload,
+)
+
+
+class BrowserlessImpl(ImplBrowser):
+    def __init__(self, settings: BrowserlessConfig) -> None:
+        self.settings = settings
+        self._session_id: Optional[str] = None
+
+    async def stop_session(self):
+        pass
+
+    async def start_browser(self, playwright: Playwright, pw_options: dict):
+        logger.debug("Starting browser")
+        url = self._format_connection_url(pw_options)
+        logger.debug(f"Connecting to browser at {url}")
+        return await playwright.chromium.connect_over_cdp(url)
+
+    def _format_connection_url(self, pw_options: dict) -> str:
+        url = self.settings.url.rstrip("?").rstrip("/")
+
+        query = {
+            "token": self.settings.api_key,
+            "blockAds": self.settings.block_ads,
+            "launch": json.dumps(pw_options),
+        }
+
+        if self.settings.proxy:
+            query["proxy"] = (self.settings.proxy,)
+            query["proxyCountry"] = (self.settings.proxy_country,)
+        return f"{url}?{urllib.parse.urlencode(query)}"
+
+    async def configure_context(self, browser: "AsyncDendrite"):
+        pass
+
+    async def get_download(
+        self,
+        dendrite_browser: "AsyncDendrite",
+        pw_page: PlaywrightPage,
+        timeout: float = 30000,
+    ) -> AsyncBrowserbaseDownload:
+        raise NotImplementedError("Downloads are not supported for Browserless")

dendrite_sdk/async_api/_ext_impl/browserless/_impl.py

@@ -0,0 +1,26 @@
+import os
+from typing import Any, Optional
+
+from pydantic import BaseModel, Field, TypeAdapter, ValidationError, model_validator
+from dendrite_sdk.exceptions import MissingApiKeyError
+
+
+class BrowserlessConfig:
+
+    def __init__(
+        self,
+        url: str = "wss://production-sfo.browserless.io",
+        api_key: Optional[str] = None,
+        proxy: Optional[str] = None,
+        proxy_country: Optional[str] = None,
+        block_ads: bool = False,
+    ):
+        api_key = api_key if api_key is not None else os.getenv("BROWSERLESS_API_KEY")
+        if api_key is None:
+            raise MissingApiKeyError("BROWSERLESS_API_KEY")
+
+        self.url = url
+        self.api_key = api_key
+        self.block_ads = block_ads
+        self.proxy = proxy
+        self.proxy_country = proxy_country

dendrite_sdk/async_api/_ext_impl/browserless/_settings.py

@@ -1,6 +1,8 @@
+from typing import Union
+from dendrite_sdk.async_api._ext_impl.browserless._settings import BrowserlessConfig
 from dendrite_sdk.remote.browserbase_config import BrowserbaseConfig
 
 
-Providers = BrowserbaseConfig
+Providers = Union[BrowserbaseConfig, BrowserlessConfig]
 
 __all__ = ["Providers", "BrowserbaseConfig"]