Visitar URL original
.NET: [BREAKING] Add GetNewThread overload for taking a ChatMessageStore at thread creation time by westey-m · Pull Request #2429 · microsoft/agent-framework · GitHub
Skip to content

.NET: [BREAKING] Add GetNewThread overload for taking a ChatMessageStore at thread creation time - #2429

Merged
westey (westey-m) merged 7 commits into
microsoft:mainfrom
westey-m:chatclientagent-getnewthread-store-overload
Nov 25, 2025
Merged

.NET: [BREAKING] Add GetNewThread overload for taking a ChatMessageStore at thread creation time#2429
westey (westey-m) merged 7 commits into
microsoft:mainfrom
westey-m:chatclientagent-getnewthread-store-overload

Conversation

@westey-m

@westey-m westey (westey-m) commented Nov 24, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Motivation and Context

In some cases users may need to provide a custom ChatMessageStore to a ChatClientAgent when they create the thread, instead of via a factory. E.g. when users need to do some async processing to generate a custom thread id.
Users may also want to access the message store object from the thread before doing the first run, to update it for their specific scenario.

#2325

Description

  • Add GetNewThread overload for taking a ChatMessageStore at thread creation time
  • Move message store creation to thread creation time, so it can be accessed before the first run.

Contribution Checklist

  • The code builds clean without any errors or warnings
  • The PR follows the Contribution Guidelines
  • All unit tests pass, and I have added new tests where possible
  • Is this a breaking change? If yes, add "[BREAKING]" prefix to the title of the PR.

@westey-m
Add GetNewThread overload for taking a ChatMessageStore at thread cre…
2c7d73c 
…ation time and move message store creation to thread creation time.
Copilot AI review requested due to automatic review settings November 24, 2025 17:02
@markwallace-microsoft Mark Wallace (markwallace-microsoft) added the .NET Usage: [Issues, PRs], Target: .Net label Nov 24, 2025
@github-actions github-actions Bot changed the title Add GetNewThread overload for taking a ChatMessageStore at thread creation time .NET: Add GetNewThread overload for taking a ChatMessageStore at thread creation time Nov 24, 2025
Copilot AI reviewed Nov 24, 2025
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds a new GetNewThread(ChatMessageStore) overload that allows users to provide a custom ChatMessageStore instance at thread creation time, addressing scenarios where async processing is needed to generate a custom thread ID or where users need to access the message store before the first run.

Key Changes

  • Adds GetNewThread(ChatMessageStore) overload for directly providing a message store instance
  • Moves message store creation from lazy initialization (during first run) to eager initialization (at thread creation time) when using ChatMessageStoreFactory
  • Updates test coverage with new test files and modified existing tests to validate the new behavior

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgent.cs Adds new GetNewThread(ChatMessageStore) overload with XML documentation and modifies parameterless GetNewThread() to eagerly create message store from factory
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgent_GetNewThreadTests.cs New test file covering GetNewThread() overloads with factory and parameter-based scenarios
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgent_DeserializeThreadTests.cs New test file covering DeserializeThread() with factory scenarios
dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs Refactors and adds tests for the new eager initialization behavior, including validation that exceptions are thrown when both ConversationId and MessageStore are used together

Comment thread dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgent.cs Resolved
Comment thread dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgent.cs Resolved
Comment thread dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs Resolved
@westey-m westey (westey-m) changed the title .NET: Add GetNewThread overload for taking a ChatMessageStore at thread creation time .NET: [BREAKING] Add GetNewThread overload for taking a ChatMessageStore at thread creation time Nov 24, 2025
rogerbarreto
Roger Barreto (rogerbarreto) reviewed Nov 25, 2025
View reviewed changes
Comment thread dotnet/src/Microsoft.Agents.AI/ChatClient/ChatClientAgent.cs Resolved
@westey-m @rogerbarreto
Apply suggestion from @rogerbarreto
246fc8c 
Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>
This was referenced Dec 15, 2025
Closed
Closed
Closed
Closed
Merged
Merged
Closed
Closed
Closed
@dependabot dependabot Bot mentioned this pull request Dec 22, 2025
Closed
@dependabot dependabot Bot mentioned this pull request Jan 1, 2026
Merged
This was referenced Jan 12, 2026
Closed
Closed
This was referenced Jan 19, 2026
Closed
Closed
Closed
Closed
@dependabot dependabot Bot mentioned this pull request Feb 2, 2026
Closed
Aris Nguyen (arisng) pushed a commit to arisng/agent-framework that referenced this pull request Feb 2, 2026
@westey-m @rogerbarreto
.NET: [BREAKING] Add GetNewThread overload for taking a ChatMessageSt…
1b41ebd 
…ore at thread creation time (microsoft#2429)

* Add GetNewThread overload for taking a ChatMessageStore at thread creation time and move message store creation to thread creation time.

* Fix formatting.

* Apply suggestions from code review

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

* Apply suggestion from @rogerbarreto

Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com>
This was referenced Feb 2, 2026
Open
Closed
@dependabot dependabot Bot mentioned this pull request Feb 16, 2026
Closed
@dependabot dependabot Bot mentioned this pull request Feb 23, 2026
Closed
@westey-m
westey (westey-m) deleted the chatclientagent-getnewthread-store-overload branch February 25, 2026 14:15
This was referenced Mar 2, 2026
Open
Closed
Open
Open
@dependabot dependabot Bot mentioned this pull request Mar 16, 2026
Merged
@dependabot dependabot Bot mentioned this pull request May 2, 2026
Closed

This branch was previously deployed

1 inactive deployment
integration — 246fc8c7 Deployed Nov 25, 2025 by westey-m via dotnet-build-and-test (net472, windows-latest, Release, true, integration) #7354
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@rogerbarreto Roger Barreto (rogerbarreto) rogerbarreto approved these changes
@SergeyMenshykh SergeyMenshykh SergeyMenshykh approved these changes

Assignees

No one assigned

Labels

.NET Usage: [Issues, PRs], Target: .Net

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@westey-m @rogerbarreto @SergeyMenshykh @markwallace-microsoft