feat: use android.util.Log for logging

This way, the SDK has a control over which logs will be used in production or debug variants of SDK users. As on outcome, this change reduces number of logs that the SDK is producing in production apps.
Parsely · Jan 10, 2025 · 3cc5f3e · 3cc5f3e
1 parent 47696a4
commit 3cc5f3e
Show file tree

Hide file tree

Showing 10 changed files with 42 additions and 53 deletions.
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/AdvertisementIdProvider.kt b/parsely/src/main/java/com/parsely/parselyandroid/AdvertisementIdProvider.kt
@@ -3,7 +3,6 @@ package com.parsely.parselyandroid
 import android.content.Context
 import android.provider.Settings
 import com.google.android.gms.ads.identifier.AdvertisingIdClient
-import com.parsely.parselyandroid.Logging.log
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 
@@ -19,7 +18,7 @@ internal class AdvertisementIdProvider(
             try {
                 adKey = AdvertisingIdClient.getAdvertisingIdInfo(context).id
             } catch (e: Exception) {
-                log("No Google play services or error!")
+                Log.e("No Google play services or error!", e)
             }
         }
     }
@@ -41,7 +40,7 @@ internal class AndroidIdProvider(private val context: Context) : IdProvider {
         } catch (ex: Exception) {
             null
         }
-        log(String.format("Android ID: %s", uuid))
+        Log.d("Android ID: $uuid")
         return uuid
     }
 }

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/DeviceInfoRepository.kt b/parsely/src/main/java/com/parsely/parselyandroid/DeviceInfoRepository.kt
@@ -1,7 +1,6 @@
 package com.parsely.parselyandroid
 
 import android.os.Build
