feat: moves library sync to work manager and adds progress

Author: kelsos

.github/workflows/flow.yml

@@ -15,17 +15,19 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  JVM_OPTS: -Xmx3200m
+  JVM_OPTS: -Xmx6g -XX:MaxMetaspaceSize=512m -XX:+HeapDumpOnOutOfMemoryError
+  GRADLE_OPTS: -Dorg.gradle.jvmargs="-Xmx6g -XX:MaxMetaspaceSize=512m" -Dorg.gradle.daemon=false
 
 jobs:
   check:
-    timeout-minutes: 30
+    timeout-minutes: 45
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           persist-credentials: false
+          fetch-depth: 0
 
       - name: Set up JDK
         uses: actions/setup-java@v4
@@ -46,7 +48,7 @@ jobs:
         with:
           sarif_file: app/build/reports/sarif/
   test:
-    timeout-minutes: 30
+    timeout-minutes: 45
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -72,8 +74,10 @@ jobs:
         with:
           files: ./app/build/reports/kover/project-xml/report.xml
           token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: false
 
       - uses: actions/upload-artifact@v4
+        if: always()
         with:
           name: test-results
           path: app/build/test-results

app/build.gradle.kts

@@ -219,6 +219,7 @@ dependencies {
   implementation(libs.androidx.recyclerview)
   implementation(libs.androidx.core.splashscreen)
   implementation(libs.androidx.viewpager2)
+  implementation(libs.androidx.work.ktx)
   implementation(libs.androidx.swiperefreshlayout)
   implementation(libs.bundles.androidx.lifecycle)
   implementation(libs.bundles.coroutines)

app/src/main/AndroidManifest.xml

@@ -8,6 +8,7 @@
   <uses-permission android:name="android.permission.INTERNET" />
   <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
   <uses-permission android:name="android.permission.FOREGROUND_SERVICE_CONNECTED_DEVICE" />
+  <uses-permission android:name="android.permission.FOREGROUND_SERVICE_DATA_SYNC" />
   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
   <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
@@ -44,6 +45,18 @@
       </intent-filter>
     </activity>
 
+    <provider
+      android:name="androidx.startup.InitializationProvider"
+      android:authorities="${applicationId}.androidx-startup"
+      android:exported="false"
+      tools:node="merge">
+      <!-- If you are using androidx.startup to initialize other components -->
+      <meta-data
+        android:name="androidx.work.WorkManagerInitializer"
+        android:value="androidx.startup"
+        tools:node="remove" />
+    </provider>
+
     <activity
       android:name=".features.library.LibraryActivity"
       android:label="@string/nav_library"
@@ -180,6 +193,11 @@
       </intent-filter>
     </service>
 
+    <service
+      android:name="androidx.work.impl.foreground.SystemForegroundService"
+      android:foregroundServiceType="dataSync"
+      tools:node="merge" />
+
     <provider
       android:name="androidx.core.content.FileProvider"
       android:authorities="${applicationId}.fileprovider"

app/src/main/java/com/kelsos/mbrc/App.kt

@@ -16,6 +16,7 @@ import coil3.request.crossfade
 import com.kelsos.mbrc.common.utilities.CustomLoggingTree
 import org.koin.android.ext.koin.androidContext
 import org.koin.androidx.fragment.koin.fragmentFactory
+import org.koin.androidx.workmanager.koin.workManagerFactory
 import org.koin.core.context.GlobalContext.startKoin
 import org.koin.core.module.Module
 import org.koin.dsl.module
@@ -56,6 +57,7 @@ open class App : Application() {
     startKoin {
       androidContext(this@App)
       fragmentFactory()
+      workManagerFactory()
       modules(appModules())
     }
     initializeTimber()

app/src/main/java/com/kelsos/mbrc/AppModule.kt

@@ -2,6 +2,7 @@ package com.kelsos.mbrc
 
 import androidx.core.app.NotificationManagerCompat
 import androidx.room.Room
+import androidx.work.WorkManager
 import com.kelsos.mbrc.common.state.AppState
 import com.kelsos.mbrc.common.state.AppStateFlow
 import com.kelsos.mbrc.common.state.AppStateManager
@@ -24,6 +25,9 @@ import com.kelsos.mbrc.features.library.LibraryActivity
 import com.kelsos.mbrc.features.library.LibrarySearchModel
 import com.kelsos.mbrc.features.library.LibrarySyncUseCase
 import com.kelsos.mbrc.features.library.LibrarySyncUseCaseImpl
+import com.kelsos.mbrc.features.library.LibrarySyncWorkHandler
+import com.kelsos.mbrc.features.library.LibrarySyncWorkHandlerImpl
+import com.kelsos.mbrc.features.library.LibrarySyncWorker
 import com.kelsos.mbrc.features.library.LibraryViewModel
 import com.kelsos.mbrc.features.library.albums.AlbumEntryAdapter
 import com.kelsos.mbrc.features.library.albums.AlbumRepository
@@ -152,6 +156,7 @@ import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.ExecutorCoroutineDispatcher
 import kotlinx.coroutines.asCoroutineDispatcher
+import org.koin.androidx.workmanager.dsl.workerOf
 import org.koin.core.module.dsl.bind
 import org.koin.core.module.dsl.factoryOf
 import org.koin.core.module.dsl.scopedOf
@@ -196,9 +201,8 @@ val appModule =
 
     singleOf(::QueueHandler)
 
-    single<NotificationManagerCompat> {
-      NotificationManagerCompat.from(get())
-    }
+    single<NotificationManagerCompat> { NotificationManagerCompat.from(get()) }
+    single { WorkManager.getInstance(get()) }
 
     singleOf(::RemoteBroadcastReceiver)
     singleOf(::SettingsManagerImpl) { bind<SettingsManager>() }
@@ -256,8 +260,11 @@ val appModule =
     factoryOf(::SimpleLogCommand)
     factoryOf(::ProtocolVersionUpdate)
 
+    workerOf(::LibrarySyncWorker)
+
     singleOf(::RemoteServiceDiscoveryImpl) { bind<RemoteServiceDiscovery>() }
     singleOf(::WidgetUpdaterImpl) { bind<WidgetUpdater>() }
+    singleOf(::LibrarySyncWorkHandlerImpl) { bind<LibrarySyncWorkHandler>() }
 
     val network = createDispatcher(name = "Network", threads = 2)
     val database = createDispatcher(name = "Database")

app/src/main/java/com/kelsos/mbrc/features/library/LibraryActivity.kt

@@ -21,6 +21,7 @@ import com.kelsos.mbrc.BaseActivity
 import com.kelsos.mbrc.R
 import kotlinx.coroutines.launch
 import org.koin.android.ext.android.inject
+import timber.log.Timber
 
 class LibraryActivity :
   BaseActivity(R.layout.activity_library),
@@ -111,6 +112,7 @@ class LibraryActivity :
               syncComplete(event.stats)
               hideSyncProgress()
             }
+
             is LibraryUiEvent.UpdateAlbumArtistOnly -> updateArtistOnlyPreference(event.enabled)
             is LibraryUiEvent.LibrarySyncFailed -> {
               syncFailure()
@@ -120,6 +122,17 @@ class LibraryActivity :
         }
       }
     }
