mirror of
https://github.com/headroomlabs-ai/headroom.git
synced 2026-08-27 14:17:10 -04:00
## Description `DirectMem0Adapter.close()` now deterministically drains or cancels background writes and releases every initialized client/driver. Fixes #2897 ## Type of Change - [x] Bug fix (non-breaking change that fixes an issue) - [ ] New feature (non-breaking change that adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to change) - [ ] Documentation update - [ ] Performance improvement - [ ] Code refactoring (no functional changes) ## Changes Made - Initialize the OpenAI client field to `None` so cleanup is safe before or after initialization. - Drain background tasks within a configurable 60-second default, cancel tasks that exceed the timeout, await cancellation, and retain completed/cancelled task status. - Close Mem0, OpenAI, Qdrant, Neo4j, embedder, and graph resources independently, including async close methods, while continuing cleanup if one resource fails. - Clear task and client references and keep `close()` idempotent. - Add regression tests for task draining, timeout cancellation, all resource cleanup, and repeated close calls. ## Testing - [x] Unit tests pass (`pytest`) - [x] Linting passes (`ruff check .`) - [x] Type checking passes (`mypy headroom`) - [x] New tests added for new functionality - [x] Manual testing performed ### Test Output ```text python -m pytest -q tests/test_memory/test_direct_mem0.py tests/test_memory/test_qdrant_env.py 52 passed ruff check . All checks passed! ruff format --check . 1383 files already formatted python -m mypy headroom Success: no issues found in 515 source files python -m pytest -q Collection blocked in this Windows environment by 174 errors, primarily missing compiled headroom._core; 18 tests skipped. ``` ## Real Behavior Proof - Environment: Windows, Python 3.12, local DirectMem0Adapter instance using real `httpx.Client` resources. - Exact command / steps: Assigned real `httpx.Client()` instances to the adapter's OpenAI and Qdrant resource slots, registered an asynchronous background task, awaited `adapter.close(timeout=1.0)`, then checked both clients' `is_closed` state and the task status. - Observed result: `real httpx clients closed and background task drained`; both clients reported closed, no pending task IDs remained, and the task status was `completed`. - Who maintains it: Headroom Labs maintains this active upstream repository and memory backend. - Install surface: No dependencies or install behavior changed. The fix uses the standard-library asyncio/inspect modules and existing resource close methods; no native code or runtime network access is introduced. - Not tested: The complete test suite could not run past collection because this Windows environment lacks the compiled `headroom._core` extension. ## Review Readiness - [x] I have performed a self-review - [x] This PR is ready for human review ## Checklist - [x] My code follows the project's style guidelines - [x] I have performed a self-review of my code - [x] I have commented my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes (full suite blocked by missing native extension; targeted tests pass) - [x] I did not edit `CHANGELOG.md` - it is generated by release-please from my Conventional Commit PR title. ## Screenshots (if applicable) Not applicable. ## Additional Notes The default close timeout is 60 seconds and can be overridden by callers that need a shorter shutdown budget. --------- Co-authored-by: Tejas Chopra <tejas@Tejass-MacBook-Pro.local>
184 lines
5.4 KiB
Python
184 lines
5.4 KiB
Python
"""Tests for the Direct Mem0 adapter lifecycle."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import asyncio
|
|
import threading
|
|
from unittest.mock import AsyncMock, MagicMock
|
|
|
|
import pytest
|
|
|
|
from headroom.memory.backends.direct_mem0 import DirectMem0Adapter, Mem0Config
|
|
|
|
|
|
def _adapter() -> DirectMem0Adapter:
|
|
return DirectMem0Adapter(Mem0Config(enable_graph=True))
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_close_drains_tasks_and_closes_initialized_resources() -> None:
|
|
adapter = _adapter()
|
|
resources = {
|
|
"_mem0_client": MagicMock(),
|
|
"_openai_client": MagicMock(),
|
|
"_qdrant_client": MagicMock(),
|
|
"_neo4j_driver": MagicMock(),
|
|
}
|
|
resources["_mem0_client"].close = AsyncMock()
|
|
for name, resource in resources.items():
|
|
setattr(adapter, name, resource)
|
|
|
|
task = asyncio.create_task(asyncio.sleep(0, result="saved"))
|
|
adapter._background_tasks["task_1"] = task
|
|
|
|
await adapter.close(timeout=1.0)
|
|
|
|
assert adapter.get_pending_tasks() == []
|
|
assert adapter.get_task_status("task_1") == {
|
|
"status": "completed",
|
|
"result": "saved",
|
|
}
|
|
resources["_mem0_client"].close.assert_awaited_once_with()
|
|
for resource in resources.values():
|
|
resource.close.assert_called_once_with()
|
|
assert adapter._initialized is False
|
|
assert adapter._mem0_client is None
|
|
assert adapter._openai_client is None
|
|
assert adapter._qdrant_client is None
|
|
assert adapter._neo4j_driver is None
|
|
|
|
await adapter.close(timeout=0.01)
|
|
resources["_mem0_client"].close.assert_awaited_once_with()
|
|
for resource in resources.values():
|
|
resource.close.assert_called_once_with()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_close_timeout_keeps_tasks_and_resources_attached() -> None:
|
|
adapter = _adapter()
|
|
release = asyncio.Event()
|
|
resource = MagicMock()
|
|
adapter._mem0_client = resource
|
|
task = asyncio.create_task(release.wait())
|
|
adapter._background_tasks["task_1"] = task
|
|
await asyncio.sleep(0)
|
|
|
|
with pytest.raises(TimeoutError, match="task_1"):
|
|
await adapter.close(timeout=0.01)
|
|
|
|
assert not task.done()
|
|
assert adapter.get_pending_tasks() == ["task_1"]
|
|
assert adapter._mem0_client is resource
|
|
resource.close.assert_not_called()
|
|
|
|
release.set()
|
|
await adapter.close(timeout=1.0)
|
|
|
|
assert adapter.get_pending_tasks() == []
|
|
assert adapter.get_task_status("task_1") == {
|
|
"status": "completed",
|
|
"result": True,
|
|
}
|
|
resource.close.assert_called_once_with()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_close_does_not_close_resources_while_sync_worker_is_running() -> None:
|
|
adapter = _adapter()
|
|
worker_started = threading.Event()
|
|
release_worker = threading.Event()
|
|
|
|
class BlockingMem0Client:
|
|
def __init__(self) -> None:
|
|
self.close_calls = 0
|
|
|
|
def add(self, *_args: object, **_kwargs: object) -> dict[str, list[dict[str, str]]]:
|
|
worker_started.set()
|
|
assert release_worker.wait(timeout=5.0), "test did not release worker"
|
|
return {"results": [{"id": "memory-1", "memory": "saved"}]}
|
|
|
|
def close(self) -> None:
|
|
self.close_calls += 1
|
|
|
|
client = BlockingMem0Client()
|
|
adapter._mem0_client = client
|
|
adapter._initialized = True
|
|
|
|
memory = await adapter.save_memory(
|
|
content="saved",
|
|
user_id="user-1",
|
|
importance=0.5,
|
|
background=True,
|
|
)
|
|
task_id = memory.metadata["_task_id"]
|
|
|
|
for _ in range(100):
|
|
if worker_started.is_set():
|
|
break
|
|
await asyncio.sleep(0.01)
|
|
assert worker_started.is_set()
|
|
|
|
with pytest.raises(TimeoutError, match=task_id):
|
|
await adapter.close(timeout=0.01)
|
|
|
|
assert client.close_calls == 0
|
|
assert adapter._mem0_client is client
|
|
assert adapter.get_pending_tasks() == [task_id]
|
|
|
|
release_worker.set()
|
|
await adapter.close(timeout=1.0)
|
|
|
|
assert client.close_calls == 1
|
|
assert adapter._mem0_client is None
|
|
assert adapter.get_pending_tasks() == []
|
|
assert adapter.get_task_status(task_id)["status"] == "completed"
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_concurrent_close_calls_serialize_resource_cleanup() -> None:
|
|
adapter = _adapter()
|
|
close_started = asyncio.Event()
|
|
release_close = asyncio.Event()
|
|
resource = MagicMock()
|
|
|
|
async def slow_close() -> None:
|
|
close_started.set()
|
|
await release_close.wait()
|
|
|
|
resource.close = AsyncMock(side_effect=slow_close)
|
|
adapter._mem0_client = resource
|
|
|
|
first = asyncio.create_task(adapter.close())
|
|
await close_started.wait()
|
|
second = asyncio.create_task(adapter.close())
|
|
await asyncio.sleep(0)
|
|
|
|
resource.close.assert_awaited_once_with()
|
|
assert not first.done()
|
|
assert not second.done()
|
|
|
|
release_close.set()
|
|
await asyncio.gather(first, second)
|
|
|
|
resource.close.assert_awaited_once_with()
|
|
|
|
|
|
@pytest.mark.asyncio
|
|
async def test_wait_for_task_timeout_does_not_cancel_background_write() -> None:
|
|
adapter = _adapter()
|
|
release = asyncio.Event()
|
|
task = asyncio.create_task(release.wait())
|
|
adapter._background_tasks["task_1"] = task
|
|
|
|
assert await adapter.wait_for_task("task_1", timeout=0.01) == {
|
|
"status": "timeout",
|
|
"task_id": "task_1",
|
|
}
|
|
assert not task.done()
|
|
assert adapter.get_pending_tasks() == ["task_1"]
|
|
|
|
release.set()
|
|
assert await adapter.wait_for_task("task_1", timeout=1.0) == {
|
|
"status": "completed",
|
|
"result": True,
|
|
}
|