Convert ImagePipeline to Kotlin (initial)

Reviewed By: oprisnik Differential Revision: D53944214 fbshipit-source-id: 1711ad8ca54fdba6bbc22be7fa1a9522bd7ad1c0
facebook · Feb 23, 2024 · 32b53b7 · 32b53b7
1 parent ba72ed9
commit 32b53b7
Show file tree

Hide file tree

Showing 9 changed files with 1,130 additions and 1,208 deletions.
diff --git a/imagepipeline/src/main/java/com/facebook/imagepipeline/core/ImagePipeline.java b/imagepipeline/src/main/java/com/facebook/imagepipeline/core/ImagePipeline.java
diff --git a/imagepipeline/src/main/java/com/facebook/imagepipeline/core/ImagePipeline.kt b/imagepipeline/src/main/java/com/facebook/imagepipeline/core/ImagePipeline.kt
diff --git a/...rc/main/java/com/facebook/imagepipeline/datasource/BaseBitmapReferenceDataSubscriber.java b/...rc/main/java/com/facebook/imagepipeline/datasource/BaseBitmapReferenceDataSubscriber.java
@@ -15,7 +15,6 @@
 import com.facebook.imagepipeline.image.CloseableImage;
 import com.facebook.imagepipeline.image.CloseableStaticBitmap;
 import com.facebook.infer.annotation.Nullsafe;
