FAD Adding in logging (#2932)

* Adding in logging

* Fixing log that always ran

* Cleaning up code

* Responding to comments

* Responding to comments logs

Co-authored-by: Manny Jimenez <[email protected]>

Author: manny-jimenez

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/CheckForUpdateClient.java

@@ -38,6 +38,7 @@
 
 class CheckForUpdateClient {
   private static final int UPDATE_THREAD_POOL_SIZE = 4;
+  private static final String TAG = "CheckForUpdateClient:";
 
   private final FirebaseApp firebaseApp;
   private final FirebaseAppDistributionTesterApiClient firebaseAppDistributionTesterApiClient;
@@ -134,6 +135,7 @@ AppDistributionReleaseInternal getLatestReleaseFromClient(
         return null;
       }
     } catch (NumberFormatException e) {
+      LogWrapper.getInstance().e(TAG + "Error parsing buildVersion.", e);
       throw new FirebaseAppDistributionException(
           Constants.ErrorMessages.NETWORK_ERROR,
           FirebaseAppDistributionException.Status.NETWORK_FAILURE,
@@ -169,6 +171,7 @@ private long getInstalledAppVersionCode(Context context) throws FirebaseAppDistr
     try {
       pInfo = context.getPackageManager().getPackageInfo(context.getPackageName(), 0);
     } catch (PackageManager.NameNotFoundException e) {
+      LogWrapper.getInstance().e(TAG + "Unable to locate Firebase App.", e);
       throw new FirebaseAppDistributionException(
           Constants.ErrorMessages.UNKNOWN_ERROR,
           FirebaseAppDistributionException.Status.UNKNOWN,
@@ -208,6 +211,7 @@ private boolean hasSameCodeHashAsInstallledRelease(AppDistributionReleaseInterna
       // of the installed release, then they are the same release.
       return externalCodeHash.equals(latestRelease.getCodeHash());
     } catch (PackageManager.NameNotFoundException e) {
+      LogWrapper.getInstance().e(TAG + "Unable to locate App.", e);
       return false;
     }
   }

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistribution.java

@@ -21,7 +21,6 @@
 import android.app.Application;
 import android.content.Context;
 import android.os.Bundle;
-import android.util.Log;
 import androidx.annotation.NonNull;
 import androidx.annotation.VisibleForTesting;
 import com.google.android.gms.common.internal.Preconditions;
@@ -34,7 +33,6 @@
 import org.jetbrains.annotations.Nullable;
 
 public class FirebaseAppDistribution implements Application.ActivityLifecycleCallbacks {
-  private static final String TAG = "FirebaseAppDistribution";
 
   private final FirebaseApp firebaseApp;
   private final TesterSignInClient testerSignInClient;
@@ -145,6 +143,7 @@ public Task<Void> signInTester() {
   @NonNull
   public synchronized Task<AppDistributionRelease> checkForUpdate() {
     if (cachedCheckForUpdateTask != null && !cachedCheckForUpdateTask.isComplete()) {
+      LogWrapper.getInstance().v("Response in progress");
       return cachedCheckForUpdateTask;
     }
 
@@ -203,22 +202,23 @@ public void signOutTester() {
 
   @Override
   public void onActivityCreated(@NonNull Activity activity, @Nullable Bundle bundle) {
-    Log.d(TAG, "Created activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().v("Created activity: " + activity.getClass().getName());
     // if SignInResultActivity is created, sign-in was successful
     if (activity instanceof SignInResultActivity) {
+      LogWrapper.getInstance().v("Sign in completed");
       this.testerSignInClient.setSuccessfulSignInResult();
       this.signInStorage.setSignInStatus(true);
     }
   }
 
   @Override
   public void onActivityStarted(@NonNull Activity activity) {
-    Log.d(TAG, "Started activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Started activity: " + activity.getClass().getName());
   }
 
   @Override
   public void onActivityResumed(@NonNull Activity activity) {
-    Log.d(TAG, "Resumed activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Resumed activity: " + activity.getClass().getName());
     // If app resumes and aab update task is in progress, assume that installation didn't happen so
     // cancel the task
     updateAppClient.tryCancelAabUpdateTask();
@@ -231,6 +231,7 @@ public void onActivityResumed(@NonNull Activity activity) {
 
     // Throw error if app reentered during sign in
     if (this.testerSignInClient.isCurrentlySigningIn()) {
+      LogWrapper.getInstance().e("App Resumed without sign in flow completing.");
       testerSignInClient.setCanceledAuthenticationError();
     }
 
@@ -241,22 +242,22 @@ public void onActivityResumed(@NonNull Activity activity) {
 
   @Override
   public void onActivityPaused(@NonNull Activity activity) {
-    Log.d(TAG, "Paused activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Paused activity: " + activity.getClass().getName());
   }
 
   @Override
   public void onActivityStopped(@NonNull Activity activity) {
-    Log.d(TAG, "Stopped activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Stopped activity: " + activity.getClass().getName());
   }
 
   @Override
   public void onActivitySaveInstanceState(@NonNull Activity activity, @NonNull Bundle bundle) {
-    Log.d(TAG, "Saved activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Saved activity: " + activity.getClass().getName());
   }
 
   @Override
   public void onActivityDestroyed(@NonNull Activity activity) {
-    Log.d(TAG, "Destroyed activity: " + activity.getClass().getName());
+    LogWrapper.getInstance().d("Destroyed activity: " + activity.getClass().getName());
     if (this.currentActivity == activity) {
       this.currentActivity = null;
       this.updateAppClient.setCurrentActivity(null);

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionNotificationsManager.java

@@ -24,14 +24,13 @@
 import android.graphics.drawable.Drawable;
 import android.os.Build;
 import android.os.Build.VERSION;
-import android.util.Log;
 import androidx.annotation.VisibleForTesting;
 import androidx.core.app.NotificationCompat;
 import androidx.core.content.ContextCompat;
 import com.google.firebase.FirebaseApp;
 
 class FirebaseAppDistributionNotificationsManager {
-  private static final String TAG = "FADNotificationsManager";
+  private static final String TAG = "NotificationsManager:";
   private static final String NOTIFICATION_CHANNEL_ID =
       "com.google.firebase.app.distribution.notification_channel_id";
 
@@ -99,7 +98,7 @@ private PendingIntent createPendingIntent() {
     Context context = firebaseApp.getApplicationContext();
     Intent intent = context.getPackageManager().getLaunchIntentForPackage(context.getPackageName());
     if (intent == null) {
-      Log.w(TAG, "No activity found to launch app");
+      LogWrapper.getInstance().w(TAG + "No activity found to launch app");
     }
     return PendingIntent.getActivity(
         firebaseApp.getApplicationContext(), 0, intent, PendingIntent.FLAG_ONE_SHOT);
@@ -123,7 +122,8 @@ private boolean isAdaptiveIcon(int iconId) {
     try {
       Drawable icon = ContextCompat.getDrawable(firebaseApp.getApplicationContext(), iconId);
       if (VERSION.SDK_INT >= Build.VERSION_CODES.O && icon instanceof AdaptiveIconDrawable) {
-        Log.e(TAG, "Adaptive icons cannot be used in notifications. Ignoring icon id: " + iconId);
+        LogWrapper.getInstance()
+            .e(TAG + "Adaptive icons cannot be used in notifications. Ignoring icon id: " + iconId);
         return true;
       } else {
         // AdaptiveIcons were introduced in API 26

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionRegistrar.java

@@ -15,7 +15,6 @@
 package com.google.firebase.appdistribution;
 
 import android.app.Application;
-import android.util.Log;
 import androidx.annotation.Keep;
 import androidx.annotation.NonNull;
 import com.google.firebase.FirebaseApp;
@@ -36,7 +35,7 @@
 @Keep
 public class FirebaseAppDistributionRegistrar implements ComponentRegistrar {
 
-  private static String TAG = "FadRegistrar";
+  private static String TAG = "Registrar:";
 
   @Override
   public @NonNull List<Component<?>> getComponents() {
@@ -59,9 +58,10 @@ private FirebaseAppDistribution buildFirebaseAppDistribution(ComponentContainer
       Application firebaseApplication = (Application) firebaseApp.getApplicationContext();
       firebaseApplication.registerActivityLifecycleCallbacks(appDistribution);
     } else {
-      Log.e(
-          TAG,
-          "Error registering app to ActivityLifecycleCallbacks. SDK might not function correctly.");
+      LogWrapper.getInstance()
+          .e(
+              TAG
+                  + "Error registering app to ActivityLifecycleCallbacks. SDK might not function correctly.");
     }
 
     return appDistribution;

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/FirebaseAppDistributionTesterApiClient.java

@@ -43,6 +43,7 @@ class FirebaseAppDistributionTesterApiClient {
   private static final String CODE_HASH_KEY = "codeHash";
   private static final String IAS_ARTIFACT_ID_KEY = "iasArtifactId";
   private static final String DOWNLOAD_URL_KEY = "downloadUrl";
+  private static final String TAG = "TesterApiClient:";
   public static final int DEFAULT_BUFFER_SIZE = 8192;
 
   public @NonNull AppDistributionReleaseInternal fetchLatestRelease(
@@ -82,10 +83,10 @@ class FirebaseAppDistributionTesterApiClient {
 
     } catch (IOException | JSONException e) {
       if (e instanceof JSONException) {
+        LogWrapper.getInstance().e(TAG + "Error parsing the latest release.", e);
         throw new FirebaseAppDistributionException(
             Constants.ErrorMessages.JSON_PARSING_ERROR, NETWORK_FAILURE, e);
       }
-
       throw getExceptionForHttpResponse(connection);
     } finally {
       connection.disconnect();
@@ -97,6 +98,7 @@ class FirebaseAppDistributionTesterApiClient {
   private FirebaseAppDistributionException getExceptionForHttpResponse(
       HttpsURLConnection connection) {
     try {
+      LogWrapper.getInstance().e(TAG + "Failed due to " + connection.getResponseCode());
       switch (connection.getResponseCode()) {
         case 401:
           return new FirebaseAppDistributionException(

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/LogWrapper.java

@@ -0,0 +1,58 @@
+// Copyright 2021 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package com.google.firebase.appdistribution;
+
+import android.util.Log;
+
+/** Wrapper that handles Android logcat logging. */
+class LogWrapper {
+
+  private static final String LOG_TAG = "FirebaseAppDistribution";
+  private static LogWrapper instance;
+
+  public static synchronized LogWrapper getInstance() {
+    if (instance == null) {
+      instance = new LogWrapper();
+    }
+
+    return instance;
+  }
+
+  void d(String msg) {
+    Log.d(LOG_TAG, msg);
+  }
+
+  void v(String msg) {
+    Log.v(LOG_TAG, msg);
+  }
+
+  void i(String msg) {
+    Log.i(LOG_TAG, msg);
+  }
+
+  void w(String msg) {
+    Log.w(LOG_TAG, msg);
+  }
+
+  void e(String msg) {
+    Log.e(LOG_TAG, msg);
+  }
+
+  void e(String msg, Throwable tr) {
+    Log.e(LOG_TAG, msg, tr);
+  }
+
+  private LogWrapper() {}
+}

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/SignInResultActivity.java

@@ -23,11 +23,12 @@
  * when SignInResultActivity is created.
  */
 public class SignInResultActivity extends AppCompatActivity {
+  private static final String TAG = "SignInResultActivity:";
 
   @Override
   public void onCreate(@NonNull Bundle savedInstanceBundle) {
     super.onCreate(savedInstanceBundle);
-
+    LogWrapper.getInstance().v(TAG + "The User is signing in");
     // While this does not appear to be achieving much, handling the redirect in this way
     // ensures that we can remove the browser tab from the back stack. See the documentation
     // on AuthorizationManagementActivity for more details.

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/TaskUtils.java

@@ -18,16 +18,18 @@
 import com.google.android.gms.tasks.Tasks;
 
 class TaskUtils {
+  private static final String TAG = "TaskUtils:";
+
   static <TResult> Task<TResult> handleTaskFailure(
       Task<TResult> task,
       String defaultErrorMessage,
       FirebaseAppDistributionException.Status defaultErrorStatus) {
     if (task.isComplete() && !task.isSuccessful()) {
       Exception e = task.getException();
+      LogWrapper.getInstance().e(TAG + "Task failed to complete due to " + e.getMessage(), e);
       if (e instanceof FirebaseAppDistributionException) {
         return task;
       }
-
       return Tasks.forException(
           new FirebaseAppDistributionException(defaultErrorMessage, defaultErrorStatus, e));
     }

firebase-app-distribution/src/main/java/com/google/firebase/appdistribution/TesterSignInClient.java

@@ -24,7 +24,6 @@
 import android.content.Intent;
 import android.content.pm.ResolveInfo;
 import android.net.Uri;
-import android.util.Log;
 import androidx.annotation.GuardedBy;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -40,7 +39,7 @@
 import java.util.List;
 
 class TesterSignInClient {
-  private static final String TAG = "FADSignInTester";
+  private static final String TAG = "TesterSignIn:";
 
   private TaskCompletionSource<Void> signInTaskCompletionSource = null;
   private final String SIGNIN_REDIRECT_URL =
@@ -66,15 +65,19 @@ class TesterSignInClient {
   @NonNull
   public synchronized Task<Void> signInTester() {
     if (signInStorage.getSignInStatus()) {
+      LogWrapper.getInstance().v(TAG + "Tester is already signed in.");
       return Tasks.forResult(null);
     }
 
     if (this.isCurrentlySigningIn()) {
+      LogWrapper.getInstance()
+          .v(TAG + "Detected In-Progress sign in task. Returning the same task.");
       return signInTaskCompletionSource.getTask();
     }
 
     Activity currentActivity = getCurrentActivity();
     if (currentActivity == null) {
+      LogWrapper.getInstance().e(TAG + "No foreground activity found.");
       return Tasks.forException(
           new FirebaseAppDistributionException(
               ErrorMessages.APP_BACKGROUNDED,
@@ -120,6 +123,7 @@ public void onClick(DialogInterface dialogInterface, int i) {
                     new OnFailureListener() {
                       @Override
                       public void onFailure(@NonNull Exception e) {
+                        LogWrapper.getInstance().e(TAG + "Fid retrieval failed.", e);
                         setSignInTaskCompletionError(
                             new FirebaseAppDistributionException(
                                 Constants.ErrorMessages.AUTHENTICATION_ERROR,
@@ -135,6 +139,7 @@ public void onFailure(@NonNull Exception e) {
         new DialogInterface.OnClickListener() {
           @Override
           public void onClick(DialogInterface dialogInterface, int i) {
+            LogWrapper.getInstance().v("Sign in has been canceled.");
             setSignInTaskCompletionError(
                 new FirebaseAppDistributionException(
                     ErrorMessages.AUTHENTICATION_CANCELED, AUTHENTICATION_CANCELED));
@@ -172,12 +177,13 @@ private static String getApplicationName(Context context) {
     try {
       return context.getApplicationInfo().loadLabel(context.getPackageManager()).toString();
     } catch (Exception e) {
-      Log.e(TAG, "Unable to retrieve App name");
+      LogWrapper.getInstance().e(TAG + "Unable to retrieve App name", e);
       return "";
     }
   }
 
   private void openSignInFlowInBrowser(Activity currentActivity, Uri uri) {
+    LogWrapper.getInstance().v(TAG + "Opening sign in flow in browser at " + uri);
     if (supportsCustomTabs(firebaseApp.getApplicationContext())) {
       // If we can launch a chrome view, try that.
       CustomTabsIntent customTabsIntent = new CustomTabsIntent.Builder().build();