Simplify SensorWorker by keeping only one implementation

Author: TimoPtr

app/src/main/kotlin/io/homeassistant/companion/android/launch/LaunchActivity.kt

@@ -42,11 +42,11 @@ import io.homeassistant.companion.android.authenticator.Authenticator
 import io.homeassistant.companion.android.authenticator.Authenticator.Companion.AuthenticationResult
 import io.homeassistant.companion.android.common.R as commonR
 import io.homeassistant.companion.android.common.compose.theme.HATheme
+import io.homeassistant.companion.android.common.sensors.SensorWorker
 import io.homeassistant.companion.android.common.util.CheckLocalNetworkPermissionUseCase
 import io.homeassistant.companion.android.common.util.SdkVersion
 import io.homeassistant.companion.android.launch.applock.HazeLockOverlay
 import io.homeassistant.companion.android.sensors.SensorReceiver
-import io.homeassistant.companion.android.sensors.SensorWorker
 import io.homeassistant.companion.android.util.ChangeLog
 import io.homeassistant.companion.android.util.CheckLocationDisabledUseCase
 import io.homeassistant.companion.android.util.PLAY_SERVICES_FLAVOR_DOC_URL

app/src/main/kotlin/io/homeassistant/companion/android/sensors/SensorWorker.kt

@@ -95,6 +95,7 @@ import io.homeassistant.companion.android.common.data.keychain.KeyChainRepositor
 import io.homeassistant.companion.android.common.data.keychain.NamedKeyChain
 import io.homeassistant.companion.android.common.data.prefs.NightModeTheme
 import io.homeassistant.companion.android.common.data.servers.ServerManager
+import io.homeassistant.companion.android.common.sensors.SensorWorker
 import io.homeassistant.companion.android.common.util.AppVersionProvider
 import io.homeassistant.companion.android.common.util.FailFast
 import io.homeassistant.companion.android.common.util.GestureAction
@@ -136,7 +137,6 @@ import io.homeassistant.companion.android.improv.ui.ImprovSetupDialog
 import io.homeassistant.companion.android.launch.LaunchActivity
 import io.homeassistant.companion.android.nfc.WriteNfcTag
 import io.homeassistant.companion.android.sensors.SensorReceiver
-import io.homeassistant.companion.android.sensors.SensorWorker
 import io.homeassistant.companion.android.settings.ConnectionSecurityLevelFragment
 import io.homeassistant.companion.android.settings.SettingsActivity
 import io.homeassistant.companion.android.settings.server.ServerChooserFragment

app/src/main/kotlin/io/homeassistant/companion/android/webview/WebViewActivity.kt

@@ -16,10 +16,10 @@ import dagger.hilt.android.testing.HiltAndroidTest
 import dagger.hilt.android.testing.HiltTestApplication
 import dagger.hilt.android.testing.UninstallModules
 import io.homeassistant.companion.android.common.data.servers.ServerManager
+import io.homeassistant.companion.android.common.sensors.SensorWorker
 import io.homeassistant.companion.android.common.util.DisabledLocationHandler
 import io.homeassistant.companion.android.di.ServerManagerModule
 import io.homeassistant.companion.android.sensors.SensorReceiver
-import io.homeassistant.companion.android.sensors.SensorWorker
 import io.homeassistant.companion.android.util.ChangeLog
 import io.homeassistant.companion.android.websocket.WebsocketManager
 import io.mockk.Runs

app/src/test/kotlin/io/homeassistant/companion/android/launch/LaunchActivityTest.kt

@@ -7,8 +7,13 @@ import android.content.pm.ServiceInfo
 import android.os.Build
 import androidx.core.app.NotificationCompat
 import androidx.core.content.getSystemService
+import androidx.work.Constraints
 import androidx.work.CoroutineWorker
+import androidx.work.ExistingPeriodicWorkPolicy
 import androidx.work.ForegroundInfo
+import androidx.work.NetworkType
+import androidx.work.PeriodicWorkRequestBuilder
+import androidx.work.WorkManager
 import androidx.work.WorkerParameters
 import dagger.hilt.EntryPoint
 import dagger.hilt.InstallIn
@@ -19,13 +24,13 @@ import io.homeassistant.companion.android.common.data.servers.ServerManager
 import io.homeassistant.companion.android.common.util.CHANNEL_SENSOR_WORKER
 import io.homeassistant.companion.android.common.util.CheckLocalNetworkPermissionUseCase
 import io.homeassistant.companion.android.common.util.SdkVersion
+import java.util.concurrent.TimeUnit
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.withContext
 import timber.log.Timber
 
