provider.py 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. """Browserbase cloud browser provider: direct ``BROWSERBASE_API_KEY`` + ``BROWSERBASE_PROJECT_ID``
  2. only (the Nous subscription routes through Browser Use). Config ``browser.cloud_provider:
  3. "browserbase"``; knobs ``BROWSERBASE_BASE_URL``, ``BROWSERBASE_PROXIES`` (true),
  4. ``BROWSERBASE_ADVANCED_STEALTH`` (false), ``BROWSERBASE_KEEP_ALIVE`` (true),
  5. ``BROWSERBASE_SESSION_TIMEOUT`` (seconds, max 21600)."""
  6. from __future__ import annotations
  7. import logging
  8. import os
  9. from typing import Any, Dict, Optional
  10. from agent.secret_scope import get_secret
  11. from plugins.browser._common import CloudBrowserProvider
  12. logger = logging.getLogger(__name__)
  13. # 402 fallbacks, in retry order: (session_config key, warning logged when dropped).
  14. _PAID_FEATURE_FALLBACKS = (
  15. ("keepAlive", "keepAlive may require paid plan (402), retrying without it. "
  16. "Sessions may timeout during long operations."),
  17. ("proxies", "Proxies unavailable (402), retrying without proxies. "
  18. "Bot detection may be less effective."))
  19. class BrowserbaseBrowserProvider(CloudBrowserProvider):
  20. """Browserbase (https://browserbase.com) cloud browser backend."""
  21. provider_id = "browserbase"
  22. label = "Browserbase"
  23. release_method = "post"
  24. release_path = "/v1/sessions/{session_id}"
  25. missing_credentials_error = (
  26. "Browserbase requires BROWSERBASE_API_KEY and BROWSERBASE_PROJECT_ID "
  27. "environment variables.")
  28. close_fail_fmt = "Failed to close session %s: HTTP %s - %s"
  29. setup_tag = "Cloud browser with stealth and proxies"
  30. setup_env_vars = [
  31. {"key": "BROWSERBASE_API_KEY", "prompt": "Browserbase API key", "url": "https://browserbase.com"},
  32. {"key": "BROWSERBASE_PROJECT_ID", "prompt": "Browserbase project ID"},
  33. ]
  34. def _get_config_or_none(self) -> Optional[dict[str, Any]]:
  35. api_key = get_secret("BROWSERBASE_API_KEY")
  36. project_id = get_secret("BROWSERBASE_PROJECT_ID")
  37. if not (api_key and project_id):
  38. return None
  39. return {
  40. "api_key": api_key,
  41. "project_id": project_id,
  42. # Per-profile like the key: the scoped key must not be sent to the default profile's endpoint.
  43. "base_url": (get_secret("BROWSERBASE_BASE_URL", "") or "https://api.browserbase.com").rstrip("/"),
  44. }
  45. def _headers(self, config: dict[str, Any]) -> dict[str, str]:
  46. return {"Content-Type": "application/json", "X-BB-API-Key": config["api_key"]}
  47. def _release_headers(self, config: dict[str, Any]) -> dict[str, str]:
  48. return {"X-BB-API-Key": config["api_key"], "Content-Type": "application/json"}
  49. def _release_body(self, config: dict[str, Any]) -> dict[str, object]:
  50. return {"projectId": config["project_id"], "status": "REQUEST_RELEASE"}
  51. def create_session(self, task_id: str) -> dict[str, object]:
  52. config = self._get_config()
  53. enable_proxies = os.environ.get("BROWSERBASE_PROXIES", "true").lower() != "false"
  54. enable_advanced_stealth = os.environ.get("BROWSERBASE_ADVANCED_STEALTH", "false").lower() == "true"
  55. enable_keep_alive = os.environ.get("BROWSERBASE_KEEP_ALIVE", "true").lower() != "false"
  56. custom_timeout_ms = os.environ.get("BROWSERBASE_SESSION_TIMEOUT")
  57. session_config: dict[str, object] = {"projectId": config["project_id"]}
  58. if enable_keep_alive:
  59. session_config["keepAlive"] = True
  60. if custom_timeout_ms:
  61. try:
  62. timeout_val = int(custom_timeout_ms)
  63. if timeout_val > 0:
  64. session_config["timeout"] = timeout_val
  65. except ValueError:
  66. logger.warning("Invalid BROWSERBASE_SESSION_TIMEOUT value: %s", custom_timeout_ms)
  67. if enable_proxies:
  68. session_config["proxies"] = True
  69. if enable_advanced_stealth:
  70. session_config["browserSettings"] = {"advancedStealth": True}
  71. url = f"{config['base_url']}/v1/sessions"
  72. headers = self._headers(config)
  73. response = self._post_create(url, headers, session_config)
  74. # 402 — paid features unavailable: drop keepAlive, then proxies, and retry.
  75. dropped = set()
  76. for key, warning in _PAID_FEATURE_FALLBACKS:
  77. if response.status_code == 402 and key in session_config:
  78. dropped.add(key)
  79. logger.warning(warning)
  80. session_config.pop(key)
  81. response = self._post_create(url, headers, session_config)
  82. self._check_created(response)
  83. session_data = response.json()
  84. session_name = self._session_name(task_id)
  85. features_enabled = {
  86. "basic_stealth": True,
  87. "proxies": enable_proxies and "proxies" not in dropped,
  88. "advanced_stealth": enable_advanced_stealth,
  89. "keep_alive": enable_keep_alive and "keepAlive" not in dropped,
  90. "custom_timeout": bool(custom_timeout_ms) and "timeout" in session_config,
  91. }
  92. feature_str = ", ".join(k for k, v in features_enabled.items() if v)
  93. logger.info("Created Browserbase session %s with features: %s", session_name, feature_str)
  94. return {
  95. "session_name": session_name,
  96. "bb_session_id": session_data["id"],
  97. "cdp_url": session_data["connectUrl"],
  98. "features": features_enabled,
  99. }