refactor: connectivity monitoring (#553)

Author: zaneschepke

app/src/main/java/com/zaneschepke/wireguardautotunnel/data/domain/Settings.kt

@@ -85,4 +85,8 @@ data class Settings(
 		defaultValue = "3",
 	)
 	val debounceDelaySeconds: Int = 3,
-)
+) {
+	fun debounceDelayMillis(): Long {
+		return debounceDelaySeconds * 1000L
+	}
+}

app/src/main/java/com/zaneschepke/wireguardautotunnel/module/NetworkQualifiers.kt

@@ -1,9 +1,7 @@
 package com.zaneschepke.wireguardautotunnel.module
 
-import com.zaneschepke.wireguardautotunnel.service.network.EthernetService
-import com.zaneschepke.wireguardautotunnel.service.network.MobileDataService
+import com.zaneschepke.wireguardautotunnel.service.network.InternetConnectivityService
 import com.zaneschepke.wireguardautotunnel.service.network.NetworkService
-import com.zaneschepke.wireguardautotunnel.service.network.WifiService
 import dagger.Binds
 import dagger.Module
 import dagger.hilt.InstallIn
@@ -14,14 +12,5 @@ import dagger.hilt.components.SingletonComponent
 abstract class ServiceModule {
 
 	@Binds
-	@Wifi
-	abstract fun provideWifiService(wifiService: WifiService): NetworkService
-
-	@Binds
-	@MobileData
-	abstract fun provideMobileDataService(mobileDataService: MobileDataService): NetworkService
-
-	@Binds
-	@Ethernet
-	abstract fun provideEthernetService(ethernetService: EthernetService): NetworkService
+	abstract fun provideInternetConnectivityService(wifiService: InternetConnectivityService): NetworkService
 }

app/src/main/java/com/zaneschepke/wireguardautotunnel/module/ServiceModule.kt

