dataconnect(change): add "X-Client-Platform" and "X-Client-Version" headers - #8486
dataconnect(change): add "X-Client-Platform" and "X-Client-Version" headers#8486dconeybe wants to merge 4 commits into
Conversation
…sion" headers Googlers see go/dataconnect:sdk:headers for details
|
/gemini review |
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces gRPC request headers for the client platform and SDK version to enable metrics collection in cloud monitoring, updating the metadata generation and adding corresponding integration and unit tests. The review feedback suggests defining these new header keys in lowercase (e.g., x-client-platform and x-client-version) to align with gRPC/HTTP2 standards and maintain consistency across the codebase and tests.
…Client-Version" strings gRPC and HTTP/2 headers are case-insensitive and are required to be lowercase on the wire. Defining metadata keys with uppercase characters (like `X-Client-Platform` and `X-Client-Version`) is inconsistent with the other headers defined in this file (which are all lowercase, e.g., `x-goog-request-params`, `x-firebase-gmpid`) and can lead to confusion or potential issues with case-sensitive interceptors or mocks. It is highly recommended to define these keys in lowercase. #8486 (comment)
📝 PRs merging into main branchOur main branch should always be in a releasable state. If you are working on a larger change, or if you don't want this change to see the light of the day just yet, consider using a feature branch first, and only merge into the main branch when the code complete and ready to be released. |
dconeybe
changed the title
1 participant
This PR adds
x-client-platformandx-client-versiongRPC request headers to thefirebase-dataconnectSDK. These headers supply the client platform (android) and SDK version to enable metrics collection in Cloud Monitoring.Highlights
x-client-platform(set to"android") andx-client-version(set to the SDK version) headers toDataConnectGrpcMetadatato enable Cloud Monitoring metrics collection.DataConnectGrpcMetadataUnitTest,DataConnectGrpcRPCsUnitTest, andGrpcMetadataIntegrationTestto verify thatx-client-platformandx-client-versionheaders are included in all gRPC requests (executeQuery,executeMutation, andconnect).CHANGELOG.mdunderfirebase-dataconnect.Changelog
x-client-platformandx-client-versionheader keys and included them in outgoing gRPC metadata.x-client-platformandx-client-versionheaders are present in integration tests.testMetadataIncludesHeaderand added unit tests forx-client-platformandx-client-version.HeaderCapturingServerInterceptorand unit tests verifyingx-client-platformandx-client-versionheaders acrossexecuteQuery,executeMutation, andconnectRPCs.