react-native-fast-image 9.1.0 → 9.2.1

package/README.md

@@ -387,7 +387,7 @@ onLoad={e => console.log(e.nativeEvent.width, e.nativeEvent.height)}
 
 **Type:** `(event: OnErrorEvent) => void`
 
-Called on an image fetching error, with a message describing it (e.g. the HTTP status code).
+Called on an image fetching error, with a message describing it (e.g. the HTTP status code). On iOS and Android, a download that gets nothing from the server for 15 seconds fails too (on Android, unless the app's OkHttp client has timeouts of its own).
 
 ```jsx
 onError={e => console.log(e.nativeEvent.error)}
@@ -571,7 +571,7 @@ const { ok } = await FastImage.getCachePath({
 })
 ```
 
-- The source's `headers`, `cacheKey` and `priority` apply, as for a view. Downloads wait in the same queue as `preload`'s, so they don't hold up the images on screen.
+- The source's `headers`, `cacheKey` and `priority` apply, as for a view. Downloads wait in the same queue as `preload`'s, so they don't hold up the images on screen. If a view or a preload is downloading the same source, `getCachePath` shares that download instead of downloading the image again (on Android, except with `cache: 'web'`).
 - The file belongs to the cache, which can remove it at any time: copy it to keep it.
 - Its name may not have an image extension (on Android it ends in `.0` or `.1`): copy it with one for APIs that need it.
 - A `file://` source is its own path. Other local images (`require()` in a release build, `content://`) have no file to give.
@@ -765,7 +765,7 @@ How the image fades in: see [`transition`](#transition).
     - `'all'`: skips it for images from the memory or disk cache too, so images that download fade in, and local files and bundled images usually only the first time (the disk cache usually keeps them too).
     - `'none'`: always fades.
 
-    Downloads, local files and bundled images (`require()`) fade in.
+    Downloads, local files and bundled images (`require()`) fade in. On Android, a `cache: 'web'` image from its HTTP cache, without a request, counts as one from the memory cache (these images aren't kept there).
 
 <!-- api:types end -->
 

package/android/build.gradle

@@ -109,3 +109,15 @@ dependencies {
     // Animated PNGs (see FastImageApng).
     implementation 'com.github.penfeizhou.android.animation:apng:3.0.5'
 }
+
+// Unit tests of the downloads (src/test, with Robolectric, which gives them
+// Android's classes), run from an example app's android folder:
+// `./gradlew :react-native-fast-image:testDebugUnitTest`. The npm package
+// doesn't include src/test, so apps don't get these.
+if (file('src/test').exists()) {
+    android.testOptions.unitTests.includeAndroidResources = true
+    dependencies {
+        testImplementation 'junit:junit:4.13.2'
+        testImplementation 'org.robolectric:robolectric:4.15.1'
+    }
+}

package/android/src/main/java/com/dylanvann/fastimage/FastImageOkHttpProgressGlideModule.java

@@ -10,7 +10,6 @@ import com.bumptech.glide.annotation.GlideModule;
 import com.bumptech.glide.load.ImageHeaderParser;
 import com.bumptech.glide.load.ImageHeaderParserUtils;
 import com.bumptech.glide.load.engine.bitmap_recycle.ArrayPool;
-import com.bumptech.glide.integration.okhttp3.OkHttpUrlLoader;
 import com.bumptech.glide.load.Options;
 import com.bumptech.glide.load.model.GlideUrl;
 import com.bumptech.glide.load.model.ModelLoader;
@@ -23,10 +22,8 @@ import com.facebook.react.modules.network.OkHttpClientProvider;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
-import java.util.HashMap;
 import java.util.Locale;
-import java.util.Map;
-import java.util.WeakHashMap;
+import java.util.concurrent.TimeUnit;
 
 import okhttp3.Cache;
 import okhttp3.HttpUrl;
@@ -34,20 +31,18 @@ import okhttp3.Interceptor;
 import okhttp3.JavaNetCookieJar;
 import okhttp3.MediaType;
 import okhttp3.OkHttpClient;
-import okhttp3.Request;
 import okhttp3.Response;
 import okhttp3.ResponseBody;
 import okio.Buffer;
 import okio.BufferedSource;
-import okio.ForwardingSource;
-import okio.Okio;
-import okio.Source;
 
 @GlideModule
 public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
 
-    private static final DispatchingProgressListener progressListener = new DispatchingProgressListener();
     private static final long WEB_CACHE_SIZE = 50 * 1024 * 1024;
+    // How long a download can get nothing from the server (see
+    // registerComponents).
+    private static final long TIMEOUT_SECONDS = 15;
     // The HTTP cache of `cache: 'web'` images, once Glide has set up.
     @Nullable
     private static Cache webCache;
@@ -67,11 +62,7 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
     static void downloadToWebCache(GlideUrl url) throws IOException {
         OkHttpClient client = webClient;
         if (client == null) throw new IOException("Glide isn't set up");
-        Request.Builder request = new Request.Builder().url(url.toStringUrl());
-        for (Map.Entry<String, String> header : url.getHeaders().entrySet()) {
-            request.addHeader(header.getKey(), header.getValue());
-        }
-        try (Response response = client.newCall(request.build()).execute()) {
+        try (Response response = client.newCall(FastImageSharedDownloads.request(url)).execute()) {
             if (!response.isSuccessful()) {
                 // As Glide's HttpException reports it.
                 throw new IOException(response.message() + ", status code: " + response.code());
@@ -107,7 +98,6 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
         OkHttpClient sharedClient = OkHttpClientProvider.getOkHttpClient();
         OkHttpClient.Builder builder = sharedClient
                 .newBuilder()
-                .addInterceptor(createInterceptor(progressListener))
                 // A network interceptor, so it runs before the HTTP cache of
                 // `web` images stores the response (checking it reads it).
                 .addNetworkInterceptor(createNonImageInterceptor(registry, glide.getArrayPool()));
@@ -118,6 +108,15 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
         if (sharedClient.cookieJar() instanceof CookieJarContainer) {
             builder.cookieJar(new JavaNetCookieJar(new FastImageCookieHandler()));
         }
+        // React Native's shared client has no timeouts, so a download that
+        // stopped (e.g. on a connection that died) never ended, and every
+        // request sharing it waited. As on iOS (SDWebImage's 15 s), one that
+        // gets nothing for TIMEOUT_SECONDS fails: connecting, or waiting for
+        // the response or the next of its bytes. Timeouts the app gave the
+        // client stay. No call timeout: a large image on a slow link can take
+        // longer than any.
+        if (sharedClient.connectTimeoutMillis() == 0) builder.connectTimeout(TIMEOUT_SECONDS, TimeUnit.SECONDS);
+        if (sharedClient.readTimeoutMillis() == 0) builder.readTimeout(TIMEOUT_SECONDS, TimeUnit.SECONDS);
         OkHttpClient client = builder.build();
         // `cache: 'web'` skips Glide's caches and relies on HTTP caching, so
         // those urls get a client with an HTTP cache (#280): one of their own,
@@ -127,6 +126,7 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
         // store them twice).
         webCache = new Cache(new File(context.getCacheDir(), "fast-image-http-cache"), WEB_CACHE_SIZE);
         webClient = client.newBuilder().cache(webCache).build();
+        FastImageSharedDownloads.setDirectory(new File(context.getCacheDir(), "fast-image-downloads"));
         registry.prepend(FastImageUrl.class, InputStream.class, new UrlLoaderFactory(client, webClient));
         FastImageSvg.register(registry, glide.getBitmapPool());
         FastImageAnimated.register(context, glide, registry);
@@ -138,12 +138,12 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
         FastImageGlide.registered(glide);
     }
 
-    // Loads FastImage's remote images (FastImageUrls): `web` ones
-    // (FastImageWebGlideUrls) with the client with the HTTP cache, others with
-    // the other client, where a view loading an image that's being preloaded
-    // waits for the preload's download. FastImageUrl isn't a GlideUrl, so
-    // Glide doesn't also give these to other GlideUrl loaders, which it would
-    // try after a failed load (e.g. a 404, requested again).
+    // Loads FastImage's remote images (FastImageUrls), with one download of an
+    // image at a time, shared by its requests (FastImageSharedDownloads):
+    // `web` ones (FastImageWebGlideUrls) with the client with the HTTP cache,
+    // others with the other client. FastImageUrl isn't a GlideUrl, so Glide
+    // doesn't also give these to other GlideUrl loaders, which it would try
+    // after a failed load (e.g. a 404, requested again).
     private static class UrlLoaderFactory implements ModelLoaderFactory<FastImageUrl, InputStream> {
         private final OkHttpClient client;
         private final OkHttpClient webClient;
@@ -156,16 +156,11 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
         @NonNull
         @Override
         public ModelLoader<FastImageUrl, InputStream> build(@NonNull MultiModelLoaderFactory multiFactory) {
-            final OkHttpUrlLoader loader = new OkHttpUrlLoader(client);
-            final OkHttpUrlLoader webLoader = new OkHttpUrlLoader(webClient);
             return new ModelLoader<FastImageUrl, InputStream>() {
                 @Override
                 public LoadData<InputStream> buildLoadData(@NonNull FastImageUrl model, int width, int height, @NonNull Options options) {
-                    if (model.url instanceof FastImageWebGlideUrl) {
-                        return webLoader.buildLoadData(model.url, width, height, options);
-                    }
-                    LoadData<InputStream> data = loader.buildLoadData(model.url, width, height, options);
-                    return data == null ? null : FastImageSharedDownloads.share(data, model.url, options);
+                    return FastImageSharedDownloads.loadData(
+                            model.url, model.url instanceof FastImageWebGlideUrl ? webClient : client);
                 }
 
                 @Override
@@ -227,132 +222,4 @@ public class FastImageOkHttpProgressGlideModule extends LibraryGlideModule {
                 || subtype.equalsIgnoreCase("xhtml+xml")
                 || subtype.equalsIgnoreCase("javascript");
     }
-
-    private static Interceptor createInterceptor(final ResponseProgressListener listener) {
-        return new Interceptor() {
-            @Override
-            public Response intercept(Chain chain) throws IOException {
-                Request request = chain.request();
-                Response response = chain.proceed(request);
-                final String key = request.url().toString();
-                return response
-                        .newBuilder()
-                        .body(new OkHttpProgressResponseBody(key, response.body(), listener))
-                        .build();
-            }
-        };
-    }
-
-    static void forget(String key) {
-        progressListener.forget(key);
-    }
-
-    static void expect(String key, FastImageProgressListener listener) {
-        progressListener.expect(key, listener);
-    }
-
-    private interface ResponseProgressListener {
-        void update(String key, long bytesRead, long contentLength);
-    }
-
-    private static class DispatchingProgressListener implements ResponseProgressListener {
-        private final Map<String, FastImageProgressListener> LISTENERS = new WeakHashMap<>();
-        private final Map<String, Long> PROGRESSES = new HashMap<>();
-
-        void forget(String key) {
-            LISTENERS.remove(key);
-            PROGRESSES.remove(key);
-        }
-
-        void expect(String key, FastImageProgressListener listener) {
-            LISTENERS.put(key, listener);
-        }
-
-        @Override
-        public void update(final String key, final long bytesRead, final long contentLength) {
-            final FastImageProgressListener listener = LISTENERS.get(key);
-            // Without a Content-Length the total is unknown (-1), and a
-            // percentage can't be worked out from it, so don't send those. (It
-            // also looked like the last update, which stopped all updates.)
-            if (listener == null || contentLength <= 0) {
-                return;
-            }
-            if (contentLength <= bytesRead) {
-                forget(key);
-            }
-            if (needsDispatch(key, bytesRead, contentLength, listener.getGranularityPercentage())) {
-                listener.onProgress(key, bytesRead, contentLength);
-            }
-        }
-
-        private boolean needsDispatch(String key, long current, long total, float granularity) {
-            if (granularity == 0 || current == 0 || total == current) {
-                return true;
-            }
-            float percent = 100f * current / total;
-            long currentProgress = (long) (percent / granularity);
-            Long lastProgress = PROGRESSES.get(key);
-            if (lastProgress == null || currentProgress != lastProgress) {
-                PROGRESSES.put(key, currentProgress);
-                return true;
-            } else {
-                return false;
-            }
-        }
-    }
-
-    private static class OkHttpProgressResponseBody extends ResponseBody {
-        private final String key;
-        private final ResponseBody responseBody;
-        private final ResponseProgressListener progressListener;
-        private BufferedSource bufferedSource;
-
-        OkHttpProgressResponseBody(
-                String key,
-                ResponseBody responseBody,
-                ResponseProgressListener progressListener
-        ) {
-            this.key = key;
-            this.responseBody = responseBody;
-            this.progressListener = progressListener;
-        }
-
-        @Override
-        public MediaType contentType() {
-            return responseBody.contentType();
-        }
-
-        @Override
-        public long contentLength() {
-            return responseBody.contentLength();
-        }
-
-        @Override
-        public BufferedSource source() {
-            if (bufferedSource == null) {
-                bufferedSource = Okio.buffer(source(responseBody.source()));
-            }
-            return bufferedSource;
-        }
-
-        private Source source(Source source) {
-            return new ForwardingSource(source) {
-                long totalBytesRead = 0L;
-
-                @Override
-                public long read(Buffer sink, long byteCount) throws IOException {
-                    long bytesRead = super.read(sink, byteCount);
-                    long fullLength = responseBody.contentLength();
-                    if (bytesRead == -1) {
-                        // this source is exhausted
-                        totalBytesRead = fullLength;
-                    } else {
-                        totalBytesRead += bytesRead;
-                    }
-                    progressListener.update(key, totalBytesRead, fullLength);
-                    return bytesRead;
-                }
-            };
-        }
-    }
 }

package/android/src/main/java/com/dylanvann/fastimage/FastImageProgressListener.java

@@ -1,5 +1,9 @@
 package com.dylanvann.fastimage;
 
+// No longer used: FastImage sends progress through FastImageViewManager's
+// onDownloadProgress. Kept, as a public type, so code that refers to it still
+// compiles.
+@Deprecated
 public interface FastImageProgressListener {
 
     void onProgress(String key, long bytesRead, long expectedLength);

package/android/src/main/java/com/dylanvann/fastimage/FastImageRequestListener.java

@@ -16,7 +16,6 @@ public class FastImageRequestListener implements RequestListener<Drawable> {
     static final String REACT_ON_ERROR_EVENT = "onFastImageError";
     static final String REACT_ON_LOAD_EVENT = "onFastImageLoad";
     static final String REACT_ON_LOAD_END_EVENT = "onFastImageLoadEnd";
-    private final String key;
     private final FastImageSource source;
     // Whether the request shows the previous image as a thumbnail meanwhile.
     private final boolean thumbnail;
@@ -24,8 +23,7 @@ public class FastImageRequestListener implements RequestListener<Drawable> {
     // view shows it at its old size if that fails.
     private final boolean events;
 
-    FastImageRequestListener(String key, FastImageSource source, boolean thumbnail, boolean events) {
-        this.key = key;
+    FastImageRequestListener(FastImageSource source, boolean thumbnail, boolean events) {
         this.source = source;
         this.thumbnail = thumbnail;
         this.events = events;
@@ -39,7 +37,6 @@ public class FastImageRequestListener implements RequestListener<Drawable> {
             }
             return false;
         }
-        FastImageOkHttpProgressGlideModule.forget(key);
         if (!(target instanceof ImageViewTarget)) {
             return false;
         }