Implement platform logging.

Author: rosalyntan

appcheck/firebase-appcheck-debug/src/main/java/com/google/firebase/appcheck/debug/internal/DebugAppCheckProvider.java

@@ -45,16 +45,7 @@ public class DebugAppCheckProvider implements AppCheckProvider {
 
   public DebugAppCheckProvider(@NonNull FirebaseApp firebaseApp, @Nullable String debugSecret) {
     checkNotNull(firebaseApp);
-    String projectId = firebaseApp.getOptions().getProjectId();
-    if (projectId == null) {
-      throw new IllegalArgumentException("FirebaseOptions#getProjectId cannot be null.");
-    }
-
-    this.networkClient =
-        new NetworkClient(
-            firebaseApp.getOptions().getApiKey(),
-            firebaseApp.getOptions().getApplicationId(),
-            projectId);
+    this.networkClient = new NetworkClient(firebaseApp);
     this.backgroundExecutor = Executors.newCachedThreadPool();
     this.debugSecretTask =
         debugSecret == null

appcheck/firebase-appcheck-safetynet/src/main/java/com/google/firebase/appcheck/safetynet/internal/SafetyNetAppCheckProvider.java

@@ -67,14 +67,9 @@ public SafetyNetAppCheckProvider(@NonNull FirebaseApp firebaseApp) {
     checkNotNull(googleApiAvailability);
     this.context = firebaseApp.getApplicationContext();
     this.apiKey = firebaseApp.getOptions().getApiKey();
-    String appId = firebaseApp.getOptions().getApplicationId();
-    String projectId = firebaseApp.getOptions().getProjectId();
-    if (projectId == null) {
-      throw new IllegalArgumentException("FirebaseOptions#getProjectId cannot be null.");
-    }
     this.backgroundExecutor = backgroundExecutor;
     this.safetyNetClientTask = initSafetyNetClient(googleApiAvailability, this.backgroundExecutor);
-    this.networkClient = new NetworkClient(apiKey, appId, projectId);
+    this.networkClient = new NetworkClient(firebaseApp);
   }
 
   @VisibleForTesting

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/FirebaseAppCheckRegistrar.java

@@ -21,6 +21,9 @@
 import com.google.firebase.components.Component;
 import com.google.firebase.components.ComponentRegistrar;
 import com.google.firebase.components.Dependency;
+import com.google.firebase.heartbeatinfo.HeartBeatInfo;
+import com.google.firebase.platforminfo.LibraryVersionComponent;
+import com.google.firebase.platforminfo.UserAgentPublisher;
 import java.util.Arrays;
 import java.util.List;
 
@@ -38,8 +41,16 @@ public List<Component<?>> getComponents() {
     return Arrays.asList(
         Component.builder(FirebaseAppCheck.class, (InternalAppCheckTokenProvider.class))
             .add(Dependency.required(FirebaseApp.class))
-            .factory((container) -> new DefaultFirebaseAppCheck(container.get(FirebaseApp.class)))
+            .add(Dependency.optionalProvider(UserAgentPublisher.class))
+            .add(Dependency.optionalProvider(HeartBeatInfo.class))
+            .factory(
+                (container) ->
+                    new DefaultFirebaseAppCheck(
+                        container.get(FirebaseApp.class),
+                        container.getProvider(UserAgentPublisher.class),
+                        container.getProvider(HeartBeatInfo.class)))
             .alwaysEager()
-            .build());
+            .build(),
+        LibraryVersionComponent.create("fire-app-check", BuildConfig.VERSION_NAME));
   }
 }

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/internal/DefaultFirebaseAppCheck.java

@@ -31,14 +31,20 @@
 import com.google.firebase.appcheck.FirebaseAppCheck;
 import com.google.firebase.appcheck.internal.util.Clock;
 import com.google.firebase.appcheck.interop.AppCheckTokenListener;