@@ -79,9 +79,7 @@ class TunnelModule {
 		@IoDispatcher ioDispatcher: CoroutineDispatcher,
 		serviceManager: ServiceManager,
 		notificationService: NotificationService,
-		@Wifi wifiService: NetworkService,
-		@MobileData mobileDataService: NetworkService,
-		@Ethernet ethernetService: NetworkService,
+		internetConnectivityService: NetworkService,
 	): TunnelService {
 		return WireGuardTunnel(
 			amneziaBackend,
@@ -92,9 +90,7 @@ class TunnelModule {
 			ioDispatcher,
 			serviceManager,
 			notificationService,
-			wifiService,
-			mobileDataService,
-			ethernetService,
+			internetConnectivityService,
 		)
 	}
 

app/src/main/java/com/zaneschepke/wireguardautotunnel/module/TunnelModule.kt

@@ -1,6 +1,7 @@
 package com.zaneschepke.wireguardautotunnel.service.foreground.autotunnel
 
 import android.content.Intent
+import android.net.NetworkCapabilities
 import android.os.IBinder
 import android.os.PowerManager
 import androidx.core.app.ServiceCompat
@@ -11,17 +12,15 @@ import com.zaneschepke.wireguardautotunnel.R
 import com.zaneschepke.wireguardautotunnel.data.domain.Settings
 import com.zaneschepke.wireguardautotunnel.data.repository.AppDataRepository
 import com.zaneschepke.wireguardautotunnel.module.AppShell
-import com.zaneschepke.wireguardautotunnel.module.Ethernet
 import com.zaneschepke.wireguardautotunnel.module.IoDispatcher
 import com.zaneschepke.wireguardautotunnel.module.MainImmediateDispatcher
-import com.zaneschepke.wireguardautotunnel.module.MobileData
-import com.zaneschepke.wireguardautotunnel.module.Wifi
 import com.zaneschepke.wireguardautotunnel.service.foreground.ServiceManager
 import com.zaneschepke.wireguardautotunnel.service.foreground.autotunnel.model.AutoTunnelEvent
 import com.zaneschepke.wireguardautotunnel.service.foreground.autotunnel.model.AutoTunnelState
 import com.zaneschepke.wireguardautotunnel.service.foreground.autotunnel.model.NetworkState
+import com.zaneschepke.wireguardautotunnel.service.network.InternetConnectivityService
 import com.zaneschepke.wireguardautotunnel.service.network.NetworkService
-import com.zaneschepke.wireguardautotunnel.service.network.WifiService
+import com.zaneschepke.wireguardautotunnel.service.network.NetworkStatus
 import com.zaneschepke.wireguardautotunnel.service.notification.NotificationAction
 import com.zaneschepke.wireguardautotunnel.service.notification.NotificationService
 import com.zaneschepke.wireguardautotunnel.service.notification.WireGuardNotification
@@ -53,16 +52,7 @@ class AutoTunnelService : LifecycleService() {
 	lateinit var rootShell: Provider<RootShell>
 
 	@Inject
-	@Wifi
-	lateinit var wifiService: NetworkService
-
-	@Inject
-	@MobileData
-	lateinit var mobileDataService: NetworkService
-
-	@Inject
-	@Ethernet
-	lateinit var ethernetService: NetworkService
+	lateinit var networkService: NetworkService
 
 	@Inject
 	lateinit var appDataRepository: Provider<AppDataRepository>
@@ -168,17 +158,28 @@ class AutoTunnelService : LifecycleService() {
 		}
 	}
 
+	suspend fun buildNetworkState(networkStatus: NetworkStatus): NetworkState {
+		return with(autoTunnelStateFlow.value.networkState) {
+			val wifiName = when {
+				networkStatus.wifiAvailable &&
+					(wifiName == null || wifiName == Constants.UNREADABLE_SSID || networkService.didWifiChangeSinceLastCapabilitiesQuery) -> {
+					networkService.getWifiCapabilities()?.let { getWifiName(it) } ?: wifiName
+				}
+				!networkStatus.wifiAvailable -> null
+				else -> wifiName
+			}
+			copy(networkStatus.wifiAvailable, networkStatus.cellularAvailable, networkStatus.ethernetAvailable, wifiName)
+		}
+	}
+
 	private fun startAutoTunnelStateJob() = lifecycleScope.launch(ioDispatcher) {
 		combine(
 			combineSettings(),
-			combineNetworkEventsJob(),
+			networkService.status.map {
+				buildNetworkState(it)
+			}.distinctUntilChanged(),
 		) { double, networkState ->
-			var wifiName: String? = null
-			if (networkState.wifiName == Constants.UNREADABLE_SSID && double.first.isTunnelOnWifiEnabled) {
-				wifiName = getWifiName(double.first)
-			}
-			val netState = wifiName?.let { networkState.copy(wifiName = it) } ?: networkState
-			AutoTunnelState(tunnelService.get().vpnState.value, netState, double.first, double.second)
+			AutoTunnelState(tunnelService.get().vpnState.value, networkState, double.first, double.second)
 		}.collect { state ->
 			Timber.d("Network state: ${state.networkState}")
 			autoTunnelStateFlow.update {
@@ -187,32 +188,15 @@ class AutoTunnelService : LifecycleService() {
 		}
 	}
 
-	private fun getWifiName(setting: Settings): String? {
+	private suspend fun getWifiName(wifiCapabilities: NetworkCapabilities): String? {
+		val setting = appDataRepository.get().settings.getSettings()
 		return if (setting.isWifiNameByShellEnabled) {
 			rootShell.get().getCurrentWifiName()
-		} else if (wifiService.capabilities != null) {
-			WifiService.getNetworkName(wifiService.capabilities!!, this@AutoTunnelService)
 		} else {
-			null
+			InternetConnectivityService.getNetworkName(wifiCapabilities, this@AutoTunnelService)
 		}
 	}
 
-	@OptIn(FlowPreview::class)
-	private fun combineNetworkEventsJob(): Flow<NetworkState> {
-		return combine(
-			wifiService.status,
-			mobileDataService.status,
-			ethernetService.status,
-		) { wifi, mobileData, ethernet ->
-			NetworkState(
-				wifi.available,
-				mobileData.available,
-				ethernet.available,
-				wifi.name,
-			)
-		}.distinctUntilChanged()
-	}
-
 	private fun combineSettings(): Flow<Pair<Settings, TunnelConfigs>> {
 		return combine(
 			appDataRepository.get().settings.getSettingsFlow(),
@@ -229,9 +213,8 @@ class AutoTunnelService : LifecycleService() {
 	private fun startAutoTunnelJob() = lifecycleScope.launch(ioDispatcher) {
 		Timber.i("Starting auto-tunnel network event watcher")
 		val settings = appDataRepository.get().settings.getSettings()
-		val debounce = settings.debounceDelaySeconds * 1000L
-		Timber.d("Starting with debounce delay of: $debounce")
-		autoTunnelStateFlow.debounce(debounce).collect { watcherState ->
+		Timber.d("Starting with debounce delay of: ${settings.debounceDelaySeconds} seconds")
+		autoTunnelStateFlow.debounce(settings.debounceDelayMillis()).collect { watcherState ->
 			if (watcherState == defaultState) return@collect
 			Timber.d("New auto tunnel state emitted")
 			when (val event = watcherState.asAutoTunnelEvent()) {