Merge pull request #1915 from raman325/feat/hermes-provider-core

feat(integrations): Hermes memory provider core
This commit is contained in:
Igor Lins e Silva 2026-08-11 07:53:44 -03:00 committed by GitHub
commit 7eaa3bc3de
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 2591 additions and 1 deletions

View File

@ -21,7 +21,12 @@ from typing import Optional
from .backends import PalaceNotFoundError
from .collision_scan import assert_no_collisions
from .ids import ID_RECIPE, make_convo_drawer_id, make_convo_sentinel_id
from .ids import (
ID_RECIPE,
make_convo_drawer_id,
make_convo_sentinel_id,
make_exchange_drawer_id,
)
from .normalize import normalize_conversations
from .entities import entities_metadata
from .palace import (
@ -60,6 +65,82 @@ def _detect_hall_cached(content: str) -> str:
return max(scores, key=scores.get) if scores else "general"
def file_conversation_exchange(
collection,
*,
wing: str,
room: str,
text: str,
source_file: str,
agent: str,
authored_at: Optional[str] = None,
extra_metadata: Optional[dict] = None,
) -> Optional[str]:
"""File one verbatim conversation exchange as a single drawer.
Canonical write path for live agent integrations (e.g. Hermes) and
their backfills both must route here so routing, normalization,
and metadata conventions stay identical between live and historical
ingest. Builds the same metadata the convo miner writes so hallway
traversal, entity search, and since/before date filters see
integration drawers exactly like mined ones.
``wing`` and ``room`` are validated with the same ``sanitize_name``
rules the MCP write tools apply, but a failed name falls back
(``wing_general`` / ``conversations``) instead of erroring: this
path files *live* turns, and dropping a turn over a config typo
would break the verbatim / 100%-recall promise. The fallback is
logged at warning level so the misconfiguration is visible.
``extra_metadata`` lets callers append integration-specific fields
(e.g. ``source`` / ``session_id``); keys that collide with the
canonical fields are ignored, so it cannot be used to overwrite or
drop them. Returns the drawer id, or None when ``text`` is empty
after stripping.
"""
from .config import sanitize_name
text = (text or "").strip()
if not text:
return None
try:
wing = sanitize_name(wing, "wing")
except ValueError:
logger.warning(
"file_conversation_exchange: invalid wing %r — filing under wing_general", wing
)
wing = "wing_general"
try:
room = sanitize_name(room, "room")
except ValueError:
logger.warning(
"file_conversation_exchange: invalid room %r — filing under conversations", room
)
room = "conversations"
filed_at = datetime.now().isoformat()
drawer_id = make_exchange_drawer_id(wing, room, source_file, filed_at, text)
metadata = {
"wing": wing,
"room": room,
"hall": _detect_hall_cached(text),
"source_file": source_file,
"chunk_index": 0,
"added_by": agent,
"filed_at": filed_at,
"entities": entities_metadata(text),
"authored_at": authored_at if authored_at is not None else filed_at,
"ingest_mode": "convos",
"extract_mode": "exchange",
"normalize_version": NORMALIZE_VERSION,
"id_recipe": ID_RECIPE,
}
if extra_metadata:
for key, value in extra_metadata.items():
metadata.setdefault(key, value)
collection.upsert(ids=[drawer_id], documents=[text], metadatas=[metadata])
return drawer_id
# File types that might contain conversations
CONVO_EXTENSIONS = {
".txt",

View File

@ -108,6 +108,27 @@ def make_convo_sentinel_id(source_file: str, extract_mode: str) -> str:
return f"_reg_{_delimited_sha256((source_file, extract_mode), _HASH_TRUNC_DRAWER)}"
def make_exchange_drawer_id(
wing: str, room: str, source_file: str, filed_at: str, content: str
) -> str:
"""Drawer ID for a single verbatim conversation exchange.
Used by live agent integrations (e.g. Hermes) and their backfills via
``convo_miner.file_conversation_exchange``. Hashes the FULL content,
not a prefix prefix hashing collided on common openings ("User: hi
can you help me with") and ChromaDB's upsert silently overwrote the
earlier drawer. ``filed_at`` is included so genuinely repeated
exchanges stay distinct drawers (verbatim always repetition is
signal, not noise).
Hash input is ``f"{source_file}|{filed_at}|{content}"``.
"""
return (
f"drawer_{wing}_{room}_"
f"{_delimited_sha256((source_file, filed_at, content), _HASH_TRUNC_DRAWER)}"
)
def make_triple_id(
sub_id: str, predicate: str, obj_id: str, valid_from: str, recorded_at: str
) -> str:

View File

File diff suppressed because it is too large Load Diff

View File

@ -836,6 +836,79 @@ def test_register_file_sentinel_includes_source_mtime():
shutil.rmtree(tmpdir, ignore_errors=True)
# ---------------------------------------------------------------------------
# file_conversation_exchange — canonical single-exchange write path
# ---------------------------------------------------------------------------
class _RecordingCollection:
"""Captures upsert kwargs without a real ChromaDB behind it."""
def __init__(self):
self.upserts = []
def upsert(self, *, ids, documents, metadatas):
self.upserts.append({"ids": ids, "documents": documents, "metadatas": metadatas})
def _exchange_kwargs(**overrides):
kwargs = {
"wing": "wing_dev",
"room": "conversations",
"text": "User: hi\n\nAssistant: hello",
"source_file": "hermes-session:s1",
"agent": "hermes",
}
kwargs.update(overrides)
return kwargs
def test_file_conversation_exchange_extra_metadata_cannot_clobber_canonical():
"""The docstring promises extras are append-only — colliding keys lose.
PR #1915 review: ``metadata.update(extra_metadata)`` let a caller
silently overwrite ``wing`` / ``filed_at`` / etc.
"""
from mempalace.convo_miner import file_conversation_exchange
col = _RecordingCollection()
file_conversation_exchange(
col,
**_exchange_kwargs(),
extra_metadata={"wing": "wing_evil", "filed_at": "1970-01-01", "source": "hermes"},
)
meta = col.upserts[0]["metadatas"][0]
assert meta["wing"] == "wing_dev"
assert meta["filed_at"] != "1970-01-01"
# Non-colliding extras still land.
assert meta["source"] == "hermes"
def test_file_conversation_exchange_invalid_wing_falls_back_to_wing_general():
"""A bad configured wing must not drop the turn — verbatim first.
Same validation the MCP write tools apply (sanitize_name), but with a
wing_general fallback instead of an error: live filing losing turns
over a config typo would violate the 100%-recall promise.
"""
from mempalace.convo_miner import file_conversation_exchange
col = _RecordingCollection()
file_conversation_exchange(col, **_exchange_kwargs(wing="../escape"))
meta = col.upserts[0]["metadatas"][0]
assert meta["wing"] == "wing_general"
assert col.upserts[0]["documents"] == ["User: hi\n\nAssistant: hello"]
def test_file_conversation_exchange_invalid_room_falls_back_to_conversations():
from mempalace.convo_miner import file_conversation_exchange
col = _RecordingCollection()
file_conversation_exchange(col, **_exchange_kwargs(room="a/b"))
meta = col.upserts[0]["metadatas"][0]
assert meta["room"] == "conversations"
def _write_dry_run_transcript(path: Path) -> None:
path.write_text(
"> What is the plan?\n"

View File

@ -0,0 +1,934 @@
"""Tests for the MemPalace ↔ Hermes integration provider.
The provider ships inside the ``mempalace`` package (at
``mempalace/integrations/hermes/``) but at runtime Hermes loads it from a
copy in ``~/.hermes/plugins/`` via ``spec_from_file_location`` not as a
package import. These tests load it the same way: by file path.
They also stub ``agent.memory_provider`` to mirror the runtime contract the
plugin is only ever imported with Hermes on the import path.
"""
from __future__ import annotations
import importlib.util
import json
import os
import sys
import threading
import types
from pathlib import Path
import pytest
# ---------------------------------------------------------------------------
# Fixtures: stub the Hermes ABC, then import the provider module by path.
# ---------------------------------------------------------------------------
def _install_stub_memory_provider() -> None:
"""Install a minimal ``agent.memory_provider`` stub into sys.modules."""
if "agent.memory_provider" in sys.modules:
return
agent_mod = types.ModuleType("agent")
mp_mod = types.ModuleType("agent.memory_provider")
class MemoryProvider: # mirrors the parts the integration class uses
pass
mp_mod.MemoryProvider = MemoryProvider # type: ignore[attr-defined]
agent_mod.memory_provider = mp_mod # type: ignore[attr-defined]
sys.modules["agent"] = agent_mod
sys.modules["agent.memory_provider"] = mp_mod
@pytest.fixture(scope="module")
def integration_module():
_install_stub_memory_provider()
path = (
Path(__file__).resolve().parent.parent
/ "mempalace"
/ "integrations"
/ "hermes"
/ "__init__.py"
)
spec = importlib.util.spec_from_file_location("hermes_integration", path)
assert spec is not None and spec.loader is not None
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
return module
@pytest.fixture
def provider(integration_module):
return integration_module.MempalaceProvider()
@pytest.fixture(autouse=True)
def _isolate_palace_env(integration_module):
"""Keep initialize()'s palace-env bridge from leaking between tests.
``initialize`` publishes the resolved palace to MEMPALACE_PALACE_PATH
(so mcp_server passthrough tools resolve the same palace) and records
ownership in the module-level ``_ENV_PALACE_BRIDGED`` sentinel. Both
are process-global restore them after every test.
"""
original = os.environ.get("MEMPALACE_PALACE_PATH")
original_sentinel = integration_module._ENV_PALACE_BRIDGED
yield
integration_module._ENV_PALACE_BRIDGED = original_sentinel
if original is None:
os.environ.pop("MEMPALACE_PALACE_PATH", None)
else:
os.environ["MEMPALACE_PALACE_PATH"] = original
# ---------------------------------------------------------------------------
# Shape: name, schemas, config, availability
# ---------------------------------------------------------------------------
def test_name_matches_plugin_yaml(provider):
assert provider.name == "mempalace"
def test_is_available_imports_mempalace(provider):
# The repo's own dev install satisfies this. Failure means a broken venv.
assert provider.is_available() is True
def test_tool_schemas_visible_before_initialize(provider):
# Regression for the discovery bug: Hermes'
# ``agent.memory_manager._register_provider`` snapshots
# ``get_tool_schemas()`` once at registration time to build its
# ``tool_name → provider`` routing table. If we returned ``[]`` there,
# the dispatcher would never learn our tool names and every later call
# would hit ``"Unknown tool: <name>"`` from the dispatcher without
# reaching ``handle_tool_call`` at all. Backend readiness gating
# belongs in ``handle_tool_call``, not here.
schemas = provider.get_tool_schemas()
assert len(schemas) == 27 # openclaw set + 8 tools added after #491
names = {s["name"] for s in schemas}
assert "mempalace_status" in names
assert "mempalace_search" in names
assert "mempalace_add_drawer" in names
assert "mempalace_update_drawer" in names # added after openclaw #491
assert "mempalace_kg_invalidate" in names
def test_config_schema_has_documented_keys(provider):
keys = {field["key"] for field in provider.get_config_schema()}
assert keys == {
"palace_path",
"identity_path",
"wing",
"n_prefetch",
}
# ``collection_name`` is intentionally absent — exposing it would let the
# provider write to a collection that ``search_memories`` doesn't read.
assert "collection_name" not in keys
def test_tool_schemas_module_constant_matches_expected_surface(integration_module):
# 27 tools — openclaw's reference skill set (19 tools at
# MemPalace/mempalace#491, April 2026) plus the 8 agent-facing tools
# mempalace has added since that openclaw hasn't caught up to.
# Admin/internal tools (sync, hook_settings, reconnect) intentionally
# omitted.
schemas = integration_module.TOOL_SCHEMAS
names = {s["name"] for s in schemas}
assert names == {
# Search + structure
"mempalace_search",
"mempalace_status",
"mempalace_list_wings",
"mempalace_list_rooms",
"mempalace_get_taxonomy",
"mempalace_get_aaak_spec",
# Drawer CRUD
"mempalace_add_drawer",
"mempalace_update_drawer",
"mempalace_delete_drawer",
"mempalace_list_drawers",
"mempalace_get_drawer",
"mempalace_check_duplicate",
# Knowledge graph
"mempalace_kg_query",
"mempalace_kg_add",
"mempalace_kg_invalidate",
"mempalace_kg_timeline",
"mempalace_kg_stats",
# Per-agent diary
"mempalace_diary_write",
"mempalace_diary_read",
# Room-graph navigation + tunnel management
"mempalace_traverse",
"mempalace_graph_stats",
"mempalace_find_tunnels",
"mempalace_create_tunnel",
"mempalace_list_tunnels",
"mempalace_delete_tunnel",
"mempalace_follow_tunnels",
# Session-level
"mempalace_memories_filed_away",
}
# ---------------------------------------------------------------------------
# Cron-context guard: provider must short-circuit on system-generated turns.
# ---------------------------------------------------------------------------
@pytest.mark.parametrize(
"kwargs",
[
{"agent_context": "cron"},
{"agent_context": "flush"},
{"platform": "cron"},
],
)
def test_initialize_skips_under_cron_context(provider, kwargs, tmp_path):
# Even with a writable hermes_home, cron/flush context must not start the
# worker or open a collection.
provider.initialize("session-1", hermes_home=str(tmp_path), **kwargs)
assert provider._cron_skipped is True
assert provider._initialized is False
assert provider.get_tool_schemas() == []
assert provider.system_prompt_block() == ""
assert provider.prefetch("anything") == ""
# Calls that would otherwise enqueue work must be no-ops.
provider.sync_turn("hi", "hello")
provider.on_session_end([])
assert provider._worker_thread is None
def test_handle_tool_call_under_cron_returns_error_json(provider, tmp_path):
provider.initialize("session-1", hermes_home=str(tmp_path), agent_context="cron")
result = json.loads(provider.handle_tool_call("mempalace_search", {"query": "x"}))
assert "error" in result
def test_handle_tool_call_without_initialize_returns_error_json(provider):
result = json.loads(provider.handle_tool_call("mempalace_status", {}))
assert "error" in result
def test_on_session_end_no_op_when_not_initialized(provider):
# Without ``_initialized``, the worker thread isn't running. Enqueueing
# here would silently fill the bounded queue with tasks that never drain.
provider._initialized = False
provider._cron_skipped = False
pre = provider._worker_queue.qsize()
provider.on_session_end([{"role": "user", "content": "hi"}])
assert provider._worker_queue.qsize() == pre
def test_on_memory_write_no_op_when_not_initialized(provider):
provider._initialized = False
provider._cron_skipped = False
pre = provider._worker_queue.qsize()
provider.on_memory_write("add", "user", "some fact")
assert provider._worker_queue.qsize() == pre
def test_normalize_content_flattens_anthropic_list(integration_module):
fn = integration_module._normalize_content
blocks = [
{"type": "text", "text": "what's the auth flow?"},
{"type": "tool_use", "name": "grep", "input": {"q": "JWT"}},
{"type": "text", "text": "(short clarifier)"},
]
out = fn(blocks)
assert "what's the auth flow?" in out
assert "[tool_use: grep]" in out
assert "(short clarifier)" in out
# Must not be the literal Python repr.
assert "{'type'" not in out
def test_match_wing_by_keywords_word_boundary(integration_module):
fn = integration_module._match_wing_by_keywords
wing_config = {
"wing_ai": {"keywords": ["ai"]},
"wing_dev": {"keywords": ["python"]},
}
# Substring matching would have routed "said" / "rain" / "available" to wing_ai.
assert fn("She said rain is available", wing_config) == "wing_general"
assert fn("write some ai bindings", wing_config) == "wing_ai"
assert fn("python script for scraping", wing_config) == "wing_dev"
# ---------------------------------------------------------------------------
# Session switch / turn counter bookkeeping.
# ---------------------------------------------------------------------------
def test_on_session_switch_repoints_session_id(provider):
provider._session_id = "old"
provider._turn_count = 7
provider.on_session_switch("new", reset=False)
assert provider._session_id == "new"
assert provider._turn_count == 7 # /resume / /branch keep counters
def test_on_session_switch_with_reset_clears_turn_counter(provider):
provider._turn_count = 9
provider.on_session_switch("new", reset=True)
assert provider._turn_count == 0
def test_on_turn_start_tracks_turn_number(provider):
provider.on_turn_start(turn_number=4, message="hi")
assert provider._turn_count == 4
# ---------------------------------------------------------------------------
# on_session_end / on_pre_compress: sync_turn is the sole filing path — these
# hooks must neither enqueue filing work nor promise persistence. Re-filing
# the raw message list mints duplicate drawers (filed_at is hashed into the
# drawer id, so upserts cannot collapse the copies).
# ---------------------------------------------------------------------------
def test_on_pre_compress_returns_no_hint_and_files_nothing(provider):
provider._cron_skipped = False
provider._initialized = True
pre = provider._worker_queue.qsize()
assert provider.on_pre_compress([{"role": "user", "content": "hi"}]) == ""
assert provider._worker_queue.qsize() == pre
def test_on_session_end_files_nothing_when_initialized(provider):
provider._cron_skipped = False
provider._initialized = True
pre = provider._worker_queue.qsize()
provider.on_session_end([{"role": "user", "content": "hi"}])
assert provider._worker_queue.qsize() == pre
def test_on_pre_compress_under_cron_returns_empty_string(provider, tmp_path):
provider.initialize("session-1", hermes_home=str(tmp_path), agent_context="cron")
assert provider.on_pre_compress([{"role": "user", "content": "hi"}]) == ""
# ---------------------------------------------------------------------------
# Wing classification: keyword-based, fall back to wing_general.
# ---------------------------------------------------------------------------
def test_classify_wing_falls_back_to_general_with_no_config(provider):
provider._wing_config = {}
assert provider._classify_wing("anything") == "wing_general"
def test_classify_wing_matches_keyword(provider):
provider._wing_config = {
"wing_dev": {"keywords": ["python", "pytest"]},
"wing_ops": {"keywords": ["deploy", "kubernetes"]},
}
assert provider._classify_wing("Running pytest -q") == "wing_dev"
assert provider._classify_wing("kubectl deploy rollout") == "wing_ops"
assert provider._classify_wing("just chatting") == "wing_general"
# ---------------------------------------------------------------------------
# Shutdown is safe even when initialize() never ran.
# ---------------------------------------------------------------------------
def test_shutdown_is_safe_without_initialize(provider):
provider.shutdown() # must not raise
def test_shutdown_drains_running_worker(provider):
# Spin a fake worker that respects _worker_stop.
def _loop():
while not provider._worker_stop.is_set():
provider._worker_stop.wait(0.05)
provider._worker_thread = threading.Thread(target=_loop, daemon=True)
provider._worker_thread.start()
provider.shutdown()
assert not provider._worker_thread.is_alive()
# ---------------------------------------------------------------------------
# End-to-end integration: real palace via mempalace's own fixtures.
#
# These exercise the ChromaBackend code path that fixes the dim-mismatch bug
# from prior in-tree Hermes PRs, and run the tool handlers against the
# `seeded_collection` / `seeded_kg` fixtures from `tests/conftest.py`.
# ---------------------------------------------------------------------------
@pytest.fixture
def initialized_provider(provider, palace_path, tmp_dir):
"""Provider initialized against a fresh temp palace."""
config_path = Path(tmp_dir) / "mempalace.json"
config_path.write_text(json.dumps({"palace_path": palace_path}))
provider.initialize("test-session-1", hermes_home=str(tmp_dir), platform="cli")
yield provider
provider.shutdown()
def test_initialize_opens_chroma_via_backend(initialized_provider):
"""The dim-mismatch fix: collection access goes through ChromaBackend."""
from mempalace.backends.chroma import ChromaBackend
assert initialized_provider._initialized is True
assert initialized_provider._collection is not None
assert isinstance(initialized_provider._backend, ChromaBackend)
def test_get_tool_schemas_returns_full_surface_after_initialize(initialized_provider):
schemas = initialized_provider.get_tool_schemas()
names = {s["name"] for s in schemas}
assert len(schemas) == 27
assert "mempalace_search" in names
assert "mempalace_kg_query" in names
assert "mempalace_add_drawer" in names
assert "mempalace_update_drawer" in names
assert "mempalace_memories_filed_away" in names
def test_sync_turn_persists_through_worker(initialized_provider):
initialized_provider.sync_turn("what's the plan?", "ship the PR")
initialized_provider._worker_queue.join() # block until worker drains the task
col = initialized_provider._collection
assert col.count() >= 1
metas = col.get(include=["metadatas"]).get("metadatas") or []
assert any(m.get("source") == "hermes" for m in metas)
def test_sync_turn_writes_canonical_drawer_metadata(initialized_provider):
"""Live turns must carry the same metadata the convo miner writes.
Without hall / entities / filed_at, Hermes drawers are silently
invisible to hallway traversal, entity search, and the since/before
date filters nothing errors, recall just degrades.
"""
initialized_provider.sync_turn("meeting with Sarah about the Q3 roadmap", "noted")
initialized_provider._worker_queue.join()
metas = initialized_provider._collection.get(include=["metadatas"]).get("metadatas") or []
hermes_metas = [m for m in metas if m.get("source") == "hermes"]
assert hermes_metas
meta = hermes_metas[0]
for key in (
"wing",
"room",
"hall",
"source_file",
"added_by",
"filed_at",
"authored_at",
"ingest_mode",
"extract_mode",
"normalize_version",
"id_recipe",
):
assert key in meta, f"missing canonical metadata key: {key!r}"
assert meta["room"] == "conversations"
assert meta["ingest_mode"] == "convos"
assert meta["extract_mode"] == "exchange"
def test_sync_turn_routes_to_configured_wing(initialized_provider):
initialized_provider._wing_config = {"wing_dev": {"keywords": ["pytest"]}}
initialized_provider.sync_turn("running pytest -q", "all passed")
initialized_provider._worker_queue.join()
metas = initialized_provider._collection.get(include=["metadatas"]).get("metadatas") or []
assert any(m.get("wing") == "wing_dev" for m in metas)
def test_sync_turn_skips_when_both_sides_empty(initialized_provider):
pre = initialized_provider._collection.count()
initialized_provider.sync_turn("", "")
# Queue should not have received an item; nothing to join, but worker has
# nothing to do either. Give it a moment then re-check.
initialized_provider._worker_queue.join()
assert initialized_provider._collection.count() == pre
# ----- Tool handlers against seeded data ----------------------------------
@pytest.fixture
def provider_on_seeded_palace(seeded_collection, provider, palace_path, tmp_dir):
"""Provider pointed at the same palace_path that ``seeded_collection`` filled.
``seeded_collection`` writes 4 drawers via raw ``chromadb.PersistentClient``;
we then have the provider open the same path via ``ChromaBackend`` the
fact that this round-trips at all is the dim-mismatch regression check.
"""
(Path(tmp_dir) / "mempalace.json").write_text(json.dumps({"palace_path": palace_path}))
provider.initialize("s1", hermes_home=str(tmp_dir))
yield provider
provider.shutdown()
def test_status_tool_counts_seeded_drawers(provider_on_seeded_palace):
result = json.loads(provider_on_seeded_palace.handle_tool_call("mempalace_status", {}))
assert result["total_drawers"] == 4
assert result["wings"]["project"] == 3
assert result["wings"]["notes"] == 1
def test_list_wings_tool_returns_seeded_wings(provider_on_seeded_palace):
result = json.loads(provider_on_seeded_palace.handle_tool_call("mempalace_list_wings", {}))
assert result["wings"] == {"project": 3, "notes": 1}
def test_list_rooms_tool_filters_by_wing(provider_on_seeded_palace):
result = json.loads(
provider_on_seeded_palace.handle_tool_call(
"mempalace_list_rooms",
{"wing": "project"},
)
)
assert result["wing"] == "project"
assert result["rooms"]["backend"] == 2
assert result["rooms"]["frontend"] == 1
def test_list_rooms_tool_rejects_missing_wing(provider_on_seeded_palace):
result = json.loads(
provider_on_seeded_palace.handle_tool_call(
"mempalace_list_rooms",
{},
)
)
assert "error" in result
def test_status_tool_omits_truncated_under_cap(provider_on_seeded_palace):
# 4 seeded drawers, cap is 5000 — the response must not advertise
# itself as a partial view when in fact it's complete.
result = json.loads(provider_on_seeded_palace.handle_tool_call("mempalace_status", {}))
assert "truncated" not in result
assert "scanned" not in result
def test_status_tool_marks_truncated_with_structured_fields(provider_on_seeded_palace):
# Force the cap below the seeded count so we exercise the truncation path.
# The model needs ``truncated`` (bool) + ``scanned`` (int) so it can
# compute coverage = scanned / total_drawers itself rather than parsing
# a sentence.
provider_on_seeded_palace.STATUS_SCAN_LIMIT = 2
result = json.loads(provider_on_seeded_palace.handle_tool_call("mempalace_status", {}))
assert result["truncated"] is True
assert result["scanned"] == 2
assert result["total_drawers"] == 4
def test_list_wings_tool_marks_truncated_with_palace_total(provider_on_seeded_palace):
# ``_tool_list_wings`` has no unconditional ``total_drawers`` field —
# when truncated it must surface ``total_drawers`` so callers can
# compute coverage without a second ``mempalace_status`` call.
provider_on_seeded_palace.STATUS_SCAN_LIMIT = 2
result = json.loads(provider_on_seeded_palace.handle_tool_call("mempalace_list_wings", {}))
assert result["truncated"] is True
assert result["scanned"] == 2
assert result["total_drawers"] == 4
def test_list_rooms_tool_marks_truncated_without_wing_total(provider_on_seeded_palace):
# Rooms can't cheaply give an exact wing total (no ``where=`` on
# ``count()`` in the pinned chroma version). The structured fields are
# still present; the absent ``total_drawers`` is intentional and
# documented in the code.
provider_on_seeded_palace.STATUS_SCAN_LIMIT = 1
result = json.loads(
provider_on_seeded_palace.handle_tool_call(
"mempalace_list_rooms",
{"wing": "project"},
)
)
assert result["truncated"] is True
assert result["scanned"] == 1
assert "total_drawers" not in result
# ----- Knowledge-graph tool handlers --------------------------------------
def test_kg_add_persists_to_palace_sibling_sqlite(initialized_provider, palace_path):
"""The provider writes to ``<palace_path>/../knowledge_graph.sqlite3``."""
from mempalace.knowledge_graph import KnowledgeGraph
result = json.loads(
initialized_provider.handle_tool_call(
"mempalace_kg_add",
{"subject": "user", "predicate": "likes", "object": "coffee"},
)
)
assert result["status"] == "ok"
db_path = str(Path(palace_path).parent / "knowledge_graph.sqlite3")
independent_kg = KnowledgeGraph(db_path=db_path)
try:
relations = independent_kg.query_entity("user")
finally:
independent_kg.close()
assert any(
(r.get("predicate") == "likes" and r.get("object") == "coffee") for r in (relations or [])
)
def test_kg_query_tool_rejects_missing_entity(initialized_provider):
result = json.loads(
initialized_provider.handle_tool_call(
"mempalace_kg_query",
{},
)
)
assert "error" in result
# ----- Diary roundtrip ----------------------------------------------------
def test_diary_write_read_roundtrip(initialized_provider):
write = json.loads(
initialized_provider.handle_tool_call(
"mempalace_diary_write",
{"entry": "Today I deepened test coverage."},
)
)
assert write["status"] == "ok"
read = json.loads(
initialized_provider.handle_tool_call(
"mempalace_diary_read",
{"n": 5},
)
)
assert read["entries"]
assert read["entries"][-1]["entry"] == "Today I deepened test coverage."
def test_diary_read_empty_when_no_writes(initialized_provider):
result = json.loads(initialized_provider.handle_tool_call("mempalace_diary_read", {}))
assert result["entries"] == []
# ----- Config-load path ---------------------------------------------------
def test_initialize_reads_mempalace_json(provider, tmp_dir, palace_path):
(Path(tmp_dir) / "mempalace.json").write_text(
json.dumps(
{
"palace_path": palace_path,
"n_prefetch": 7,
"wing": "wing_from_config",
}
)
)
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._config["n_prefetch"] == 7
assert provider._config["wing"] == "wing_from_config"
finally:
provider.shutdown()
def test_collection_name_is_not_hermes_configurable(provider, tmp_dir, palace_path):
# A hermes-side ``collection_name`` would be a second way to set the
# name — the write and read sides could silently diverge, making the
# provider look mute. The key is ignored; with no mempalace-side
# override (conftest redirects HOME to a temp dir), the default applies.
(Path(tmp_dir) / "mempalace.json").write_text(
json.dumps({"palace_path": palace_path, "collection_name": "custom_drawers"})
)
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._collection_name == provider.DEFAULT_COLLECTION_NAME
finally:
provider.shutdown()
def test_collection_name_follows_mempalace_config(
integration_module, provider, tmp_dir, palace_path, tmp_path, monkeypatch
):
# One source of truth: the provider writes to the collection that
# ``search_memories`` and the mcp_server passthrough actually read —
# mempalace's own config — so a customized ``collection_name`` in
# ``~/.mempalace/config.json`` cannot make live turns invisible to
# recall.
mp_config_dir = tmp_path / "mp_home"
mp_config_dir.mkdir()
(mp_config_dir / "config.json").write_text(json.dumps({"collection_name": "family_drawers"}))
from mempalace.config import MempalaceConfig as real_config
def _patched_config(config_dir=None):
return real_config(config_dir=str(mp_config_dir))
# Patch the provider module's own reference — it imported the name at
# module load, so patching mempalace.config wouldn't reach it.
monkeypatch.setattr(integration_module, "MempalaceConfig", _patched_config)
(Path(tmp_dir) / "mempalace.json").write_text(json.dumps({"palace_path": palace_path}))
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._collection_name == "family_drawers"
finally:
provider.shutdown()
def test_env_vars_override_config_file(provider, tmp_dir, palace_path, monkeypatch):
monkeypatch.setenv("MEMPALACE_PALACE_PATH", palace_path)
monkeypatch.setenv("MEMPALACE_WING", "wing_forced")
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._palace_path == palace_path
assert provider._config["wing"] == "wing_forced"
finally:
provider.shutdown()
# ---------------------------------------------------------------------------
# PR #1915 review fixes: scan truncation boundary, None metadata, bad keywords.
# ---------------------------------------------------------------------------
class _FakeScanCollection:
"""Serves ``n`` rows through the same get(limit=...) shape chroma uses."""
def __init__(self, n, metadatas=None):
self._n = n
self._metadatas = metadatas
def count(self):
return self._n
def get(self, **kwargs):
if self._metadatas is not None:
return {"metadatas": list(self._metadatas)}
limit = kwargs.get("limit") or self._n
return {"metadatas": [{"wing": "wing_a", "room": "r"} for _ in range(min(self._n, limit))]}
def test_scan_metadatas_not_truncated_at_exactly_cap(provider):
cap = provider.STATUS_SCAN_LIMIT
metas, truncated = provider._scan_metadatas(_FakeScanCollection(cap))
assert len(metas) == cap
# Exactly cap rows means the view is complete — flagging it truncated
# makes the model qualify a breakdown that is in fact 100% coverage.
assert truncated is False
def test_scan_metadatas_truncated_above_cap(provider):
cap = provider.STATUS_SCAN_LIMIT
metas, truncated = provider._scan_metadatas(_FakeScanCollection(cap + 1))
assert truncated is True
# Callers still get at most cap rows — the +1 probe row is trimmed.
assert len(metas) == cap
def test_status_and_list_tools_tolerate_none_metadata_entries(provider):
# Legacy palaces / raw writers can leave None metadata entries; the
# breakdown loops must count them as "unknown", not fail the tool call.
rows = [None, {"wing": "wing_a", "room": "room_a"}]
provider._collection = _FakeScanCollection(2, metadatas=rows)
status = provider._tool_status()
assert "error" not in status
assert status["wings"] == {"unknown": 1, "wing_a": 1}
wings = provider._tool_list_wings()
assert "error" not in wings
assert wings["wings"] == {"unknown": 1, "wing_a": 1}
rooms = provider._tool_list_rooms("wing_a")
assert "error" not in rooms
assert rooms["rooms"] == {"unknown": 1, "room_a": 1}
def test_match_wing_by_keywords_ignores_non_string_keywords(integration_module):
# A hand-edited wing_config.json with a number/null in a keyword list
# must not break wing routing — a raised AttributeError inside
# _file_turn's try/except silently drops every live turn.
fn = integration_module._match_wing_by_keywords
wing_config = {"wing_dev": {"keywords": [None, 3, "python"]}}
assert fn("write some python code", wing_config) == "wing_dev"
assert fn("unrelated chatter", wing_config) == "wing_general"
# ---------------------------------------------------------------------------
# Palace unification: the mcp_server passthrough tools must operate on the
# SAME palace the provider writes and searches. The provider bridges its
# resolved palace into MEMPALACE_PALACE_PATH (mcp_server re-reads that var on
# every config access — its own --palace flag works the same way), and the
# KG tools are handled natively because mcp_server's KG path ignores the env
# var unless its CLI flag was given.
# ---------------------------------------------------------------------------
def test_initialize_bridges_palace_env_for_passthrough(provider, tmp_dir, palace_path):
from mempalace.config import MempalaceConfig
(Path(tmp_dir) / "mempalace.json").write_text(json.dumps({"palace_path": palace_path}))
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
expected = os.path.abspath(os.path.expanduser(palace_path))
assert os.environ.get("MEMPALACE_PALACE_PATH") == expected
# The passthrough side (mcp_server's config) now resolves the same
# palace the provider writes — the split-brain regression check.
assert MempalaceConfig().palace_path == expected
finally:
provider.shutdown()
def test_reinitialize_follows_updated_hermes_config(provider, tmp_dir, palace_path, tmp_path):
# The bridge write from session 1 must not masquerade as a user env
# override in session 2 — a stale bridge would pin the palace to the
# old hermes-side value forever.
config_path = Path(tmp_dir) / "mempalace.json"
config_path.write_text(json.dumps({"palace_path": palace_path}))
provider.initialize("s1", hermes_home=str(tmp_dir))
provider.shutdown()
new_palace = str(tmp_path / "palace_b")
config_path.write_text(json.dumps({"palace_path": new_palace}))
provider.initialize("s2", hermes_home=str(tmp_dir))
try:
assert provider._palace_path == new_palace
assert os.environ.get("MEMPALACE_PALACE_PATH") == os.path.abspath(new_palace)
finally:
provider.shutdown()
def test_user_set_palace_env_wins_and_is_never_cleared(
provider, tmp_dir, palace_path, tmp_path, monkeypatch
):
# A user-set env var outranks the hermes-side config (documented
# precedence) and the bridge must not claim ownership of it — a later
# re-initialize must leave the user's value in place.
monkeypatch.setenv("MEMPALACE_PALACE_PATH", palace_path)
(Path(tmp_dir) / "mempalace.json").write_text(
json.dumps({"palace_path": str(tmp_path / "other_palace")})
)
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._palace_path == palace_path
assert os.environ.get("MEMPALACE_PALACE_PATH") == palace_path
# Ownership was not claimed: the sentinel stays unset.
assert provider.__class__.__module__ is not None # provider alive
finally:
provider.shutdown()
provider.initialize("s2", hermes_home=str(tmp_dir))
try:
assert os.environ.get("MEMPALACE_PALACE_PATH") == palace_path
finally:
provider.shutdown()
def test_hermes_config_defers_to_mempalace_config_when_unset(
integration_module, provider, tmp_dir, tmp_path, monkeypatch
):
# No hermes-side palace_path → the provider follows mempalace's own
# config rather than hardcoding the default location.
mp_config_dir = tmp_path / "mp_home"
mp_config_dir.mkdir()
custom_palace = str(tmp_path / "custom_palace")
(mp_config_dir / "config.json").write_text(json.dumps({"palace_path": custom_palace}))
from mempalace.config import MempalaceConfig as real_config
def _patched_config(config_dir=None):
return real_config(config_dir=str(mp_config_dir))
# Patch the provider module's own reference — it imported the name at
# module load, so patching mempalace.config wouldn't reach it.
monkeypatch.setattr(integration_module, "MempalaceConfig", _patched_config)
(Path(tmp_dir) / "mempalace.json").write_text(json.dumps({}))
provider.initialize("s1", hermes_home=str(tmp_dir))
try:
assert provider._palace_path == custom_palace
finally:
provider.shutdown()
def test_kg_tools_all_use_provider_sibling_kg(initialized_provider, palace_path):
# All five KG tools must hit the SAME database: the sibling of the
# provider's palace dir — never mcp_server's global DEFAULT_KG_PATH.
add = json.loads(
initialized_provider.handle_tool_call(
"mempalace_kg_add",
{"subject": "user", "predicate": "drinks", "object": "tea"},
)
)
assert add["status"] == "ok"
timeline = json.loads(
initialized_provider.handle_tool_call("mempalace_kg_timeline", {"entity": "user"})
)
assert timeline["count"] >= 1
assert any(t["predicate"] == "drinks" and t["object"] == "tea" for t in timeline["timeline"])
stats = json.loads(initialized_provider.handle_tool_call("mempalace_kg_stats", {}))
assert stats["triples"] >= 1
inv = json.loads(
initialized_provider.handle_tool_call(
"mempalace_kg_invalidate",
{"subject": "user", "predicate": "drinks", "object": "tea"},
)
)
assert inv["success"] is True
# And the file itself lives next to the palace dir.
assert (Path(palace_path).parent / "knowledge_graph.sqlite3").exists()
def test_kg_invalidate_rejects_invalid_input(initialized_provider):
result = json.loads(
initialized_provider.handle_tool_call(
"mempalace_kg_invalidate",
{"subject": "user", "predicate": "likes", "object": "x", "ended": "not-a-date"},
)
)
assert result["success"] is False
assert "error" in result
# ---------------------------------------------------------------------------
# on_memory_write: Hermes' memory tool defaults to target="memory" (the
# agent's own notes); only target="user" carries facts about the user. Both
# must mirror into the knowledge graph, under distinct subjects.
# ---------------------------------------------------------------------------
def test_on_memory_write_mirrors_both_targets(initialized_provider, palace_path):
from mempalace.knowledge_graph import KnowledgeGraph
initialized_provider.on_memory_write("add", "user", "lives in Boston")
initialized_provider.on_memory_write("add", "memory", "repo uses uv for deps")
initialized_provider._worker_queue.join()
kg = KnowledgeGraph(db_path=str(Path(palace_path).parent / "knowledge_graph.sqlite3"))
try:
user_relations = kg.query_entity("user")
agent_relations = kg.query_entity("hermes")
finally:
kg.close()
assert any(
r.get("predicate") == "asserted" and r.get("object") == "lives in Boston"
for r in user_relations
)
assert any(
r.get("predicate") == "noted" and r.get("object") == "repo uses uv for deps"
for r in agent_relations
)
def test_on_memory_write_skips_unknown_target_and_non_add(initialized_provider):
pre = initialized_provider._worker_queue.qsize()
initialized_provider.on_memory_write("add", "bogus", "x")
initialized_provider.on_memory_write("replace", "memory", "x")
initialized_provider.on_memory_write("remove", "user", "x")
assert initialized_provider._worker_queue.qsize() == pre