Skip to content

Commit 4818109

Browse files
authored
chore: Add X-Goog-Api-Client metric header to Auth and FCM requests (#2738)
* [chore] Add `X-Goog-Api-Client` metric header to Auth and FCM requests * trigger integration tests
1 parent 0d21e94 commit 4818109

File tree

4 files changed

+8
-2
lines changed

4 files changed

+8
-2
lines changed

src/auth/auth-api-request.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,9 @@ import {
4545
import { ProjectConfig, ProjectConfigServerResponse, UpdateProjectConfigRequest } from './project-config';
4646

4747
/** Firebase Auth request header. */
48-
const FIREBASE_AUTH_HEADER = {
48+
const FIREBASE_AUTH_HEADERS = {
4949
'X-Client-Version': `Node/Admin/${utils.getSdkVersion()}`,
50+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${utils.getSdkVersion()}`
5051
};
5152
/** Firebase Auth request timeout duration in milliseconds. */
5253
const FIREBASE_AUTH_TIMEOUT = 25000;
@@ -1919,7 +1920,7 @@ export abstract class AbstractAuthRequestHandler {
19191920
const req: HttpRequestConfig = {
19201921
method: apiSettings.getHttpMethod(),
19211922
url,
1922-
headers: FIREBASE_AUTH_HEADER,
1923+
headers: FIREBASE_AUTH_HEADERS,
19231924
data: requestData,
19241925
timeout: FIREBASE_AUTH_TIMEOUT,
19251926
};

src/messaging/messaging-api-request-internal.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,11 @@ const FIREBASE_MESSAGING_BATCH_URL = 'https://fcm.googleapis.com/batch';
3333
const FIREBASE_MESSAGING_HTTP_METHOD: HttpMethod = 'POST';
3434
const FIREBASE_MESSAGING_HEADERS = {
3535
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
36+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`
3637
};
3738
const LEGACY_FIREBASE_MESSAGING_HEADERS = {
3839
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
40+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
3941
'access_token_auth': 'true',
4042
};
4143

test/unit/auth/auth-api-request.spec.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -863,10 +863,12 @@ AUTH_REQUEST_HANDLER_TESTS.forEach((handler) => {
863863
const mockAccessToken: string = utils.generateRandomAccessToken();
864864
const expectedHeaders: {[key: string]: string} = {
865865
'X-Client-Version': `Node/Admin/${getSdkVersion()}`,
866+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
866867
'Authorization': 'Bearer ' + mockAccessToken,
867868
};
868869
const expectedHeadersEmulator: {[key: string]: string} = {
869870
'X-Client-Version': `Node/Admin/${getSdkVersion()}`,
871+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
870872
'Authorization': 'Bearer owner',
871873
};
872874
const callParams = (path: string, method: any, data: any): HttpRequestConfig => {

test/unit/messaging/messaging.spec.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -357,6 +357,7 @@ describe('Messaging', () => {
357357
const expectedHeaders = {
358358
'Authorization': 'Bearer ' + mockAccessToken,
359359
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
360+
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
360361
'access_token_auth': 'true',
361362
};
362363
const emptyResponse = utils.responseFrom({});

0 commit comments

Comments
 (0)