Add copy constructors and Clone methods to the various .NET config option bags#422
Open
stephentoub wants to merge 2 commits intogithub:mainfrom
Open
Add copy constructors and Clone methods to the various .NET config option bags#422stephentoub wants to merge 2 commits intogithub:mainfrom
stephentoub wants to merge 2 commits intogithub:mainfrom
Conversation
…tion bags Consuming libraries like Agent Framework sometimes have a need to clone the various options bags, e.g. their caller passes in options and that middle library needs to tweak the settings before passing them along (e.g. set Streaming to true or false) but it doesn't want to mutate the caller's object. Without clone methods, such libraries need to manually copy every property, which then means when new properties are added, they get ignored and options are lost. This PR adds such public Clone methods, and accomodates the non-sealed nature of the types by adding protected copy constructors that the virtual Clone methods use. (If instead we want to seal these types, that'd be viable as well.)
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds cloning support to key .NET SDK option/config “bags” to let middle-layer libraries adjust settings without mutating caller-provided instances, by introducing protected copy constructors and public virtual Clone() methods.
Changes:
- Added protected copy constructors for
CopilotClientOptions,SessionConfig,ResumeSessionConfig, andMessageOptions. - Added public virtual
Clone()methods that use those copy constructors. - Implemented defensive copies for several collection properties (arrays/lists/dictionaries).
Comments suppressed due to low confidence (1)
dotnet/src/Types.cs:878
- Same as in
SessionConfig: cloningMcpServerswithnew Dictionary<string, object>(...)drops any custom key comparer from the original dictionary. If callers can pass in dictionaries with non-default comparers, preserve that comparer when cloning from aDictionary<string, object>instance.
InfiniteSessions = other.InfiniteSessions;
McpServers = other.McpServers is not null ? new Dictionary<string, object>(other.McpServers) : null;
Model = other.Model;
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Consuming libraries like Agent Framework sometimes have a need to clone the various options bags, e.g. their caller passes in options and that middle library needs to tweak the settings before passing them along (e.g. set Streaming to true or false) but it doesn't want to mutate the caller's object. Without clone methods, such libraries need to manually copy every property, which then means when new properties are added, they get ignored and options are lost.
This PR adds such public Clone methods, and accomodates the non-sealed nature of the types by adding protected copy constructors that the virtual Clone methods use. (If instead we want to seal these types, that'd be viable as well.)