+import com.google.firebase.heartbeatinfo.HeartBeatInfo;
+import com.google.firebase.inject.Provider;
+import com.google.firebase.platforminfo.UserAgentPublisher;
 import java.util.ArrayList;
 import java.util.List;
 
 public class DefaultFirebaseAppCheck extends FirebaseAppCheck {
 
   private static final long BUFFER_TIME_MILLIS = 5 * 60 * 1000; // 5 minutes in milliseconds
+  private static final String HEART_BEAT_STORAGE_TAG = "fire-app-check";
 
   private final FirebaseApp firebaseApp;
+  private final Provider<UserAgentPublisher> userAgentPublisherProvider;
+  private final Provider<HeartBeatInfo> heartBeatInfoProvider;
   private final List<AppCheckTokenListener> appCheckTokenListenerList;
   private final StorageHelper storageHelper;
   private final TokenRefreshManager tokenRefreshManager;
@@ -48,9 +54,16 @@ public class DefaultFirebaseAppCheck extends FirebaseAppCheck {
   private AppCheckProvider appCheckProvider;
   private AppCheckToken cachedToken;
 
-  public DefaultFirebaseAppCheck(@NonNull FirebaseApp firebaseApp) {
+  public DefaultFirebaseAppCheck(
+      @NonNull FirebaseApp firebaseApp,
+      @NonNull Provider<UserAgentPublisher> userAgentPublisherProvider,
+      @NonNull Provider<HeartBeatInfo> heartBeatInfoProvider) {
     checkNotNull(firebaseApp);
+    checkNotNull(userAgentPublisherProvider);
+    checkNotNull(heartBeatInfoProvider);
     this.firebaseApp = firebaseApp;
+    this.userAgentPublisherProvider = userAgentPublisherProvider;
+    this.heartBeatInfoProvider = heartBeatInfoProvider;
     this.appCheckTokenListenerList = new ArrayList<>();
     this.storageHelper =
         new StorageHelper(firebaseApp.getApplicationContext(), firebaseApp.getPersistenceKey());
@@ -155,6 +168,21 @@ public Task<AppCheckTokenResult> then(@NonNull Task<AppCheckToken> task) {
             });
   }
 
+  @Nullable
+  String getUserAgent() {
+    return userAgentPublisherProvider.get() != null
+        ? userAgentPublisherProvider.get().getUserAgent()
+        : null;
+  }
+
+  @Nullable
+  String getHeartbeatCode() {
+    return heartBeatInfoProvider.get() != null
+        ? Integer.toString(
+            heartBeatInfoProvider.get().getHeartBeatCode(HEART_BEAT_STORAGE_TAG).getCode())
+        : null;
+  }
+
   /** Sets the in-memory cached {@link AppCheckToken}. */
   @VisibleForTesting
   void setCachedToken(@NonNull AppCheckToken token) {

appcheck/firebase-appcheck/src/main/java/com/google/firebase/appcheck/internal/NetworkClient.java

@@ -19,8 +19,9 @@
 import androidx.annotation.IntDef;
 import androidx.annotation.NonNull;
 import androidx.annotation.VisibleForTesting;
+import com.google.firebase.FirebaseApp;
 import com.google.firebase.FirebaseException;
-import com.google.firebase.appcheck.BuildConfig;
+import com.google.firebase.appcheck.FirebaseAppCheck;
 import java.io.BufferedOutputStream;
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -47,8 +48,9 @@ public class NetworkClient {
   private static final String APPLICATION_JSON = "application/json";
   private static final String UTF_8 = "UTF-8";
   private static final String X_FIREBASE_CLIENT = "X-Firebase-Client";
-  private static final String PLATFORM_NAME = "fire-app-check";
+  private static final String X_FIREBASE_CLIENT_LOG_TYPE = "X-Firebase-Client-Log-Type";
 
+  private final DefaultFirebaseAppCheck firebaseAppCheck;
   private final String apiKey;
   private final String appId;
   private final String projectId;
@@ -61,13 +63,15 @@ public class NetworkClient {
   public static final int SAFETY_NET = 1;
   public static final int DEBUG = 2;
 
-  public NetworkClient(@NonNull String apiKey, @NonNull String appId, @NonNull String projectId) {
-    checkNotNull(apiKey);
-    checkNotNull(appId);
-    checkNotNull(projectId);
-    this.apiKey = apiKey;
-    this.appId = appId;
-    this.projectId = projectId;
+  public NetworkClient(@NonNull FirebaseApp firebaseApp) {
+    checkNotNull(firebaseApp);
+    this.firebaseAppCheck = (DefaultFirebaseAppCheck) FirebaseAppCheck.getInstance(firebaseApp);
+    this.apiKey = firebaseApp.getOptions().getApiKey();
+    this.appId = firebaseApp.getOptions().getApplicationId();
+    this.projectId = firebaseApp.getOptions().getProjectId();
+    if (projectId == null) {
+      throw new IllegalArgumentException("FirebaseOptions#getProjectId cannot be null.");
+    }
   }
 
   /**
@@ -85,8 +89,13 @@ public AppCheckTokenResponse exchangeAttestationForAppCheckToken(
       urlConnection.setDoOutput(true);
       urlConnection.setFixedLengthStreamingMode(requestBytes.length);
       urlConnection.setRequestProperty(CONTENT_TYPE, APPLICATION_JSON);
-      urlConnection.setRequestProperty(
-          X_FIREBASE_CLIENT, PLATFORM_NAME + "/" + BuildConfig.VERSION_NAME);
+      if (firebaseAppCheck.getUserAgent() != null) {
+        urlConnection.setRequestProperty(X_FIREBASE_CLIENT, firebaseAppCheck.getUserAgent());
+      }
+      if (firebaseAppCheck.getHeartbeatCode() != null) {
+        urlConnection.setRequestProperty(
+            X_FIREBASE_CLIENT_LOG_TYPE, firebaseAppCheck.getHeartbeatCode());
+      }
 
       try (OutputStream out =
           new BufferedOutputStream(urlConnection.getOutputStream(), requestBytes.length)) {