simplify getGoogleCredentialsMetricsHeader logic and deal with additi…

…onal case.
googleapis · Sep 30, 2024 · 225a42b · 225a42b
1 parent cb6bb84
commit 225a42b
Showing 1 changed file with 14 additions and 39 deletions.
diff --git a/oauth2_http/java/com/google/auth/oauth2/MetricsUtils.java b/oauth2_http/java/com/google/auth/oauth2/MetricsUtils.java
@@ -90,51 +90,26 @@ public String getLabel() {
   }
 
   /**
-   * Formulates metrics header string.
+   * Formulates metrics header string. Header string takes format: “gl-java/JAVA_VERSION
+   * auth/LIB_VERSION auth-request-type/REQUEST_TYPE cred-type/CREDENTIAL_TYPE”. "auth-request-type"
+   * and "cred-type" can be omitted.
    *
-   * <p>For UserCredentials access token or id token requests, no request type is specified, metric
-   * header string takes format: “gl-java/JAVA_VERSION auth/LIB_VERSION cred-type/u”
-   *
-   * <p>For MDS pin, credentials type should not include in header, metric header string takes
-   * format: “gl-java/JAVA_VERSION auth/LIB_VERSION auth-request-type/mds”
-   *
-   * <p>For ServiceAccountCredentials, ComputeEngineCredentials and ImpersonatedCredentials access
-   * token or id token requests, metric header string takes format “gl-java/JAVA_VERSION
-   * auth/LIB_VERSION auth-request-type/[it/at] cred-type/[mds/sa/imp]”
-   *
-   * @param requestType
-   * @param credentialTypeForMetrics
+   * @param requestType Auth request type to be specified in metrics, omit when {@code
+   *     RequestType.UNSPECIFIED}
+   * @param credentialTypeForMetrics Credential type to be included in metrics string, omit when
+   *     {@code CredentialTypeForMetrics.DO_NOT_SEND}
    * @return metrics header string to send
    */
   static String getGoogleCredentialsMetricsHeader(
       RequestType requestType, CredentialTypeForMetrics credentialTypeForMetrics) {
-    // This case is not used
-    if (requestType == RequestType.UNSPECIFIED
-        && credentialTypeForMetrics == CredentialTypeForMetrics.DO_NOT_SEND) {
-      return MetricsUtils.getLanguageAndAuthLibraryVersions();
-    }
-    // format for UserCredentials requests
-    if (requestType == RequestType.UNSPECIFIED) {
-      return String.format(
-          "%s %s/%s",
-          MetricsUtils.getLanguageAndAuthLibraryVersions(),
-          CRED_TYPE,
-          credentialTypeForMetrics.getLabel());
+    StringBuilder stringBuilder =
+        new StringBuilder(MetricsUtils.getLanguageAndAuthLibraryVersions());
+    if (requestType != RequestType.UNSPECIFIED) {
+      stringBuilder.append(String.format(" %s/%s", AUTH_REQUEST_TYPE, requestType.getLabel()));
     }
-    // format for MDS pin
-    if (credentialTypeForMetrics == CredentialTypeForMetrics.DO_NOT_SEND) {
-      return String.format(
-          "%s %s/%s",
-          MetricsUtils.getLanguageAndAuthLibraryVersions(),
-          AUTH_REQUEST_TYPE,
-          requestType.getLabel());
+    if (credentialTypeForMetrics != CredentialTypeForMetrics.DO_NOT_SEND) {
+      stringBuilder.append(String.format(" %s/%s", CRED_TYPE, credentialTypeForMetrics.getLabel()));
     }
-    return String.format(
-        "%s %s/%s %s/%s",
-        MetricsUtils.getLanguageAndAuthLibraryVersions(),
-        AUTH_REQUEST_TYPE,
-        requestType.getLabel(),
-        CRED_TYPE,
-        credentialTypeForMetrics.getLabel());
+    return stringBuilder.toString();
   }
 }