chore: Add X-Goog-Api-Client metric header to outgoing requests (#1039)

jonathanedey · web-flow · commit b4b2fc125109 · 2024-11-26T14:15:13.000-05:00
diff --git a/src/main/java/com/google/firebase/internal/ErrorHandlingHttpClient.java b/src/main/java/com/google/firebase/internal/ErrorHandlingHttpClient.java
@@ -89,6 +89,7 @@ public void sendAndParse(HttpRequestInfo requestInfo, Object destination) throws
   }
 
   public IncomingHttpResponse send(HttpRequestInfo requestInfo) throws T {
+    requestInfo.addHeader("X-Goog-Api-Client", SdkUtils.getMetricsHeader());
     HttpRequest request = createHttpRequest(requestInfo);
 
     HttpResponse response = null;
diff --git a/src/main/java/com/google/firebase/internal/SdkUtils.java b/src/main/java/com/google/firebase/internal/SdkUtils.java
@@ -39,6 +39,14 @@ public static String getVersion() {
     return SDK_VERSION;
   }
 
+  public static String getJavaVersion() {
+    return System.getProperty("java.version");
+  }
+
+  public static String getMetricsHeader() {
+    return String.format("gl-java/%s fire-admin/%s", getJavaVersion(), getVersion());
+  }
+
   private static String loadSdkVersion() {
     try (InputStream in = SdkUtils.class.getClassLoader()
         .getResourceAsStream(ADMIN_SDK_PROPERTIES)) {
diff --git a/src/test/java/com/google/firebase/auth/FirebaseUserManagerTest.java b/src/test/java/com/google/firebase/auth/FirebaseUserManagerTest.java
@@ -3026,6 +3026,8 @@ private static void checkRequestHeaders(TestResponseInterceptor interceptor) {
 
     String clientVersion = "Java/Admin/" + SdkUtils.getVersion();
     assertEquals(clientVersion, headers.getFirstHeaderStringValue("X-Client-Version"));
+    assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));
+
   }
 
   private static void checkUrl(TestResponseInterceptor interceptor, String method, String url) {
diff --git a/src/test/java/com/google/firebase/auth/internal/CryptoSignersTest.java b/src/test/java/com/google/firebase/auth/internal/CryptoSignersTest.java
@@ -39,6 +39,7 @@
 import com.google.firebase.auth.FirebaseAuthException;
 import com.google.firebase.auth.MockGoogleCredentials;
 import com.google.firebase.internal.ApiClientUtils;
+import com.google.firebase.internal.SdkUtils;
 import com.google.firebase.testing.MultiRequestMockHttpTransport;
 import com.google.firebase.testing.ServiceAccount;
 import com.google.firebase.testing.TestResponseInterceptor;
@@ -87,6 +88,8 @@ public void testIAMCryptoSigner() throws Exception {
     final String url = "https://iamcredentials.googleapis.com/v1/projects/-/serviceAccounts/"
         + "test-service-account@iam.gserviceaccount.com:signBlob";
     assertEquals(url, interceptor.getResponse().getRequest().getUrl().toString());
+    HttpRequest request = interceptor.getResponse().getRequest();
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
   }
 
   @Test
@@ -173,6 +176,7 @@ public void testMetadataService() throws Exception {
     HttpRequest request = interceptor.getResponse().getRequest();
     assertEquals(url, request.getUrl().toString());
     assertEquals("Bearer test-token", request.getHeaders().getAuthorization());
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
   }
 
   @Test
@@ -203,6 +207,7 @@ public void testExplicitServiceAccountEmail() throws Exception {
     HttpRequest request = interceptor.getResponse().getRequest();
     assertEquals(url, request.getUrl().toString());
     assertEquals("Bearer test-token", request.getHeaders().getAuthorization());
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
   }
 
   @Test
diff --git a/src/test/java/com/google/firebase/auth/multitenancy/FirebaseTenantClientTest.java b/src/test/java/com/google/firebase/auth/multitenancy/FirebaseTenantClientTest.java
@@ -353,6 +353,7 @@ private static void checkRequestHeaders(TestResponseInterceptor interceptor) {
 
     String clientVersion = "Java/Admin/" + SdkUtils.getVersion();
     assertEquals(clientVersion, headers.getFirstHeaderStringValue("X-Client-Version"));
+    assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));
   }
 
   private static void checkUrl(TestResponseInterceptor interceptor, String method, String url) {
diff --git a/src/test/java/com/google/firebase/auth/multitenancy/TenantAwareFirebaseAuthTest.java b/src/test/java/com/google/firebase/auth/multitenancy/TenantAwareFirebaseAuthTest.java
@@ -38,6 +38,7 @@
 import com.google.firebase.auth.MockTokenVerifier;
 import com.google.firebase.auth.SessionCookieOptions;
 import com.google.firebase.internal.ApiClientUtils;
+import com.google.firebase.internal.SdkUtils;
 import com.google.firebase.testing.TestResponseInterceptor;
 import com.google.firebase.testing.TestUtils;
 import java.io.ByteArrayOutputStream;
@@ -85,6 +86,7 @@ public void testCreateSessionCookieAsync() throws Exception {
     assertEquals("testToken", parsed.get("idToken"));
     assertEquals(new BigDecimal(3600), parsed.get("validDuration"));
     checkUrl(interceptor, AUTH_BASE_URL + ":createSessionCookie");
+    checkHeaders(interceptor);
   }
 
   @Test
@@ -121,6 +123,7 @@ public void testCreateSessionCookie() throws Exception {
     assertEquals("testToken", parsed.get("idToken"));
     assertEquals(new BigDecimal(3600), parsed.get("validDuration"));
     checkUrl(interceptor, AUTH_BASE_URL + ":createSessionCookie");
+    checkHeaders(interceptor);
   }
 
   @Test
@@ -212,6 +215,7 @@ public void testVerifySessionCookieWithCheckRevoked() throws FirebaseAuthExcepti
     assertEquals("uid", token.getUid());
     assertEquals("cookie", tokenVerifier.getLastTokenString());
     checkUrl(interceptor, AUTH_BASE_URL + "/accounts:lookup");
+    checkHeaders(interceptor);
   }
 
   @Test
@@ -290,4 +294,9 @@ private static void checkUrl(TestResponseInterceptor interceptor, String url) {
     assertEquals(HttpMethods.POST, request.getRequestMethod());
     assertEquals(url, request.getUrl().getRawPath());
   }
+
+  private static void checkHeaders(TestResponseInterceptor interceptor) {
+    HttpRequest request = interceptor.getResponse().getRequest();
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
+  }
 }
diff --git a/src/test/java/com/google/firebase/iid/FirebaseInstanceIdTest.java b/src/test/java/com/google/firebase/iid/FirebaseInstanceIdTest.java
@@ -38,6 +38,7 @@
 import com.google.firebase.OutgoingHttpRequest;
 import com.google.firebase.TestOnlyImplFirebaseTrampolines;
 import com.google.firebase.auth.MockGoogleCredentials;
+import com.google.firebase.internal.SdkUtils;
 import com.google.firebase.testing.GenericFunction;
 import com.google.firebase.testing.TestResponseInterceptor;
 import com.google.firebase.testing.TestUtils;
@@ -174,6 +175,7 @@ public Void call(Object... args) throws Exception {
       assertEquals(HttpMethods.DELETE, request.getRequestMethod());
       assertEquals(TEST_URL, request.getUrl().toString());
       assertEquals("Bearer test-token", request.getHeaders().getAuthorization());
+      assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
     }
   }
 
diff --git a/src/test/java/com/google/firebase/internal/ErrorHandlingHttpClientTest.java b/src/test/java/com/google/firebase/internal/ErrorHandlingHttpClientTest.java
@@ -127,6 +127,7 @@ public void testSuccessfulRequestWithHeadersAndBody() throws FirebaseException,
     assertEquals("v1", last.getHeaders().get("h1"));
     assertEquals("v2", last.getHeaders().get("h2"));
     assertEquals("v3", last.getHeaders().get("h3"));
+    assertEquals(SdkUtils.getMetricsHeader(), last.getHeaders().get("x-goog-api-client"));
 
     ByteArrayOutputStream out = new ByteArrayOutputStream();
     last.getContent().writeTo(out);
