For mozilla-mobile/fenix#7310 - Adds bypassCache parameter to reload.

boek · Jul 13, 2020 · 2847d39 · 2847d39
1 parent cdef87e
commit 2847d39
Show file tree

Hide file tree

Showing 12 changed files with 91 additions and 16 deletions.
diff --git a/...ne-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/...ne-gecko-beta/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -132,8 +132,14 @@ class GeckoEngineSession(
     /**
      * See [EngineSession.reload]
      */
-    override fun reload() {
-        geckoSession.reload()
+    override fun reload(bypassCache: Boolean) {
+        val flags = if (bypassCache) {
+            GeckoSession.LOAD_FLAGS_BYPASS_CACHE
+        } else {
+            GeckoSession.LOAD_FLAGS_NONE
+        }
+
+        geckoSession.reload(flags)
     }
 
     /**
@@ -146,7 +152,7 @@ class GeckoEngineSession(
         }
     }
     /**
-     * See [EngineSession.goForward]
+     * See [EngineSession.goForward]1
      */
     override fun goForward() {
         geckoSession.goForward()

diff --git a/...ecko-beta/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...ecko-beta/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -467,7 +467,18 @@ class GeckoEngineSessionTest {
 
         engineSession.reload()
 
-        verify(geckoSession).reload()
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_NONE)
+    }
+
+    @Test
+    fun reloadBypassingCache() {
+        val engineSession = GeckoEngineSession(mock(),
+                geckoSessionProvider = geckoSessionProvider)
+        engineSession.loadUrl("http://mozilla.org")
+
+        engineSession.reload(bypassCache = true)
+
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_BYPASS_CACHE)
     }
 
     @Test

diff --git a/...gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/...gecko-nightly/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -132,8 +132,14 @@ class GeckoEngineSession(
     /**
      * See [EngineSession.reload]
      */
-    override fun reload() {
-        geckoSession.reload()
+    override fun reload(bypassCache: Boolean) {
+        val flags = if (bypassCache) {
+            GeckoSession.LOAD_FLAGS_BYPASS_CACHE
+        } else {
+            GeckoSession.LOAD_FLAGS_NONE
+        }
+
+        geckoSession.reload(flags)
     }
 
     /**

diff --git a/...o-nightly/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...o-nightly/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -467,7 +467,18 @@ class GeckoEngineSessionTest {
 
         engineSession.reload()
 
-        verify(geckoSession).reload()
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_NONE)
+    }
+
+    @Test
+    fun reloadBypassingCache() {
+        val engineSession = GeckoEngineSession(mock(),
+                geckoSessionProvider = geckoSessionProvider)
+        engineSession.loadUrl("http://mozilla.org")
+
+        engineSession.reload(bypassCache = true)
+
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_BYPASS_CACHE)
     }
 
     @Test

diff --git a/.../engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt b/.../engine-gecko/src/main/java/mozilla/components/browser/engine/gecko/GeckoEngineSession.kt
@@ -132,8 +132,14 @@ class GeckoEngineSession(
     /**
      * See [EngineSession.reload]
      */
-    override fun reload() {
-        geckoSession.reload()
+    override fun reload(bypassCache: Boolean) {
+        val flags = if (bypassCache) {
+            GeckoSession.LOAD_FLAGS_BYPASS_CACHE
+        } else {
+            GeckoSession.LOAD_FLAGS_NONE
+        }
+
+        geckoSession.reload(flags)
     }
 
     /**

diff --git a/...ine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt b/...ine-gecko/src/test/java/mozilla/components/browser/engine/gecko/GeckoEngineSessionTest.kt
@@ -467,7 +467,18 @@ class GeckoEngineSessionTest {
 
         engineSession.reload()
 
-        verify(geckoSession).reload()
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_NONE)
+    }
+
+    @Test
+    fun reloadBypassingCache() {
+        val engineSession = GeckoEngineSession(mock(),
+                geckoSessionProvider = geckoSessionProvider)
+        engineSession.loadUrl("http://mozilla.org")
+
+        engineSession.reload(bypassCache = true)
+
+        verify(geckoSession).reload(GeckoSession.LOAD_FLAGS_BYPASS_CACHE)
     }
 
     @Test

diff --git a/...gine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt b/...gine-system/src/main/java/mozilla/components/browser/engine/system/SystemEngineSession.kt
@@ -104,7 +104,11 @@ class SystemEngineSession(
     /**
      * See [EngineSession.reload]
      */
-    override fun reload() {
+    override fun reload(bypassCache: Boolean) {
+        if (bypassCache) {
+            webView.clearCache(true)
+        }
+
         webView.reload()
     }
 

diff --git a/...-system/src/test/java/mozilla/components/browser/engine/system/SystemEngineSessionTest.kt b/...-system/src/test/java/mozilla/components/browser/engine/system/SystemEngineSessionTest.kt
@@ -150,6 +150,22 @@ class SystemEngineSessionTest {
         verify(webView).reload()
     }
 
+    @Test
+    fun reloadBypassingCache() {
+        val engineSession = spy(SystemEngineSession(testContext))
+        val webView = mock<WebView>()
+
+        engineSession.reload(bypassCache = true)
+        verify(webView, never()).clearCache(true)
+        verify(webView, never()).reload()
+
+        engineSession.webView = webView
+
+        engineSession.reload(bypassCache = true)
+        verify(webView).clearCache(true)
+        verify(webView).reload()
+    }
+
     @Test
     fun goBack() {
         val engineSession = spy(SystemEngineSession(testContext))

diff --git a/...ser/session/src/test/java/mozilla/components/browser/session/engine/EngineObserverTest.kt b/...ser/session/src/test/java/mozilla/components/browser/session/engine/EngineObserverTest.kt
@@ -55,7 +55,7 @@ class EngineObserverTest {
             override fun goBack() {}
             override fun goForward() {}
             override fun goToHistoryIndex(index: Int) {}
-            override fun reload() {}
+            override fun reload(bypassCache: Boolean) {}
             override fun stopLoading() {}
             override fun restoreState(state: EngineSessionState): Boolean { return false }
             override fun enableTrackingProtection(policy: TrackingProtectionPolicy) {}
@@ -112,7 +112,7 @@ class EngineObserverTest {
             override fun goForward() {}
             override fun goToHistoryIndex(index: Int) {}
             override fun stopLoading() {}
-            override fun reload() {}
+            override fun reload(bypassCache: Boolean) {}
             override fun restoreState(state: EngineSessionState): Boolean { return false }
             override fun enableTrackingProtection(policy: TrackingProtectionPolicy) {}
             override fun disableTrackingProtection() {}
@@ -157,7 +157,7 @@ class EngineObserverTest {
             override fun goForward() {}
             override fun goToHistoryIndex(index: Int) {}
             override fun stopLoading() {}
-            override fun reload() {}
+            override fun reload(bypassCache: Boolean) {}
             override fun restoreState(state: EngineSessionState): Boolean { return false }
             override fun enableTrackingProtection(policy: TrackingProtectionPolicy) {
                 notifyObservers { onTrackerBlockingEnabledChange(true) }

diff --git a/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt b/components/concept/engine/src/main/java/mozilla/components/concept/engine/EngineSession.kt
@@ -452,8 +452,10 @@ abstract class EngineSession(
 
     /**
      * Reloads the current URL.
+     *
+     * @param bypassCache true if you want to reload the URL bypassing the cache.
      */
-    abstract fun reload()
+    abstract fun reload(bypassCache: Boolean = false)
 
     /**
      * Navigates back in the history of this session.

diff --git a/...nents/concept/engine/src/test/java/mozilla/components/concept/engine/EngineSessionTest.kt b/...nents/concept/engine/src/test/java/mozilla/components/concept/engine/EngineSessionTest.kt
@@ -827,7 +827,7 @@ open class DummyEngineSession : EngineSession() {
 
     override fun stopLoading() {}
 
-    override fun reload() {}
+    override fun reload(bypassCache: Boolean) {}
 
     override fun goBack() {}
 

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -12,6 +12,7 @@ permalink: /changelog/
 * [Gecko](https://github.com/mozilla-mobile/android-components/blob/master/buildSrc/src/main/java/Gecko.kt)
 * [Configuration](https://github.com/mozilla-mobile/android-components/blob/master/buildSrc/src/main/java/Config.kt)
 
+
 * **feature-session**
   * Added `SessionFeature.release()`: Calling this method stops the feature from rendering sessions on the `EngineView` (until explicitly started again) and releases an already rendering session from the `EngineView`.
   * Added `SessionUseCases.goToHistoryIndex` to allow consumers to jump to a specific index in a session's history.
@@ -21,6 +22,7 @@ permalink: /changelog/
 
 * **concept-engine**
   * Added `EngineSession.goToHistoryIndex` to jump to a specific index in a session's history.
+  * Adds `bypassCache` parameter to `reload` to bypass the cache on reload.
 
 * **service-location**
   * `LocationService.hasRegionCached()` is introduced to query if the region is already cached and a long running operation to fetch the region is not needed.