Removing confusing field from CosmosDBStorageConfig by rodrigobr-msft · Pull Request #377 · microsoft/Agents-for-python

Rodrigo Brandão (rodrigobr-msft) · 2026-04-22T19:17:49Z

This pull request refactors the Cosmos DB storage configuration and client initialization to improve clarity and error handling. The main changes include removing the ambiguous url parameter in favor of a more clearly named cosmos_db_endpoint, updating client initialization logic to enforce required parameters, and improving error messages for missing configuration.

Configuration and parameter changes:

Removed the url parameter from the CosmosDBStorageConfig class and replaced all usages with cosmos_db_endpoint for clearer intent. [1][2][3][4]

Client initialization and validation improvements:

Updated the _create_client method in cosmos_db_storage.py to require cosmos_db_endpoint and either credential or auth_key, raising clear ValueErrors if these are missing. This ensures that clients are only created with valid configurations and provides more helpful error messages. [1][2]

Test updates:

Updated tests to use the new cosmos_db_endpoint parameter instead of the removed url parameter.

Rodrigo Brandão (rodrigobr-msft) · 2026-04-22T19:18:29Z

Awaiting completion of end-to-end test harness before merging this.

Copilot

Pull request overview

This PR refactors Cosmos DB storage configuration by removing the ambiguous url field in favor of cosmos_db_endpoint, and tightens Cosmos client creation by validating required configuration up-front.

Changes:

Removes url from CosmosDBStorageConfig and updates configuration usage to cosmos_db_endpoint.
Updates CosmosDBStorage._create_client() to require cosmos_db_endpoint and either credential or auth_key, with clearer ValueErrors.
Updates Cosmos storage tests to use cosmos_db_endpoint.

Reviewed changes

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

File	Description
tests/storage_cosmos/test_cosmos_db_storage.py	Updates Azure-credential test setup to pass `cosmos_db_endpoint` instead of the removed `url`.
libraries/microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py	Removes the `url` config field/param and its docstring mention.
libraries/microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage.py	Adds stricter client initialization validation and improved configuration error handling.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…or of `|`

Copilot

Pull request overview

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

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

Copilot

Pull request overview

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

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

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

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

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

Copilot

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Copilot

Pull request overview

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

@@ -36,9 +36,8 @@ def __init__(
 key characters. (e.g. not: '\\', '?', '/', '#', '*')


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

Copilot

Pull request overview

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

 cred = DefaultAzureCredential()
-url = os.environ.get("TEST_COSMOS_DB_ENDPOINT")
+cosmos_db_endpoint = os.environ.get("TEST_COSMOS_DB_ENDPOINT", "")
 config = CosmosDBStorageConfig(
-url=url,
+cosmos_db_endpoint=cosmos_db_endpoint,
 credential=cred,


+ if "url" in kwargs:
+ warnings.warn(
+ "The 'url' parameter is deprecated. Please use 'cosmos_db_endpoint' instead.",
+ DeprecationWarning,
+ stacklevel=2,


Copilot

Pull request overview

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

CopilotAI review requested due to automatic review settings April 22, 2026 19:17

Rodrigo Brandão (rodrigobr-msft) linked an issue Apr 22, 2026 that may be closed by this pull request
Simplify CosmosDBStorage configuration #330
Open

Copilotstarted reviewing on behalf of Rodrigo Brandão (rodrigobr-msft)April 22, 2026 19:18 View session

CopilotAI reviewed Apr 22, 2026
View reviewed changes

Rodrigo Brandão (rodrigobr-msft)and others added 2 commits June 30, 2026 14:21

Removing confusing field from CosmosDBStorageConfig
07ef52a

raise error for url in kwargs
71d32dc

Kyle Rohn (kylerohn-msft)force-pushed the users/robrandao/cosmos-config branch from cfa398d to 71d32dcCompare June 30, 2026 21:24

Kyle Rohn (kylerohn-msft) added 2 commits June 30, 2026 14:47

use specific errors, fix docstring specificity, remove Union in fav…
ae8ceeb
…or of `|`

update unit tests
97f8851

CopilotAI review requested due to automatic review settings June 30, 2026 21:49

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)June 30, 2026 21:50 View session

CopilotAI reviewed Jun 30, 2026
View reviewed changes

Comment threadlibraries/microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage.py Outdated
Comment thread.../microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py

Kyle Rohn (kylerohn-msft)and others added 2 commits June 30, 2026 15:01

fix error representations
617851a

Use standardized error message instance
56eafe7
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings June 30, 2026 22:04

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)June 30, 2026 22:05 View session

CopilotAI reviewed Jun 30, 2026
View reviewed changes

Comment thread.../microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py
Comment threadtests/storage_cosmos/test_cosmos_db_storage.py Outdated
Comment threadtests/storage_cosmos/test_cosmos_db_storage.py Outdated

More robust assertion for testing empty cosmos endpoint
65d952e
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings June 30, 2026 22:13

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)June 30, 2026 22:14 View session

More robust assertion for testing empty authorization
bcc4356
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

CopilotAI reviewed Jun 30, 2026
View reviewed changes

Comment threadtests/storage_cosmos/test_cosmos_db_storage.py

CopilotAI review requested due to automatic review settings June 30, 2026 22:17

Copilotstarted reviewing on behalf of Rodrigo Brandão (rodrigobr-msft)June 30, 2026 22:18 View session

CopilotAI reviewed Jun 30, 2026
View reviewed changes

Comment thread.../microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py Outdated
Comment thread.../microsoft-agents-storage-cosmos/microsoft_agents/storage/cosmos/cosmos_db_storage_config.py

Specify ambiguous message
35251a6
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings July 1, 2026 17:44

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)July 1, 2026 17:45 View session

CopilotAI reviewed Jul 1, 2026
View reviewed changes

Comment threadtests/storage_cosmos/test_cosmos_db_storage.py

change url error to dep warning
edad8cc

Kyle Rohn (kylerohn-msft) requested a review from Axel Suárez (axelsrz)July 1, 2026 18:02

Kyle Rohn (kylerohn-msft) marked this pull request as ready for review July 1, 2026 19:00

Kyle Rohn (kylerohn-msft) requested a review from a team as a code owner July 1, 2026 19:00

CopilotAI review requested due to automatic review settings July 1, 2026 19:00

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)July 1, 2026 19:00 View session

CopilotAI reviewed Jul 1, 2026
View reviewed changes

Potential fix for pull request finding
a996c26
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

CopilotAI review requested due to automatic review settings July 13, 2026 18:44

Copilotstarted reviewing on behalf of Kyle Rohn (kylerohn-msft)July 13, 2026 18:48 View session

use logging instead of warnings
c508cbb

CopilotAI reviewed Jul 13, 2026
View reviewed changes

CopilotAI review requested due to automatic review settings July 13, 2026 18:53

Copilotstarted reviewing on behalf of Rodrigo Brandão (rodrigobr-msft)July 13, 2026 18:54 View session

CopilotAI reviewed Jul 13, 2026
View reviewed changes

		@@ -36,9 +36,8 @@ def __init__(
		key characters. (e.g. not: '\\', '?', '/', '#', '*')

Uh oh!

Conversation

Rodrigo Brandão (rodrigobr-msft) commented Apr 22, 2026

Uh oh!

Rodrigo Brandão (rodrigobr-msft) commented Apr 22, 2026

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants