Introduce LoadingStrategy for Dod (#43)

* Introduce LoadingStrategy for Dod --------- Co-authored-by: Artem Mochalov <artyom.mochalov@revolut.com>
revolut-mobile · Nov 24, 2023 · 1ab0073 · 1ab0073
1 parent 08423ed
commit 1ab0073
Show file tree

Hide file tree

Showing 11 changed files with 145 additions and 52 deletions.
diff --git a/README.md b/README.md
@@ -21,9 +21,9 @@ And then to the module level `build.gradle.kts`:
 
 ```
 dependencies {
-    implementation 'com.revolut.rxdata:dod:1.4'
-    implementation 'com.revolut.rxdata:core:1.4'
-    implementation 'com.revolut.rxdata:scheduler:1.4'
+    implementation 'com.revolut.rxdata:dod:1.5.13'
+    implementation 'com.revolut.rxdata:core:1.5.13'
+    implementation 'com.revolut.rxdata:scheduler:1.5.13'
 }
 ```
 

diff --git a/dfd/gradle.properties b/dfd/gradle.properties
@@ -1,5 +1,5 @@
 POM_ARTIFACT_ID=dfd
-VERSION_NAME=1.5.12
+VERSION_NAME=1.5.13
 POM_NAME=dfd
 POM_PACKAGING=jar
 GROUP=com.revolut.flowdata
diff --git a/dod-wrapper/gradle.properties b/dod-wrapper/gradle.properties
@@ -1,5 +1,5 @@
 POM_ARTIFACT_ID=dod-wrapper
-VERSION_NAME=1.5.12
+VERSION_NAME=1.5.13
 POM_NAME=dod-wrapper
 POM_PACKAGING=jar
 GROUP=com.revolut.rxdata
diff --git a/dod/gradle.properties b/dod/gradle.properties
@@ -1,5 +1,5 @@
 POM_ARTIFACT_ID=dod
-VERSION_NAME=1.5.12
+VERSION_NAME=1.5.13
 POM_NAME=dod
 POM_PACKAGING=jar
 GROUP=com.revolut.rxdata
diff --git a/dod/src/main/java/com/revolut/rxdata/dod/DataObservableDelegate.kt b/dod/src/main/java/com/revolut/rxdata/dod/DataObservableDelegate.kt
@@ -98,23 +98,22 @@ class DataObservableDelegate<Params : Any, Domain : Any> constructor(
      * Requests data from network and subscribes to updates
      * (can be triggered by other subscribers or manual cache overrides)
      *
-     * @param forceReload - if true network request will be made even if data exists in caches
+     * @param loadingStrategy - [LoadingStrategy]
      */
-    @Suppress("RedundantLambdaArrow")
-    fun observe(params: Params, forceReload: Boolean = true): Observable<Data<Domain>> =
+    fun observe(params: Params, loadingStrategy: LoadingStrategy): Observable<Data<Domain>> =
         Observable.defer {
             val memCache = fromMemory(params)
             val memoryIsEmpty = memCache == null
             val subject = subject(params)
-            val loading = forceReload || memoryIsEmpty || failedNetworkRequests.containsKey(params)
+            val loading = loadingStrategy.refreshMemory || memoryIsEmpty || failedNetworkRequests.containsKey(params)
 
             val observable: Observable<Data<Domain>> = if (memCache != null) {
                 concat(
                     just(Data(content = memCache, loading = loading)),
                     subject
                 ).doAfterSubscribe {
                     if (loading) {
-                        subject.onNext(Data(content = memCache, loading = loading))
+                        subject.onNext(Data(content = memCache, loading = true))
                         fetchFromNetwork(memCache, params)
                     }
                 }
@@ -125,7 +124,9 @@ class DataObservableDelegate<Params : Any, Domain : Any> constructor(
                             just(cached),
                             subject
                         ).doAfterSubscribe {
-                            fetchFromNetwork(cached.content, params)
+                            if (loadingStrategy.refreshStorage || cached.content == null) {
+                                fetchFromNetwork(cached.content, params)
+                            }
                         }
                     }
                     .startWith(Data(null, loading = true))
@@ -136,6 +137,19 @@ class DataObservableDelegate<Params : Any, Domain : Any> constructor(
                 .muteRepetitiveReloading()
         }
 
+    /**
+     * Requests data from network and subscribes to updates
+     * (can be triggered by other subscribers or manual cache overrides)
+     *
+     * @param forceReload - if true network request will be made even if data exists in caches
+     */
+    @Deprecated(
+        message = "please migrate to the method with the LoadingStrategy",
+        replaceWith = ReplaceWith("fun observe(params: Params, loadingStrategy: LoadingStrategy)")
+    )
+    fun observe(params: Params, forceReload: Boolean = true): Observable<Data<Domain>> =
+        observe(params, loadingStrategy = if (forceReload) LoadingStrategy.ForceReload else LoadingStrategy.Auto)
+
     private fun Observable<Data<Domain>>.muteRepetitiveReloading(): Observable<Data<Domain>> =
         this.scan(ReloadingDataScanner<Domain>()) { scanner, newEmit ->
             scanner.registerData(newEmit)

diff --git a/dod/src/main/java/com/revolut/rxdata/dod/LoadingStrategy.kt b/dod/src/main/java/com/revolut/rxdata/dod/LoadingStrategy.kt
@@ -0,0 +1,36 @@
+package com.revolut.rxdata.dod
+
+/**
+ * [DataObservableDelegate] observation loading strategy
+ *
+ * @param refreshMemory - if true data will be fetched from network even if there is something in the memory
+ * @param refreshStorage - if true data will be fetched from network even if there is something in the storage
+ */
+sealed class LoadingStrategy(
+    internal val refreshMemory: Boolean,
+    internal val refreshStorage: Boolean,
+) {
+    /**
+     * data will be fetched from the Network even if the data exists in the cache
+     */
+    object ForceReload: LoadingStrategy(
+        refreshMemory = true,
+        refreshStorage = true,
+    )
+
+    /**
+     * data will not be fetched from the Network if the data exists in the memory cache
+     */
+    object Auto: LoadingStrategy(
+        refreshMemory = false,
+        refreshStorage = true,
+    )
+
+    /**
+     * data will not be fetched from the Network if the data exists in the cache memory or storage
+     */
+    object LazyReload: LoadingStrategy(
+        refreshMemory = false,
+        refreshStorage = false,
+    )
+}