-import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
 /**
@@ -49,7 +48,7 @@ public abstract class BaseBitmapReferenceDataSubscriber
     extends BaseDataSubscriber<CloseableReference<CloseableImage>> {
 
   @Override
-  public void onNewResultImpl(@Nonnull DataSource<CloseableReference<CloseableImage>> dataSource) {
+  public void onNewResultImpl(DataSource<CloseableReference<CloseableImage>> dataSource) {
     if (!dataSource.isFinished()) {
       return;
     }

diff --git a/...epipeline/src/main/java/com/facebook/imagepipeline/listener/ForwardingRequestListener2.kt b/...epipeline/src/main/java/com/facebook/imagepipeline/listener/ForwardingRequestListener2.kt
@@ -10,13 +10,16 @@ package com.facebook.imagepipeline.listener
 import com.facebook.common.logging.FLog
 import com.facebook.imagepipeline.producers.ProducerContext
 import java.util.ArrayList
-import java.util.Set
 
 class ForwardingRequestListener2 : RequestListener2 {
 
-  private var requestListeners: MutableList<RequestListener2>
+  private val requestListeners: MutableList<RequestListener2>
 
-  constructor(listenersToAdd: Set<RequestListener2?>) {
+  constructor(listenersToAdd: Set<RequestListener2?>?) {
+    if (listenersToAdd == null) {
+      requestListeners = mutableListOf()
+      return
+    }
     requestListeners = ArrayList(listenersToAdd.size)
     listenersToAdd.filterNotNullTo(requestListeners)
   }

diff --git a/imagepipeline/src/test/java/com/facebook/imagepipeline/core/ImagePipelineTest.java b/imagepipeline/src/test/java/com/facebook/imagepipeline/core/ImagePipelineTest.java
@@ -13,7 +13,6 @@
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.ArgumentMatchers.isNull;
 import static org.mockito.Mockito.anyObject;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.verify;
@@ -22,6 +21,7 @@
 
 import android.net.Uri;
 import com.facebook.cache.common.CacheKey;
+import com.facebook.cache.common.DebuggingCacheKey;
 import com.facebook.cache.common.MultiCacheKey;
 import com.facebook.cache.common.SimpleCacheKey;
 import com.facebook.common.internal.Predicate;
@@ -56,11 +56,13 @@
 /** Tests for ImagePipeline */
 @RunWith(RobolectricTestRunner.class)
 public class ImagePipelineTest {
+
   @Mock public ImageRequest mImageRequest;
   @Mock public ProducerSequenceFactory mProducerSequenceFactory;
   @Mock public CacheKeyFactory mCacheKeyFactory;
   @Mock public Object mCallerContext;
   @Mock public ImagePipelineConfigInterface mConfig;
+  @Mock public ImagePipelineExperiments mImagePipelineExperiments;
 
   private Supplier<Boolean> mPrefetchEnabledSupplier;
   private Supplier<Boolean> mSuppressBitmapPrefetchingSupplier;
@@ -112,6 +114,9 @@ public void setUp() throws Exception {
     when(mImageRequest.getLowestPermittedRequestLevel())
         .thenReturn(ImageRequest.RequestLevel.FULL_FETCH);
     when(mImageRequest.shouldDecodePrefetches()).thenReturn(null);
+
+    when(mConfig.getExperiments()).thenReturn(mImagePipelineExperiments);
+    when(mImagePipelineExperiments.getPrefetchShortcutEnabled()).thenReturn(false);
   }
 
   @Test
@@ -499,14 +504,20 @@ public void testClearMemoryCaches() {
   @Test
   public void testIsInDiskCacheFromMainDiskCache() {
     when(mImageRequest.getCacheChoice()).thenReturn(ImageRequest.CacheChoice.DEFAULT);
-    when(mMainDiskStorageCache.diskCheckSync(isNull(CacheKey.class))).thenReturn(true);
+    CacheKey cacheKey = mock(DebuggingCacheKey.class);
+    when(mMainDiskStorageCache.diskCheckSync(cacheKey)).thenReturn(true);
+    when(mCacheKeyFactory.getEncodedCacheKey(any(ImageRequest.class), anyObject()))
+        .thenReturn(cacheKey);
     assertTrue(mImagePipeline.isInDiskCacheSync(mImageRequest));
   }
 
   @Test
   public void testIsInDiskCacheFromSmallDiskCache() {
     when(mImageRequest.getCacheChoice()).thenReturn(ImageRequest.CacheChoice.SMALL);
-    when(mSmallImageDiskStorageCache.diskCheckSync(isNull(CacheKey.class))).thenReturn(true);
+    CacheKey cacheKey = mock(DebuggingCacheKey.class);
+    when(mSmallImageDiskStorageCache.diskCheckSync(cacheKey)).thenReturn(true);
+    when(mCacheKeyFactory.getEncodedCacheKey(any(ImageRequest.class), anyObject()))
+        .thenReturn(cacheKey);
     assertTrue(mImagePipeline.isInDiskCacheSync(mImageRequest));
   }
 

diff --git a/...re-java-impl/src/main/java/com/facebook/fresco/vito/core/impl/FrescoVitoPrefetcherImpl.kt b/...re-java-impl/src/main/java/com/facebook/fresco/vito/core/impl/FrescoVitoPrefetcherImpl.kt
@@ -37,7 +37,7 @@ class FrescoVitoPrefetcherImpl(
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> {
+  ): DataSource<Void?> {
     return when (prefetchTarget) {
       PrefetchTarget.MEMORY_DECODED ->
           prefetchToBitmapCache(uri, imageOptions, callerContext, callsite)
@@ -54,7 +54,7 @@ class FrescoVitoPrefetcherImpl(
       imageOptions: DecodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> {
+  ): DataSource<Void?> {
     val imageRequest = imagePipelineUtils.buildImageRequest(uri, imageOptions ?: defaults())
     return prefetch(PrefetchTarget.MEMORY_DECODED, imageRequest, callerContext, null)
   }
@@ -64,7 +64,7 @@ class FrescoVitoPrefetcherImpl(
       imageOptions: EncodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> {
+  ): DataSource<Void?> {
     val imageRequest = imagePipelineUtils.buildEncodedImageRequest(uri, imageOptions ?: defaults())
     return prefetch(PrefetchTarget.MEMORY_ENCODED, imageRequest, callerContext, null)
   }
@@ -74,7 +74,7 @@ class FrescoVitoPrefetcherImpl(
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> {
+  ): DataSource<Void?> {
     val imageRequest = imagePipelineUtils.buildEncodedImageRequest(uri, imageOptions ?: defaults())
     return prefetch(PrefetchTarget.DISK, imageRequest, callerContext, null)
   }
@@ -85,15 +85,15 @@ class FrescoVitoPrefetcherImpl(
       callerContext: Any?,
       requestListener: RequestListener?,
       callsite: String
-  ): DataSource<Void> =
+  ): DataSource<Void?> =
       prefetch(prefetchTarget, imageRequest.finalImageRequest, callerContext, requestListener)
 
   private fun prefetch(
       prefetchTarget: PrefetchTarget,
       imageRequest: ImageRequest?,
       callerContext: Any?,
       requestListener: RequestListener?
-  ): DataSource<Void> {
+  ): DataSource<Void?> {
     callerContextVerifier?.verifyCallerContext(callerContext, false)
     return if (imageRequest == null) {
       DataSources.immediateFailedDataSource(NULL_IMAGE_MESSAGE)

diff --git a/...re-java-impl/src/main/java/com/facebook/fresco/vito/core/impl/NoOpFrescoVitoPrefetcher.kt b/...re-java-impl/src/main/java/com/facebook/fresco/vito/core/impl/NoOpFrescoVitoPrefetcher.kt
@@ -26,36 +26,36 @@ class NoOpFrescoVitoPrefetcher : FrescoVitoPrefetcher {
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> = throwUnsupportedOperationException()
+  ): DataSource<Void?> = throwUnsupportedOperationException()
 
   override fun prefetchToBitmapCache(
       uri: Uri,
       imageOptions: DecodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> = throwUnsupportedOperationException()
+  ): DataSource<Void?> = throwUnsupportedOperationException()
 
   override fun prefetchToEncodedCache(
       uri: Uri,
       imageOptions: EncodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> = throwUnsupportedOperationException()
+  ): DataSource<Void?> = throwUnsupportedOperationException()
 
   override fun prefetchToDiskCache(
       uri: Uri,
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void> = throwUnsupportedOperationException()
+  ): DataSource<Void?> = throwUnsupportedOperationException()
 
   override fun prefetch(
       prefetchTarget: PrefetchTarget,
       imageRequest: VitoImageRequest,
       callerContext: Any?,
       requestListener: RequestListener?,
       callsite: String
-  ): DataSource<Void> = throwUnsupportedOperationException()
+  ): DataSource<Void?> = throwUnsupportedOperationException()
 
   override fun setDistanceToViewport(
       distance: Int,

diff --git a/vito/core/src/main/java/com/facebook/fresco/vito/core/FrescoVitoPrefetcher.kt b/vito/core/src/main/java/com/facebook/fresco/vito/core/FrescoVitoPrefetcher.kt
@@ -35,7 +35,7 @@ interface FrescoVitoPrefetcher {
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void>
+  ): DataSource<Void?>
 
   /**
    * Prefetch an image to the bitmap memory cache (for decoded images). In order to cancel the
@@ -55,7 +55,7 @@ interface FrescoVitoPrefetcher {
       imageOptions: DecodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void>
+  ): DataSource<Void?>
 
   /**
    * Prefetch an image to the encoded memory cache. In order to cancel the prefetch, close the
@@ -75,7 +75,7 @@ interface FrescoVitoPrefetcher {
       imageOptions: EncodedImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void>
+  ): DataSource<Void?>
 
   /**
    * Prefetch an image to the disk cache. In order to cancel the prefetch, close the [DataSource]
@@ -95,7 +95,7 @@ interface FrescoVitoPrefetcher {
       imageOptions: ImageOptions?,
       callerContext: Any?,
       callsite: String
-  ): DataSource<Void>
+  ): DataSource<Void?>
 
   /**
    * Prefetch an image to the given [PrefetchTarget] using a [VitoImageRequest]. In order to cancel
@@ -116,7 +116,7 @@ interface FrescoVitoPrefetcher {
       callerContext: Any?,
       requestListener: RequestListener?,
       callsite: String
-  ): DataSource<Void>
+  ): DataSource<Void?>
 
   /**
    * Sets the image's relative distance to the viewport for the purpose of prioritization.

diff --git a/vito/litho/src/main/java/com/facebook/fresco/vito/litho/FrescoVitoImage2Spec.kt b/vito/litho/src/main/java/com/facebook/fresco/vito/litho/FrescoVitoImage2Spec.kt
@@ -83,7 +83,7 @@ object FrescoVitoImage2Spec {
   @OnCreateInitialState
   fun onCreateInitialState(
       context: ComponentContext,
-      workingRangePrefetchData: StateValue<AtomicReference<DataSource<Void>>>,
+      workingRangePrefetchData: StateValue<AtomicReference<DataSource<Void?>>>,
   ) {
     if (FrescoVitoProvider.hasBeenInitialized() &&
         FrescoVitoProvider.getConfig().prefetchConfig.prefetchWithWorkingRange()) {
@@ -146,7 +146,7 @@ object FrescoVitoImage2Spec {
       @Prop(optional = true) prefetch: Prefetch?,
       @Prop(optional = true) prefetchRequestListener: RequestListener?,
       @CachedValue requestCachedValue: VitoImageRequest?,
-      prefetchDataSource: Output<DataSource<Void>>,
+      prefetchDataSource: Output<DataSource<Void?>>,
   ) {
     if (requestCachedValue == null) {
       return
@@ -177,7 +177,7 @@ object FrescoVitoImage2Spec {
       @FromBoundsDefined requestFromBoundsDefined: VitoImageRequest?,
       @FromPrepare prefetchDataSource: DataSource<Void?>?,
       @FromBoundsDefined viewportDimensions: Rect,
-      @State workingRangePrefetchData: AtomicReference<DataSource<Void>>?,
+      @State workingRangePrefetchData: AtomicReference<DataSource<Void?>>?,
       @TreeProp contextChain: ContextChain?,
   ) {
     val request = requestCachedValue ?: requestFromBoundsDefined
@@ -224,7 +224,7 @@ object FrescoVitoImage2Spec {
       @FromBoundsDefined requestFromBoundsDefined: VitoImageRequest?,
       @FromPrepare prefetchDataSource: DataSource<Void?>?,
       @FromBoundsDefined viewportDimensions: Rect,
-      @State workingRangePrefetchData: AtomicReference<DataSource<Void>>?,
+      @State workingRangePrefetchData: AtomicReference<DataSource<Void?>>?,
   ) {
     val request = requestCachedValue ?: requestFromBoundsDefined
     // We fetch in both mount and bind in case an unbind event triggered a delayed release.
@@ -250,7 +250,7 @@ object FrescoVitoImage2Spec {
   fun onUnbind(
       c: ComponentContext,
       frescoDrawable: FrescoDrawableInterface,
-      @FromPrepare prefetchDataSource: DataSource<Void>?,
+      @FromPrepare prefetchDataSource: DataSource<Void?>?,
   ) {
     frescoDrawable.imagePerfListener.onImageUnbind(frescoDrawable)
     if (FrescoVitoProvider.getConfig().useBindOnly()) {
@@ -266,7 +266,7 @@ object FrescoVitoImage2Spec {
   fun onUnmount(
       c: ComponentContext,
       frescoDrawable: FrescoDrawableInterface,
-      @FromPrepare prefetchDataSource: DataSource<Void>?,
+      @FromPrepare prefetchDataSource: DataSource<Void?>?,
   ) {
     frescoDrawable.imagePerfListener.onImageUnmount(frescoDrawable)
     if (FrescoVitoProvider.getConfig().useBindOnly()) {
@@ -338,8 +338,8 @@ object FrescoVitoImage2Spec {
       @Prop(optional = true) prefetch: Prefetch?,
       @Prop(optional = true) callerContext: Any?,
       @CachedValue requestCachedValue: VitoImageRequest?,
-      @FromPrepare prefetchDataSource: DataSource<Void>?,
-      @State workingRangePrefetchData: AtomicReference<DataSource<Void>>?,
+      @FromPrepare prefetchDataSource: DataSource<Void?>?,
+      @State workingRangePrefetchData: AtomicReference<DataSource<Void?>>?,
   ) {
     if (requestCachedValue == null || workingRangePrefetchData == null) {
       return
@@ -366,7 +366,7 @@ object FrescoVitoImage2Spec {
   @OnExitedRange(name = "imagePrefetch")
   fun onExitedWorkingRange(
       c: ComponentContext,
-      @State workingRangePrefetchData: AtomicReference<DataSource<Void>>?,
+      @State workingRangePrefetchData: AtomicReference<DataSource<Void?>>?,
   ) {
     cancelWorkingRangePrefetch(workingRangePrefetchData)
   }
@@ -479,7 +479,7 @@ object FrescoVitoImage2Spec {
   }
 
   @JvmStatic
-  fun cancelWorkingRangePrefetch(prefetchData: AtomicReference<DataSource<Void>>?) {
+  fun cancelWorkingRangePrefetch(prefetchData: AtomicReference<DataSource<Void?>>?) {
     if (prefetchData == null) {
       return
     }