Fix passing global ImageLoader extras to Options. (#2223)

* Add regression test for RequestService setting bitmap config. * Update test. * Fix bug.
coil-kt · May 9, 2024 · 5db3838 · 5db3838
1 parent fb469cb
commit 5db3838
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/coil-core/api/android/coil-core.api b/coil-core/api/android/coil-core.api
@@ -109,6 +109,7 @@ public final class coil3/Extras {
 public final class coil3/Extras$Builder {
 	public fun <init> ()V
 	public fun <init> (Lcoil3/Extras;)V
+	public fun <init> (Ljava/util/Map;)V
 	public final fun build ()Lcoil3/Extras;
 	public final fun set (Lcoil3/Extras$Key;Ljava/lang/Object;)Lcoil3/Extras$Builder;
 	public final fun setAll (Lcoil3/Extras;)Lcoil3/Extras$Builder;
@@ -131,6 +132,7 @@ public final class coil3/ExtrasKt {
 	public static final fun getExtra (Lcoil3/request/Options;Lcoil3/Extras$Key;)Ljava/lang/Object;
 	public static final fun getOrDefault (Lcoil3/Extras;Lcoil3/Extras$Key;)Ljava/lang/Object;
 	public static final fun orEmpty (Lcoil3/Extras;)Lcoil3/Extras;
+	public static final fun plus (Lcoil3/Extras;Lcoil3/Extras;)Lcoil3/Extras;
 }
 
 public abstract interface class coil3/Image {

diff --git a/coil-core/api/jvm/coil-core.api b/coil-core/api/jvm/coil-core.api
@@ -95,6 +95,7 @@ public final class coil3/Extras {
 public final class coil3/Extras$Builder {
 	public fun <init> ()V
 	public fun <init> (Lcoil3/Extras;)V
+	public fun <init> (Ljava/util/Map;)V
 	public final fun build ()Lcoil3/Extras;
 	public final fun set (Lcoil3/Extras$Key;Ljava/lang/Object;)Lcoil3/Extras$Builder;
 	public final fun setAll (Lcoil3/Extras;)Lcoil3/Extras$Builder;
@@ -117,6 +118,7 @@ public final class coil3/ExtrasKt {
 	public static final fun getExtra (Lcoil3/request/Options;Lcoil3/Extras$Key;)Ljava/lang/Object;
 	public static final fun getOrDefault (Lcoil3/Extras;Lcoil3/Extras$Key;)Ljava/lang/Object;
 	public static final fun orEmpty (Lcoil3/Extras;)Lcoil3/Extras;
+	public static final fun plus (Lcoil3/Extras;Lcoil3/Extras;)Lcoil3/Extras;
 }
 
 public abstract interface class coil3/Image {

diff --git a/coil-core/src/androidMain/kotlin/coil3/request/RequestService.kt b/coil-core/src/androidMain/kotlin/coil3/request/RequestService.kt
@@ -99,14 +99,14 @@ internal class AndroidRequestService(
             transformations.isEmpty() &&
             bitmapConfig != Bitmap.Config.ALPHA_8
 
-        var builder: Extras.Builder? = null
+        var builder = Extras.Builder(defaults.extras.asMap() + extras.asMap())
         if (bitmapConfig != this.bitmapConfig) {
-            builder = extras.newBuilder().set(Extras.Key.bitmapConfig, bitmapConfig)
+            builder = builder.set(Extras.Key.bitmapConfig, bitmapConfig)
         }
         if (allowRgb565 != this.allowRgb565) {
-            builder = (builder ?: extras.newBuilder()).set(Extras.Key.allowRgb565, allowRgb565)
+            builder = builder.set(Extras.Key.allowRgb565, allowRgb565)
         }
-        return builder?.build() ?: extras
+        return builder.build()
     }
 
     override fun updateOptionsOnWorkerThread(options: Options): Options {

diff --git a/coil-core/src/androidUnitTest/kotlin/coil3/request/RequestServiceTest.kt b/coil-core/src/androidUnitTest/kotlin/coil3/request/RequestServiceTest.kt
@@ -128,4 +128,18 @@ class RequestServiceTest : RobolectricTest() {
         val options = service.options(request, Size(100, 100))
         assertEquals(Bitmap.Config.RGB_565, options.bitmapConfig)
     }
+
+    /** Regression test: https://github.com/coil-kt/coil/issues/2221 */
+    @Test
+    fun `ImageLoader bitmapConfig is preserved`() {
+        val imageLoader = ImageLoader.Builder(context)
+            .bitmapConfig(Bitmap.Config.RGB_565)
+            .build()
+        val request = ImageRequest.Builder(context)
+            .data(Unit)
+            .defaults(imageLoader.defaults)
+            .build()
+        val options = service.options(request, Size(100, 100))
+        assertEquals(Bitmap.Config.RGB_565, options.bitmapConfig)
+    }
 }
diff --git a/coil-core/src/commonMain/kotlin/coil3/Extras.kt b/coil-core/src/commonMain/kotlin/coil3/Extras.kt
@@ -41,6 +41,10 @@ class Extras private constructor(
             data = mutableMapOf()
         }
 
+        constructor(map: Map<Key<*>, Any>) {
+            data = map.toMutableMap()
+        }
+
         constructor(extras: Extras) {
             data = extras.data.toMutableMap()
         }
@@ -70,6 +74,10 @@ class Extras private constructor(
     }
 }
 
+operator fun Extras.plus(other: Extras): Extras {
+    return Extras.Builder(asMap() + other.asMap()).build()
+}
+
 fun <T> Extras.getOrDefault(key: Extras.Key<T>): T {
     return this[key] ?: key.default
 }