diff --git a/src/test/java/com/google/firebase/messaging/FirebaseMessagingClientImplTest.java b/src/test/java/com/google/firebase/messaging/FirebaseMessagingClientImplTest.java
@@ -389,6 +389,7 @@ private void checkRequestHeader(HttpRequest request) {
     HttpHeaders headers = request.getHeaders();
     assertEquals("2", headers.get("X-GOOG-API-FORMAT-VERSION"));
     assertEquals("fire-admin-java/" + SdkUtils.getVersion(), headers.get("X-Firebase-Client"));
+    assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));
   }
 
   private void checkRequest(
diff --git a/src/test/java/com/google/firebase/messaging/InstanceIdClientImplTest.java b/src/test/java/com/google/firebase/messaging/InstanceIdClientImplTest.java
@@ -41,6 +41,7 @@
 import com.google.firebase.TestOnlyImplFirebaseTrampolines;
 import com.google.firebase.auth.MockGoogleCredentials;
 import com.google.firebase.internal.ApiClientUtils;
+import com.google.firebase.internal.SdkUtils;
 import com.google.firebase.testing.TestResponseInterceptor;
 import com.google.firebase.testing.TestUtils;
 import java.io.ByteArrayOutputStream;
@@ -447,6 +448,8 @@ private void checkTopicManagementRequestHeader(
       HttpRequest request, String expectedUrl) {
     assertEquals("POST", request.getRequestMethod());
     assertEquals(expectedUrl, request.getUrl().toString());
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
+
   }
 
   private void checkExceptionFromHttpResponse(
diff --git a/src/test/java/com/google/firebase/projectmanagement/FirebaseProjectManagementServiceImplTest.java b/src/test/java/com/google/firebase/projectmanagement/FirebaseProjectManagementServiceImplTest.java
@@ -1124,6 +1124,7 @@ private void checkRequestHeader(int index, String expectedUrl, HttpMethod httpMe
     assertEquals(expectedUrl, request.getUrl().toString());
     assertEquals("Bearer test-token", request.getHeaders().getAuthorization());
     assertEquals(CLIENT_VERSION, request.getHeaders().get("X-Client-Version"));
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
   }
 
   private void checkRequestPayload(Map<String, String> expected) throws IOException {
diff --git a/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientImplTest.java b/src/test/java/com/google/firebase/remoteconfig/FirebaseRemoteConfigClientImplTest.java
@@ -1185,6 +1185,7 @@ private void checkGetRequestHeader(HttpRequest request, String urlSuffix) {
     assertEquals(TEST_REMOTE_CONFIG_URL + urlSuffix, request.getUrl().toString());
     HttpHeaders headers = request.getHeaders();
     assertEquals("fire-admin-java/" + SdkUtils.getVersion(), headers.get("X-Firebase-Client"));
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
     assertEquals("gzip", headers.getAcceptEncoding());
   }
 
@@ -1197,6 +1198,7 @@ private void checkPutRequestHeader(HttpRequest request, String urlSuffix, String
     assertEquals(TEST_REMOTE_CONFIG_URL + urlSuffix, request.getUrl().toString());
     HttpHeaders headers = request.getHeaders();
     assertEquals("fire-admin-java/" + SdkUtils.getVersion(), headers.get("X-Firebase-Client"));
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
     assertEquals("gzip", headers.getAcceptEncoding());
     assertEquals(ifMatch, headers.getIfMatch());
   }
@@ -1206,6 +1208,7 @@ private void checkPostRequestHeader(HttpRequest request, String urlSuffix) {
     assertEquals(TEST_REMOTE_CONFIG_URL + urlSuffix, request.getUrl().toString());
     HttpHeaders headers = request.getHeaders();
     assertEquals("fire-admin-java/" + SdkUtils.getVersion(), headers.get("X-Firebase-Client"));
+    assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));
     assertEquals("gzip", headers.getAcceptEncoding());
   }
 

Original file line number	Diff line number	Diff line change
`@@ -89,6 +89,7 @@ public void sendAndParse(HttpRequestInfo requestInfo, Object destination) throws`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`public IncomingHttpResponse send(HttpRequestInfo requestInfo) throws T {`
	`92`	`+ requestInfo.addHeader("X-Goog-Api-Client", SdkUtils.getMetricsHeader());`
`92`	`93`	`HttpRequest request = createHttpRequest(requestInfo);`
`93`	`94`
`94`	`95`	`HttpResponse response = null;`
Original file line number	Diff line number	Diff line change
`@@ -3026,6 +3026,8 @@ private static void checkRequestHeaders(TestResponseInterceptor interceptor) {`
`3026`	`3026`
`3027`	`3027`	`String clientVersion = "Java/Admin/" + SdkUtils.getVersion();`
`3028`	`3028`	`assertEquals(clientVersion, headers.getFirstHeaderStringValue("X-Client-Version"));`
	`3029`	`+ assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));`
	`3030`	`+`
`3029`	`3031`	`}`
`3030`	`3032`
`3031`	`3033`	`private static void checkUrl(TestResponseInterceptor interceptor, String method, String url) {`
Original file line number	Diff line number	Diff line change
`@@ -353,6 +353,7 @@ private static void checkRequestHeaders(TestResponseInterceptor interceptor) {`
`353`	`353`
`354`	`354`	`String clientVersion = "Java/Admin/" + SdkUtils.getVersion();`
`355`	`355`	`assertEquals(clientVersion, headers.getFirstHeaderStringValue("X-Client-Version"));`
	`356`	`+ assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));`
`356`	`357`	`}`
`357`	`358`
`358`	`359`	`private static void checkUrl(TestResponseInterceptor interceptor, String method, String url) {`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@`
`38`	`38`	`import com.google.firebase.OutgoingHttpRequest;`
`39`	`39`	`import com.google.firebase.TestOnlyImplFirebaseTrampolines;`
`40`	`40`	`import com.google.firebase.auth.MockGoogleCredentials;`
	`41`	`+import com.google.firebase.internal.SdkUtils;`
`41`	`42`	`import com.google.firebase.testing.GenericFunction;`
`42`	`43`	`import com.google.firebase.testing.TestResponseInterceptor;`
`43`	`44`	`import com.google.firebase.testing.TestUtils;`
`@@ -174,6 +175,7 @@ public Void call(Object... args) throws Exception {`
`174`	`175`	`assertEquals(HttpMethods.DELETE, request.getRequestMethod());`
`175`	`176`	`assertEquals(TEST_URL, request.getUrl().toString());`
`176`	`177`	`assertEquals("Bearer test-token", request.getHeaders().getAuthorization());`
	`178`	`+ assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));`
`177`	`179`	`}`
`178`	`180`	`}`
`179`	`181`
Original file line number	Diff line number	Diff line change
`@@ -389,6 +389,7 @@ private void checkRequestHeader(HttpRequest request) {`
`389`	`389`	`HttpHeaders headers = request.getHeaders();`
`390`	`390`	`assertEquals("2", headers.get("X-GOOG-API-FORMAT-VERSION"));`
`391`	`391`	`assertEquals("fire-admin-java/" + SdkUtils.getVersion(), headers.get("X-Firebase-Client"));`
	`392`	`+ assertEquals(SdkUtils.getMetricsHeader(), headers.get("X-Goog-Api-Client"));`
`392`	`393`	`}`
`393`	`394`
`394`	`395`	`private void checkRequest(`
Original file line number	Diff line number	Diff line change
`@@ -1124,6 +1124,7 @@ private void checkRequestHeader(int index, String expectedUrl, HttpMethod httpMe`
`1124`	`1124`	`assertEquals(expectedUrl, request.getUrl().toString());`
`1125`	`1125`	`assertEquals("Bearer test-token", request.getHeaders().getAuthorization());`
`1126`	`1126`	`assertEquals(CLIENT_VERSION, request.getHeaders().get("X-Client-Version"));`
	`1127`	`+ assertEquals(SdkUtils.getMetricsHeader(), request.getHeaders().get("X-Goog-Api-Client"));`
`1127`	`1128`	`}`
`1128`	`1129`
`1129`	`1130`	`private void checkRequestPayload(Map<String, String> expected) throws IOException {`