Skip to content

chore: Add X-Goog-Api-Client metric header to Auth and FCM requests #2738

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

Merged
merged 3 commits into from
Oct 23, 2024
Merged

chore: Add X-Goog-Api-Client metric header to Auth and FCM requests #2738

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
769976d
[chore] Add `X-Goog-Api-Client` metric header to Auth and FCM requests
jonathanedey Oct 23, 2024
23d08d0
Merge branch 'master' into je-headers
jonathanedey Oct 23, 2024
4e03f5b
trigger integration tests
jonathanedey Oct 23, 2024
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
5 changes: 3 additions & 2 deletions src/auth/auth-api-request.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ import {
import { ProjectConfig, ProjectConfigServerResponse, UpdateProjectConfigRequest } from './project-config';

/** Firebase Auth request header. */
const FIREBASE_AUTH_HEADER = {
const FIREBASE_AUTH_HEADERS = {
'X-Client-Version': `Node/Admin/${utils.getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${utils.getSdkVersion()}`
};
/** Firebase Auth request timeout duration in milliseconds. */
const FIREBASE_AUTH_TIMEOUT = 25000;
Expand Down Expand Up @@ -1919,7 +1920,7 @@ export abstract class AbstractAuthRequestHandler {
const req: HttpRequestConfig = {
method: apiSettings.getHttpMethod(),
url,
headers: FIREBASE_AUTH_HEADER,
headers: FIREBASE_AUTH_HEADERS,
data: requestData,
timeout: FIREBASE_AUTH_TIMEOUT,
};
Expand Down
2 changes: 2 additions & 0 deletions src/messaging/messaging-api-request-internal.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,11 @@ const FIREBASE_MESSAGING_BATCH_URL = 'https://fcm.googleapis.com/batch';
const FIREBASE_MESSAGING_HTTP_METHOD: HttpMethod = 'POST';
const FIREBASE_MESSAGING_HEADERS = {
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`
};
const LEGACY_FIREBASE_MESSAGING_HEADERS = {
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
'access_token_auth': 'true',
};

Expand Down
2 changes: 2 additions & 0 deletions test/unit/auth/auth-api-request.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -863,10 +863,12 @@ AUTH_REQUEST_HANDLER_TESTS.forEach((handler) => {
const mockAccessToken: string = utils.generateRandomAccessToken();
const expectedHeaders: {[key: string]: string} = {
'X-Client-Version': `Node/Admin/${getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
'Authorization': 'Bearer ' + mockAccessToken,
};
const expectedHeadersEmulator: {[key: string]: string} = {
'X-Client-Version': `Node/Admin/${getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
'Authorization': 'Bearer owner',
};
const callParams = (path: string, method: any, data: any): HttpRequestConfig => {
Expand Down
1 change: 1 addition & 0 deletions test/unit/messaging/messaging.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,6 +357,7 @@ describe('Messaging', () => {
const expectedHeaders = {
'Authorization': 'Bearer ' + mockAccessToken,
'X-Firebase-Client': `fire-admin-node/${getSdkVersion()}`,
'X-Goog-Api-Client': `gl-node/${process.versions.node} fire-admin/${getSdkVersion()}`,
'access_token_auth': 'true',
};
const emptyResponse = utils.responseFrom({});
Expand Down