-abstract class SensorWorkerBase(val appContext: Context, workerParams: WorkerParameters) :
-    CoroutineWorker(appContext, workerParams) {
-    protected abstract val sensorReceiver: SensorReceiverBase
+class SensorWorker(private val context: Context, workerParams: WorkerParameters) :
+    CoroutineWorker(context, workerParams) {
 
     @EntryPoint
     @InstallIn(SingletonComponent::class)
@@ -34,21 +39,36 @@ abstract class SensorWorkerBase(val appContext: Context, workerParams: WorkerPar
         fun checkLocalNetworkPermission(): CheckLocalNetworkPermissionUseCase
         fun lastUpdateManager(): LastUpdateManager
         fun sensorRepository(): SensorRepository
+        fun sensorUpdater(): SensorUpdater
     }
 
     companion object {
-        const val TAG = "SensorWorker"
-        const val NOTIFICATION_ID = 42
+        private const val TAG = "SensorWorker"
+        private const val NOTIFICATION_ID = 42
+
+        fun start(context: Context) {
+            val constraints = Constraints.Builder()
+                .setRequiredNetworkType(NetworkType.CONNECTED).build()
+
+            val sensorWorker =
+                PeriodicWorkRequestBuilder<SensorWorker>(15, TimeUnit.MINUTES)
+                    .setConstraints(constraints)
+                    .build()
+
+            WorkManager.getInstance(context)
+                .enqueueUniquePeriodicWork(TAG, ExistingPeriodicWorkPolicy.CANCEL_AND_REENQUEUE, sensorWorker)
+        }
     }
 
-    private val notificationManager = appContext.getSystemService<NotificationManager>()!!
+    private val notificationManager = context.getSystemService<NotificationManager>()!!
 
     override suspend fun doWork(): Result = withContext(Dispatchers.IO) {
-        val entryPoint = EntryPointAccessors.fromApplication(appContext, SensorWorkerEntryPoint::class.java)
+        val entryPoint = EntryPointAccessors.fromApplication(context, SensorWorkerEntryPoint::class.java)
         val sensorRepository = entryPoint.sensorRepository()
         val serverManager = entryPoint.serverManager()
         val checkLocalNetworkPermission = entryPoint.checkLocalNetworkPermission()
         val lastUpdateManager = entryPoint.lastUpdateManager()
+        val sensorUpdater = entryPoint.sensorUpdater()
 
         val enabledSensorCount = sensorRepository.getEnabledCount()
         if (
@@ -64,7 +84,7 @@ abstract class SensorWorkerBase(val appContext: Context, workerParams: WorkerPar
             createNotificationChannel()
             val notification = NotificationCompat.Builder(applicationContext, CHANNEL_SENSOR_WORKER)
                 .setSmallIcon(commonR.drawable.ic_stat_ic_notification)
-                .setContentTitle(appContext.getString(commonR.string.updating_sensors))
+                .setContentTitle(context.getString(commonR.string.updating_sensors))
                 .setPriority(NotificationCompat.PRIORITY_LOW)
                 .build()
 
@@ -91,7 +111,7 @@ abstract class SensorWorkerBase(val appContext: Context, workerParams: WorkerPar
             if (lastUpdateSensor.any { it.enabled }) {
                 lastUpdateManager.sendLastUpdate(TAG)
             }
-            sensorReceiver.updateSensors(appContext, serverManager, sensorRepository, null)
+            sensorUpdater.updateSensors()
         }
 
         // Cleanup orphaned sensors that may have been created by a slow or long running update
@@ -102,11 +122,11 @@ abstract class SensorWorkerBase(val appContext: Context, workerParams: WorkerPar
         Result.success()
     }
 
-    protected fun createNotificationChannel() {
+    private fun createNotificationChannel() {
         if (SdkVersion.isAtLeast(Build.VERSION_CODES.O)) {
             val notificationChannel = NotificationChannel(
                 CHANNEL_SENSOR_WORKER,
-                appContext.getString(commonR.string.sensor_updates),
+                context.getString(commonR.string.sensor_updates),
                 NotificationManager.IMPORTANCE_LOW,
             )
             notificationManager.createNotificationChannel(notificationChannel)

…droid/common/sensors/SensorWorkerBase.kt …n/android/common/sensors/SensorWorker.ktcommon/src/main/kotlin/io/homeassistant/companion/android/common/sensors/SensorWorkerBase.kt renamed to common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/SensorWorker.kt common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/SensorWorkerBase.kt renamed to common/src/main/kotlin/io/homeassistant/companion/android/common/sensors/SensorWorker.kt

@@ -16,6 +16,7 @@ import androidx.lifecycle.lifecycleScope
 import androidx.lifecycle.repeatOnLifecycle
 import androidx.wear.protolayout.ActionBuilders
 import dagger.hilt.android.AndroidEntryPoint
+import io.homeassistant.companion.android.common.sensors.SensorWorker
 import io.homeassistant.companion.android.common.util.SdkVersion
 import io.homeassistant.companion.android.home.views.DEEPLINK_PREFIX_SET_CAMERA_TILE
 import io.homeassistant.companion.android.home.views.DEEPLINK_PREFIX_SET_SHORTCUT_TILE
@@ -24,7 +25,6 @@ import io.homeassistant.companion.android.home.views.DEEPLINK_PREFIX_SET_THERMOS
 import io.homeassistant.companion.android.home.views.LoadHomePage
 import io.homeassistant.companion.android.onboarding.OnboardingActivity
 import io.homeassistant.companion.android.sensors.SensorReceiver
-import io.homeassistant.companion.android.sensors.SensorWorker
 import io.homeassistant.companion.android.tiles.OpenTileSettingsActivity
 import javax.inject.Inject
 import kotlinx.coroutines.CancellationException