Background generation (based on WorkManager API) (#228)

* Prototype WorkManager implementation

* - Beta Work manager implementation
- Local Diffusion VAE memory leak fix
- core notification & localization infra

* Stable (kind of) work manager implementation

* Introduce start notification, optimize work scheduling

* Optimize presentation module resources

* Resolve merge conflicts

* Add some Unit Tests

* Fix i2i form gallery input

* Selection toggle

Author: ShiftHackZ

app/build.gradle

@@ -90,13 +90,15 @@ android {
 dependencies {
     implementation project(":core:common")
     implementation project(":core:imageprocessing")
+    implementation project(":core:notification")
     implementation project(":core:validation")
     implementation project(":presentation")
     implementation project(":network")
     implementation project(":storage")
     implementation project(":domain")
     implementation project(":feature:auth")
     implementation project(":feature:diffusion")
+    implementation project(":feature:work")
     implementation project(":data")
     implementation project(":demo")
     implementation di.koinCore
@@ -107,6 +109,7 @@ dependencies {
     implementation log.timber
     implementation ui.catppuccinSplashscreen
     implementation ui.catppuccinLegacy
+    implementation androidx.workManager
 }
 
 kapt {

app/src/dev/AndroidManifest.xml

@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="utf-8"?>
+<manifest xmlns:tools="http://schemas.android.com/tools"
+    xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <uses-feature
+        android:name="android.hardware.camera"
+        android:required="false" />
+
+    <uses-permission android:name="android.permission.CAMERA" />
+    <uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-permission android:name="android.permission.VIBRATE" />
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
+
+    <uses-permission
+        android:name="android.permission.READ_EXTERNAL_STORAGE"
+        android:maxSdkVersion="32" />
+
+    <uses-permission
+        android:name="android.permission.WRITE_EXTERNAL_STORAGE"
+        android:maxSdkVersion="31"
+        tools:ignore="ScopedStorage" />
+
+    <uses-permission
+        android:name="android.permission.MANAGE_EXTERNAL_STORAGE"
+        tools:ignore="ScopedStorage" />
+
+</manifest>

app/src/foss/AndroidManifest.xml

@@ -10,7 +10,10 @@
     <uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-permission android:name="android.permission.VIBRATE" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
 
     <uses-permission
         android:name="android.permission.READ_EXTERNAL_STORAGE"

app/src/main/AndroidManifest.xml

@@ -25,6 +25,12 @@
             </intent-filter>
         </activity>
 
+        <provider
+            android:name="androidx.startup.InitializationProvider"
+            android:authorities="${applicationId}.androidx-startup"
+            tools:node="remove">
+        </provider>
+
         <provider
             android:name="androidx.core.content.FileProvider"
             android:authorities="${applicationId}.fileprovider"
@@ -35,6 +41,11 @@
                 android:resource="@xml/file_provider_paths" />
         </provider>
 
+        <service
+            android:name="androidx.work.impl.foreground.SystemForegroundService"
+            android:foregroundServiceType="dataSync"
+            tools:node="merge" />
+
         <service
             android:name="androidx.appcompat.app.AppLocalesMetadataHolderService"
             android:enabled="false"

app/src/main/java/com/shifthackz/aisdv1/app/AiStableDiffusionClientApp.kt

@@ -5,24 +5,29 @@ import android.app.Application
 import android.database.CursorWindow
 import android.os.StrictMode
 import android.os.StrictMode.VmPolicy
+import androidx.work.Configuration
+import androidx.work.WorkManager
 import com.shifthackz.aisdv1.app.di.featureModule
 import com.shifthackz.aisdv1.app.di.preferenceModule
 import com.shifthackz.aisdv1.app.di.providersModule
 import com.shifthackz.aisdv1.core.common.log.FileLoggingTree
 import com.shifthackz.aisdv1.core.common.log.errorLog
 import com.shifthackz.aisdv1.core.imageprocessing.di.imageProcessingModule
+import com.shifthackz.aisdv1.core.notification.di.notificationModule
 import com.shifthackz.aisdv1.core.validation.di.validatorsModule
 import com.shifthackz.aisdv1.data.di.dataModule
 import com.shifthackz.aisdv1.demo.di.demoModule
 import com.shifthackz.aisdv1.domain.di.domainModule
 import com.shifthackz.aisdv1.network.di.networkModule
 import com.shifthackz.aisdv1.presentation.di.presentationModule
 import com.shifthackz.aisdv1.storage.di.databaseModule
+import com.shifthackz.aisdv1.work.di.SdaiWorkerFactory
+import com.shifthackz.aisdv1.work.di.backgroundWorkModule
+import org.koin.android.ext.android.inject
 import org.koin.android.ext.koin.androidContext
 import org.koin.core.context.startKoin
 import timber.log.Timber
 
-
 class AiStableDiffusionClientApp : Application() {
 
     override fun onCreate() {
@@ -32,6 +37,7 @@ class AiStableDiffusionClientApp : Application() {
         initializeKoin()
         initializeLogging()
         initializeCursorSize()
+        initializeWorkManager()
     }
 
     /**
@@ -53,12 +59,14 @@ class AiStableDiffusionClientApp : Application() {
     private fun initializeKoin() = startKoin {
         androidContext(this@AiStableDiffusionClientApp)
         modules(
+            notificationModule,
             demoModule,
             *featureModule,
             preferenceModule,
             providersModule,
             *domainModule,
             *dataModule,
+            backgroundWorkModule,
             networkModule,
             databaseModule,
             validatorsModule,
@@ -73,4 +81,17 @@ class AiStableDiffusionClientApp : Application() {
         }
         Timber.plant(FileLoggingTree())
     }
+
+    private fun initializeWorkManager() {
+        try {
+            val workerFactory: SdaiWorkerFactory by inject()
+            val configuration = Configuration.Builder()
+                .setWorkerFactory(workerFactory)
+                .build()
+
+            WorkManager.initialize(this, configuration)
+        } catch (e: Exception) {
+            errorLog(e)
+        }
+    }
 }

app/src/main/java/com/shifthackz/aisdv1/app/di/ProvidersModule.kt

@@ -1,6 +1,8 @@
 package com.shifthackz.aisdv1.app.di
 
+import android.content.Intent
 import com.shifthackz.aisdv1.app.BuildConfig
+import com.shifthackz.aisdv1.core.common.appbuild.ActivityIntentProvider
 import com.shifthackz.aisdv1.core.common.appbuild.BuildInfoProvider
 import com.shifthackz.aisdv1.core.common.appbuild.BuildType
 import com.shifthackz.aisdv1.core.common.appbuild.BuildVersion
@@ -20,10 +22,12 @@ import com.shifthackz.aisdv1.network.qualifiers.ApiUrlProvider
 import com.shifthackz.aisdv1.network.qualifiers.CredentialsProvider
 import com.shifthackz.aisdv1.network.qualifiers.NetworkHeaders
 import com.shifthackz.aisdv1.network.qualifiers.NetworkPrefixes
+import com.shifthackz.aisdv1.presentation.activity.AiStableDiffusionActivity
 import io.reactivex.rxjava3.android.schedulers.AndroidSchedulers
 import io.reactivex.rxjava3.core.Scheduler
 import io.reactivex.rxjava3.schedulers.Schedulers
 import org.koin.android.ext.koin.androidApplication
+import org.koin.android.ext.koin.androidContext
 import org.koin.dsl.module
 import java.util.Date
 import java.util.concurrent.Executor
@@ -150,8 +154,8 @@ val providersModule = module {
             override val providerPath: String = "${androidApplication().packageName}.fileprovider"
             override val imagesCacheDirPath: String = "${androidApplication().cacheDir}/images"
             override val logsCacheDirPath: String = "${androidApplication().cacheDir}/logs"
-            override val localModelDirPath: String =
-                "${androidApplication().filesDir.absolutePath}/model"
+            override val localModelDirPath: String = "${androidApplication().filesDir.absolutePath}/model"
+            override val workCacheDirPath: String = "${androidApplication().cacheDir}/work"
         }
     }
 
@@ -166,4 +170,10 @@ val providersModule = module {
     single {
         LocalModelIdProvider { get<PreferenceManager>().localModelId }
     }
+
+    single {
+        ActivityIntentProvider {
+            Intent(androidContext(), AiStableDiffusionActivity::class.java)
+        }
+    }
 }

app/src/main/res/xml/file_provider_paths.xml

@@ -8,6 +8,10 @@
         name="folder_logs"
         path="logs/" />
 
+    <cache-path
+        name="folder_work"
+        path="work/" />
+
     <external-path name="media" path="." />
     <external-path name="external_files" path="."/>
     <external-path name="external" path="."/>

app/src/playstore/AndroidManifest.xml

@@ -10,7 +10,10 @@
     <uses-permission android:name="android.permission.READ_MEDIA_IMAGES" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
+    <uses-permission android:name="android.permission.VIBRATE" />
     <uses-permission android:name="android.permission.WAKE_LOCK" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
 
     <uses-permission
         android:name="android.permission.READ_EXTERNAL_STORAGE"

core/common/src/main/java/com/shifthackz/aisdv1/core/common/appbuild/ActivityIntentProvider.kt

@@ -0,0 +1,7 @@
+package com.shifthackz.aisdv1.core.common.appbuild
+
+import android.content.Intent
+
+fun interface ActivityIntentProvider {
+    operator fun invoke(): Intent
+}

core/ui/src/main/java/com/shifthackz/aisdv1/core/contract/RxDisposableContract.kt renamed to core/common/src/main/java/com/shifthackz/aisdv1/core/common/contract/RxDisposableContract.kt

@@ -1,4 +1,4 @@
-package com.shifthackz.aisdv1.core.contract
+package com.shifthackz.aisdv1.core.common.contract
 
 import io.reactivex.rxjava3.disposables.CompositeDisposable
 import io.reactivex.rxjava3.disposables.Disposable