From 57bf81232b81abae8c1de5fd59fb3fc00f885246 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ga=C3=ABtan=20Muller?= <gaetan.muller@rts.ch>
Date: Mon, 25 Nov 2024 11:39:25 +0100
Subject: [PATCH] Upgrade to Coil 3.0.3 (#801)

---
 gradle/libs.versions.toml                     | 10 ++++--
 gradle/wrapper/gradle-wrapper.properties      |  2 +-
 pillarbox-demo-tv/build.gradle.kts            |  7 +++-
 .../src/main/AndroidManifest.xml              |  1 +
 .../pillarbox/demo/tv/DemoApplication.kt      | 33 +++++++++++++++++++
 .../demo/tv/ui/examples/ExamplesHome.kt       |  2 +-
 .../pillarbox/demo/tv/ui/lists/ListsHome.kt   |  2 +-
 .../tv/ui/player/compose/MediaMetadataView.kt |  2 +-
 pillarbox-demo/build.gradle.kts               |  6 +++-
 .../srgssr/pillarbox/demo/DemoApplication.kt  | 26 +++++++++++++--
 .../ui/player/controls/MediaMetadataView.kt   |  2 +-
 .../ui/showcases/layouts/ChapterShowcase.kt   |  2 +-
 .../layouts/thumbnail/ThumbnailViewModel.kt   | 16 ++++-----
 13 files changed, 88 insertions(+), 23 deletions(-)
 create mode 100644 pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/DemoApplication.kt

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
index f94e1e707..4d170abca 100644
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -16,7 +16,7 @@ androidx-test-ext-junit = "1.2.1"
 androidx-test-monitor = "1.7.2"
 androidx-test-runner = "1.6.2"
 androidx-tv-material = "1.0.0"
-coil = "2.7.0"
+coil = "3.0.3"
 comscore = "6.11.1"
 dependency-analysis-gradle-plugin = "2.4.2"
 detekt = "1.23.7"
@@ -63,8 +63,12 @@ androidx-test-core = { module = "androidx.test:core", version.ref = "androidx-te
 androidx-test-monitor = { module = "androidx.test:monitor", version.ref = "androidx-test-monitor" }
 androidx-test-runner = { module = "androidx.test:runner", version.ref = "androidx-test-runner" }
 androidx-tv-material = { module = "androidx.tv:tv-material", version.ref = "androidx-tv-material" }
-coil = { group = "io.coil-kt", name = "coil-compose", version.ref = "coil" }
-coil-base = { module = "io.coil-kt:coil-compose-base", version.ref = "coil" }
+coil = { group = "io.coil-kt.coil3", name = "coil", version.ref = "coil" }
+coil-compose = { group = "io.coil-kt.coil3", name = "coil-compose", version.ref = "coil" }
+coil-core = { group = "io.coil-kt.coil3", name = "coil-core", version.ref = "coil" }
+coil-network-cache-control = { group = "io.coil-kt.coil3", name = "coil-network-cache-control", version.ref = "coil" }
+coil-network-core = { group = "io.coil-kt.coil3", name = "coil-network-core", version.ref = "coil" }
+coil-network-okhttp = { group = "io.coil-kt.coil3", name = "coil-network-okhttp", version.ref = "coil" }
 dokka-gradle-plugin = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 json = { module = "org.json:json", version.ref = "json" }
 kotlin-gradle-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
index 7cf748e74..c1d5e0185 100644
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.11-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
diff --git a/pillarbox-demo-tv/build.gradle.kts b/pillarbox-demo-tv/build.gradle.kts
index c9a27220e..892f6dba2 100644
--- a/pillarbox-demo-tv/build.gradle.kts
+++ b/pillarbox-demo-tv/build.gradle.kts
@@ -41,10 +41,15 @@ dependencies {
     implementation(libs.androidx.paging.compose)
     implementation(libs.androidx.tv.material)
     implementation(libs.coil)
-    implementation(libs.coil.base)
+    implementation(libs.coil.compose)
+    implementation(libs.coil.core)
+    implementation(libs.coil.network.cache.control)
+    implementation(libs.coil.network.core)
+    implementation(libs.coil.network.okhttp)
     implementation(libs.kotlin.stdlib)
     implementation(libs.kotlinx.coroutines.core)
     implementation(libs.kotlinx.serialization.core)
+    implementation(libs.okhttp)
     implementation(libs.srg.data)
     implementation(libs.srg.dataprovider.retrofit)
 
diff --git a/pillarbox-demo-tv/src/main/AndroidManifest.xml b/pillarbox-demo-tv/src/main/AndroidManifest.xml
index 40291e0f5..ac6094667 100644
--- a/pillarbox-demo-tv/src/main/AndroidManifest.xml
+++ b/pillarbox-demo-tv/src/main/AndroidManifest.xml
@@ -12,6 +12,7 @@
         android:required="false" />
 
     <application
+        android:name=".DemoApplication"
         android:allowBackup="true"
         android:banner="@mipmap/ic_pillarbox_banner"
         android:icon="@mipmap/ic_launcher_pillarbox"
diff --git a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/DemoApplication.kt b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/DemoApplication.kt
new file mode 100644
index 000000000..6ebcf02b5
--- /dev/null
+++ b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/DemoApplication.kt
@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) SRG SSR. All rights reserved.
+ * License information is available from the LICENSE file.
+ */
+package ch.srgssr.pillarbox.demo.tv
+
+import android.app.Application
+import ch.srgssr.pillarbox.player.network.PillarboxOkHttp
+import coil3.ImageLoader
+import coil3.PlatformContext
+import coil3.SingletonImageLoader
+import coil3.annotation.ExperimentalCoilApi
+import coil3.network.cachecontrol.CacheControlCacheStrategy
+import coil3.network.okhttp.OkHttpNetworkFetcherFactory
+
+/**
+ * Demo application that sets up Coil.
+ */
+class DemoApplication : Application(), SingletonImageLoader.Factory {
+    @OptIn(ExperimentalCoilApi::class)
+    override fun newImageLoader(context: PlatformContext): ImageLoader {
+        return ImageLoader.Builder(context)
+            .components {
+                add(
+                    OkHttpNetworkFetcherFactory(
+                        callFactory = { PillarboxOkHttp() },
+                        cacheStrategy = { CacheControlCacheStrategy() },
+                    )
+                )
+            }
+            .build()
+    }
+}
diff --git a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/examples/ExamplesHome.kt b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/examples/ExamplesHome.kt
index 0be65f5c8..70cc67bb8 100644
--- a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/examples/ExamplesHome.kt
+++ b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/examples/ExamplesHome.kt
@@ -57,7 +57,7 @@ import ch.srgssr.pillarbox.demo.shared.ui.NavigationRoutes
 import ch.srgssr.pillarbox.demo.shared.ui.examples.ExamplesViewModel
 import ch.srgssr.pillarbox.demo.tv.ui.theme.PillarboxTheme
 import ch.srgssr.pillarbox.demo.tv.ui.theme.paddings
-import coil.compose.AsyncImage
+import coil3.compose.AsyncImage
 import kotlinx.coroutines.launch
 
 /**
diff --git a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/lists/ListsHome.kt b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/lists/ListsHome.kt
index f51c24fd9..589444173 100644
--- a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/lists/ListsHome.kt
+++ b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/lists/ListsHome.kt
@@ -91,7 +91,7 @@ import ch.srgssr.pillarbox.demo.tv.R
 import ch.srgssr.pillarbox.demo.tv.ui.player.PlayerActivity
 import ch.srgssr.pillarbox.demo.tv.ui.theme.PillarboxTheme
 import ch.srgssr.pillarbox.demo.tv.ui.theme.paddings
-import coil.compose.AsyncImage
+import coil3.compose.AsyncImage
 import kotlinx.coroutines.flow.flowOf
 import kotlinx.coroutines.launch
 import java.util.Date
diff --git a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/player/compose/MediaMetadataView.kt b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/player/compose/MediaMetadataView.kt
index 92cec5c4b..60ca70b28 100644
--- a/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/player/compose/MediaMetadataView.kt
+++ b/pillarbox-demo-tv/src/main/java/ch/srgssr/pillarbox/demo/tv/ui/player/compose/MediaMetadataView.kt
@@ -29,7 +29,7 @@ import androidx.tv.material3.MaterialTheme
 import androidx.tv.material3.Text
 import ch.srgssr.pillarbox.demo.tv.ui.theme.PillarboxTheme
 import ch.srgssr.pillarbox.demo.tv.ui.theme.paddings
-import coil.compose.AsyncImage
+import coil3.compose.AsyncImage
 
 /**
  * Media metadata view
diff --git a/pillarbox-demo/build.gradle.kts b/pillarbox-demo/build.gradle.kts
index 4a91c89f8..873c26083 100644
--- a/pillarbox-demo/build.gradle.kts
+++ b/pillarbox-demo/build.gradle.kts
@@ -85,7 +85,11 @@ dependencies {
     implementation(libs.androidx.paging.common)
     implementation(libs.androidx.paging.compose)
     implementation(libs.coil)
-    implementation(libs.coil.base)
+    implementation(libs.coil.compose)
+    implementation(libs.coil.core)
+    implementation(libs.coil.network.cache.control)
+    implementation(libs.coil.network.core)
+    implementation(libs.coil.network.okhttp)
     implementation(libs.guava)
     implementation(libs.kotlin.stdlib)
     implementation(libs.kotlinx.coroutines.core)
diff --git a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/DemoApplication.kt b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/DemoApplication.kt
index bc41841ca..05934214a 100644
--- a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/DemoApplication.kt
+++ b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/DemoApplication.kt
@@ -9,12 +9,18 @@ import ch.srgssr.pillarbox.analytics.AnalyticsConfig
 import ch.srgssr.pillarbox.analytics.SRGAnalytics.initSRGAnalytics
 import ch.srgssr.pillarbox.analytics.UserConsent
 import ch.srgssr.pillarbox.analytics.comscore.ComScoreUserConsent
+import ch.srgssr.pillarbox.player.network.PillarboxOkHttp
+import coil3.ImageLoader
+import coil3.PlatformContext
+import coil3.SingletonImageLoader
+import coil3.annotation.ExperimentalCoilApi
+import coil3.network.cachecontrol.CacheControlCacheStrategy
+import coil3.network.okhttp.OkHttpNetworkFetcherFactory
 
 /**
- * Demo application
- *  - Init SRG Analytics
+ * Demo application that initializes SRG Analytics and Coil.
  */
-class DemoApplication : Application() {
+class DemoApplication : Application(), SingletonImageLoader.Factory {
 
     override fun onCreate() {
         super.onCreate()
@@ -32,4 +38,18 @@ class DemoApplication : Application() {
         )
         initSRGAnalytics(config = config)
     }
+
+    @OptIn(ExperimentalCoilApi::class)
+    override fun newImageLoader(context: PlatformContext): ImageLoader {
+        return ImageLoader.Builder(context)
+            .components {
+                add(
+                    OkHttpNetworkFetcherFactory(
+                        callFactory = { PillarboxOkHttp() },
+                        cacheStrategy = { CacheControlCacheStrategy() },
+                    )
+                )
+            }
+            .build()
+    }
 }
diff --git a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/controls/MediaMetadataView.kt b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/controls/MediaMetadataView.kt
index abcc603e9..50c29e176 100644
--- a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/controls/MediaMetadataView.kt
+++ b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/player/controls/MediaMetadataView.kt
@@ -21,7 +21,7 @@ import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
 import androidx.media3.common.MediaMetadata
 import ch.srgssr.pillarbox.demo.ui.theme.paddings
-import coil.compose.AsyncImage
+import coil3.compose.AsyncImage
 
 /**
  * Media metadata view
diff --git a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/ChapterShowcase.kt b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/ChapterShowcase.kt
index 993a55f90..ba1ea91aa 100644
--- a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/ChapterShowcase.kt
+++ b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/ChapterShowcase.kt
@@ -51,7 +51,7 @@ import ch.srgssr.pillarbox.demo.ui.player.PlayerView
 import ch.srgssr.pillarbox.demo.ui.theme.PillarboxTheme
 import ch.srgssr.pillarbox.demo.ui.theme.paddings
 import ch.srgssr.pillarbox.player.asset.timeRange.Chapter
-import coil.compose.AsyncImage
+import coil3.compose.AsyncImage
 import kotlin.time.Duration.Companion.minutes
 
 /**
diff --git a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/thumbnail/ThumbnailViewModel.kt b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/thumbnail/ThumbnailViewModel.kt
index d775f3118..b15a1aefb 100644
--- a/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/thumbnail/ThumbnailViewModel.kt
+++ b/pillarbox-demo/src/main/java/ch/srgssr/pillarbox/demo/ui/showcases/layouts/thumbnail/ThumbnailViewModel.kt
@@ -6,7 +6,6 @@ package ch.srgssr.pillarbox.demo.ui.showcases.layouts.thumbnail
 
 import android.app.Application
 import android.graphics.Bitmap
-import android.graphics.drawable.BitmapDrawable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.setValue
@@ -16,12 +15,13 @@ import androidx.media3.exoplayer.image.ImageOutput
 import ch.srgssr.pillarbox.core.business.PillarboxExoPlayer
 import ch.srgssr.pillarbox.core.business.SRGMediaItem
 import ch.srgssr.pillarbox.demo.shared.data.DemoItem
-import ch.srgssr.pillarbox.player.network.PillarboxOkHttp
 import ch.srgssr.pillarbox.ui.ProgressTrackerState
 import ch.srgssr.pillarbox.ui.SmoothProgressTrackerState
-import coil.imageLoader
-import coil.request.ImageRequest
-import coil.size.Scale
+import coil3.BitmapImage
+import coil3.imageLoader
+import coil3.request.ImageRequest
+import coil3.request.allowConversionToBitmap
+import coil3.size.Scale
 
 /**
  * A ViewModel to demonstrate how to work with Image track.
@@ -29,9 +29,7 @@ import coil.size.Scale
  * @param application The [Application].
  */
 class ThumbnailViewModel(application: Application) : AndroidViewModel(application), ImageOutput {
-    private val imageLoader = application.imageLoader.newBuilder()
-        .okHttpClient(PillarboxOkHttp())
-        .build()
+    private val imageLoader = application.imageLoader
 
     /**
      * Player
@@ -44,7 +42,7 @@ class ThumbnailViewModel(application: Application) : AndroidViewModel(applicatio
                     .scale(Scale.FILL) // FILL to have the source image size!
                     .allowConversionToBitmap(enable = true)
                     .target { result ->
-                        val bitmap = (result as BitmapDrawable).bitmap
+                        val bitmap = (result as BitmapImage).bitmap
                         onComplete(bitmap)
                     }
                     .build()