+
+    lifecycleScope.launch {
+      viewModel.progress.collect { progress ->
+        Timber.v("progress: $progress")
+        if (progress.running) {
+          showSyncProgress(progress)
+        } else {
+          hideSyncProgress()
+        }
+      }
+    }
   }
 
   override fun onCreateOptionsMenu(menu: Menu): Boolean {
@@ -141,16 +154,17 @@ class LibraryActivity :
     when (item.itemId) {
       R.id.library_refresh_item -> {
         viewModel.sync()
-        showSyncProgress()
         true
       }
+
       R.id.library_album_artist -> {
         albumArtistOnly?.let {
           it.isChecked = !it.isChecked
           viewModel.updateAlbumArtistOnly(it.isChecked)
         }
         true
       }
+
       R.id.library_search_clear -> {
         supportActionBar?.setTitle(R.string.nav_library)
         supportActionBar?.subtitle = ""
@@ -159,6 +173,7 @@ class LibraryActivity :
         searchClear?.isVisible = false
         true
       }
+
       R.id.library_sync_state -> {
         viewModel.displayLibraryStats()
         true
@@ -222,9 +237,25 @@ class LibraryActivity :
     Snackbar.make(pager, R.string.library__sync_failed, Snackbar.LENGTH_LONG).show()
   }
 
-  fun showSyncProgress() {
-    findViewById<LinearProgressIndicator>(R.id.sync_progress).isGone = false
-    findViewById<TextView>(R.id.sync_progress_text).isGone = false
+  fun getCategoryText(mediaType: LibraryMediaType): String =
+    when (mediaType) {
+      LibraryMediaType.Albums -> getString(R.string.media__albums)
+      LibraryMediaType.Artists -> getString(R.string.media__artists)
+      LibraryMediaType.Genres -> getString(R.string.media__genres)
+      LibraryMediaType.Playlists -> getString(R.string.media__playlists)
+      LibraryMediaType.Tracks -> getString(R.string.media__tracks)
+      LibraryMediaType.Covers -> getString(R.string.media__covers)
+    }
+
+  fun showSyncProgress(progress: LibrarySyncProgress) {
+    val syncText = findViewById<TextView>(R.id.sync_progress_text)
+    val progressIndicator = findViewById<LinearProgressIndicator>(R.id.sync_progress)
+    val categoryText = getCategoryText(progress.category)
+    syncText.isGone = false
+    syncText.text = getString(R.string.library__sync_progress, progress.current, progress.total, categoryText)
+    progressIndicator.isGone = false
+    progressIndicator.progress = progress.current
+    progressIndicator.max = progress.total
   }
 
   fun hideSyncProgress() {

app/src/main/java/com/kelsos/mbrc/features/library/LibraryMediaType.kt

@@ -0,0 +1,41 @@
+package com.kelsos.mbrc.features.library
+
+import androidx.annotation.StringRes
+import com.kelsos.mbrc.R
+
+sealed class LibraryMediaType(
+  val code: Int,
+  @StringRes val nameRes: Int = 0,
+) {
+  object Genres : LibraryMediaType(GENRES, R.string.media__genres)
+
+  object Artists : LibraryMediaType(ARTISTS, R.string.media__artists)
+
+  object Albums : LibraryMediaType(ALBUMS, R.string.media__albums)
+
+  object Tracks : LibraryMediaType(TRACKS, R.string.media__tracks)
+
+  object Playlists : LibraryMediaType(PLAYLISTS, R.string.media__playlists)
+
+  object Covers : LibraryMediaType(COVERS, R.string.media__covers)
+
+  companion object {
+    const val GENRES = 1
+    const val ARTISTS = 2
+    const val ALBUMS = 3
+    const val TRACKS = 4
+    const val PLAYLISTS = 5
+    const val COVERS = 6
+
+    fun fromCode(code: Int): LibraryMediaType =
+      when (code) {
+        GENRES -> Genres
+        ARTISTS -> Artists
+        ALBUMS -> Albums
+        TRACKS -> Tracks
+        PLAYLISTS -> Playlists
+        COVERS -> Covers
+        else -> throw IllegalArgumentException("Unknown media type code: $code")
+      }
+  }
+}

app/src/main/java/com/kelsos/mbrc/features/library/LibraryStats.kt

@@ -1,9 +1,30 @@
 package com.kelsos.mbrc.features.library
 
+import androidx.work.Data
+import androidx.work.workDataOf
+
 data class LibraryStats(
   val genres: Long,
   val artists: Long,
   val albums: Long,
   val tracks: Long,
   val playlists: Long,
 )
+
+fun LibraryStats.toWorkData(): Data =
+  workDataOf(
+    "genres" to genres,
+    "artists" to artists,
+    "albums" to albums,
+    "tracks" to tracks,
+    "playlists" to playlists,
+  )
+
+fun Data.toLibraryStats(): LibraryStats =
+  LibraryStats(
+    getLong("genres", 0),
+    getLong("artists", 0),
+    getLong("albums", 0),
+    getLong("tracks", 0),
+    getLong("playlists", 0),
+  )