Merge pull request #123 from android/firebase-appcheck-logs

Firebase AppCheck - Add more logging

Author: riggaroo

app/build.gradle.kts

@@ -136,6 +136,7 @@ dependencies {
 
     implementation(platform(libs.firebase.bom))
     implementation(libs.firebase.crashlytics)
+    implementation(libs.timber)
     implementation(libs.firebase.ai)
     implementation(libs.firebase.app.check)
     implementation(libs.firebase.config)

app/proguard-rules.pro

@@ -43,3 +43,11 @@
 
 # Ignore missing Java SE annotation processing classes, often from libraries like AutoValue
 -dontwarn javax.lang.model.**
+
+# OkHttp
+-keep class okhttp3.** { *; }
+-keep interface okhttp3.** { *; }
+-dontwarn okhttp3.**
+
+# Ignore SAX parser warning
+-dontwarn org.xml.sax.**

app/src/main/java/com/android/developers/androidify/AndroidifyApplication.kt

@@ -23,7 +23,9 @@ import coil3.ImageLoader
 import coil3.PlatformContext
 import coil3.SingletonImageLoader
 import dagger.hilt.android.HiltAndroidApp
+import timber.log.Timber
 import javax.inject.Inject
+
 @HiltAndroidApp
 class AndroidifyApplication : Application(), SingletonImageLoader.Factory {
 
@@ -32,6 +34,11 @@ class AndroidifyApplication : Application(), SingletonImageLoader.Factory {
 
     override fun onCreate() {
         super.onCreate()
+        if (isDebuggable()) {
+            Timber.plant(Timber.DebugTree())
+        } else {
+            Timber.plant(CrashlyticsTree())
+        }
         setStrictModePolicy()
     }
 

app/src/main/java/com/android/developers/androidify/CrashlyticsTree.kt

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2025 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.android.developers.androidify
+
+import android.util.Log
+import com.google.firebase.crashlytics.FirebaseCrashlytics
+import timber.log.Timber
+
+/**
+ * A Timber tree that logs to Crashlytics.
+ *
+ * In debug builds, this tree does nothing. In release builds, it logs non-fatal exceptions
+ * to Crashlytics.
+ */
+class CrashlyticsTree : Timber.Tree() {
+
+    private val crashlytics by lazy { FirebaseCrashlytics.getInstance() }
+
+    override fun log(priority: Int, tag: String?, message: String, t: Throwable?) {
+        if (priority == Log.VERBOSE || priority == Log.DEBUG) {
+            return
+        }
+
+        crashlytics.log(message)
+
+        if (t != null) {
+            crashlytics.recordException(t)
+        }
+    }
+}

core/network/build.gradle.kts

@@ -71,6 +71,7 @@ dependencies {
     implementation(libs.coil.compose.http)
     implementation(libs.coil.gif)
     implementation(platform(libs.firebase.bom))
+    implementation(libs.timber)
     implementation(libs.firebase.ai)
     implementation(libs.firebase.analytics) {
         exclude(group = "com.google.guava")

core/network/src/main/java/com/android/developers/androidify/ondevice/LocalSegmentationDataSource.kt

@@ -16,7 +16,6 @@
 package com.android.developers.androidify.ondevice
 
 import android.graphics.Bitmap
-import android.util.Log
 import com.google.android.gms.common.moduleinstall.InstallStatusListener
 import com.google.android.gms.common.moduleinstall.ModuleInstallClient
 import com.google.android.gms.common.moduleinstall.ModuleInstallRequest
@@ -28,6 +27,7 @@ import com.google.mlkit.vision.segmentation.subject.SubjectSegmentation
 import com.google.mlkit.vision.segmentation.subject.SubjectSegmenterOptions
 import kotlinx.coroutines.CancellableContinuation
 import kotlinx.coroutines.suspendCancellableCoroutine
+import timber.log.Timber
 import javax.inject.Inject
 import kotlin.coroutines.resume
 import kotlin.coroutines.resumeWithException
@@ -64,7 +64,7 @@ class LocalSegmentationDataSourceImpl @Inject constructor(
     ) : InstallStatusListener {
 
         override fun onInstallStatusUpdated(update: ModuleInstallStatusUpdate) {
-            Log.d("LocalSegmentationDataSource", "Download progress: ${update.installState}.. ${continuation.hashCode()} ${continuation.isActive}")
+            Timber.d("Download progress: ${update.installState}.. ${continuation.hashCode()} ${continuation.isActive}")
             if (!continuation.isActive) return
             if (update.installState == ModuleInstallStatusUpdate.InstallState.STATE_COMPLETED) {
                 continuation.resume(true)
@@ -73,7 +73,7 @@ class LocalSegmentationDataSourceImpl @Inject constructor(
                     ImageSegmentationException("Module download failed or was canceled. State: ${update.installState}"),
                 )
             } else {
-                Log.d("LocalSegmentationDataSource", "State update: ${update.installState}")
+                Timber.d("State update: ${update.installState}")
             }
         }
     }
@@ -88,11 +88,11 @@ class LocalSegmentationDataSourceImpl @Inject constructor(
             moduleInstallClient
                 .installModules(moduleInstallRequest)
                 .addOnFailureListener {
-                    Log.e("LocalSegmentationDataSource", "Failed to download module", it)
+                    Timber.e(it, "Failed to download module")
                     continuation.resumeWithException(it)
                 }
                 .addOnCompleteListener {
-                    Log.d("LocalSegmentationDataSource", "Successfully triggered download - await download progress updates")
+                    Timber.d("Successfully triggered download - await download progress updates")
                 }
         }
         return result
@@ -102,13 +102,13 @@ class LocalSegmentationDataSourceImpl @Inject constructor(
         val areModulesAvailable = isSubjectSegmentationModuleInstalled()
 
         if (!areModulesAvailable) {
-            Log.d("LocalSegmentationDataSource", "Modules not available - downloading")
+            Timber.d("Modules not available - downloading")
             val result = installSubjectSegmentationModule()
             if (!result) {
                 throw Exception("Failed to download module")
             }
         } else {
-            Log.d("LocalSegmentationDataSource", "Modules available")
+            Timber.d("Modules available")
         }
         val image = InputImage.fromBitmap(bitmap, 0)
         return suspendCancellableCoroutine { continuation ->
@@ -121,7 +121,7 @@ class LocalSegmentationDataSourceImpl @Inject constructor(
                     }
                 }
                 .addOnFailureListener { e ->
-                    Log.e("LocalSegmentationDataSource", "Exception while executing background removal", e)
+                    Timber.e(e, "Exception while executing background removal")
                     continuation.resumeWithException(e)
                 }
         }

core/network/src/main/java/com/android/developers/androidify/startup/FirebaseAppCheckInitializer.kt

@@ -17,34 +17,48 @@ package com.android.developers.androidify.startup
 
 import android.annotation.SuppressLint
 import android.content.Context
-import android.util.Log
 import androidx.startup.Initializer
 import com.android.developers.androidify.network.BuildConfig
 import com.google.firebase.Firebase
 import com.google.firebase.appcheck.FirebaseAppCheck
 import com.google.firebase.appcheck.appCheck
 import com.google.firebase.appcheck.debug.DebugAppCheckProviderFactory
 import com.google.firebase.appcheck.playintegrity.PlayIntegrityAppCheckProviderFactory
+import timber.log.Timber
 
 /**
  * Initialize [FirebaseAppCheck] using the App Startup Library.
  */
 @SuppressLint("EnsureInitializerMetadata") // Registered in :app module
 class FirebaseAppCheckInitializer : Initializer<FirebaseAppCheck> {
     override fun create(context: Context): FirebaseAppCheck {
-        return Firebase.appCheck.apply {
+        val appCheck = Firebase.appCheck.apply {
             if (BuildConfig.DEBUG) {
-                Log.i("AndroidifyAppCheck", "Firebase debug")
+                Timber.i(
+                    "Installing Firebase debug, ensure your " +
+                        "debug token is registered on Firebase Console",
+                )
                 installAppCheckProviderFactory(
                     DebugAppCheckProviderFactory.getInstance(),
                 )
             } else {
-                Log.i("AndroidifyAppCheck", "Play integrity")
+                Timber.i("Play integrity installing...")
                 installAppCheckProviderFactory(
                     PlayIntegrityAppCheckProviderFactory.getInstance(),
                 )
             }
+            setTokenAutoRefreshEnabled(true)
+        }
+
+        val token = appCheck.getAppCheckToken(false)
+        token.addOnCompleteListener {
+            if (token.isSuccessful) {
+                Timber.i("Firebase app check token success: ${token.result.expireTimeMillis}")
+            } else {
+                Timber.e(token.exception, "Firebase app check token failure")
+            }
         }
+        return appCheck
     }
 
     override fun dependencies(): List<Class<out Initializer<*>?>?> {

core/network/src/main/java/com/android/developers/androidify/startup/FirebaseRemoteConfigInitializer.kt

@@ -17,13 +17,13 @@ package com.android.developers.androidify.startup
 
 import android.annotation.SuppressLint
 import android.content.Context
-import android.util.Log
 import androidx.startup.Initializer
 import com.android.developers.androidify.network.R
 import com.google.firebase.Firebase
 import com.google.firebase.remoteconfig.FirebaseRemoteConfig
 import com.google.firebase.remoteconfig.remoteConfig
 import com.google.firebase.remoteconfig.remoteConfigSettings
+import timber.log.Timber
 
 /**
  * Initialize [FirebaseRemoteConfig] using the App Startup Library.
@@ -39,10 +39,10 @@ class FirebaseRemoteConfigInitializer : Initializer<FirebaseRemoteConfig> {
             setDefaultsAsync(R.xml.remote_config_defaults)
             fetchAndActivate()
                 .addOnSuccessListener {
-                    Log.d("FirebaseRemoteConfig", "Config params updated: $it")
+                    Timber.d("Config params updated: $it")
                 }
                 .addOnFailureListener {
-                    Log.d("FirebaseRemoteConfig", "Config params failed: $it")
+                    Timber.d("Config params failed: $it")
                 }
         }
     }

core/testing/src/main/java/com/android/developers/testing/repository/FakeWatchFaceInstallationRepository.kt

@@ -1,3 +1,18 @@
+/*
+ * Copyright 2025 The Android Open Source Project
+ *
+ * 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
+ *
+ *     https://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.android.developers.testing.repository
 
 import android.graphics.Bitmap
@@ -65,4 +80,4 @@ class FakeWatchFaceInstallationRepository : WatchFaceInstallationRepository {
     public fun setWatchAsConnected() {
         _connectedWatch.value = watch
     }
-}
+}

core/theme/src/main/res/drawable/squiggle_full.xml

@@ -1,4 +1,5 @@
-<?xml version="1.0" encoding="utf-8"?><!--
+<?xml version="1.0" encoding="utf-8"?>
+<!--
      Copyright 2025 The Android Open Source Project
 
      Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,7 +14,6 @@
      See the License for the specific language governing permissions and
      limitations under the License.
 -->
-<!-- The squiggle but cropped to the viewport. -->
 <vector xmlns:android="http://schemas.android.com/apk/res/android"
     android:width="1425dp"
     android:height="822dp"