mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
1e350ea22f
* PR2: Wire context provider pipeline and update all internal consumers - Replace AgentThread with AgentSession across all packages - Replace ContextProvider with BaseContextProvider across all packages - Replace context_provider param with context_providers (Sequence) - Replace thread= with session= in run() signatures - Replace get_new_thread() with create_session() - Add get_session(service_session_id) to agent interface - DurableAgentThread -> DurableAgentSession - Remove _notify_thread_of_new_messages from WorkflowAgent - Wire before_run/after_run context provider pipeline in RawAgent - Auto-inject InMemoryHistoryProvider when no providers configured * fix: update all tests for context provider pipeline, fix lazy-loaders, remove old test files * refactor: update all sample files for context provider pipeline (AgentThread→AgentSession, ContextProvider→BaseContextProvider) * fix: update remaining ag-ui references (client docstring, getting_started sample) * fix: make get_session service_session_id keyword-only to avoid confusion with session_id * refactor: rename _RunContext.thread_messages to session_messages * refactor: remove _threads.py, _memory.py, and old provider files; migrate devui to use plain message lists * rename: remove _new_ prefix from test files * refactor: rewrite SlidingWindowChatMessageStore as SlidingWindowHistoryProvider(InMemoryHistoryProvider) * fix: read full history from session state directly instead of reaching into provider internals * fix: update stale .pyi stubs, sample imports, and README references for new provider types * fix: remove stale message_store, _notify_thread_of_new_messages, and session_id.key references in samples * refactor: merge context_providers and sessions sample folders into sessions, remove aggregate_context_provider * refactor: UserInfoMemory stores state in session.state instead of instance attributes * feat: add Pydantic BaseModel support to session state serialization Pydantic models stored in session.state are now automatically serialized via model_dump() and restored via model_validate() during to_dict()/from_dict() round-trips. Models are auto-registered on first serialization; use register_state_type() for cold-start deserialization. Also export register_state_type as a public API. * fix mem0 * Update sample README links and descriptions for session terminology - Replace 'thread' with 'session' in sample descriptions across all READMEs - Update file links for renamed samples (mem0_sessions, redis_sessions, etc.) - Fix Threads section → Sessions section in main samples/README.md - Update tools, middleware, workflows, durabletask, azure_functions READMEs - Update architecture diagrams in concepts/tools/README.md - Update migration guides (autogen, semantic-kernel) * Fix broken Redis README link to renamed sample * Fix Mem0 OSS client search: pass scoping params as direct kwargs AsyncMemory (OSS) expects user_id/agent_id/run_id as direct kwargs, while AsyncMemoryClient (Platform) expects them in a filters dict. Adds tests for both client types. Port of fix from #3844 to new Mem0ContextProvider. * Fix rebase issues: restore missing _conversation_state.py and checkpoint decode logic - Add back _conversation_state.py (encode/decode_chat_messages) lost in rebase - Fix on_checkpoint_restore to decode cache/conversation with decode_chat_messages - Fix on_checkpoint_restore to use decode_checkpoint_value for pending requests - Add tests/workflow/__init__.py for relative import support - Fix test_agent_executor checkpoint selection (checkpoints[1] not superstep) * Add STORES_BY_DEFAULT ClassVar to skip redundant InMemoryHistoryProvider injection Chat clients that store history server-side by default (OpenAI Responses API, Azure AI Agent) now declare STORES_BY_DEFAULT = True. The agent checks this during auto-injection and skips InMemoryHistoryProvider unless the user explicitly sets store=False. * Fix broken markdown links in azure_ai and redis READMEs * Fix getting-started samples to use session API instead of removed thread/ContextProvider API * updates to workflow as agent * fix group chat import * Rename Thread→Session throughout, fix service_session_id propagation, remove stale AGUIThread - Fix: Propagate conversation_id from ChatResponse back to session.service_session_id in both streaming and non-streaming paths in _agents.py - Rename AgentThreadException → AgentSessionException - Remove stale AGUIThread from ag_ui lazy-loader - Rename use_service_thread → use_service_session in ag-ui package - Rename test functions from *_thread_* to *_session_* - Rename sample files from *_thread* to *_session* - Update docstrings and comments: thread → session - Update _mcp.py kwargs filter: add 'session' alongside 'thread' - Fix ContinuationToken docstring example: thread=thread → session=session - Fix _clients.py docstring: 'Agent threads' → 'Agent sessions' * Fix broken markdown links after thread→session file renames * fix azure ai test
309 lines
12 KiB
Python
309 lines
12 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
"""Unit tests for AgentSessionId and DurableAgentSession."""
|
|
|
|
import pytest
|
|
from agent_framework import AgentSession
|
|
|
|
from agent_framework_durabletask._models import AgentSessionId, DurableAgentSession
|
|
|
|
|
|
class TestAgentSessionId:
|
|
"""Test suite for AgentSessionId."""
|
|
|
|
def test_init_creates_session_id(self) -> None:
|
|
"""Test that AgentSessionId initializes correctly."""
|
|
session_id = AgentSessionId(name="AgentEntity", key="test-key-123")
|
|
|
|
assert session_id.name == "AgentEntity"
|
|
assert session_id.key == "test-key-123"
|
|
|
|
def test_with_random_key_generates_guid(self) -> None:
|
|
"""Test that with_random_key generates a GUID."""
|
|
session_id = AgentSessionId.with_random_key(name="AgentEntity")
|
|
|
|
assert session_id.name == "AgentEntity"
|
|
assert len(session_id.key) == 32 # UUID hex is 32 chars
|
|
# Verify it's a valid hex string
|
|
int(session_id.key, 16)
|
|
|
|
def test_with_random_key_unique_keys(self) -> None:
|
|
"""Test that with_random_key generates unique keys."""
|
|
session_id1 = AgentSessionId.with_random_key(name="AgentEntity")
|
|
session_id2 = AgentSessionId.with_random_key(name="AgentEntity")
|
|
|
|
assert session_id1.key != session_id2.key
|
|
|
|
def test_str_representation(self) -> None:
|
|
"""Test string representation."""
|
|
session_id = AgentSessionId(name="AgentEntity", key="test-key-123")
|
|
str_repr = str(session_id)
|
|
|
|
assert str_repr == "@AgentEntity@test-key-123"
|
|
|
|
def test_repr_representation(self) -> None:
|
|
"""Test repr representation."""
|
|
session_id = AgentSessionId(name="AgentEntity", key="test-key")
|
|
repr_str = repr(session_id)
|
|
|
|
assert "AgentSessionId" in repr_str
|
|
assert "AgentEntity" in repr_str
|
|
assert "test-key" in repr_str
|
|
|
|
def test_parse_valid_session_id(self) -> None:
|
|
"""Test parsing valid session ID string."""
|
|
session_id = AgentSessionId.parse("@AgentEntity@test-key-123")
|
|
|
|
assert session_id.name == "AgentEntity"
|
|
assert session_id.key == "test-key-123"
|
|
|
|
def test_parse_invalid_format_no_prefix(self) -> None:
|
|
"""Test parsing invalid format without @ prefix."""
|
|
with pytest.raises(ValueError) as exc_info:
|
|
AgentSessionId.parse("AgentEntity@test-key")
|
|
|
|
assert "Invalid agent session ID format" in str(exc_info.value)
|
|
|
|
def test_parse_invalid_format_single_part(self) -> None:
|
|
"""Test parsing invalid format with single part."""
|
|
with pytest.raises(ValueError) as exc_info:
|
|
AgentSessionId.parse("@AgentEntity")
|
|
|
|
assert "Invalid agent session ID format" in str(exc_info.value)
|
|
|
|
def test_parse_with_multiple_at_signs_in_key(self) -> None:
|
|
"""Test parsing with @ signs in the key."""
|
|
session_id = AgentSessionId.parse("@AgentEntity@key-with@symbols")
|
|
|
|
assert session_id.name == "AgentEntity"
|
|
assert session_id.key == "key-with@symbols"
|
|
|
|
def test_parse_round_trip(self) -> None:
|
|
"""Test round-trip parse and string conversion."""
|
|
original = AgentSessionId(name="AgentEntity", key="test-key")
|
|
str_repr = str(original)
|
|
parsed = AgentSessionId.parse(str_repr)
|
|
|
|
assert parsed.name == original.name
|
|
assert parsed.key == original.key
|
|
|
|
def test_to_entity_name_adds_prefix(self) -> None:
|
|
"""Test that to_entity_name adds the dafx- prefix."""
|
|
entity_name = AgentSessionId.to_entity_name("TestAgent")
|
|
assert entity_name == "dafx-TestAgent"
|
|
|
|
def test_parse_with_agent_name_override(self) -> None:
|
|
"""Test parsing @name@key format with agent_name parameter overrides the name."""
|
|
session_id = AgentSessionId.parse("@OriginalAgent@test-key-123", agent_name="OverriddenAgent")
|
|
|
|
assert session_id.name == "OverriddenAgent"
|
|
assert session_id.key == "test-key-123"
|
|
|
|
def test_parse_without_agent_name_uses_parsed_name(self) -> None:
|
|
"""Test parsing @name@key format without agent_name uses name from string."""
|
|
session_id = AgentSessionId.parse("@ParsedAgent@test-key-123")
|
|
|
|
assert session_id.name == "ParsedAgent"
|
|
assert session_id.key == "test-key-123"
|
|
|
|
def test_parse_plain_string_with_agent_name(self) -> None:
|
|
"""Test parsing plain string with agent_name uses entire string as key."""
|
|
session_id = AgentSessionId.parse("simple-thread-123", agent_name="TestAgent")
|
|
|
|
assert session_id.name == "TestAgent"
|
|
assert session_id.key == "simple-thread-123"
|
|
|
|
def test_parse_plain_string_without_agent_name_raises(self) -> None:
|
|
"""Test parsing plain string without agent_name raises ValueError."""
|
|
with pytest.raises(ValueError) as exc_info:
|
|
AgentSessionId.parse("simple-thread-123")
|
|
|
|
assert "Invalid agent session ID format" in str(exc_info.value)
|
|
|
|
|
|
class TestDurableAgentSession:
|
|
"""Test suite for DurableAgentSession."""
|
|
|
|
def test_init_with_durable_session_id(self) -> None:
|
|
"""Test DurableAgentSession initialization with durable session ID."""
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key")
|
|
session = DurableAgentSession(durable_session_id=session_id)
|
|
|
|
assert session.durable_session_id is not None
|
|
assert session.durable_session_id == session_id
|
|
|
|
def test_init_without_durable_session_id(self) -> None:
|
|
"""Test DurableAgentSession initialization without durable session ID."""
|
|
session = DurableAgentSession()
|
|
|
|
assert session.durable_session_id is None
|
|
|
|
def test_durable_session_id_setter(self) -> None:
|
|
"""Test setting a durable session ID to an existing session."""
|
|
session = DurableAgentSession()
|
|
assert session.durable_session_id is None
|
|
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key")
|
|
session.durable_session_id = session_id
|
|
|
|
assert session.durable_session_id is not None
|
|
assert session.durable_session_id == session_id
|
|
assert session.durable_session_id.name == "TestAgent"
|
|
|
|
def test_from_session_id(self) -> None:
|
|
"""Test creating DurableAgentSession from session ID."""
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key")
|
|
session = DurableAgentSession.from_session_id(session_id)
|
|
|
|
assert isinstance(session, DurableAgentSession)
|
|
assert session.durable_session_id is not None
|
|
assert session.durable_session_id == session_id
|
|
assert session.durable_session_id.name == "TestAgent"
|
|
assert session.durable_session_id.key == "test-key"
|
|
|
|
def test_from_session_id_with_service_session_id(self) -> None:
|
|
"""Test creating DurableAgentSession with service session ID."""
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key")
|
|
session = DurableAgentSession.from_session_id(session_id, service_session_id="service-123")
|
|
|
|
assert session.durable_session_id is not None
|
|
assert session.durable_session_id == session_id
|
|
assert session.service_session_id == "service-123"
|
|
|
|
def test_to_dict_with_durable_session_id(self) -> None:
|
|
"""Test serialization includes durable session ID."""
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key")
|
|
session = DurableAgentSession(durable_session_id=session_id)
|
|
|
|
serialized = session.to_dict()
|
|
|
|
assert isinstance(serialized, dict)
|
|
assert "durable_session_id" in serialized
|
|
assert serialized["durable_session_id"] == "@TestAgent@test-key"
|
|
|
|
def test_to_dict_without_durable_session_id(self) -> None:
|
|
"""Test serialization without durable session ID."""
|
|
session = DurableAgentSession()
|
|
|
|
serialized = session.to_dict()
|
|
|
|
assert isinstance(serialized, dict)
|
|
assert "durable_session_id" not in serialized
|
|
|
|
def test_from_dict_with_durable_session_id(self) -> None:
|
|
"""Test deserialization restores durable session ID."""
|
|
serialized = {
|
|
"type": "session",
|
|
"session_id": "session-123",
|
|
"service_session_id": "service-123",
|
|
"state": {},
|
|
"durable_session_id": "@TestAgent@test-key",
|
|
}
|
|
|
|
session = DurableAgentSession.from_dict(serialized)
|
|
|
|
assert isinstance(session, DurableAgentSession)
|
|
assert session.durable_session_id is not None
|
|
assert session.durable_session_id.name == "TestAgent"
|
|
assert session.durable_session_id.key == "test-key"
|
|
assert session.service_session_id == "service-123"
|
|
|
|
def test_from_dict_without_durable_session_id(self) -> None:
|
|
"""Test deserialization without durable session ID."""
|
|
serialized = {
|
|
"type": "session",
|
|
"session_id": "session-456",
|
|
"service_session_id": "service-456",
|
|
"state": {},
|
|
}
|
|
|
|
session = DurableAgentSession.from_dict(serialized)
|
|
|
|
assert isinstance(session, DurableAgentSession)
|
|
assert session.durable_session_id is None
|
|
assert session.session_id == "session-456"
|
|
|
|
def test_round_trip_serialization(self) -> None:
|
|
"""Test round-trip serialization preserves durable session ID."""
|
|
session_id = AgentSessionId(name="TestAgent", key="test-key-789")
|
|
original = DurableAgentSession(durable_session_id=session_id)
|
|
|
|
serialized = original.to_dict()
|
|
restored = DurableAgentSession.from_dict(serialized)
|
|
|
|
assert isinstance(restored, DurableAgentSession)
|
|
assert restored.durable_session_id is not None
|
|
assert restored.durable_session_id.name == session_id.name
|
|
assert restored.durable_session_id.key == session_id.key
|
|
|
|
def test_from_dict_invalid_durable_session_id_type(self) -> None:
|
|
"""Test deserialization with invalid durable session ID type raises error."""
|
|
serialized = {
|
|
"type": "session",
|
|
"session_id": "session-123",
|
|
"state": {},
|
|
"durable_session_id": 12345, # Invalid type
|
|
}
|
|
|
|
with pytest.raises(ValueError, match="durable_session_id must be a string"):
|
|
DurableAgentSession.from_dict(serialized)
|
|
|
|
|
|
class TestAgentSessionCompatibility:
|
|
"""Test suite for compatibility between AgentSession and DurableAgentSession."""
|
|
|
|
def test_agent_session_to_dict(self) -> None:
|
|
"""Test that base AgentSession can be serialized."""
|
|
session = AgentSession()
|
|
|
|
serialized = session.to_dict()
|
|
|
|
assert isinstance(serialized, dict)
|
|
assert "session_id" in serialized
|
|
|
|
def test_agent_session_from_dict(self) -> None:
|
|
"""Test that base AgentSession can be deserialized."""
|
|
session = AgentSession()
|
|
serialized = session.to_dict()
|
|
|
|
restored = AgentSession.from_dict(serialized)
|
|
|
|
assert isinstance(restored, AgentSession)
|
|
assert restored.session_id == session.session_id
|
|
|
|
def test_durable_session_is_agent_session(self) -> None:
|
|
"""Test that DurableAgentSession is an AgentSession."""
|
|
session = DurableAgentSession()
|
|
|
|
assert isinstance(session, AgentSession)
|
|
assert isinstance(session, DurableAgentSession)
|
|
|
|
|
|
class TestModelIntegration:
|
|
"""Test suite for integration between models."""
|
|
|
|
def test_session_id_string_format(self) -> None:
|
|
"""Test that AgentSessionId string format is consistent."""
|
|
session_id = AgentSessionId.with_random_key("AgentEntity")
|
|
session_id_str = str(session_id)
|
|
|
|
assert session_id_str.startswith("@AgentEntity@")
|
|
|
|
def test_session_with_durable_id_preserves_on_serialization(self) -> None:
|
|
"""Test that session with durable session ID preserves it through serialization."""
|
|
session_id = AgentSessionId(name="TestAgent", key="preserved-key")
|
|
session = DurableAgentSession.from_session_id(session_id)
|
|
|
|
# Serialize and deserialize
|
|
serialized = session.to_dict()
|
|
restored = DurableAgentSession.from_dict(serialized)
|
|
|
|
# Durable session ID should be preserved
|
|
assert restored.durable_session_id is not None
|
|
assert restored.durable_session_id.name == "TestAgent"
|
|
assert restored.durable_session_id.key == "preserved-key"
|
|
|
|
|
|
if __name__ == "__main__":
|
|
pytest.main([__file__, "-v", "--tb=short"])
|