mirror of
https://github.com/langchain-ai/langgraph.git
synced 2026-08-25 00:52:25 +02:00
jacoblee93
d7735fb0b2
Previously, when ensure_config was called with multiple configs (e.g.
Pregel.stream's ensure_config(self.config, config)), a later config's
configurable dict fully overwrote an earlier one. This caused values
bound via with_config({"configurable": {...}}) to be silently dropped
whenever the invoke-time config supplied any other configurable key.
Concretely, create_agent binds {configurable: {ls_agent_type: 'root'}}
via with_config, and any real invocation with a checkpointer supplies
{configurable: {thread_id: ...}} at invoke time. The bound ls_agent_type
was dropped, so no root-level runs were tagged with ls_agent_type='root'
in LangSmith.
Fix: merge the configurable dict across configs (stdlib merge_configs in
langchain_core already does this correctly; langgraph's merge_configs
helper in this same file also does this at line 109). Invoke-time values
still override bound values when keys collide.
Adds a regression test in tests/test_utils.py.
459 lines
15 KiB
Python
459 lines
15 KiB
Python
import functools
|
|
import sys
|
|
import uuid
|
|
from collections.abc import Callable
|
|
from typing import (
|
|
Annotated,
|
|
Any,
|
|
ForwardRef,
|
|
Literal,
|
|
Optional,
|
|
TypeVar,
|
|
Union,
|
|
)
|
|
from unittest.mock import MagicMock, patch
|
|
|
|
import langsmith
|
|
import pytest
|
|
from langchain_core.runnables import RunnableConfig
|
|
from langchain_core.tracers import LangChainTracer
|
|
from typing_extensions import NotRequired, Required, TypedDict
|
|
|
|
from langgraph._internal._config import (
|
|
_is_not_empty,
|
|
ensure_config,
|
|
get_callback_manager_for_config,
|
|
)
|
|
from langgraph._internal._fields import (
|
|
_is_optional_type,
|
|
get_enhanced_type_hints,
|
|
get_field_default,
|
|
)
|
|
from langgraph._internal._runnable import is_async_callable, is_async_generator
|
|
from langgraph.constants import END
|
|
from langgraph.graph import StateGraph
|
|
from langgraph.graph.state import CompiledStateGraph
|
|
|
|
# ruff: noqa: UP045, UP007
|
|
|
|
pytestmark = pytest.mark.anyio
|
|
|
|
|
|
def test_is_async() -> None:
|
|
async def func() -> None:
|
|
pass
|
|
|
|
assert is_async_callable(func)
|
|
wrapped_func = functools.wraps(func)(func)
|
|
assert is_async_callable(wrapped_func)
|
|
|
|
def sync_func() -> None:
|
|
pass
|
|
|
|
assert not is_async_callable(sync_func)
|
|
wrapped_sync_func = functools.wraps(sync_func)(sync_func)
|
|
assert not is_async_callable(wrapped_sync_func)
|
|
|
|
class AsyncFuncCallable:
|
|
async def __call__(self) -> None:
|
|
pass
|
|
|
|
runnable = AsyncFuncCallable()
|
|
assert is_async_callable(runnable)
|
|
wrapped_runnable = functools.wraps(runnable)(runnable)
|
|
assert is_async_callable(wrapped_runnable)
|
|
|
|
class SyncFuncCallable:
|
|
def __call__(self) -> None:
|
|
pass
|
|
|
|
sync_runnable = SyncFuncCallable()
|
|
assert not is_async_callable(sync_runnable)
|
|
wrapped_sync_runnable = functools.wraps(sync_runnable)(sync_runnable)
|
|
assert not is_async_callable(wrapped_sync_runnable)
|
|
|
|
|
|
def test_is_generator() -> None:
|
|
async def gen():
|
|
yield
|
|
|
|
assert is_async_generator(gen)
|
|
|
|
wrapped_gen = functools.wraps(gen)(gen)
|
|
assert is_async_generator(wrapped_gen)
|
|
|
|
def sync_gen():
|
|
yield
|
|
|
|
assert not is_async_generator(sync_gen)
|
|
wrapped_sync_gen = functools.wraps(sync_gen)(sync_gen)
|
|
assert not is_async_generator(wrapped_sync_gen)
|
|
|
|
class AsyncGenCallable:
|
|
async def __call__(self):
|
|
yield
|
|
|
|
runnable = AsyncGenCallable()
|
|
assert is_async_generator(runnable)
|
|
wrapped_runnable = functools.wraps(runnable)(runnable)
|
|
assert is_async_generator(wrapped_runnable)
|
|
|
|
class SyncGenCallable:
|
|
def __call__(self):
|
|
yield
|
|
|
|
sync_runnable = SyncGenCallable()
|
|
assert not is_async_generator(sync_runnable)
|
|
wrapped_sync_runnable = functools.wraps(sync_runnable)(sync_runnable)
|
|
assert not is_async_generator(wrapped_sync_runnable)
|
|
|
|
|
|
@pytest.fixture
|
|
def rt_graph() -> CompiledStateGraph:
|
|
class State(TypedDict):
|
|
foo: int
|
|
node_run_id: int
|
|
|
|
def node(_: State):
|
|
from langsmith import get_current_run_tree # type: ignore
|
|
|
|
return {"node_run_id": get_current_run_tree().id} # type: ignore
|
|
|
|
graph = StateGraph(State)
|
|
graph.add_node(node)
|
|
graph.set_entry_point("node")
|
|
graph.add_edge("node", END)
|
|
return graph.compile()
|
|
|
|
|
|
def test_runnable_callable_tracing_nested(rt_graph: CompiledStateGraph) -> None:
|
|
with patch("langsmith.client.Client", spec=langsmith.Client) as mock_client:
|
|
with patch("langchain_core.tracers.langchain.get_client") as mock_get_client:
|
|
mock_get_client.return_value = mock_client
|
|
with langsmith.tracing_context(enabled=True):
|
|
res = rt_graph.invoke({"foo": 1})
|
|
assert isinstance(res["node_run_id"], uuid.UUID)
|
|
|
|
|
|
@pytest.mark.skipif(
|
|
sys.version_info < (3, 11),
|
|
reason="Python 3.11+ is required for async contextvars support",
|
|
)
|
|
async def test_runnable_callable_tracing_nested_async(
|
|
rt_graph: CompiledStateGraph,
|
|
) -> None:
|
|
with patch("langsmith.client.Client", spec=langsmith.Client) as mock_client:
|
|
with patch("langchain_core.tracers.langchain.get_client") as mock_get_client:
|
|
mock_get_client.return_value = mock_client
|
|
with langsmith.tracing_context(enabled=True):
|
|
res = await rt_graph.ainvoke({"foo": 1})
|
|
assert isinstance(res["node_run_id"], uuid.UUID)
|
|
|
|
|
|
def test_is_optional_type():
|
|
assert _is_optional_type(None)
|
|
assert not _is_optional_type(type(None))
|
|
assert _is_optional_type(Optional[list])
|
|
assert not _is_optional_type(int)
|
|
assert _is_optional_type(Optional[Literal[1, 2, 3]])
|
|
assert not _is_optional_type(Literal[1, 2, 3])
|
|
assert _is_optional_type(Optional[list[int]])
|
|
assert _is_optional_type(Optional[dict[str, int]])
|
|
assert not _is_optional_type(list[int | None])
|
|
assert _is_optional_type(Union[str | None, int | None])
|
|
assert _is_optional_type(Union[str | None | int | None, float | None | dict | None])
|
|
assert not _is_optional_type(Union[str | int, float | dict])
|
|
|
|
assert _is_optional_type(Union[int, None])
|
|
assert _is_optional_type(Union[str, None, int])
|
|
assert _is_optional_type(Union[None, str, int])
|
|
assert not _is_optional_type(Union[int, str])
|
|
|
|
assert not _is_optional_type(Any) # Do we actually want this?
|
|
assert _is_optional_type(Optional[Any])
|
|
|
|
class MyClass:
|
|
pass
|
|
|
|
assert _is_optional_type(Optional[MyClass])
|
|
assert not _is_optional_type(MyClass)
|
|
assert _is_optional_type(Optional[ForwardRef("MyClass")])
|
|
assert not _is_optional_type(ForwardRef("MyClass"))
|
|
|
|
assert _is_optional_type(Optional[list[int] | dict[str, int | None]])
|
|
assert not _is_optional_type(Union[list[int], dict[str, int | None]])
|
|
|
|
assert _is_optional_type(Optional[Callable[[int], str]])
|
|
assert not _is_optional_type(Callable[[int], str | None])
|
|
|
|
T = TypeVar("T")
|
|
assert _is_optional_type(Optional[T])
|
|
assert not _is_optional_type(T)
|
|
|
|
U = TypeVar("U", bound=T | None) # type: ignore
|
|
assert _is_optional_type(U)
|
|
|
|
|
|
def test_is_required():
|
|
class MyBaseTypedDict(TypedDict):
|
|
val_1: Required[str | None]
|
|
val_2: Required[str]
|
|
val_3: NotRequired[str]
|
|
val_4: NotRequired[str | None]
|
|
val_5: Annotated[NotRequired[int], "foo"]
|
|
val_6: NotRequired[Annotated[int, "foo"]]
|
|
val_7: Annotated[Required[int], "foo"]
|
|
val_8: Required[Annotated[int, "foo"]]
|
|
val_9: str | None
|
|
val_10: str
|
|
|
|
annos = MyBaseTypedDict.__annotations__
|
|
assert get_field_default("val_1", annos["val_1"], MyBaseTypedDict) == ...
|
|
assert get_field_default("val_2", annos["val_2"], MyBaseTypedDict) == ...
|
|
assert get_field_default("val_3", annos["val_3"], MyBaseTypedDict) is None
|
|
assert get_field_default("val_4", annos["val_4"], MyBaseTypedDict) is None
|
|
# See https://peps.python.org/pep-0655/#interaction-with-annotated
|
|
assert get_field_default("val_5", annos["val_5"], MyBaseTypedDict) is None
|
|
assert get_field_default("val_6", annos["val_6"], MyBaseTypedDict) is None
|
|
assert get_field_default("val_7", annos["val_7"], MyBaseTypedDict) == ...
|
|
assert get_field_default("val_8", annos["val_8"], MyBaseTypedDict) == ...
|
|
assert get_field_default("val_9", annos["val_9"], MyBaseTypedDict) is None
|
|
assert get_field_default("val_10", annos["val_10"], MyBaseTypedDict) == ...
|
|
|
|
class MyChildDict(MyBaseTypedDict):
|
|
val_11: int
|
|
val_11b: int | None
|
|
val_11c: int | None | str
|
|
|
|
class MyGrandChildDict(MyChildDict, total=False):
|
|
val_12: int
|
|
val_13: Required[str]
|
|
|
|
cannos = MyChildDict.__annotations__
|
|
gcannos = MyGrandChildDict.__annotations__
|
|
assert get_field_default("val_11", cannos["val_11"], MyChildDict) == ...
|
|
assert get_field_default("val_11b", cannos["val_11b"], MyChildDict) is None
|
|
assert get_field_default("val_11c", cannos["val_11c"], MyChildDict) is None
|
|
assert get_field_default("val_12", gcannos["val_12"], MyGrandChildDict) is None
|
|
assert get_field_default("val_9", gcannos["val_9"], MyGrandChildDict) is None
|
|
assert get_field_default("val_13", gcannos["val_13"], MyGrandChildDict) == ...
|
|
|
|
|
|
def test_enhanced_type_hints() -> None:
|
|
from dataclasses import dataclass
|
|
from typing import Annotated
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
class MyTypedDict(TypedDict):
|
|
val_1: str
|
|
val_2: int = 42
|
|
val_3: str = "default"
|
|
|
|
hints = list(get_enhanced_type_hints(MyTypedDict))
|
|
assert len(hints) == 3
|
|
assert hints[0] == ("val_1", str, None, None)
|
|
assert hints[1] == ("val_2", int, 42, None)
|
|
assert hints[2] == ("val_3", str, "default", None)
|
|
|
|
@dataclass
|
|
class MyDataclass:
|
|
val_1: str
|
|
val_2: int = 42
|
|
val_3: str = "default"
|
|
|
|
hints = list(get_enhanced_type_hints(MyDataclass))
|
|
assert len(hints) == 3
|
|
assert hints[0] == ("val_1", str, None, None)
|
|
assert hints[1] == ("val_2", int, 42, None)
|
|
assert hints[2] == ("val_3", str, "default", None)
|
|
|
|
class MyPydanticModel(BaseModel):
|
|
val_1: str
|
|
val_2: int = 42
|
|
val_3: str = Field(default="default", description="A description")
|
|
|
|
hints = list(get_enhanced_type_hints(MyPydanticModel))
|
|
assert len(hints) == 3
|
|
assert hints[0] == ("val_1", str, None, None)
|
|
assert hints[1] == ("val_2", int, 42, None)
|
|
assert hints[2] == ("val_3", str, "default", "A description")
|
|
|
|
class MyPydanticModelWithAnnotated(BaseModel):
|
|
val_1: Annotated[str, Field(description="A description")]
|
|
val_2: Annotated[int, Field(default=42)]
|
|
val_3: Annotated[
|
|
str, Field(default="default", description="Another description")
|
|
]
|
|
|
|
hints = list(get_enhanced_type_hints(MyPydanticModelWithAnnotated))
|
|
assert len(hints) == 3
|
|
assert hints[0] == ("val_1", str, None, "A description")
|
|
assert hints[1] == ("val_2", int, 42, None)
|
|
assert hints[2] == ("val_3", str, "default", "Another description")
|
|
|
|
|
|
def test_is_not_empty() -> None:
|
|
assert _is_not_empty("foo")
|
|
assert _is_not_empty("")
|
|
assert _is_not_empty(1)
|
|
assert _is_not_empty(0)
|
|
assert not _is_not_empty(None)
|
|
assert not _is_not_empty([])
|
|
assert not _is_not_empty(())
|
|
assert not _is_not_empty({})
|
|
|
|
|
|
def test_configurable_metadata() -> None:
|
|
config = {
|
|
"configurable": {
|
|
"a-key": "foo",
|
|
"somesecretval": "bar",
|
|
"sometoken": "thetoken",
|
|
"__dontinclude": "bar",
|
|
"includeme": "hi",
|
|
"andme": 42,
|
|
"nested": {"foo": "bar"},
|
|
"nooverride": -2,
|
|
"thread_id": "th-123",
|
|
"checkpoint_id": "ckpt-1",
|
|
"checkpoint_ns": "ns-1",
|
|
"task_id": "task-1",
|
|
"run_id": "run-456",
|
|
"assistant_id": "asst-789",
|
|
"graph_id": "graph-0",
|
|
"model": "gpt-4o",
|
|
"user_id": "uid-1",
|
|
"cron_id": "cron-1",
|
|
"langgraph_auth_user_id": "user-1",
|
|
},
|
|
"metadata": {"nooverride": 18},
|
|
}
|
|
merged = ensure_config(config)
|
|
metadata = merged["metadata"]
|
|
assert set(metadata) == {
|
|
"nooverride",
|
|
"assistant_id",
|
|
"thread_id",
|
|
"checkpoint_id",
|
|
"run_id",
|
|
"graph_id",
|
|
"checkpoint_ns",
|
|
"task_id",
|
|
}
|
|
assert metadata["nooverride"] == 18
|
|
|
|
|
|
def test_callback_manager_copies_whitelisted_configurable_ids_to_metadata() -> None:
|
|
config = {
|
|
"configurable": {
|
|
"thread_id": "th-123",
|
|
"checkpoint_id": "ckpt-1",
|
|
"checkpoint_ns": "ns-1",
|
|
"task_id": "task-1",
|
|
"run_id": "run-456",
|
|
"assistant_id": "asst-789",
|
|
"graph_id": "graph-0",
|
|
"model": "gpt-4o",
|
|
"user_id": "uid-1",
|
|
"cron_id": "cron-1",
|
|
"langgraph_auth_user_id": "user-1",
|
|
},
|
|
"metadata": {
|
|
"thread_id": "from-metadata",
|
|
"nooverride": 18,
|
|
},
|
|
}
|
|
manager = ensure_config(config)
|
|
callback_manager = get_callback_manager_for_config(manager)
|
|
assert callback_manager.metadata == {
|
|
"thread_id": "from-metadata",
|
|
"nooverride": 18,
|
|
"checkpoint_id": "ckpt-1",
|
|
"checkpoint_ns": "ns-1",
|
|
"task_id": "task-1",
|
|
"run_id": "run-456",
|
|
"assistant_id": "asst-789",
|
|
"graph_id": "graph-0",
|
|
}
|
|
|
|
|
|
def test_callback_manager_copies_configurable_ids_to_tracing_metadata() -> None:
|
|
tracer = LangChainTracer(client=MagicMock())
|
|
config: RunnableConfig = {
|
|
"configurable": {
|
|
"thread_id": "th-123",
|
|
"checkpoint_id": "ckpt-1",
|
|
"checkpoint_ns": "ns-1",
|
|
"task_id": "task-1",
|
|
"run_id": "run-456",
|
|
"assistant_id": "asst-789",
|
|
"graph_id": "graph-0",
|
|
"model": "gpt-4o",
|
|
"user_id": "uid-1",
|
|
"cron_id": "cron-1",
|
|
"langgraph_auth_user_id": "user-1",
|
|
"includeme": "hi",
|
|
"andme": 42,
|
|
"__dontinclude": "bar",
|
|
"some_api_key": "secret",
|
|
"custom_setting": {"nested": True},
|
|
},
|
|
"metadata": {
|
|
"thread_id": "from-metadata",
|
|
"user_id": "from-metadata-user",
|
|
"includeme": "from-metadata",
|
|
},
|
|
"callbacks": [tracer],
|
|
}
|
|
|
|
manager = ensure_config(config)
|
|
callback_manager = get_callback_manager_for_config(manager)
|
|
handlers = callback_manager.handlers
|
|
tracers = [handler for handler in handlers if isinstance(handler, LangChainTracer)]
|
|
assert len(tracers) == 1
|
|
tracer = tracers[0]
|
|
assert tracer.tracing_metadata == {
|
|
"checkpoint_id": "ckpt-1",
|
|
"checkpoint_ns": "ns-1",
|
|
"task_id": "task-1",
|
|
"run_id": "run-456",
|
|
"assistant_id": "asst-789",
|
|
"graph_id": "graph-0",
|
|
"model": "gpt-4o",
|
|
"cron_id": "cron-1",
|
|
"andme": 42,
|
|
"includeme": "hi",
|
|
"thread_id": "th-123",
|
|
"user_id": "uid-1",
|
|
}
|
|
|
|
|
|
def test_ensure_config_merges_configurable_across_configs() -> None:
|
|
"""`ensure_config(bound, invoke_time)` should merge `configurable` dicts.
|
|
|
|
Prior to the fix, a later config's `configurable` dict fully overwrote an
|
|
earlier one, causing values bound via `with_config({"configurable": {...}})`
|
|
(e.g. `ls_agent_type="root"` set by `create_agent`) to be dropped whenever
|
|
an invoke-time config supplied any other configurable key like `thread_id`.
|
|
"""
|
|
bound: RunnableConfig = {
|
|
"configurable": {"ls_agent_type": "root", "custom_setting": "keep_me"},
|
|
"metadata": {"ls_integration": "langchain_create_agent"},
|
|
}
|
|
invoke_time: RunnableConfig = {
|
|
"configurable": {"thread_id": "t-1"},
|
|
}
|
|
merged = ensure_config(bound, invoke_time)
|
|
# Both the bound and invoke-time configurable keys are preserved.
|
|
assert merged["configurable"] == {
|
|
"ls_agent_type": "root",
|
|
"custom_setting": "keep_me",
|
|
"thread_id": "t-1",
|
|
}
|
|
# Invoke-time values still override bound values when they collide.
|
|
override: RunnableConfig = {"configurable": {"ls_agent_type": "subagent"}}
|
|
merged2 = ensure_config(bound, override)
|
|
assert merged2["configurable"]["ls_agent_type"] == "subagent"
|
|
assert merged2["configurable"]["custom_setting"] == "keep_me"
|