"""Declarative configuration schema for memory provider plugins. Each provider *declares* its configurable surface in a ``config_schema.py`` next to its ``__init__.py`` (fields, kinds, secrets, select options); one generic renderer in the desktop UI and one generic ``GET/PUT /api/memory/providers/{name}/config`` endpoint pair drive the whole experience. Schema files are loaded by path, never via package import: plugin ``__init__.py`` files pull in the agent runtime, which must not load into the web server. A ``config_schema.py`` may only import from this module, and this module is pure data (nothing from the config/env layer). ``web_server`` owns the read/write logic, dispatching on ``ProviderConfigSchema.storage``. """ from __future__ import annotations import importlib.util import logging from dataclasses import dataclass, field as dataclass_field _log = logging.getLogger(__name__) # Field kinds understood by the generic renderer. KIND_TEXT = "text" KIND_SELECT = "select" KIND_SECRET = "secret" KIND_BOOL = "bool" KIND_NUMBER = "number" KIND_JSON = "json" # Storage backends understood by web_server (see its read/write dispatch). STORAGE_FLAT_JSON = "flat_json" STORAGE_HONCHO_HOST_BLOCK = "honcho_host_block" @dataclass(frozen=True) class ProviderFieldOption: """A single choice for a ``select`` field.""" value: str label: str description: str = "" @dataclass(frozen=True) class ProviderField: """One configurable field on a memory provider. Stored in exactly one place by ``kind``: non-secret kinds go to the provider's storage backend under ``key``; ``secret`` goes to the env store under ``env_key`` and is never read back over the API (only an ``is_set`` flag). ``aliases``/``env_fallbacks`` read legacy values from earlier CLI/env setup. ``inline`` marks the compact-panel subset; the rest appear only in the full-config modal, bucketed by ``group``. """ key: str label: str kind: str = KIND_TEXT default: str = "" description: str = "" placeholder: str = "" options: tuple[ProviderFieldOption, ...] = () env_key: str | None = None aliases: tuple[str, ...] = () env_fallbacks: tuple[str, ...] = () inline: bool = False group: str = "" # Longer help text surfaced as an info tooltip next to the field label. info: str = "" # Host-block placement: "host" (per-profile) or "root"; flat-json ignores it. scope: str = "host" @property def is_secret(self) -> bool: return self.kind == KIND_SECRET def allowed_values(self) -> set[str]: return {opt.value for opt in self.options} @dataclass(frozen=True) class ProviderConfigSchema: """A provider plugin's declared config surface.""" name: str label: str storage: str = STORAGE_FLAT_JSON # Optional link to the provider's config docs, shown in the full-config modal. docs_url: str = "" fields: tuple[ProviderField, ...] = dataclass_field(default_factory=tuple) def inline_fields(self) -> tuple[ProviderField, ...]: return tuple(f for f in self.fields if f.inline) _SCHEMA_CACHE: dict[str, ProviderConfigSchema] = {} def get_provider_config_schema(name: str) -> ProviderConfigSchema | None: """``CONFIG_SCHEMA`` declared by provider ``name``; None (no panel) without a ``config_schema.py``. The cache keys on the resolved schema file, not the name: user-installed plugins are per-profile, so one profile's lookup must never answer for another's. """ from plugins.memory import find_provider_dir provider_dir = find_provider_dir(name) path = provider_dir / "config_schema.py" if provider_dir else None if path is None or not path.is_file(): return None key = str(path) if key in _SCHEMA_CACHE: return _SCHEMA_CACHE[key] try: spec = importlib.util.spec_from_file_location(f"_hermes_memory_config_schema.{name}", path) module = importlib.util.module_from_spec(spec) spec.loader.exec_module(module) schema = getattr(module, "CONFIG_SCHEMA", None) except Exception: # Never cache a failed load: it would pin an empty panel until restart. _log.exception("failed to load config schema for memory provider %r", name) return None if schema is not None: _SCHEMA_CACHE[key] = schema return schema