Chore: Migrate to coil3 + use ArtemisImageProvider

app/src/main/java/de/tum/informatics/www1/artemis/native_app/android/ArtemisApplication.kt

@@ -5,10 +5,12 @@ import android.app.Application
 import android.app.NotificationChannel
 import android.os.Bundle
 import androidx.core.app.NotificationManagerCompat
-import coil.ImageLoader
-import coil.ImageLoaderFactory
-import coil.memory.MemoryCache
+import coil3.ImageLoader
+import coil3.PlatformContext
+import coil3.SingletonImageLoader
+import coil3.memory.MemoryCache
 import de.tum.informatics.www1.artemis.native_app.android.db.dbModule
+import de.tum.informatics.www1.artemis.native_app.core.common.ArtemisNotificationChannel
 import de.tum.informatics.www1.artemis.native_app.core.common.CurrentActivityListener
 import de.tum.informatics.www1.artemis.native_app.core.data.dataModule
 import de.tum.informatics.www1.artemis.native_app.core.datastore.datastoreModule
@@ -22,7 +24,6 @@ import de.tum.informatics.www1.artemis.native_app.feature.exerciseview.exerciseM
 import de.tum.informatics.www1.artemis.native_app.feature.lectureview.lectureModule
 import de.tum.informatics.www1.artemis.native_app.feature.login.loginModule
 import de.tum.informatics.www1.artemis.native_app.feature.metis.communicationModule
-import de.tum.informatics.www1.artemis.native_app.core.common.ArtemisNotificationChannel
 import de.tum.informatics.www1.artemis.native_app.feature.push.pushModule
 import de.tum.informatics.www1.artemis.native_app.feature.quiz.quizParticipationModule
 import de.tum.informatics.www1.artemis.native_app.feature.settings.settingsModule
@@ -32,7 +33,7 @@ import org.koin.android.ext.koin.androidContext
 import org.koin.androidx.workmanager.koin.workManagerFactory
 import org.koin.core.context.startKoin
 
