Creates callback api to notify when image becomes visible to user

PiperOrigin-RevId: 774423696

Author: falhassen

integration/compose/src/androidTest/java/com/bumptech/glide/integration/compose/GlideImageTest.kt

@@ -16,7 +16,9 @@ import androidx.compose.ui.platform.LocalDensity
 import androidx.compose.ui.test.assert
 import androidx.compose.ui.test.onNodeWithContentDescription
 import androidx.compose.ui.test.onNodeWithText
+import androidx.compose.ui.test.onRoot
 import androidx.compose.ui.test.performClick
+import androidx.compose.ui.test.printToString
 import androidx.compose.ui.unit.dp
 import androidx.test.core.app.ApplicationProvider
 import com.bumptech.glide.Glide
@@ -37,6 +39,9 @@ import java.util.concurrent.atomic.AtomicInteger
 import java.util.concurrent.atomic.AtomicReference
 import org.junit.Rule
 import org.junit.Test
+import org.mockito.kotlin.any
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.verify
 
 class GlideImageTest {
   private val context: Context = ApplicationProvider.getApplicationContext()
@@ -64,7 +69,7 @@ class GlideImageTest {
       GlideImage(
         model = resourceId,
         contentDescription = description,
-        modifier = Modifier.size(300.dp, 300.dp)
+        modifier = Modifier.size(300.dp, 300.dp),
       )
     }
 
@@ -95,7 +100,7 @@ class GlideImageTest {
         GlideImage(
           model = model.value,
           modifier = Modifier.size(100.dp),
-          contentDescription = description
+          contentDescription = description,
         )
       }
     }
