Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dconeybe wants to merge 2 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47e7b00
data-connect-api-client-internal.ts: add "x-firebase-sqlconnect-affin…
dconeybe Jul 31, 2026
99549fa
data-connect-api-client-internal.ts: GetHeadersParameters added, to
dconeybe Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions src/data-connect/data-connect-api-client-internal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,11 +70,19 @@ const IMPERSONATE_MUTATION_ENDPOINT = 'impersonateMutation';
/** @internal The maximum number of items allowed in the @allow directive's maxCount argument. */
export const ALLOW_DIRECTIVE_MAX_COUNT = 10_000;

function getHeaders(isUsingGen: boolean): { [key: string]: string } {
interface GetHeadersParameters {
projectId: string;
serviceId: string;
isUsingGen: boolean;
}

function getHeaders(parameters: GetHeadersParameters): { [key: string]: string } {
const { projectId, serviceId, isUsingGen } = parameters;
const headerValue = {
'X-Firebase-Client': `fire-admin-node/${utils.getSdkVersion()}`,
'X-Goog-Api-Client': utils.getMetricsHeader(),
'X-Client-Version': `node/${utils.getSdkVersion()}`,
'X-Firebase-Sqlconnect-Affinity': `${projectId}${serviceId}`,
Comment thread
dconeybe marked this conversation as resolved.
};
if (isUsingGen) {
headerValue['X-Goog-Api-Client'] += ' admin-js/gen';
Expand Down Expand Up @@ -386,10 +394,15 @@ export class DataConnectApiClient {
*/
private async makeGqlRequest<GraphqlResponse>(url: string, data: object):
Promise<ExecuteGraphqlResponse<GraphqlResponse>> {
const projectId = await this.getProjectId();
const request: HttpRequestConfig = {
method: 'POST',
url,
headers: getHeaders(this.isUsingGen),
headers: getHeaders({
projectId,
serviceId: this.connectorConfig.serviceId,
isUsingGen: this.isUsingGen,
}),
data,
};
const resp = await this.httpClient.send(request);
Expand Down
3 changes: 3 additions & 0 deletions test/unit/data-connect/data-connect-api-client-internal.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,20 +54,23 @@ describe('DataConnectApiClient', () => {
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': getMetricsHeader(),
'X-Client-Version': `node/${getSdkVersion()}`,
'X-Firebase-Sqlconnect-Affinity': 'test-projectmy-service',
Comment thread
dconeybe marked this conversation as resolved.
};

const EXPECTED_HEADERS_WITH_GEN = {
'Authorization': 'Bearer mock-token',
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': getMetricsHeader() + ' admin-js/gen',
'X-Client-Version': `node/${getSdkVersion()}`,
'X-Firebase-Sqlconnect-Affinity': 'test-projectmy-service',
Comment thread
dconeybe marked this conversation as resolved.
};

const EMULATOR_EXPECTED_HEADERS = {
'Authorization': 'Bearer owner',
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': getMetricsHeader(),
'X-Client-Version': `node/${getSdkVersion()}`,
'X-Firebase-Sqlconnect-Affinity': 'test-projectmy-service',
Comment thread
dconeybe marked this conversation as resolved.
};

const noProjectId = 'Failed to determine project ID. Initialize the SDK with service '
Expand Down
Loading