Merge pull request #98 from Parsely/issue/prepare_for_parsely_tracker_kotlin_migration

wzieba · web-flow · commit fe141cfd96c1 · 2023-12-13T18:32:00.000+01:00
Prepare `ParselyTracker` for Kotlin migration
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/AdvertisementIdProvider.kt b/parsely/src/main/java/com/parsely/parselyandroid/AdvertisementIdProvider.kt
@@ -3,6 +3,7 @@ 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
 
@@ -18,7 +19,7 @@ internal class AdvertisementIdProvider(
             try {
                 adKey = AdvertisingIdClient.getAdvertisingIdInfo(context).id
             } catch (e: Exception) {
-                ParselyTracker.PLog("No Google play services or error!")
+                log("No Google play services or error!")
             }
         }
     }
@@ -40,7 +41,7 @@ internal class AndroidIdProvider(private val context: Context) : IdProvider {
         } catch (ex: Exception) {
             null
         }
-        ParselyTracker.PLog(String.format("Android ID: %s", uuid))
+        log(String.format("Android ID: %s", uuid))
         return uuid
     }
 }
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ConnectivityStatusProvider.kt b/parsely/src/main/java/com/parsely/parselyandroid/ConnectivityStatusProvider.kt
@@ -0,0 +1,22 @@
+package com.parsely.parselyandroid
+
+import android.content.Context
+import android.net.ConnectivityManager
+
+internal interface ConnectivityStatusProvider {
+    /**
+     * @return Whether the network is accessible.
+     */
+    fun isReachable(): Boolean
+}
+
+internal class AndroidConnectivityStatusProvider(private val context: Context): ConnectivityStatusProvider {
+
+    override fun isReachable(): Boolean {
+        val cm = context.getSystemService(
+            Context.CONNECTIVITY_SERVICE
+        ) as ConnectivityManager
+        val netInfo = cm.activeNetworkInfo
+        return netInfo != null && netInfo.isConnectedOrConnecting
+    }
+}
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/DeviceInfoRepository.kt b/parsely/src/main/java/com/parsely/parselyandroid/DeviceInfoRepository.kt
@@ -1,6 +1,7 @@
 package com.parsely.parselyandroid
 
 import android.os.Build
+import com.parsely.parselyandroid.Logging.log
 
 internal interface DeviceInfoRepository{
     fun collectDeviceInfo(): Map<String, String>
@@ -34,12 +35,12 @@ internal open class AndroidDeviceInfoRepository(
             val adKey = advertisementIdProvider.provide()
             val androidId = androidIdProvider.provide()
 
-            ParselyTracker.PLog("adkey is: %s, uuid is %s", adKey, androidId)
+            log("adkey is: %s, uuid is %s", adKey, androidId)
 
             return if (adKey != null) {
                 adKey
             } else {
-                ParselyTracker.PLog("falling back to device uuid")
+                log("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,6 @@
 package com.parsely.parselyandroid
 
-import kotlin.time.Duration
+import com.parsely.parselyandroid.Logging.log
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
@@ -62,7 +62,7 @@ internal class EngagementManager(
         val event: MutableMap<String, Any> = HashMap(
             baseEvent
         )
-        ParselyTracker.PLog(String.format("Enqueuing %s event.", event["action"]))
+        log(String.format("Enqueuing %s event.", event["action"]))
 
         // 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.java b/parsely/src/main/java/com/parsely/parselyandroid/EventsBuilder.java
@@ -1,8 +1,6 @@
 package com.parsely.parselyandroid;
 
-import static com.parsely.parselyandroid.ParselyTracker.PLog;
-
-import android.content.Context;
+import static com.parsely.parselyandroid.Logging.log;
 
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
@@ -44,7 +42,7 @@ Map<String, Object> buildEvent(
             Map<String, Object> extraData,
             @Nullable String uuid
     ) {
-        PLog("buildEvent called for %s/%s", action, url);
+        log("buildEvent called for %s/%s", action, url);
 
         Calendar now = Calendar.getInstance(TimeZone.getTimeZone("UTC"));
 
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/FlushQueue.kt b/parsely/src/main/java/com/parsely/parselyandroid/FlushQueue.kt
@@ -1,6 +1,7 @@
 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
@@ -10,12 +11,17 @@ internal class FlushQueue(
     private val flushManager: FlushManager,
     private val repository: QueueRepository,
     private val restClient: RestClient,
-    private val scope: CoroutineScope
+    private val scope: CoroutineScope,
+    private val connectivityStatusProvider: ConnectivityStatusProvider
 ) {
 
     private val mutex = Mutex()
 
     operator fun invoke(skipSendingEvents: Boolean) {
+        if (!connectivityStatusProvider.isReachable()) {
+            log("Network unreachable. Not flushing.")
+            return
+        }
         scope.launch {
             mutex.withLock {
                 val eventsToSend = repository.getStoredQueue()
@@ -26,23 +32,23 @@ internal class FlushQueue(
                 }
 
                 if (skipSendingEvents) {
-                    ParselyTracker.PLog("Debug mode on. Not sending to Parse.ly. Otherwise, would sent ${eventsToSend.size} events")
+                    log("Debug mode on. Not sending to Parse.ly. Otherwise, would sent ${eventsToSend.size} events")
                     repository.remove(eventsToSend)
                     return@launch
                 }
-                ParselyTracker.PLog("Sending request with %d events", eventsToSend.size)
+                log("Sending request with %d events", eventsToSend.size)
                 val jsonPayload = toParselyEventsPayload(eventsToSend)
-                ParselyTracker.PLog("POST Data %s", jsonPayload)
-                ParselyTracker.PLog("Requested %s", ParselyTracker.ROOT_URL)
+                log("POST Data %s", jsonPayload)
+                log("Requested %s", ParselyTracker.ROOT_URL)
                 restClient.send(jsonPayload)
                     .fold(
                         onSuccess = {
-                            ParselyTracker.PLog("Pixel request success")
+                            log("Pixel request success")
                             repository.remove(eventsToSend)
                         },
                         onFailure = {
-                            ParselyTracker.PLog("Pixel request exception")
-                            ParselyTracker.PLog(it.toString())
+                            log("Pixel request exception")
+                            log(it.toString())
                         }
                     )
             }
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/InMemoryBuffer.kt b/parsely/src/main/java/com/parsely/parselyandroid/InMemoryBuffer.kt
@@ -1,5 +1,6 @@
 package com.parsely.parselyandroid
 
+import com.parsely.parselyandroid.Logging.log
 import kotlin.time.Duration.Companion.seconds
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.delay
@@ -22,7 +23,7 @@ internal class InMemoryBuffer(
             while (isActive) {
                 mutex.withLock {
                     if (buffer.isNotEmpty()) {
-                        ParselyTracker.PLog("Persisting ${buffer.size} events")
+                        log("Persisting ${buffer.size} events")
                         localStorageRepository.insertEvents(buffer)
                         buffer.clear()
                     }
@@ -35,7 +36,7 @@ internal class InMemoryBuffer(
     fun add(event: Map<String, Any>) {
         coroutineScope.launch {
             mutex.withLock {
-                ParselyTracker.PLog("Event added to buffer")
+                log("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,6 +1,7 @@
 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
@@ -34,7 +35,7 @@ internal class LocalStorageRepository(private val context: Context) : QueueRepos
             oos.close()
             fos.close()
         } catch (ex: Exception) {
-            ParselyTracker.PLog("Exception thrown during queue serialization: %s", ex.toString())
+            log("Exception thrown during queue serialization: %s", ex.toString())
         }
     }
 
@@ -52,7 +53,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) {
-            ParselyTracker.PLog(
+            log(
                 "Exception thrown during queue deserialization: %s",
                 ex.toString()
             )
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/Logging.kt b/parsely/src/main/java/com/parsely/parselyandroid/Logging.kt
@@ -0,0 +1,17 @@
+package com.parsely.parselyandroid
+
+import java.util.Formatter
+
+object Logging {
+
+    /**
+     * Log a message to the console.
+     */
+    @JvmStatic
+    fun log(logString: String, vararg objects: Any?) {
+        if (logString == "") {
+            return
+        }
+        println(Formatter().format("[Parsely] $logString", *objects).toString())
+    }
+}
diff --git a/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.java b/parsely/src/main/java/com/parsely/parselyandroid/ParselyTracker.java
diff --git a/parsely/src/test/java/com/parsely/parselyandroid/FlushQueueTest.kt b/parsely/src/test/java/com/parsely/parselyandroid/FlushQueueTest.kt

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@ package com.parsely.parselyandroid`
`3`	`3`	`import android.content.Context`
`4`	`4`	`import android.provider.Settings`
`5`	`5`	`import com.google.android.gms.ads.identifier.AdvertisingIdClient`
	`6`	`+import com.parsely.parselyandroid.Logging.log`
`6`	`7`	`import kotlinx.coroutines.CoroutineScope`
`7`	`8`	`import kotlinx.coroutines.launch`
`8`	`9`
`@@ -18,7 +19,7 @@ internal class AdvertisementIdProvider(`
`18`	`19`	`try {`
`19`	`20`	`adKey = AdvertisingIdClient.getAdvertisingIdInfo(context).id`
`20`	`21`	`} catch (e: Exception) {`
`21`		`- ParselyTracker.PLog("No Google play services or error!")`
	`22`	`+ log("No Google play services or error!")`
`22`	`23`	`}`
`23`	`24`	`}`
`24`	`25`	`}`
`@@ -40,7 +41,7 @@ internal class AndroidIdProvider(private val context: Context) : IdProvider {`
`40`	`41`	`} catch (ex: Exception) {`
`41`	`42`	`null`
`42`	`43`	`}`
`43`		`- ParselyTracker.PLog(String.format("Android ID: %s", uuid))`
	`44`	`+ log(String.format("Android ID: %s", uuid))`
`44`	`45`	`return uuid`
`45`	`46`	`}`
`46`	`47`	`}`