fix: Fix local resource cache issue on Android. (DylanVann#472)

fix DylanVann#402
perrystreetsoftware · May 25, 2019 · 5f65383 · 5f65383
1 parent 1eed575
commit 5f65383
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/android/src/main/java/com/dylanvann/fastimage/FastImageViewConverter.java b/android/src/main/java/com/dylanvann/fastimage/FastImageViewConverter.java
@@ -16,6 +16,7 @@
 import com.bumptech.glide.load.model.Headers;
 import com.bumptech.glide.load.model.LazyHeaders;
 import com.bumptech.glide.request.RequestOptions;
+import com.bumptech.glide.signature.ApplicationVersionSignature;
 import com.facebook.react.bridge.JSApplicationIllegalArgumentException;
 import com.facebook.react.bridge.NoSuchKeyException;
 import com.facebook.react.bridge.ReadableMap;
@@ -30,6 +31,8 @@
 
 import javax.annotation.Nullable;
 
+import static com.bumptech.glide.request.RequestOptions.signatureOf;
+
 class FastImageViewConverter {
     private static final Drawable TRANSPARENT_DRAWABLE = new ColorDrawable(Color.TRANSPARENT);
 
@@ -81,7 +84,7 @@ static Headers getHeaders(ReadableMap source) {
         return headers;
     }
 
-    static RequestOptions getOptions(ReadableMap source) {
+    static RequestOptions getOptions(Context context, FastImageSource imageSource, ReadableMap source) {
         // Get priority.
         final Priority priority = FastImageViewConverter.getPriority(source);
         // Get cache control method.
@@ -102,12 +105,25 @@ static RequestOptions getOptions(ReadableMap source) {
                 // Use defaults.
                 break;
         }
-        return new RequestOptions()
-                .diskCacheStrategy(diskCacheStrategy)
-                .onlyRetrieveFromCache(onlyFromCache)
-                .skipMemoryCache(skipMemoryCache)
-                .priority(priority)
-                .placeholder(TRANSPARENT_DRAWABLE);
+
+        RequestOptions options = new RequestOptions()
+            .diskCacheStrategy(diskCacheStrategy)
+            .onlyRetrieveFromCache(onlyFromCache)
+            .skipMemoryCache(skipMemoryCache)
+            .priority(priority)
+            .placeholder(TRANSPARENT_DRAWABLE);
+
+        if (imageSource.isResource()) {
+            // Every local resource (drawable) in Android has its own unique numeric id, which are
+            // generated at build time. Although these ids are unique, they are not guaranteed unique
+            // across builds. The underlying glide implementation caches these resources. To make
+            // sure the cache does not return the wrong image, we should clear the cache when the
+            // application version changes. Adding a cache signature for only these local resources
+            // solves this issue: https://github.com/DylanVann/react-native-fast-image/issues/402
+            options = options.apply(signatureOf(ApplicationVersionSignature.obtain(context)));
+        }
+
+        return options;                
     }
 
     private static FastImageCacheControl getCacheControl(ReadableMap source) {

diff --git a/android/src/main/java/com/dylanvann/fastimage/FastImageViewManager.java b/android/src/main/java/com/dylanvann/fastimage/FastImageViewManager.java
@@ -103,7 +103,7 @@ public void setSrc(FastImageViewWithUrl view, @Nullable ReadableMap source) {
                     //    - android.resource://
                     //    - data:image/png;base64
                     .load(imageSource.getSourceForLoad())
-                    .apply(FastImageViewConverter.getOptions(source))
+                    .apply(FastImageViewConverter.getOptions(context, imageSource, source))
                     .listener(new FastImageRequestListener(key))
                     .into(view);
         }

diff --git a/android/src/main/java/com/dylanvann/fastimage/FastImageViewModule.java b/android/src/main/java/com/dylanvann/fastimage/FastImageViewModule.java
@@ -47,7 +47,7 @@ public void run() {
                                     imageSource.isBase64Resource() ? imageSource.getSource() :
                                     imageSource.isResource() ? imageSource.getUri() : imageSource.getGlideUrl()
                             )
-                            .apply(FastImageViewConverter.getOptions(source))
+                            .apply(FastImageViewConverter.getOptions(activity, imageSource, source))
                             .preload();
                 }
             }