@@ -119,7 +124,7 @@ class GlideImageTest {
         model = android.R.drawable.star_big_on,
         requestBuilderTransform = { it.fitCenter() },
         contentDescription = description,
-        modifier = Modifier.size(viewDimension.dp, viewDimension.dp)
+        modifier = Modifier.size(viewDimension.dp, viewDimension.dp),
       )
 
       with(LocalDensity.current) {
@@ -161,68 +166,47 @@ class GlideImageTest {
     val description = "test"
     glideComposeRule.setContent {
       Box(modifier = Modifier.size(0.dp)) {
-        GlideImage(
-          model = android.R.drawable.star_big_on,
-          contentDescription = description,
-        )
+        GlideImage(model = android.R.drawable.star_big_on, contentDescription = description)
       }
     }
     glideComposeRule.waitForIdle()
-    glideComposeRule
-      .onNodeWithContentDescription(description)
-      .assertDisplays(null)
+    glideComposeRule.onNodeWithContentDescription(description).assertDisplays(null)
   }
 
-
   @Test
   fun glideImage_withNegativeSize_doesNotStartLoad() {
     val description = "test"
     glideComposeRule.setContent {
       Box(modifier = Modifier.size((-10).dp)) {
-        GlideImage(
-          model = android.R.drawable.star_big_on,
-          contentDescription = description,
-        )
+        GlideImage(model = android.R.drawable.star_big_on, contentDescription = description)
       }
     }
     glideComposeRule.waitForIdle()
-    glideComposeRule
-      .onNodeWithContentDescription(description)
-      .assertDisplays(null)
+    glideComposeRule.onNodeWithContentDescription(description).assertDisplays(null)
   }
 
   @Test
   fun glideImage_withZeroWidth_validHeight_doesNotStartLoad() {
     val description = "test"
     glideComposeRule.setContent {
       Box(modifier = Modifier.size(0.dp, 10.dp)) {
-        GlideImage(
-          model = android.R.drawable.star_big_on,
-          contentDescription = description,
-        )
+        GlideImage(model = android.R.drawable.star_big_on, contentDescription = description)
       }
     }
     glideComposeRule.waitForIdle()
-    glideComposeRule
-      .onNodeWithContentDescription(description)
-      .assertDisplays(null)
+    glideComposeRule.onNodeWithContentDescription(description).assertDisplays(null)
   }
 
   @Test
   fun glideImage_withValidWidth_zeroHeight_doesNotStartLoad() {
     val description = "test"
     glideComposeRule.setContent {
       Box(modifier = Modifier.size(10.dp, 0.dp)) {
-        GlideImage(
-          model = android.R.drawable.star_big_on,
-          contentDescription = description,
-        )
+        GlideImage(model = android.R.drawable.star_big_on, contentDescription = description)
       }
     }
     glideComposeRule.waitForIdle()
-    glideComposeRule
-      .onNodeWithContentDescription(description)
-      .assertDisplays(null)
+    glideComposeRule.onNodeWithContentDescription(description).assertDisplays(null)
   }
 
   @Test
@@ -238,10 +222,7 @@ class GlideImageTest {
 
       TextButton(onClick = ::swapSize) { Text(text = "Swap") }
       Box(modifier = Modifier.size(currentSize.value)) {
-        GlideImage(
-          model = resourceId,
-          contentDescription = description,
-        )
+        GlideImage(model = resourceId, contentDescription = description)
       }
     }
     glideComposeRule.waitForIdle()
@@ -268,10 +249,7 @@ class GlideImageTest {
 
       TextButton(onClick = ::swapSize) { Text(text = "Swap") }
       Box(modifier = Modifier.size(currentSize.value)) {
-        GlideImage(
-          model = resourceId,
-          contentDescription = description,
-        )
+        GlideImage(model = resourceId, contentDescription = description)
       }
     }
     repeat(validSizeDps.size) {
@@ -291,28 +269,29 @@ class GlideImageTest {
   @Test
   fun glideImage_withSuccessfulResource_callsOnResourceReadyOnce() {
     val onResourceReadyCounter = AtomicInteger()
-    val requestListener = object : RequestListener<Drawable> {
-      override fun onLoadFailed(
-        e: GlideException?,
-        model: Any?,
-        target: Target<Drawable>?,
-        isFirstResource: Boolean,
-      ): Boolean {
-        throw UnsupportedOperationException()
+    val requestListener =
+      object : RequestListener<Drawable> {
+        override fun onLoadFailed(
+          e: GlideException?,
+          model: Any?,
+          target: Target<Drawable>?,
+          isFirstResource: Boolean,
+        ): Boolean {
+          throw UnsupportedOperationException()
+        }
+
+        override fun onResourceReady(
+          resource: Drawable?,
+          model: Any?,
+          target: Target<Drawable>?,
+          dataSource: DataSource?,
+          isFirstResource: Boolean,
+        ): Boolean {
+          onResourceReadyCounter.incrementAndGet()
+          return false
+        }
       }
 
-      override fun onResourceReady(
-        resource: Drawable?,
-        model: Any?,
-        target: Target<Drawable>?,
-        dataSource: DataSource?,
-        isFirstResource: Boolean,
-      ): Boolean {
-        onResourceReadyCounter.incrementAndGet()
-        return false
-      }
-    }
-
     glideComposeRule.setContent {
       GlideImage(model = android.R.drawable.star_big_on, contentDescription = "") {
         it.listener(requestListener)
@@ -323,4 +302,31 @@ class GlideImageTest {
 
     assertThat(onResourceReadyCounter.get()).isEqualTo(1)
   }
+
+  @Test
+  fun glideImage_loadImageFromFile_callsOnImageVisibleToUser() {
+    val onImageVisibleToUser = mock<(Drawable) -> Unit>()
+
+    glideComposeRule.setContent {
+      GlideImage(
+        model = android.R.drawable.star_big_on,
+        contentDescription = "star",
+        onImageVisibleToUser = onImageVisibleToUser,
+      )
+    }
+    glideComposeRule.waitUntilContentDescriptionWithinRootNode("star")
+
+    verify(onImageVisibleToUser).invoke(any())
+  }
+
+  private fun GlideComposeRule.waitUntilContentDescriptionWithinRootNode(
+    contentDescription: String
+  ) {
+    waitUntil(
+      conditionDescription = "waitUntilContentDescriptionWithinRootNode",
+      timeoutMillis = 10000,
+    ) {
+      onRoot(useUnmergedTree = false).printToString().contains(contentDescription)
+    }
+  }
 }

integration/compose/src/main/java/com/bumptech/glide/integration/compose/GlideImage.kt

@@ -5,6 +5,7 @@ import androidx.annotation.DrawableRes
 import androidx.compose.foundation.Image
 import androidx.compose.foundation.layout.Box
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.LaunchedEffect
 import androidx.compose.runtime.MutableState
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope
@@ -71,17 +72,17 @@ public typealias RequestBuilderTransform<T> = (RequestBuilder<T>) -> RequestBuil
  * [RequestBuilder.error].
  *
  * @param loading A [Placeholder] that will be displayed while the request is loading. Specifically
- * it's used if the request is cleared ([com.bumptech.glide.request.target.Target.onLoadCleared]) or
- * loading ([com.bumptech.glide.request.target.Target.onLoadStarted]. There's a subtle difference in
- * behavior depending on which type of [Placeholder] you use. The resource and `Drawable` variants
- * will be displayed if the request fails and no other failure handling is specified, but the
- * `Composable` will not.
+ *   it's used if the request is cleared ([com.bumptech.glide.request.target.Target.onLoadCleared])
+ *   or loading ([com.bumptech.glide.request.target.Target.onLoadStarted]. There's a subtle
+ *   difference in behavior depending on which type of [Placeholder] you use. The resource and
+ *   `Drawable` variants will be displayed if the request fails and no other failure handling is
+ *   specified, but the `Composable` will not.
  * @param failure A [Placeholder] that will be displayed if the request fails. Specifically it's
- * used when [com.bumptech.glide.request.target.Target.onLoadFailed] is called. If
- * [RequestBuilder.error] is called in [requestBuilderTransform] with a valid [RequestBuilder] (as
- * opposed to resource id or [Drawable]), this [Placeholder] will not be used unless the `error`
- * [RequestBuilder] also fails. This parameter does not override error [RequestBuilder]s, only error
- * resource ids and/or [Drawable]s.
+ *   used when [com.bumptech.glide.request.target.Target.onLoadFailed] is called. If
+ *   [RequestBuilder.error] is called in [requestBuilderTransform] with a valid [RequestBuilder] (as
+ *   opposed to resource id or [Drawable]), this [Placeholder] will not be used unless the `error`
+ *   [RequestBuilder] also fails. This parameter does not override error [RequestBuilder]s, only
+ *   error resource ids and/or [Drawable]s.
  */
 // TODO(judds): the API here is not particularly composeesque, we should consider alternatives
 // to RequestBuilder (though thumbnail() may make that a challenge).
@@ -101,6 +102,7 @@ public fun GlideImage(
   // See http://shortn/_x79pjkMZIH for an internal discussion.
   loading: Placeholder? = null,
   failure: Placeholder? = null,
+  onImageVisibleToUser: ((resource: Drawable) -> Unit)? = null,
   // TODO(judds): Consider defaulting to load the model here instead of always doing so below.
   requestBuilderTransform: RequestBuilderTransform<Drawable> = { it },
 ) {
@@ -132,6 +134,7 @@ public fun GlideImage(
     colorFilter = colorFilter,
     placeholder = loading?.maybeComposable(),
     failure = failure?.maybeComposable(),
+    onImageVisibleToUser = onImageVisibleToUser,
   )
 }
 
@@ -143,7 +146,7 @@ private fun PreviewResourceOrDrawable(
   modifier: Modifier,
 ) {
   val drawable =
-    when(loading) {
+    when (loading) {
       is Placeholder.OfDrawable -> loading.drawable
       is Placeholder.OfResourceId -> LocalContext.current.getDrawable(loading.resourceId)
       is Placeholder.OfComposable ->
@@ -205,7 +208,9 @@ public fun placeholder(composable: @Composable () -> Unit): Placeholder =
 @ExperimentalGlideComposeApi
 public sealed class Placeholder {
   internal class OfDrawable(internal val drawable: Drawable?) : Placeholder()
+
   internal class OfResourceId(@DrawableRes internal val resourceId: Int) : Placeholder()
+
   internal class OfComposable(internal val composable: @Composable () -> Unit) : Placeholder()
 
   internal fun isResourceOrDrawable() =
@@ -223,7 +228,7 @@ public sealed class Placeholder {
 
   internal fun <T> apply(
     resource: (Int) -> RequestBuilder<T>,
-    drawable: (Drawable?) -> RequestBuilder<T>
+    drawable: (Drawable?) -> RequestBuilder<T>,
   ): RequestBuilder<T> =
     when (this) {
       is OfDrawable -> drawable(this.drawable)
@@ -238,18 +243,15 @@ private data class SizeAndModifier(val size: ResolvableGlideSize, val modifier:
 
 @OptIn(InternalGlideApi::class)
 @Composable
-private fun rememberSizeAndModifier(
-  overrideSize: Size?,
-  modifier: Modifier,
-) =
+private fun rememberSizeAndModifier(overrideSize: Size?, modifier: Modifier) =
   remember(overrideSize, modifier) {
     if (overrideSize != null) {
       SizeAndModifier(ImmediateGlideSize(overrideSize), modifier)
     } else {
       val sizeObserver = SizeObserver()
       SizeAndModifier(
         AsyncGlideSize(sizeObserver::getSize),
-        modifier.sizeObservingModifier(sizeObserver)
+        modifier.sizeObservingModifier(sizeObserver),
       )
     }
   }
@@ -259,7 +261,7 @@ private fun rememberRequestBuilderWithDefaults(
   model: Any?,
   requestManager: RequestManager,
   requestBuilderTransform: RequestBuilderTransform<Drawable>,
-  contentScale: ContentScale
+  contentScale: ContentScale,
 ) =
   remember(model, requestManager, requestBuilderTransform, contentScale) {
     requestBuilderTransform(requestManager.load(model).contentScaleTransform(contentScale))
@@ -300,15 +302,24 @@ private fun SizedGlideImage(
   colorFilter: ColorFilter?,
   placeholder: @Composable (() -> Unit)?,
   failure: @Composable (() -> Unit)?,
+  onImageVisibleToUser: ((resource: Drawable) -> Unit)? = null,
 ) {
   // Use a Box so we can infer the size if the request doesn't have an explicit size.
   @Composable fun @Composable () -> Unit.boxed() = Box(modifier = modifier) { this@boxed() }
 
-  val painter =
-    rememberGlidePainter(
-      requestBuilder = requestBuilder,
-      size = size,
-    )
+  val painter = rememberGlidePainter(requestBuilder = requestBuilder, size = size)
+
+  if (onImageVisibleToUser != null) {
+    val currentStatus = painter.status
+    val currentDrawable = painter.currentDrawable.value
+
+    LaunchedEffect(currentStatus, currentDrawable) {
+      if (currentStatus == Status.SUCCEEDED && currentDrawable != null) {
+        onImageVisibleToUser(currentDrawable)
+      }
+    }
+  }
+
   if (placeholder != null && painter.status.showPlaceholder()) {
     placeholder.boxed()
   } else if (failure != null && painter.status == Status.FAILED) {
@@ -321,7 +332,7 @@ private fun SizedGlideImage(
       contentScale = contentScale,
       alpha = alpha,
       colorFilter = colorFilter,
-      modifier = modifier.then(Modifier.semantics { displayedDrawable = painter.currentDrawable })
+      modifier = modifier.then(Modifier.semantics { displayedDrawable = painter.currentDrawable }),
     )
   }
 }