[contrib] Add computer: HyperbrowserBrowser

.env.example

@@ -6,4 +6,6 @@ OPENAI_ORG = "org-123"
 BROWSERBASE_API_KEY="00000000-0000-0000-0000-000000000000"
 BROWSERBASE_PROJECT_ID="bb_live_00000000-00000"
 
+HYPERBROWSER_API_KEY="hb_0000000000000000000000000000"
+
 SCRAPYBARA_API_KEY="scrapy-123"

README.md

@@ -94,6 +94,7 @@ This sample app provides a set of implemented `Computer` examples, but feel free
 | `LocalPlaywright`   | local-playwright   | `browser` | Local browser window              | [Playwright SDK](https://playwright.dev/)                        |
 | `Docker`            | docker             | `linux`   | Docker container environment      | [Docker](https://docs.docker.com/engine/install/) running        |
 | `Browserbase`       | browserbase        | `browser` | Remote browser environment        | [Browserbase](https://www.browserbase.com/) API key in `.env`    |
+| `Hyperbrowser`      | hyperbrowser       | `browser` | Remote browser environment        | [Hyperbrowser](https://hyperbrowser.ai/) API key in `.env`       |
 | `ScrapybaraBrowser` | scrapybara-browser | `browser` | Remote browser environment        | [Scrapybara](https://scrapybara.com/dashboard) API key in `.env` |
 | `ScrapybaraUbuntu`  | scrapybara-ubuntu  | `linux`   | Remote Ubuntu desktop environment | [Scrapybara](https://scrapybara.com/dashboard) API key in `.env` |
 
@@ -113,7 +114,7 @@ python cli.py --show --computer docker
 
 | Computer | Option | Type | Description | Requirements |
 | -------- | ------ | ---- | ----------- | ------------ |
-| `tbd`    | tbd    | tbd  | tbd         | tbd          |
+| `Hyperbrowser`      | hyperbrowser       | `browser` | Remote browser environment        | [Hyperbrowser](https://hyperbrowser.ai/) API key in `.env`       |
 
 > [!NOTE]  
 > If you've implemented a new computer, please add it to the "Contributed Computers" section of the README.md file. Clearly indicate any auth / signup requirements. See the [Contributing](#contributing) section for more details.

cli.py

@@ -54,7 +54,7 @@ def main():
         )
         items = []
 
-        if args.computer in ["browserbase", "local-playwright"]:
+        if args.computer in ["browserbase", "local-playwright", "hyperbrowser"]:
             if not args.start_url.startswith("http"):
                 args.start_url = "https://" + args.start_url
             agent.computer.goto(args.start_url)

computers/config.py

@@ -7,4 +7,5 @@
     "browserbase": BrowserbaseBrowser,
     "scrapybara-browser": ScrapybaraBrowser,
     "scrapybara-ubuntu": ScrapybaraUbuntu,
+    "hyperbrowser": HyperbrowserBrowser,
 }

computers/contrib/__init__.py

@@ -0,0 +1,3 @@
+from .hyperbrowser import HyperbrowserBrowser
+
+__all__ = ["HyperbrowserBrowser"]

computers/contrib/hyperbrowser.py

@@ -0,0 +1,171 @@
+import os
+from typing import Tuple
+from playwright.sync_api import Browser, Page, Error as PlaywrightError
+from hyperbrowser import Hyperbrowser
+from hyperbrowser.models import CreateSessionParams, ScreenConfig
+from dotenv import load_dotenv
+
+from ..shared.base_playwright import BasePlaywrightComputer
+
+
+load_dotenv()
+
+
+class HyperbrowserBrowser(BasePlaywrightComputer):
+    """
+    Hyperbrowser is the next-generation platform for effortless, scalable browser automation. It provides a cloud-based browser instance
+    that can be controlled through code, eliminating the need for local infrastructure setup.
+    Key features include:
+    - Instant Scalability: Spin up hundreds of browser sessions in seconds without infrastructure headaches
+    - Simple Integration: Works seamlessly with popular tools like Puppeteer and Playwright
+    - Powerful APIs: Easy to use APIs for managing sessions, scraping/crawling any site, and much more
+    - Production Ready: Enterprise-grade reliability and security built-in
+    - Bypass Anti-Bot Measures: Built-in stealth mode, ad blocking, automatic CAPTCHA solving, and rotating proxies
+    IMPORTANT: This Hyperbrowser computer requires the use of the `goto` tool defined in playwright_with_custom_functions.py.
+    Make sure to include this tool in your configuration when using the Hyperbrowser computer.
+    """
+
+    def get_dimensions(self):
+        return self.dimensions
+
+    def __init__(
+        self,
+        width: int = 1024,
+        height: int = 768,
+        use_proxy: bool = False,
+        adblock: bool = False,
+        block_trackers: bool = False,
+        block_annoyances: bool = False,
+        accept_cookies: bool = False,
+    ):
+        """
+        Initialize the Hyperbrowser session.
+        Additional configuration options for a Hyperbrowser session can be found in the Hyperbrowser documentation: https://docs.hyperbrowser.ai/sessions/overview/session-parameters
+
+        Args:
+            width (int): The width of the browser viewport. Default is 1024.
+            height (int): The height of the browser viewport. Default is 768.
+            use_proxy (bool): Whether to use a proxy for the session. Default is False.
+            adblock (bool): Whether to block ads and other unwanted content. Default is False.
+            block_trackers (bool): Whether to block web trackers and other privacy-invasive technologies. Default is False.
+            block_annoyances (bool): Whether to block common annoyances like pop-ups, overlays, and other disruptive elements. Default is False.
+            accept_cookies (bool): Whether to accept all cookies on sites that are visited. Default is False.
+        """
+        super().__init__()
+        self.hb = Hyperbrowser(api_key=os.getenv("HYPERBROWSER_API_KEY"))
+        self.session = None
+        self.dimensions = (width, height)
+        self.use_proxy = use_proxy
+        self.adblock = adblock
+        self.block_trackers = block_trackers
+        self.block_annoyances = block_annoyances
+        self.accept_cookies = accept_cookies
+
+    def _get_browser_and_page(self) -> Tuple[Browser, Page]:
+        """
+        Create a Hyperbrowser session and connect to it.
+        This method creates a cloud-based browser session using Hyperbrowser's Sessions API,
+        configures it with the specified parameters, and establishes a connection using Playwright.
+
+        Returns:
+            Tuple[Browser, Page]: A tuple containing the connected browser and page objects.
+        """
+        # Create a session on Hyperbrowser with specified parameters
+        # To view all session parameters, see the Hyperbrowser Sessions API Reference: https://docs.hyperbrowser.ai/reference/api-reference/sessions#post-api-session
+        width, height = self.dimensions
+        session_params = CreateSessionParams(
+            use_proxy=self.use_proxy,
+            adblock=self.adblock,
+            trackers=self.block_trackers,
+            annoyances=self.block_annoyances,
+            accept_cookies=self.accept_cookies,
+            screen=ScreenConfig(width=width, height=height),
+        )
+        self.session = self.hb.sessions.create(session_params)
+
+        # Print the live session URL
+        print(f"Watch and control this browser live at {self.session.live_url}")
+
+        # Connect to the remote session
+        browser = self._playwright.chromium.connect_over_cdp(
+            self.session.ws_endpoint, timeout=60000
+        )
+        context = browser.contexts[0]
+
+        # Add event listeners for page creation and closure
+        context.on("page", self._handle_new_page)
+
+        page = context.pages[0]
+        page.set_viewport_size({"width": width, "height": height})
+        page.on("close", self._handle_page_close)
+
+        page.goto("https://bing.com")
+
+        return browser, page
+
+    def _handle_new_page(self, page: Page):
+        """Handle the creation of a new page."""
+        print("New page created")
+        self._page = page
+        self._page.set_viewport_size(
+            {"width": self.dimensions[0], "height": self.dimensions[1]}
+        )
+        page.on("close", self._handle_page_close)
+
+    def _handle_page_close(self, page: Page):
+        """Handle the closure of a page."""
+        print("Page closed")
+        if self._page == page:
+            if self._browser.contexts[0].pages:
+                self._page = self._browser.contexts[0].pages[-1]
+            else:
+                print("Warning: All pages have been closed.")
+                self._page = None
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """
+        Clean up resources when exiting the context manager.
+
+        Args:
+            exc_type: The type of the exception that caused the context to be exited.
+            exc_val: The exception instance that caused the context to be exited.
+            exc_tb: A traceback object encapsulating the call stack at the point where the exception occurred.
+        """
+        if self._playwright:
+            self._playwright.stop()
+        if self._page or self._browser:
+            if self.session:
+                self.hb.sessions.stop(self.session.id)
+            else:
+                if self._page:
+                    self._page.close()
+                if self._browser:
+                    self._browser.close()
+
+        if self.session:
+            print(
+                f"Session completed. View replay at https://app.hyperbrowser.ai/features/sessions/{self.session.id}"
+            )
+
+    def screenshot(self) -> str:
+        """
+        Capture a screenshot of the current viewport using CDP.
+
+        Returns:
+            str: A base64 encoded string of the screenshot.
+        """
+        try:
+            # Get CDP session from the page
+            cdp_session = self._page.context.new_cdp_session(self._page)
+
+            # Capture screenshot using CDP
+            result = cdp_session.send(
+                "Page.captureScreenshot", {"format": "png", "fromSurface": True}
+            )
+
+            return result["data"]
+        except PlaywrightError as error:
+            print(
+                f"CDP screenshot failed, falling back to standard screenshot: {error}"
+            )
+            return super().screenshot()

requirements.txt

@@ -8,6 +8,7 @@ greenlet==3.1.1
 h11==0.14.0
 httpcore==1.0.7
 httpx==0.28.1
+hyperbrowser==0.48.0
 idna==3.10
 jiter==0.8.2
 pillow==11.1.0