d63e380324
Every PLUGIN-COMPAT __getattr__ now calls hermes_cli.plugin_compat.warn_once(facade, name, target) before
resolving, emitting a HermesPluginCompatWarning (FutureWarning) once per process per name: old path, new
path, removal target. Importing a facade for its live API stays silent; only resolving a moved name warns.
COMPAT_MANIFEST.md documents the warning and how to silence it during migration.
Verified the runtime never routes through a pointer: every entry point (run_agent, cli, hermes_cli.main,
gateway.run, tui_gateway.server, web_server, model_tools + tool discovery, hermes_state, cron.scheduler,
browser_tool, mcp_tool, kanban, auth) imports clean and `hermes doctor` runs end to end with the warning
promoted to an error.
Also restores the check_compat_pointers CI step to .github/workflows/lint.yml, which a0be177aac dropped
when the compat layer was regenerated (the lint script itself was present; the workflow step was not).
hermes_cli/plugin_compat.py, tests/test_plugin_compat_warning.py and the two-line insert per facade are
part of the compat layer and go away with it.
87 lines
3.6 KiB
Python
87 lines
3.6 KiB
Python
"""Browser provider registry: cloud browser backends registered by plugins via
|
|
:meth:`PluginContext.register_browser_provider`, consumed by ``tools.browser_tool_cloud._get_cloud_provider``.
|
|
|
|
Active-provider precedence (see :func:`_resolve`): ``browser.cloud_provider`` in config.yaml wins
|
|
regardless of ``is_available()`` (so the dispatcher surfaces a typed "X_API_KEY is not set" error
|
|
instead of silently switching); else the legacy auto-detect walk ``browser-use`` → ``browserbase``
|
|
filtered by availability; else ``None`` (local browser mode). There is no capability split here —
|
|
every provider implements the full :class:`agent.browser_provider.BrowserProvider` lifecycle.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
from typing import Optional
|
|
|
|
from agent.browser_provider import BrowserProvider
|
|
from agent.provider_registry import ProviderRegistry, is_available_safe
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
_registry: ProviderRegistry[BrowserProvider] = ProviderRegistry(
|
|
label="Browser", provider_cls=BrowserProvider, logger=logger,
|
|
)
|
|
_registry.export(globals())
|
|
|
|
|
|
# Auto-detect order when ``browser.cloud_provider`` is unset (historic order: Browser Use first because
|
|
# it covers both the managed Nous gateway and the direct API key path; Browserbase as the older
|
|
# direct-credentials fallback). Firecrawl is deliberately absent — see :func:`_resolve`.
|
|
_LEGACY_PREFERENCE = ("browser-use", "browserbase")
|
|
|
|
|
|
def _resolve(configured: Optional[str]) -> Optional[BrowserProvider]:
|
|
"""Resolve the active browser provider (rules in the module docstring).
|
|
|
|
Intentionally NO "single-eligible shortcut" (unlike ``agent.web_search_registry._resolve``): only
|
|
``_LEGACY_PREFERENCE`` names are auto-eligible. Firecrawl shares its API key with the *web* extract
|
|
plugin, so a user with ``FIRECRAWL_API_KEY`` must never be routed to a paid cloud browser without
|
|
setting ``browser.cloud_provider``; the same gate applies to third-party browser-provider plugins.
|
|
"""
|
|
snapshot = _registry.merged()
|
|
if configured == "local":
|
|
return None
|
|
if configured:
|
|
provider = snapshot.get(configured)
|
|
if provider is not None:
|
|
return provider
|
|
logger.debug(
|
|
"browser cloud_provider '%s' configured but not registered; falling back to auto-detect",
|
|
configured,
|
|
)
|
|
for legacy in _LEGACY_PREFERENCE:
|
|
provider = snapshot.get(legacy)
|
|
if provider is not None and is_available_safe(
|
|
provider, logger,
|
|
"Browser provider %s.is_available() raised %s — treating as unavailable",
|
|
level=logging.WARNING, exc_info=True,
|
|
):
|
|
return provider
|
|
return None
|
|
|
|
|
|
# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
|
|
# Names external plugins imported from this module before the Sep 2026 decomposition.
|
|
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
|
|
# The whole block is removed by reverting the commit that added it.
|
|
from typing import Dict # noqa: F401,E402
|
|
from typing import List # noqa: F401,E402
|
|
import threading # noqa: F401,E402
|
|
|
|
|
|
_PLUGIN_COMPAT_LAZY = {
|
|
'hermes_home_key': ('hermes_constants', 'hermes_home_key'),
|
|
}
|
|
|
|
|
|
def __getattr__(name): # PEP 562 — lazy so no import cycles
|
|
target = _PLUGIN_COMPAT_LAZY.get(name)
|
|
if target is None:
|
|
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
import importlib
|
|
from hermes_cli.plugin_compat import warn_once
|
|
warn_once(__name__, name, *target)
|
|
return getattr(importlib.import_module(target[0]), target[1])
|
|
# ---- END PLUGIN-COMPAT ----
|