-import com.parsely.parselyandroid.Logging.log
 
 internal interface DeviceInfoRepository{
     fun collectDeviceInfo(): Map<String, String>
@@ -25,7 +24,7 @@ internal open class AndroidDeviceInfoRepository(
         dInfo["parsely_site_uuid"] = parselySiteUuid
         dInfo["manufacturer"] = Build.MANUFACTURER
         dInfo["os"] = "android"
-        dInfo["os_version"] = String.format("%d", Build.VERSION.SDK_INT)
+        dInfo["os_version"] = Build.VERSION.SDK_INT.toString()
 
         return dInfo
     }
@@ -35,12 +34,12 @@ internal open class AndroidDeviceInfoRepository(
             val adKey = advertisementIdProvider.provide()
             val androidId = androidIdProvider.provide()
 
-            log("adkey is: %s, uuid is %s", adKey, androidId)
+            Log.d("adkey is: $adKey, uuid is $androidId")
 
             return if (adKey != null) {
                 adKey
             } else {
-                log("falling back to device uuid")
+                Log.d("falling back to device uuid")
                 androidId .orEmpty()
             }
         }

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/EngagementManager.kt b/parsely/src/main/java/com/parsely/parselyandroid/EngagementManager.kt
@@ -1,6 +1,5 @@
 package com.parsely.parselyandroid
 
-import com.parsely.parselyandroid.Logging.log
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
@@ -62,7 +61,7 @@ internal class EngagementManager(
         val event: MutableMap<String, Any> = HashMap(
             baseEvent
         )
-        log(String.format("Enqueuing %s event.", event["action"]))
+        Log.d("Enqueuing ${event["action"]} event.")
 
         // Update `ts` for the event since it's happening right now.
         val baseEventData = (event["data"] as Map<String, Any>?)!!

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/EventsBuilder.kt b/parsely/src/main/java/com/parsely/parselyandroid/EventsBuilder.kt
@@ -1,7 +1,5 @@
 package com.parsely.parselyandroid
 
-import com.parsely.parselyandroid.Logging.log
-
 internal class EventsBuilder(
     private val deviceInfoRepository: DeviceInfoRepository,
     private val initializationSiteId: String,
@@ -27,7 +25,7 @@ internal class EventsBuilder(
         uuid: String,
         siteIdSource: SiteIdSource,
     ): Map<String, Any> {
-        log("buildEvent called for %s/%s", action, url)
+        Log.d("buildEvent called for $action/$url")
 
         // Main event info
         val event: MutableMap<String, Any> = HashMap()

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/FlushQueue.kt b/parsely/src/main/java/com/parsely/parselyandroid/FlushQueue.kt
@@ -1,7 +1,6 @@
 package com.parsely.parselyandroid
 
 import com.parsely.parselyandroid.JsonSerializer.toParselyEventsPayload
-import com.parsely.parselyandroid.Logging.log
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.sync.Mutex
@@ -19,7 +18,7 @@ internal class FlushQueue(
 
     operator fun invoke(skipSendingEvents: Boolean) {
         if (!connectivityStatusProvider.isReachable()) {
-            log("Network unreachable. Not flushing.")
+            Log.d("Network unreachable. Not flushing.")
             return
         }
         scope.launch {
@@ -33,22 +32,21 @@ internal class FlushQueue(
 
                 val jsonPayload = toParselyEventsPayload(eventsToSend)
                 if (skipSendingEvents) {
-                    log("Debug mode on. Not sending to Parse.ly. Otherwise, would sent ${eventsToSend.size} events: $jsonPayload")
+                    Log.d("Debug mode on. Not sending to Parse.ly. Otherwise, would sent ${eventsToSend.size} events: $jsonPayload")
                     repository.remove(eventsToSend)
                     return@launch
                 }
-                log("Sending request with %d events", eventsToSend.size)
-                log("POST Data %s", jsonPayload)
-                log("Requested %s", ParselyTrackerInternal.ROOT_URL)
+                Log.d("Sending request with ${eventsToSend.size} events")
+                Log.d("POST Data $jsonPayload")
+                Log.d("Requested ${ParselyTrackerInternal.ROOT_URL}")
                 restClient.send(jsonPayload)
                     .fold(
                         onSuccess = {
-                            log("Pixel request success")
+                            Log.i("Pixel request success")
                             repository.remove(eventsToSend)
                         },
                         onFailure = {
-                            log("Pixel request exception")
-                            log(it.toString())
+                            Log.e("Pixel request exception", it)
                         }
                     )
             }

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/InMemoryBuffer.kt b/parsely/src/main/java/com/parsely/parselyandroid/InMemoryBuffer.kt
@@ -1,6 +1,5 @@
 package com.parsely.parselyandroid
 
-import com.parsely.parselyandroid.Logging.log
 import kotlin.time.Duration.Companion.seconds
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.delay
@@ -23,7 +22,7 @@ internal class InMemoryBuffer(
             while (isActive) {
                 mutex.withLock {
                     if (buffer.isNotEmpty()) {
-                        log("Persisting ${buffer.size} events")
+                        Log.d("Persisting ${buffer.size} events")
                         localStorageRepository.insertEvents(buffer)
                         buffer.clear()
                     }
@@ -36,7 +35,7 @@ internal class InMemoryBuffer(
     fun add(event: Map<String, Any>) {
         coroutineScope.launch {
             mutex.withLock {
-                log("Event added to buffer")
+                Log.d("Event added to buffer")
                 buffer.add(event)
                 onEventAddedListener()
             }

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/LocalStorageRepository.kt b/parsely/src/main/java/com/parsely/parselyandroid/LocalStorageRepository.kt
@@ -1,7 +1,6 @@
 package com.parsely.parselyandroid
 
 import android.content.Context
-import com.parsely.parselyandroid.Logging.log
 import java.io.EOFException
 import java.io.FileNotFoundException
 import java.io.ObjectInputStream
@@ -35,7 +34,7 @@ internal class LocalStorageRepository(private val context: Context) : QueueRepos
             oos.close()
             fos.close()
         } catch (ex: Exception) {
-            log("Exception thrown during queue serialization: %s", ex.toString())
+            Log.e("Exception thrown during queue serialization", ex)
         }
     }
 
@@ -53,10 +52,7 @@ internal class LocalStorageRepository(private val context: Context) : QueueRepos
         } catch (ex: FileNotFoundException) {
             // Nothing to do here. Means there was no saved queue.
         } catch (ex: Exception) {
-            log(
-                "Exception thrown during queue deserialization: %s",
-                ex.toString()
-            )
+            Log.e("Exception thrown during queue deserialization", ex)
         }
         return storedQueue
     }

diff --git a/parsely/src/main/java/com/parsely/parselyandroid/Log.kt b/parsely/src/main/java/com/parsely/parselyandroid/Log.kt
@@ -0,0 +1,18 @@
+package com.parsely.parselyandroid
+
+import android.util.Log
+
+internal object Log {
+
+    fun i(message: String) {
+        Log.i("Parsely", message)
+    }
+
+    fun d(message: String) {
+        Log.d("Parsely", message)
+    }
+
+    fun e(message: String, throwable: Throwable? = null) {
+        Log.e("Parsely", message, throwable)
+    }
+}
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/Logging.kt b/parsely/src/main/java/com/parsely/parselyandroid/Logging.kt
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTrackerInternal.kt
@@ -44,7 +44,7 @@ internal class ParselyTrackerInternal internal constructor(
         inMemoryBuffer = InMemoryBuffer(sdkScope, localStorageRepository) {
             if (!flushTimerIsActive()) {
                 startFlushTimer()
-                Logging.log("Flush flushTimer set to %ds", flushManager.intervalMillis / 1000)
+                Log.d("Flush flushTimer set to ${flushManager.intervalMillis / 1000}")
             }
         }
         flushQueue = FlushQueue(
@@ -92,7 +92,7 @@ internal class ParselyTrackerInternal internal constructor(
         siteIdSource: SiteIdSource,
     ) {
         if (url.isBlank()) {
-            Logging.log("url cannot be empty")
+            Log.e("url cannot be empty")
             return
         }
 
@@ -119,12 +119,12 @@ internal class ParselyTrackerInternal internal constructor(
         siteIdSource: SiteIdSource,
     ) {
         if (url.isBlank()) {
-            Logging.log("url cannot be empty")
+            Log.e("url cannot be empty")
             return
         }
         val pageViewUuid = lastPageviewUuid
         if (pageViewUuid == null) {
-            Logging.log("engagement session cannot start without calling trackPageview first")
+            Log.e("engagement session cannot start without calling trackPageview first")
             return
         }
 
@@ -147,7 +147,7 @@ internal class ParselyTrackerInternal internal constructor(
     override fun stopEngagement() {
         engagementManager?.let {
             it.stop()
-            Logging.log("Engagement session has been stopped")
+            Log.d("Engagement session has been stopped")
         }
         engagementManager = null
     }
@@ -160,7 +160,7 @@ internal class ParselyTrackerInternal internal constructor(
         siteIdSource: SiteIdSource,
     ) {
         if (url.isBlank()) {
-            Logging.log("url cannot be empty")
+            Log.e("url cannot be empty")
             return
         }