-class ArtemisApplication : Application(), ImageLoaderFactory, CurrentActivityListener {
+class ArtemisApplication : Application(), SingletonImageLoader.Factory, CurrentActivityListener {
 
     override val currentActivity = MutableStateFlow<Activity?>(null)
 
@@ -84,11 +85,11 @@ class ArtemisApplication : Application(), ImageLoaderFactory, CurrentActivityLis
         registerActivityLifecycleCallbacks(this)
     }
 
-    override fun newImageLoader(): ImageLoader =
+    override fun newImageLoader(context: PlatformContext): ImageLoader =
         ImageLoader.Builder(this)
             .memoryCache {
-                MemoryCache.Builder(this)
-                    .maxSizePercent(0.25)
+                MemoryCache.Builder()
+                    .maxSizePercent(context, 0.25)
                     .build()
             }
             .build()

core/core-test/build.gradle.kts

@@ -12,6 +12,7 @@ dependencies {
     implementation(project(":core:common"))
     api(project(":core:common-test"))
     implementation(project(":core:ui"))
+    api(project(":core:ui-test"))
     implementation(project(":core:datastore"))
     implementation(project(":core:device"))
     api(project(":core:device-test"))

core/core-test/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/test/core_test_modules.kt

@@ -5,7 +5,7 @@ import de.tum.informatics.www1.artemis.native_app.core.data.test.testDataModule
 import de.tum.informatics.www1.artemis.native_app.core.datastore.ServerConfigurationService
 import de.tum.informatics.www1.artemis.native_app.core.datastore.datastoreModule
 import de.tum.informatics.www1.artemis.native_app.core.test.test_setup.TestServerConfigurationProvider
-import de.tum.informatics.www1.artemis.native_app.core.ui.uiModule
+import de.tum.informatics.www1.artemis.native_app.core.ui.test.uiTestModule
 import de.tum.informatics.www1.artemis.native_app.core.websocket.websocketModule
 import de.tum.informatics.www1.artemis.native_app.device.test.deviceTestModule
 import org.koin.dsl.module
@@ -15,7 +15,7 @@ val coreTestModules = listOf(
     testDataModule,
     datastoreModule,
     deviceTestModule,
-    uiModule,
+    uiTestModule,
     websocketModule,
     module {
         single<ServerConfigurationService> { TestServerConfigurationProvider() }

core/ui-test/build.gradle.kts

@@ -0,0 +1,18 @@
+plugins {
+    id("artemis.android.library")
+    id("artemis.android.library.compose")
+    id("artemis.android.flavor.library.instanceSelection")
+}
+
+android {
+    namespace = "de.tum.informatics.www1.artemis.native_app.core.ui.test"
+}
+
+dependencies {
+    implementation(project(":core:ui"))
+
+    implementation(libs.koin.core)
+    implementation(libs.kotlinx.coroutines.core)
+
+    implementation(libs.coil.test)
+}

core/ui-test/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/test/ArtemisImageProviderStub.kt

@@ -0,0 +1,42 @@
+package de.tum.informatics.www1.artemis.native_app.core.ui.test
+
+import android.content.Context
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.platform.LocalContext
+import coil3.ImageLoader
+import coil3.SingletonImageLoader
+import coil3.annotation.DelicateCoilApi
+import coil3.request.ImageRequest
+import coil3.test.FakeImage
+import coil3.test.FakeImageLoaderEngine
+import de.tum.informatics.www1.artemis.native_app.core.ui.remote_images.ArtemisImageProvider
+
+
+@OptIn(DelicateCoilApi::class)
+class ArtemisImageProviderStub : ArtemisImageProvider {
+
+    companion object {
+        fun setup(context: Context) {
+            // For more info on testing coil, see: https://coil-kt.github.io/coil/testing/
+            val engine = FakeImageLoaderEngine.Builder()
+                .default(FakeImage(color = 0x00F))
+                .build()
+            val imageLoader = ImageLoader.Builder(context)
+                .components { add(engine) }
+                .build()
+            SingletonImageLoader.setUnsafe(imageLoader)
+        }
+    }
+
+    @Composable
+    override fun rememberArtemisImageRequest(imagePath: String): ImageRequest {
+        return ImageRequest.Builder(LocalContext.current)
+            .data(imagePath)
+            .build()
+    }
+
+    @Composable
+    override fun rememberArtemisImageLoader(): coil.ImageLoader {
+        return coil.ImageLoader(LocalContext.current)
+    }
+}

core/ui-test/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/test/ui_test_module.kt

@@ -0,0 +1,8 @@
+package de.tum.informatics.www1.artemis.native_app.core.ui.test
+
+import de.tum.informatics.www1.artemis.native_app.core.ui.remote_images.ArtemisImageProvider
+import org.koin.dsl.module
+
+val uiTestModule = module {
+    single<ArtemisImageProvider> { ArtemisImageProviderStub() }
+}

core/ui/build.gradle.kts

@@ -26,7 +26,11 @@ dependencies {
     api(libs.androidx.compose.ui.util)
     api(libs.androidx.compose.runtime)
     api(libs.androidx.navigation.compose)
+    api(libs.coil2.base)
     api(libs.coil.compose)
+    api(libs.coil.network)
+    debugApi(libs.coil.compose.core)
+    debugApi(libs.coil.test)
     api(libs.accompanist.webview)
 
     implementation(libs.kotlinx.datetime)

core/ui/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/common/course/CourseListUi.kt

@@ -53,7 +53,7 @@ import de.tum.informatics.www1.artemis.native_app.core.ui.R
 import de.tum.informatics.www1.artemis.native_app.core.ui.common.AutoResizeText
 import de.tum.informatics.www1.artemis.native_app.core.ui.common.FontSizeRange
 import de.tum.informatics.www1.artemis.native_app.core.ui.getWindowSizeClass
-import de.tum.informatics.www1.artemis.native_app.core.ui.remote_images.LocalCourseImageProvider
+import de.tum.informatics.www1.artemis.native_app.core.ui.remote_images.LocalArtemisImageProvider
 
 private val headerHeight = 80.dp
 
@@ -100,13 +100,11 @@ fun Modifier.computeCourseItemModifier(isCompact: Boolean): Modifier {
 fun CompactCourseItemHeader(
     modifier: Modifier,
     course: Course,
-    serverUrl: String,
-    authorizationToken: String,
     compactCourseHeaderViewMode: CompactCourseHeaderViewMode,
     onClick: () -> Unit = {},
     content: @Composable ColumnScope.() -> Unit
 ) {
-    val painter = getCourseIconPainter(course, serverUrl, authorizationToken)
+    val painter = getCourseIconPainter(course)
 
     Card(modifier = modifier, onClick = onClick) {
         Column(
@@ -173,14 +171,10 @@ fun CompactCourseItemHeader(
 @Composable
 private fun getCourseIconPainter(
     course: Course,
-    serverUrl: String,
-    authorizationToken: String
 ): Painter {
     return if (course.courseIconPath != null) {
-        LocalCourseImageProvider.current.rememberCourseImagePainter(
-            courseIconPath = course.courseIconPath.orEmpty(),
-            serverUrl = serverUrl,
-            authorizationToken = authorizationToken
+        LocalArtemisImageProvider.current.rememberArtemisAsyncImagePainter(
+            imagePath = course.courseIconPath.orEmpty()
         )
     } else rememberVectorPainter(image = Icons.Default.QuestionMark)
 }
@@ -189,13 +183,11 @@ private fun getCourseIconPainter(
 fun ExpandedCourseItemHeader(
     modifier: Modifier,
     course: Course,
-    serverUrl: String,
-    authorizationToken: String,
     onClick: () -> Unit = {},
     content: @Composable ColumnScope.() -> Unit,
     rightHeaderContent: @Composable BoxScope.() -> Unit
 ) {
-    val courseIconPainter = getCourseIconPainter(course, serverUrl, authorizationToken)
+    val courseIconPainter = getCourseIconPainter(course)
 
     val courseColor: Color? = remember {
         try {

core/ui/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/common/image/RetryableAsyncImage.kt

@@ -1,6 +1,5 @@
 package de.tum.informatics.www1.artemis.native_app.core.ui.common.image
 
-import android.graphics.drawable.Drawable
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.derivedStateOf
@@ -9,16 +8,17 @@ import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.platform.LocalContext
-import coil.imageLoader
-import coil.request.ErrorResult
-import coil.request.ImageRequest
-import coil.request.SuccessResult
+import coil3.Image
+import coil3.imageLoader
+import coil3.request.ErrorResult
+import coil3.request.ImageRequest
+import coil3.request.SuccessResult
 import de.tum.informatics.www1.artemis.native_app.core.data.DataState
 
 @Composable
 fun loadAsyncImageDrawable(request: ImageRequest): AsyncImageDrawableResult {
     val context = LocalContext.current
-    var dataState: DataState<Drawable> by remember(request) { mutableStateOf(DataState.Loading()) }
+    var dataState: DataState<Image> by remember(request) { mutableStateOf(DataState.Loading()) }
 
     // We simply increase this counter to trigger a reload
     var reloadCounter by remember(request) { mutableStateOf(0) }
@@ -31,7 +31,7 @@ fun loadAsyncImageDrawable(request: ImageRequest): AsyncImageDrawableResult {
             }
 
             is SuccessResult -> {
-                DataState.Success(result.drawable)
+                DataState.Success(result.image)
             }
         }
     }
@@ -48,6 +48,6 @@ fun loadAsyncImageDrawable(request: ImageRequest): AsyncImageDrawableResult {
 }
 
 data class AsyncImageDrawableResult(
-    val dataState: DataState<Drawable>,
+    val dataState: DataState<Image>,
     val requestRetry: () -> Unit
 )

core/ui/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/markdown/LocalMarkwon.kt

@@ -6,14 +6,15 @@ import androidx.compose.runtime.ProvidableCompositionLocal
 import androidx.compose.runtime.compositionLocalOf
 import androidx.compose.runtime.remember
 import androidx.compose.ui.platform.LocalContext
-import coil.ImageLoader
+import de.tum.informatics.www1.artemis.native_app.core.ui.remote_images.LocalArtemisImageProvider
 import io.noties.markwon.Markwon
 
 val LocalMarkwon: ProvidableCompositionLocal<Markwon?> =
     compositionLocalOf { null }
 
 @Composable
-fun ProvideMarkwon(imageLoader: ImageLoader? = null, content: @Composable () -> Unit) {
+fun ProvideMarkwon(content: @Composable () -> Unit) {
+    val imageLoader = LocalArtemisImageProvider.current.rememberArtemisImageLoader()
     val context = LocalContext.current
 
     val imageWith = context.resources.displayMetrics.widthPixels

core/ui/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/remote_images/ArtemisImageProvider.kt

@@ -2,9 +2,10 @@ package de.tum.informatics.www1.artemis.native_app.core.ui.remote_images
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.compositionLocalOf
-import coil.compose.AsyncImagePainter
-import coil.compose.rememberAsyncImagePainter
-import coil.request.ImageRequest
+import coil.ImageLoader
+import coil3.compose.AsyncImagePainter
+import coil3.compose.rememberAsyncImagePainter
+import coil3.request.ImageRequest
 
 
 val LocalArtemisImageProvider = compositionLocalOf<ArtemisImageProvider> { error("No ArtemisImageProvider provided") }
@@ -24,5 +25,8 @@ interface ArtemisImageProvider {
     fun rememberArtemisAsyncImagePainter(
         imagePath: String,
     ): AsyncImagePainter = rememberAsyncImagePainter(model = rememberArtemisImageRequest(imagePath))
+
+    @Composable
+    fun rememberArtemisImageLoader() : ImageLoader
 }
 

core/ui/src/main/kotlin/de/tum/informatics/www1/artemis/native_app/core/ui/remote_images/BaseImageProvider.kt

@@ -2,13 +2,12 @@ package de.tum.informatics.www1.artemis.native_app.core.ui.remote_images
 
 import android.content.Context
 import coil.ImageLoader
-import coil.request.ImageRequest
+import coil3.request.ImageRequest
 
 interface BaseImageProvider {
     fun createImageRequest(
         context: Context,
-        imagePath: String,
-        serverUrl: String,
+        imageUrl: String,
         authorizationToken: String,
         memoryCacheKey: String? = null
     ): ImageRequest