Python: [BREAKING] PR2 — Wire context provider pipeline, remove old types, update all consumers (#3850)

* 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
This commit is contained in:
Eduard van Valkenburg
2026-02-12 22:00:32 +01:00
committed by GitHub
Unverified
parent 0c67dbbce5
commit 1e350ea22f
312 changed files with 6669 additions and 11423 deletions
@@ -13,10 +13,10 @@ from agent_framework import (
AgentMiddlewareTypes,
AgentResponse,
AgentResponseUpdate,
AgentThread,
AgentSession,
BaseAgent,
BaseContextProvider,
Content,
ContextProvider,
Message,
ResponseStream,
normalize_messages,
@@ -149,7 +149,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
id: str | None = None,
name: str | None = None,
description: str | None = None,
context_provider: ContextProvider | None = None,
context_providers: Sequence[BaseContextProvider] | None = None,
middleware: Sequence[AgentMiddlewareTypes] | None = None,
tools: FunctionTool
| Callable[..., Any]
@@ -171,7 +171,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
id: ID of the GitHubCopilotAgent.
name: Name of the GitHubCopilotAgent.
description: Description of the GitHubCopilotAgent.
context_provider: Context Provider, to be used by the agent.
context_providers: Context Providers, to be used by the agent.
middleware: Agent middleware used by the agent.
tools: Tools to use for the agent. Can be functions
or tool definition dicts. These are converted to Copilot SDK tools internally.
@@ -187,7 +187,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
id=id,
name=name,
description=description,
context_provider=context_provider,
context_providers=context_providers,
middleware=list(middleware) if middleware else None,
)
@@ -280,7 +280,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
messages: str | Message | Sequence[str | Message] | None = None,
*,
stream: Literal[False] = False,
thread: AgentThread | None = None,
session: AgentSession | None = None,
options: OptionsT | None = None,
**kwargs: Any,
) -> Awaitable[AgentResponse]: ...
@@ -291,7 +291,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
messages: str | Message | Sequence[str | Message] | None = None,
*,
stream: Literal[True],
thread: AgentThread | None = None,
session: AgentSession | None = None,
options: OptionsT | None = None,
**kwargs: Any,
) -> ResponseStream[AgentResponseUpdate, AgentResponse]: ...
@@ -301,7 +301,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
messages: str | Message | Sequence[str | Message] | None = None,
*,
stream: bool = False,
thread: AgentThread | None = None,
session: AgentSession | None = None,
options: OptionsT | None = None,
**kwargs: Any,
) -> Awaitable[AgentResponse] | ResponseStream[AgentResponseUpdate, AgentResponse]:
@@ -316,7 +316,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
Keyword Args:
stream: Whether to stream the response. Defaults to False.
thread: The conversation thread associated with the message(s).
session: The conversation session associated with the message(s).
options: Runtime options (model, timeout, etc.).
kwargs: Additional keyword arguments.
@@ -333,16 +333,16 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
return AgentResponse.from_updates(updates)
return ResponseStream(
self._stream_updates(messages=messages, thread=thread, options=options, **kwargs),
self._stream_updates(messages=messages, session=session, options=options, **kwargs),
finalizer=_finalize,
)
return self._run_impl(messages=messages, thread=thread, options=options, **kwargs)
return self._run_impl(messages=messages, session=session, options=options, **kwargs)
async def _run_impl(
self,
messages: str | Message | Sequence[str | Message] | None = None,
*,
thread: AgentThread | None = None,
session: AgentSession | None = None,
options: OptionsT | None = None,
**kwargs: Any,
) -> AgentResponse:
@@ -350,18 +350,18 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
if not self._started:
await self.start()
if not thread:
thread = self.get_new_thread()
if not session:
session = self.create_session()
opts: dict[str, Any] = dict(options) if options else {}
timeout = opts.pop("timeout", None) or self._settings["timeout"] or DEFAULT_TIMEOUT_SECONDS
session = await self._get_or_create_session(thread, streaming=False, runtime_options=opts)
copilot_session = await self._get_or_create_session(session, streaming=False, runtime_options=opts)
input_messages = normalize_messages(messages)
prompt = "\n".join([message.text for message in input_messages])
try:
response_event = await session.send_and_wait({"prompt": prompt}, timeout=timeout)
response_event = await copilot_session.send_and_wait({"prompt": prompt}, timeout=timeout)
except Exception as ex:
raise ServiceException(f"GitHub Copilot request failed: {ex}") from ex
@@ -390,7 +390,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
self,
messages: str | Message | Sequence[str | Message] | None = None,
*,
thread: AgentThread | None = None,
session: AgentSession | None = None,
options: OptionsT | None = None,
**kwargs: Any,
) -> AsyncIterable[AgentResponseUpdate]:
@@ -400,7 +400,7 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
messages: The message(s) to send to the agent.
Keyword Args:
thread: The conversation thread associated with the message(s).
session: The conversation session associated with the message(s).
options: Runtime options (model, timeout, etc.).
kwargs: Additional keyword arguments.
@@ -413,12 +413,12 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
if not self._started:
await self.start()
if not thread:
thread = self.get_new_thread()
if not session:
session = self.create_session()
opts: dict[str, Any] = dict(options) if options else {}
session = await self._get_or_create_session(thread, streaming=True, runtime_options=opts)
copilot_session = await self._get_or_create_session(session, streaming=True, runtime_options=opts)
input_messages = normalize_messages(messages)
prompt = "\n".join([message.text for message in input_messages])
@@ -441,10 +441,10 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
error_msg = event.data.message or "Unknown error"
queue.put_nowait(ServiceException(f"GitHub Copilot session error: {error_msg}"))
unsubscribe = session.on(event_handler)
unsubscribe = copilot_session.on(event_handler)
try:
await session.send({"prompt": prompt})
await copilot_session.send({"prompt": prompt})
while (item := await queue.get()) is not None:
if isinstance(item, Exception):
@@ -530,14 +530,14 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
async def _get_or_create_session(
self,
thread: AgentThread,
agent_session: AgentSession,
streaming: bool = False,
runtime_options: dict[str, Any] | None = None,
) -> CopilotSession:
"""Get an existing session or create a new one for the thread.
"""Get an existing session or create a new one for the session.
Args:
thread: The conversation thread.
agent_session: The conversation session.
streaming: Whether to enable streaming for the session.
runtime_options: Runtime options from run that take precedence.
@@ -551,11 +551,11 @@ class GitHubCopilotAgent(BaseAgent, Generic[OptionsT]):
raise ServiceException("GitHub Copilot client not initialized. Call start() first.")
try:
if thread.service_thread_id:
return await self._resume_session(thread.service_thread_id, streaming)
if agent_session.service_session_id:
return await self._resume_session(agent_session.service_session_id, streaming)
session = await self._create_session(streaming, runtime_options)
thread.service_thread_id = session.session_id
agent_session.service_session_id = session.session_id
return session
except Exception as ex:
raise ServiceException(f"Failed to create GitHub Copilot session: {ex}") from ex
@@ -10,7 +10,7 @@ import pytest
from agent_framework import (
AgentResponse,
AgentResponseUpdate,
AgentThread,
AgentSession,
Content,
Message,
)
@@ -300,21 +300,21 @@ class TestGitHubCopilotAgentRun:
assert isinstance(response, AgentResponse)
assert len(response.messages) == 1
async def test_run_with_thread(
async def test_run_with_session(
self,
mock_client: MagicMock,
mock_session: MagicMock,
assistant_message_event: SessionEvent,
) -> None:
"""Test run method with existing thread."""
"""Test run method with existing session."""
mock_session.send_and_wait.return_value = assistant_message_event
agent = GitHubCopilotAgent(client=mock_client)
thread = AgentThread()
response = await agent.run("Hello", thread=thread)
session = AgentSession()
response = await agent.run("Hello", session=session)
assert isinstance(response, AgentResponse)
assert thread.service_thread_id == mock_session.session_id
assert session.service_session_id == mock_session.session_id
async def test_run_with_runtime_options(
self,
@@ -392,13 +392,13 @@ class TestGitHubCopilotAgentRunStreaming:
assert responses[0].role == "assistant"
assert responses[0].contents[0].text == "Hello"
async def test_run_streaming_with_thread(
async def test_run_streaming_with_session(
self,
mock_client: MagicMock,
mock_session: MagicMock,
session_idle_event: SessionEvent,
) -> None:
"""Test streaming with existing thread."""
"""Test streaming with existing session."""
def mock_on(handler: Any) -> Any:
handler(session_idle_event)
@@ -407,12 +407,12 @@ class TestGitHubCopilotAgentRunStreaming:
mock_session.on = mock_on
agent = GitHubCopilotAgent(client=mock_client)
thread = AgentThread()
session = AgentSession()
async for _ in agent.run("Hello", thread=thread, stream=True):
async for _ in agent.run("Hello", session=session, stream=True):
pass
assert thread.service_thread_id == mock_session.session_id
assert session.service_session_id == mock_session.session_id
async def test_run_streaming_error(
self,
@@ -461,20 +461,20 @@ class TestGitHubCopilotAgentRunStreaming:
class TestGitHubCopilotAgentSessionManagement:
"""Test cases for session management."""
async def test_session_resumed_for_same_thread(
async def test_session_resumed_for_same_session(
self,
mock_client: MagicMock,
mock_session: MagicMock,
assistant_message_event: SessionEvent,
) -> None:
"""Test that subsequent calls on the same thread resume the session."""
"""Test that subsequent calls on the same session resume the session."""
mock_session.send_and_wait.return_value = assistant_message_event
agent = GitHubCopilotAgent(client=mock_client)
thread = AgentThread()
session = AgentSession()
await agent.run("Hello", thread=thread)
await agent.run("World", thread=thread)
await agent.run("Hello", session=session)
await agent.run("World", session=session)
mock_client.create_session.assert_called_once()
mock_client.resume_session.assert_called_once_with(mock_session.session_id, unittest.mock.ANY)
@@ -490,7 +490,7 @@ class TestGitHubCopilotAgentSessionManagement:
)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -508,7 +508,7 @@ class TestGitHubCopilotAgentSessionManagement:
)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -531,7 +531,7 @@ class TestGitHubCopilotAgentSessionManagement:
"system_message": {"mode": "replace", "content": "Runtime instructions"}
}
await agent._get_or_create_session( # type: ignore
AgentThread(),
AgentSession(),
runtime_options=runtime_options,
)
@@ -549,25 +549,25 @@ class TestGitHubCopilotAgentSessionManagement:
agent = GitHubCopilotAgent(client=mock_client)
await agent.start()
await agent._get_or_create_session(AgentThread(), streaming=True) # type: ignore
await agent._get_or_create_session(AgentSession(), streaming=True) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
assert config["streaming"] is True
async def test_resume_session_with_existing_service_thread_id(
async def test_resume_session_with_existing_service_session_id(
self,
mock_client: MagicMock,
mock_session: MagicMock,
) -> None:
"""Test that session is resumed when thread has a service_thread_id."""
"""Test that session is resumed when session has a service_session_id."""
agent = GitHubCopilotAgent(client=mock_client)
await agent.start()
thread = AgentThread()
thread.service_thread_id = "existing-session-id"
session = AgentSession()
session.service_session_id = "existing-session-id"
await agent._get_or_create_session(thread) # type: ignore
await agent._get_or_create_session(session) # type: ignore
mock_client.create_session.assert_not_called()
mock_client.resume_session.assert_called_once()
@@ -596,10 +596,10 @@ class TestGitHubCopilotAgentSessionManagement:
)
await agent.start()
thread = AgentThread()
thread.service_thread_id = "existing-session-id"
session = AgentSession()
session.service_session_id = "existing-session-id"
await agent._get_or_create_session(thread) # type: ignore
await agent._get_or_create_session(session) # type: ignore
mock_client.resume_session.assert_called_once()
call_args = mock_client.resume_session.call_args
@@ -639,7 +639,7 @@ class TestGitHubCopilotAgentMCPServers:
)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -672,10 +672,10 @@ class TestGitHubCopilotAgentMCPServers:
)
await agent.start()
thread = AgentThread()
thread.service_thread_id = "existing-session-id"
session = AgentSession()
session.service_session_id = "existing-session-id"
await agent._get_or_create_session(thread) # type: ignore
await agent._get_or_create_session(session) # type: ignore
mock_client.resume_session.assert_called_once()
call_args = mock_client.resume_session.call_args
@@ -692,7 +692,7 @@ class TestGitHubCopilotAgentMCPServers:
agent = GitHubCopilotAgent(client=mock_client)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -716,7 +716,7 @@ class TestGitHubCopilotAgentToolConversion:
agent = GitHubCopilotAgent(client=mock_client, tools=[my_tool])
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -739,7 +739,7 @@ class TestGitHubCopilotAgentToolConversion:
agent = GitHubCopilotAgent(client=mock_client, tools=[my_tool])
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -764,7 +764,7 @@ class TestGitHubCopilotAgentToolConversion:
agent = GitHubCopilotAgent(client=mock_client, tools=[failing_tool])
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -867,7 +867,7 @@ class TestGitHubCopilotAgentErrorHandling:
await agent.start()
with pytest.raises(ServiceException, match="Failed to create GitHub Copilot session"):
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
async def test_get_or_create_session_raises_when_client_not_initialized(self) -> None:
"""Test that _get_or_create_session raises ServiceException when client is not initialized."""
@@ -875,7 +875,7 @@ class TestGitHubCopilotAgentErrorHandling:
# Don't call start() - client remains None
with pytest.raises(ServiceException, match="GitHub Copilot client not initialized"):
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
class TestGitHubCopilotAgentPermissions:
@@ -919,7 +919,7 @@ class TestGitHubCopilotAgentPermissions:
)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]
@@ -935,7 +935,7 @@ class TestGitHubCopilotAgentPermissions:
agent = GitHubCopilotAgent(client=mock_client)
await agent.start()
await agent._get_or_create_session(AgentThread()) # type: ignore
await agent._get_or_create_session(AgentSession()) # type: ignore
call_args = mock_client.create_session.call_args
config = call_args[0][0]