browser_registry.py 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. """Browser provider registry: cloud browser backends registered by plugins via
  2. :meth:`PluginContext.register_browser_provider`, consumed by ``tools.browser_session_cloud.get_cloud_provider``.
  3. Active-provider precedence (see :func:`_resolve`): ``browser.cloud_provider`` in config.yaml wins
  4. regardless of ``is_available()`` (so the dispatcher surfaces a typed "X_API_KEY is not set" error
  5. instead of silently switching); else the legacy auto-detect walk ``browser-use`` → ``browserbase``
  6. filtered by availability; else ``None`` (local browser mode). There is no capability split here —
  7. every provider implements the full :class:`agent.browser_provider.BrowserProvider` lifecycle.
  8. """
  9. from __future__ import annotations
  10. import logging
  11. from typing import Optional
  12. from agent.browser_provider import BrowserProvider
  13. from agent.provider_registry import ProviderRegistry, is_available_safe
  14. logger = logging.getLogger(__name__)
  15. _registry: ProviderRegistry[BrowserProvider] = ProviderRegistry(
  16. label="Browser", provider_cls=BrowserProvider, logger=logger,
  17. )
  18. _registry.export(globals())
  19. # Auto-detect order when ``browser.cloud_provider`` is unset (historic order: Browser Use first because
  20. # it covers both the managed Nous gateway and the direct API key path; Browserbase as the older
  21. # direct-credentials fallback). Firecrawl is deliberately absent — see :func:`_resolve`.
  22. _LEGACY_PREFERENCE = ("browser-use", "browserbase")
  23. def _resolve(configured: Optional[str]) -> Optional[BrowserProvider]:
  24. """Resolve the active browser provider (rules in the module docstring).
  25. Intentionally NO "single-eligible shortcut" (unlike ``agent.web_search_registry._resolve``): only
  26. ``_LEGACY_PREFERENCE`` names are auto-eligible. Firecrawl shares its API key with the *web* extract
  27. plugin, so a user with ``FIRECRAWL_API_KEY`` must never be routed to a paid cloud browser without
  28. setting ``browser.cloud_provider``; the same gate applies to third-party browser-provider plugins.
  29. """
  30. snapshot = _registry.merged()
  31. if configured == "local":
  32. return None
  33. if configured:
  34. provider = snapshot.get(configured)
  35. if provider is not None:
  36. return provider
  37. logger.debug(
  38. "browser cloud_provider '%s' configured but not registered; falling back to auto-detect",
  39. configured,
  40. )
  41. for legacy in _LEGACY_PREFERENCE:
  42. provider = snapshot.get(legacy)
  43. if provider is not None and is_available_safe(
  44. provider, logger,
  45. "Browser provider %s.is_available() raised %s — treating as unavailable",
  46. level=logging.WARNING, exc_info=True,
  47. ):
  48. return provider
  49. return None