mirror of
https://gitee.com/wanwujie/deer-flow
synced 2026-04-19 04:14:46 +08:00
* fix(checkpointer): return InMemorySaver instead of None when not configured (#1016) * fix(checkpointer): also fix get_checkpointer() to return InMemorySaver Make all three checkpointer functions consistent: - make_checkpointer() (async) → InMemorySaver - checkpointer_context() (sync) → InMemorySaver - get_checkpointer() (sync singleton) → InMemorySaver This ensures DeerFlowClient always has a valid checkpointer. * fix: address CI failure and Copilot review feedback - Fix import order in test_checkpointer_none_fix.py (I001 ruff error) - Fix type annotation: _checkpointer should be Checkpointer | None - Update docstring: change "None if not configured" to "InMemorySaver if not configured" - Ensure app config is loaded before checking checkpointer config to prevent incorrect InMemorySaver fallback --------- Co-authored-by: Willem Jiang <willem.jiang@gmail.com>
This commit is contained in:
@@ -10,7 +10,7 @@ Usage (e.g. FastAPI lifespan)::
|
|||||||
from src.agents.checkpointer.async_provider import make_checkpointer
|
from src.agents.checkpointer.async_provider import make_checkpointer
|
||||||
|
|
||||||
async with make_checkpointer() as checkpointer:
|
async with make_checkpointer() as checkpointer:
|
||||||
app.state.checkpointer = checkpointer # None if not configured
|
app.state.checkpointer = checkpointer # InMemorySaver if not configured
|
||||||
|
|
||||||
For sync usage see :mod:`src.agents.checkpointer.provider`.
|
For sync usage see :mod:`src.agents.checkpointer.provider`.
|
||||||
"""
|
"""
|
||||||
@@ -87,20 +87,22 @@ async def _async_checkpointer(config) -> AsyncIterator[Checkpointer]:
|
|||||||
|
|
||||||
|
|
||||||
@contextlib.asynccontextmanager
|
@contextlib.asynccontextmanager
|
||||||
async def make_checkpointer() -> AsyncIterator[Checkpointer | None]:
|
async def make_checkpointer() -> AsyncIterator[Checkpointer]:
|
||||||
"""Async context manager that yields a checkpointer for the caller's lifetime.
|
"""Async context manager that yields a checkpointer for the caller's lifetime.
|
||||||
Resources are opened on enter and closed on exit — no global state::
|
Resources are opened on enter and closed on exit — no global state::
|
||||||
|
|
||||||
async with make_checkpointer() as checkpointer:
|
async with make_checkpointer() as checkpointer:
|
||||||
app.state.checkpointer = checkpointer
|
app.state.checkpointer = checkpointer
|
||||||
|
|
||||||
Yields ``None`` when no checkpointer is configured in *config.yaml*.
|
Yields an ``InMemorySaver`` when no checkpointer is configured in *config.yaml*.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
config = get_app_config()
|
config = get_app_config()
|
||||||
|
|
||||||
if config.checkpointer is None:
|
if config.checkpointer is None:
|
||||||
yield None
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
yield InMemorySaver()
|
||||||
return
|
return
|
||||||
|
|
||||||
async with _async_checkpointer(config.checkpointer) as saver:
|
async with _async_checkpointer(config.checkpointer) as saver:
|
||||||
|
|||||||
@@ -107,14 +107,14 @@ def _sync_checkpointer_cm(config: CheckpointerConfig) -> Iterator[Checkpointer]:
|
|||||||
# Sync singleton
|
# Sync singleton
|
||||||
# ---------------------------------------------------------------------------
|
# ---------------------------------------------------------------------------
|
||||||
|
|
||||||
_checkpointer: Checkpointer = None
|
_checkpointer: Checkpointer | None = None
|
||||||
_checkpointer_ctx = None # open context manager keeping the connection alive
|
_checkpointer_ctx = None # open context manager keeping the connection alive
|
||||||
|
|
||||||
|
|
||||||
def get_checkpointer() -> Checkpointer | None:
|
def get_checkpointer() -> Checkpointer:
|
||||||
"""Return the global sync checkpointer singleton, creating it on first call.
|
"""Return the global sync checkpointer singleton, creating it on first call.
|
||||||
|
|
||||||
Returns ``None`` when no checkpointer is configured in *config.yaml*.
|
Returns an ``InMemorySaver`` when no checkpointer is configured in *config.yaml*.
|
||||||
|
|
||||||
Raises:
|
Raises:
|
||||||
ImportError: If the required package for the configured backend is not installed.
|
ImportError: If the required package for the configured backend is not installed.
|
||||||
@@ -125,11 +125,29 @@ def get_checkpointer() -> Checkpointer | None:
|
|||||||
if _checkpointer is not None:
|
if _checkpointer is not None:
|
||||||
return _checkpointer
|
return _checkpointer
|
||||||
|
|
||||||
|
# Ensure app config is loaded before checking checkpointer config
|
||||||
|
# This prevents returning InMemorySaver when config.yaml actually has a checkpointer section
|
||||||
|
# but hasn't been loaded yet
|
||||||
|
from src.config.app_config import _app_config
|
||||||
from src.config.checkpointer_config import get_checkpointer_config
|
from src.config.checkpointer_config import get_checkpointer_config
|
||||||
|
|
||||||
|
if _app_config is None:
|
||||||
|
# Only load config if it hasn't been initialized yet
|
||||||
|
# In tests, config may be set directly via set_checkpointer_config()
|
||||||
|
try:
|
||||||
|
get_app_config()
|
||||||
|
except FileNotFoundError:
|
||||||
|
# In test environments without config.yaml, this is expected
|
||||||
|
# Tests will set config directly via set_checkpointer_config()
|
||||||
|
pass
|
||||||
|
|
||||||
config = get_checkpointer_config()
|
config = get_checkpointer_config()
|
||||||
if config is None:
|
if config is None:
|
||||||
return None
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
logger.info("Checkpointer: using InMemorySaver (in-process, not persistent)")
|
||||||
|
_checkpointer = InMemorySaver()
|
||||||
|
return _checkpointer
|
||||||
|
|
||||||
_checkpointer_ctx = _sync_checkpointer_cm(config)
|
_checkpointer_ctx = _sync_checkpointer_cm(config)
|
||||||
_checkpointer = _checkpointer_ctx.__enter__()
|
_checkpointer = _checkpointer_ctx.__enter__()
|
||||||
@@ -159,7 +177,7 @@ def reset_checkpointer() -> None:
|
|||||||
|
|
||||||
|
|
||||||
@contextlib.contextmanager
|
@contextlib.contextmanager
|
||||||
def checkpointer_context() -> Iterator[Checkpointer | None]:
|
def checkpointer_context() -> Iterator[Checkpointer]:
|
||||||
"""Sync context manager that yields a checkpointer and cleans up on exit.
|
"""Sync context manager that yields a checkpointer and cleans up on exit.
|
||||||
|
|
||||||
Unlike :func:`get_checkpointer`, this does **not** cache the instance —
|
Unlike :func:`get_checkpointer`, this does **not** cache the instance —
|
||||||
@@ -168,11 +186,15 @@ def checkpointer_context() -> Iterator[Checkpointer | None]:
|
|||||||
|
|
||||||
with checkpointer_context() as cp:
|
with checkpointer_context() as cp:
|
||||||
graph.invoke(input, config={"configurable": {"thread_id": "1"}})
|
graph.invoke(input, config={"configurable": {"thread_id": "1"}})
|
||||||
|
|
||||||
|
Yields an ``InMemorySaver`` when no checkpointer is configured in *config.yaml*.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
config = get_app_config()
|
config = get_app_config()
|
||||||
if config.checkpointer is None:
|
if config.checkpointer is None:
|
||||||
yield None
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
yield InMemorySaver()
|
||||||
return
|
return
|
||||||
|
|
||||||
with _sync_checkpointer_cm(config.checkpointer) as saver:
|
with _sync_checkpointer_cm(config.checkpointer) as saver:
|
||||||
|
|||||||
@@ -71,8 +71,13 @@ class TestCheckpointerConfig:
|
|||||||
|
|
||||||
|
|
||||||
class TestGetCheckpointer:
|
class TestGetCheckpointer:
|
||||||
def test_returns_none_when_not_configured(self):
|
def test_returns_in_memory_saver_when_not_configured(self):
|
||||||
assert get_checkpointer() is None
|
"""get_checkpointer should return InMemorySaver when not configured."""
|
||||||
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
cp = get_checkpointer()
|
||||||
|
assert cp is not None
|
||||||
|
assert isinstance(cp, InMemorySaver)
|
||||||
|
|
||||||
def test_memory_returns_in_memory_saver(self):
|
def test_memory_returns_in_memory_saver(self):
|
||||||
load_checkpointer_config_from_dict({"type": "memory"})
|
load_checkpointer_config_from_dict({"type": "memory"})
|
||||||
|
|||||||
54
backend/tests/test_checkpointer_none_fix.py
Normal file
54
backend/tests/test_checkpointer_none_fix.py
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
"""Test for issue #1016: checkpointer should not return None."""
|
||||||
|
|
||||||
|
from unittest.mock import MagicMock, patch
|
||||||
|
|
||||||
|
import pytest
|
||||||
|
from langgraph.checkpoint.memory import InMemorySaver
|
||||||
|
|
||||||
|
|
||||||
|
class TestCheckpointerNoneFix:
|
||||||
|
"""Tests that checkpointer context managers return InMemorySaver instead of None."""
|
||||||
|
|
||||||
|
@pytest.mark.anyio
|
||||||
|
async def test_async_make_checkpointer_returns_in_memory_saver_when_not_configured(self):
|
||||||
|
"""make_checkpointer should return InMemorySaver when config.checkpointer is None."""
|
||||||
|
from src.agents.checkpointer.async_provider import make_checkpointer
|
||||||
|
|
||||||
|
# Mock get_app_config to return a config with checkpointer=None
|
||||||
|
mock_config = MagicMock()
|
||||||
|
mock_config.checkpointer = None
|
||||||
|
|
||||||
|
with patch("src.agents.checkpointer.async_provider.get_app_config", return_value=mock_config):
|
||||||
|
async with make_checkpointer() as checkpointer:
|
||||||
|
# Should return InMemorySaver, not None
|
||||||
|
assert checkpointer is not None
|
||||||
|
assert isinstance(checkpointer, InMemorySaver)
|
||||||
|
|
||||||
|
# Should be able to call alist() without AttributeError
|
||||||
|
# This is what LangGraph does and what was failing in issue #1016
|
||||||
|
result = []
|
||||||
|
async for item in checkpointer.alist(config={"configurable": {"thread_id": "test"}}):
|
||||||
|
result.append(item)
|
||||||
|
|
||||||
|
# Empty list is expected for a fresh checkpointer
|
||||||
|
assert result == []
|
||||||
|
|
||||||
|
def test_sync_checkpointer_context_returns_in_memory_saver_when_not_configured(self):
|
||||||
|
"""checkpointer_context should return InMemorySaver when config.checkpointer is None."""
|
||||||
|
from src.agents.checkpointer.provider import checkpointer_context
|
||||||
|
|
||||||
|
# Mock get_app_config to return a config with checkpointer=None
|
||||||
|
mock_config = MagicMock()
|
||||||
|
mock_config.checkpointer = None
|
||||||
|
|
||||||
|
with patch("src.agents.checkpointer.provider.get_app_config", return_value=mock_config):
|
||||||
|
with checkpointer_context() as checkpointer:
|
||||||
|
# Should return InMemorySaver, not None
|
||||||
|
assert checkpointer is not None
|
||||||
|
assert isinstance(checkpointer, InMemorySaver)
|
||||||
|
|
||||||
|
# Should be able to call list() without AttributeError
|
||||||
|
result = list(checkpointer.list(config={"configurable": {"thread_id": "test"}}))
|
||||||
|
|
||||||
|
# Empty list is expected for a fresh checkpointer
|
||||||
|
assert result == []
|
||||||
Reference in New Issue
Block a user