Skip to content

dataconnect(change): add "X-Firebase-Sqlconnect-Affinity" header for GSLB soft stickiness - #8499

Open
dconeybe wants to merge 6 commits into
mainfrom
dconeybe/dataconnect/GslbStickiness
Open

dataconnect(change): add "X-Firebase-Sqlconnect-Affinity" header for GSLB soft stickiness#8499
dconeybe wants to merge 6 commits into
mainfrom
dconeybe/dataconnect/GslbStickiness

Conversation

@dconeybe

@dconeybe dconeybe commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

This PR adds the x-firebase-sqlconnect-affinity gRPC request header to outgoing Data Connect gRPC requests. This header enables backend server affinity routing for SQL Connect to improve server resource usage efficiency and performance.

Highlights

  • SQL Connect Server Affinity Header: Added the x-firebase-sqlconnect-affinity header containing ${projectId}${connectorServiceId} to DataConnectGrpcMetadata.
  • Unit and Integration Test Coverage: Added unit tests in DataConnectGrpcMetadataUnitTest and DataConnectGrpcRPCsUnitTest, and integration test assertions in GrpcMetadataIntegrationTest to verify the header key and formatted value.
Changelog
  • CHANGELOG.md
    • Added unreleased entry for the SQL Connect server affinity header.
  • DataConnectGrpcMetadata.kt
    • Added connectorServiceId and projectId properties to DataConnectGrpcMetadata.
    • Added sqlConnectAffinityHeader key (x-firebase-sqlconnect-affinity) and included ${projectId}${connectorServiceId} in metadata.
    • Updated forSystemVersions to accept projectId and connectorServiceId.
  • FirebaseDataConnectImpl.kt
    • Passed projectId and config.serviceId to DataConnectGrpcMetadata.forSystemVersions().
  • GrpcMetadataIntegrationTest.kt
    • Added assertion for x-firebase-sqlconnect-affinity header.
  • DataConnectGrpcMetadataUnitTest.kt
    • Added unit test verifying x-firebase-sqlconnect-affinity header inclusion.
    • Updated forSystemVersions() test assertions.
  • DataConnectGrpcRPCsUnitTest.kt
    • Added unit tests verifying x-firebase-sqlconnect-affinity header for executeQuery, executeMutation, and connect.
  • arbs.kt
    • Updated dataConnectGrpcMetadata arbitrary generator to include connectorServiceId and projectId.

dconeybe added 4 commits July 30, 2026 16:59
…er, but use appId/connectorLocation as the value for now for simplicity.

A future commit will fix this to use projectId/connectorServiceId.
… the

"X-Firebase-SqlConnect-Affinity" header value
"X-Firebase-SqlConnect-Affinity" header value
@gemini-code-assist

Copy link
Copy Markdown
Contributor
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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.

@dconeybe

Copy link
Copy Markdown
Contributor Author

/gemini review

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a new gRPC request header, x-firebase-sqlconnect-affinity, to support SQL Connect server affinity, which improves server resource usage efficiency and performance. To implement this, DataConnectGrpcMetadata has been updated to accept and include the projectId and connectorServiceId in the metadata headers. The changes are accompanied by corresponding updates to integration and unit tests. The reviewer noted that the placeholder #NNNN in the CHANGELOG.md should be replaced with the actual pull request number before merging.

Comment thread firebase-dataconnect/CHANGELOG.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

📝 PRs merging into main branch

Our 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 dconeybe changed the title dataconnect(change): add "X-Firebase-Sqlconnect-Affinity" header dataconnect(change): add "X-Firebase-Sqlconnect-Affinity" header for GSLB soft stickiness Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant