ui: replace GlobalScope with a hand-rolled CoroutineScope

GlobalScope has numerous problems[1] that make it unfit for
use in most applications and making it behave correctly requires
an excessive amount of verbosity that's alleviated simply by using
any other scope. Since we run multiple operations in the context
of the application's lifecycle, introduce a new scope that is created
when our application is, and cancelled upon its termination.

While at it, make the scope default to Dispatchers.IO to reduce pressure
on the UI event loop. Tasks requiring access to the UI thread appropriately
switch context making the change completely safe.

1: https://medium.com/@elizarov/the-reason-to-avoid-globalscope-835337445abc

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>

2 files changed, 8 insertions, 8 deletions

diff --git a/ui/src/main/java/com/wireguard/android/model/ObservableTunnel.kt b/ui/src/main/java/com/wireguard/android/model/ObservableTunnel.kt
index 89ad9a67..8bf8bf76 100644
--- a/ui/src/main/java/com/wireguard/android/model/ObservableTunnel.kt
+++ b/ui/src/main/java/com/wireguard/android/model/ObservableTunnel.kt
@@ -11,9 +11,9 @@ import com.wireguard.android.BR
 import com.wireguard.android.backend.Statistics
 import com.wireguard.android.backend.Tunnel
 import com.wireguard.android.databinding.Keyed
+import com.wireguard.android.util.applicationScope
 import com.wireguard.config.Config
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.withContext
 
@@ -74,7 +74,7 @@ class ObservableTunnel internal constructor(
         get() {
             if (field == null)
             // Opportunistically fetch this if we don't have a cached one, and rely on data bindings to update it eventually
-                GlobalScope.launch(Dispatchers.Main.immediate) {
+                applicationScope.launch {
                     try {
                         manager.getTunnelConfig(this@ObservableTunnel)
                     } catch (e: Throwable) {
@@ -110,7 +110,7 @@ class ObservableTunnel internal constructor(
         get() {
             if (field == null || field?.isStale != false)
             // Opportunistically fetch this if we don't have a cached one, and rely on data bindings to update it eventually
-                GlobalScope.launch(Dispatchers.Main.immediate) {
+                applicationScope.launch {
                     try {
                         manager.getTunnelStatistics(this@ObservableTunnel)
                     } catch (e: Throwable) {
diff --git a/ui/src/main/java/com/wireguard/android/model/TunnelManager.kt b/ui/src/main/java/com/wireguard/android/model/TunnelManager.kt
index 1f9bc6c0..f4a0f1b4 100644
--- a/ui/src/main/java/com/wireguard/android/model/TunnelManager.kt
+++ b/ui/src/main/java/com/wireguard/android/model/TunnelManager.kt
@@ -22,10 +22,10 @@ import com.wireguard.android.backend.Statistics
 import com.wireguard.android.backend.Tunnel
 import com.wireguard.android.configStore.ConfigStore
 import com.wireguard.android.databinding.ObservableSortedKeyedArrayList
+import com.wireguard.android.util.applicationScope
 import com.wireguard.config.Config
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.GlobalScope
 import kotlinx.coroutines.SupervisorJob
 import kotlinx.coroutines.async
 import kotlinx.coroutines.awaitAll
@@ -101,7 +101,7 @@ class TunnelManager(private val configStore: ConfigStore) : BaseObservable() {
     }
 
     fun onCreate() {
-        GlobalScope.launch(Dispatchers.Main.immediate) {
+        applicationScope.launch {
             try {
                 onTunnelsLoaded(withContext(Dispatchers.IO) { configStore.enumerate() }, withContext(Dispatchers.IO) { getBackend().runningTunnelNames })
             } catch (e: Throwable) {
@@ -122,7 +122,7 @@ class TunnelManager(private val configStore: ConfigStore) : BaseObservable() {
     }
 
     private fun refreshTunnelStates() {
-        GlobalScope.launch(Dispatchers.Main.immediate) {
+        applicationScope.launch {
             try {
                 val running = withContext(Dispatchers.IO) { getBackend().runningTunnelNames }
                 for (tunnel in tunnelMap)
@@ -139,7 +139,7 @@ class TunnelManager(private val configStore: ConfigStore) : BaseObservable() {
         val previouslyRunning = getSharedPreferences().getStringSet(KEY_RUNNING_TUNNELS, null)
                 ?: return
         if (previouslyRunning.isEmpty()) return
-        GlobalScope.launch(Dispatchers.Main.immediate) {
+        applicationScope.launch {
             withContext(Dispatchers.IO) {
                 try {
                     tunnelMap.filter { previouslyRunning.contains(it.name) }.map { async(SupervisorJob()) { setTunnelState(it, Tunnel.State.UP) } }.awaitAll()
@@ -232,7 +232,7 @@ class TunnelManager(private val configStore: ConfigStore) : BaseObservable() {
                 else -> return
             }
             val tunnelName = intent.getStringExtra("tunnel") ?: return
-            GlobalScope.launch(Dispatchers.Main.immediate) {
+            applicationScope.launch {
                 val tunnels = manager.getTunnels()
                 val tunnel = tunnels[tunnelName] ?: return@launch
                 manager.setTunnelState(tunnel, state)