Add client id to all request headers #42104
Merged
+50
−2
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR extends the inclusion of Client ID headers to all Cosmos DB requests, whereas previously it was only added to database account operations. The change ensures consistent client identification across all API calls.
- Adds
client_id=self.client_idparameter to allbase.GetHeaders()calls in both sync and async client connections - Adds comprehensive test coverage to verify Client ID is included in request headers
- Updates changelog to document this enhancement
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
_cosmos_client_connection_async.py |
Updates all async operation methods to include client_id parameter in headers |
_cosmos_client_connection.py |
Updates all sync operation methods to include client_id parameter in headers |
test_headers_async.py |
Adds async test to verify Client ID presence in request headers |
test_headers.py |
Adds sync test to verify Client ID presence in request headers |
CHANGELOG.md |
Documents the Client ID header enhancement |
Comments suppressed due to low confidence (2)
sdk/cosmos/azure-cosmos/tests/test_headers_async.py:227
- The test only verifies Client ID inclusion for read_item operations. Since the PR claims to add Client ID to 'all requests', consider testing other operation types (create, update, delete, query) to ensure comprehensive coverage.
await self.container.read_item(item="id-1", partition_key="pk-1")
sdk/cosmos/azure-cosmos/tests/test_headers.py:113
- The test only verifies Client ID inclusion for read_item operations. Since the PR claims to add Client ID to 'all requests', consider testing other operation types (create, update, delete, query) to ensure comprehensive coverage.
self.container.read_item(item="id-1", partition_key="pk-1")
xinlian12
reviewed
Jul 22, 2025
xinlian12
reviewed
Jul 22, 2025
sdk/cosmos/azure-cosmos/azure/cosmos/aio/_cosmos_client_connection_async.py
Outdated
Show resolved
Hide resolved
simorenoh
approved these changes
Jul 22, 2025
update client connection to not pass in client id and instead have it set to headers in base.getheaders
simorenoh
approved these changes
Jul 25, 2025
simorenoh
reviewed
Jul 25, 2025
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.
Description
Previously, Client ID was only included in the headers when doing database account operations. It will now be included in every request/response.