FIX:Fix HttpTool config round-trip in StaticStreamWorkbench when headers is None#7180
Open
yyf0101 wants to merge 1 commit intomicrosoft:mainfrom
Open
FIX:Fix HttpTool config round-trip in StaticStreamWorkbench when headers is None#7180yyf0101 wants to merge 1 commit intomicrosoft:mainfrom
yyf0101 wants to merge 1 commit intomicrosoft:mainfrom
Conversation
Author
|
@microsoft-github-policy-service agree |
Author
|
@ekzhu hi Eric ,could you please take a look at this PR (fix for #7172)? When an HttpTool is created with headers=None and put into a StaticStreamWorkbench , dump_component() uses exclude_none=True and drops headers from the serialized config, then _from_config() fails under Pydantic v2 with headers missing . This breaks workbench save/restore and config round-trips. The PR makes HttpToolConfig.headers default to None (so missing is OK) and adds a regression test for the round-trip. Thanks! |
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.
Why are these changes needed?
What This PR fixes a ValidationError when round-tripping a StaticStreamWorkbench containing an HttpTool created with headers=None via _to_config() / _from_config() .
Why Component.dump_component() serializes configs with exclude_none=True , which drops fields whose value is None . HttpToolConfig.headers was annotated as Optional[...] but had no default, making it required under Pydantic v2. As a result, the serialized config omitted headers , and loading failed with: headers: Field required [type=missing] .
Changes
Set defaults in HttpToolConfig :
Add regression test to ensure workbench config round-trip works when headers is None .
Tests
python -m pytest packages/autogen-ext/tests/tools/http/test_http_tool.py -k test_workbench_from_config_with_missing_headers_field
Related issue number
Closes #7172
Checks