Make it easier to work with lists (#548)

* Make it possible to provide memory cache

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Format

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Add HybridCache

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Fix putList

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Enable memory cache delegation with Guava as default

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Add MutableStoreWithHybridCacheTests

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Support all cache methods

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Rename to multicache

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Refactor from list decomposition to collection decomposition

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Remove ReactiveCircus/android-emulator-runner

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Remove MemoryCache

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Update .ci_test_and_publish.yml

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Update .ci_test_and_publish.yml

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Update .ci_test_and_publish.yml

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Update .ci_test_and_publish.yml

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Format

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

* Prepare for release 5.0.0-beta01

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

---------

Signed-off-by: Matt Ramotar <mramotar@dropbox.com>

Author: matt-ramotar

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## [Unreleased]
 
+## [5.0.0-beta01] (2023-05-19)
+
+* Delegate memory cache implementation and provide a hybrid cache with automatic list decomposition as a separate
+  artifact [#548](https://github.com/MobileNativeFoundation/Store/pull/548)
+
 ## [5.0.0-alpha06] (2023-05-08)
 
 * Separate MutableStoreBuilder from
@@ -255,7 +260,9 @@ This is a first alpha release of Store ported to RxJava 2.
 * The change log for Store version 1.x can be
   found [here](https://github.com/NYTimes/Store/blob/develop/CHANGELOG.md).
 
-[Unreleased]: https://github.com/MobileNativeFoundation/Store/compare/v5.0.0-alpha06...HEAD
+[Unreleased]: https://github.com/MobileNativeFoundation/Store/compare/v5.0.0-beta01...HEAD
+
+[5.0.0-beta01]: https://github.com/MobileNativeFoundation/Store/releases/tag/5.0.0-beta01
 
 [5.0.0-alpha06]: https://github.com/MobileNativeFoundation/Store/releases/tag/5.0.0-alpha06
 

README.md

@@ -37,7 +37,7 @@
 
 #### Android
 ```kotlin
-implementation "org.mobilenativefoundation.store:store5:5.0.0-alpha06"
+implementation "org.mobilenativefoundation.store:store5:5.0.0-beta01"
 implementation "org.jetbrains.kotlinx:atomicfu:0.18.5"
 ```
 
@@ -46,7 +46,7 @@ implementation "org.jetbrains.kotlinx:atomicfu:0.18.5"
 ```kotlin
 commonMain {
   dependencies {
-    implementation("org.mobilenativefoundation.store:store5:5.0.0-alpha06")
+    implementation("org.mobilenativefoundation.store:store5:5.0.0-beta01")
     implementation("org.jetbrains.kotlinx:atomicfu:0.18.5")
   }
 }

buildSrc/src/main/kotlin/Version.kt

@@ -32,6 +32,6 @@ object Version {
     const val navigationCompose = "2.5.2"
     const val sqlDelight = "1.5.4"
     const val sqlDelightGradlePlugin = sqlDelight
-    const val store = "5.0.0-alpha06"
+    const val store = "5.0.0-beta01"
     const val truth = "1.1.3"
 }

cache/src/commonMain/kotlin/org/mobilenativefoundation/store/cache5/Identifiable.kt

@@ -0,0 +1,5 @@
+package org.mobilenativefoundation.store.cache5
+
+interface Identifiable<Id : Any> {
+    val id: Id
+}

cache/src/commonMain/kotlin/org/mobilenativefoundation/store/cache5/MultiCache.kt

@@ -0,0 +1,77 @@
+@file:Suppress("UNCHECKED_CAST")
+
+package org.mobilenativefoundation.store.cache5
+
+/**
+ * Implementation of a cache with collection decomposition.
+ * Stores and manages the relationship among single items and collections.
+ * Delegates cache storage and behavior to Guava caches.
+ */
+class MultiCache<Key : Any, Output : Identifiable<Key>>(
+    cacheBuilder: CacheBuilder<Key, Output>
+) {
+    private val collectionCacheBuilder = CacheBuilder<Key, Collection<Output>>().apply {
+        expireAfterAccess(cacheBuilder.expireAfterAccess)
+        expireAfterWrite(cacheBuilder.expireAfterWrite)
+
+        if (cacheBuilder.maximumSize > 0) {
+            maximumSize(cacheBuilder.maximumSize)
+        }
+        // TODO(): Support weigher
+    }
+
+    private val itemKeyToCollectionKey = mutableMapOf<Key, Key>()
+
+    private val itemCache: Cache<Key, Output> = cacheBuilder.build()
+
+    private val collectionCache: Cache<Key, Collection<Output>> = collectionCacheBuilder.build()
+
+    fun getItem(key: Key): Output? {
+        return itemCache.getIfPresent(key)
+    }
+
+    fun putItem(key: Key, item: Output) {
+        itemCache.put(key, item)
+
+        val collectionKey = itemKeyToCollectionKey[key]
+        if (collectionKey != null) {
+            val updatedCollection = collectionCache.getIfPresent(collectionKey)?.map { if (it.id == key) item else it }
+            if (updatedCollection != null) {
+                collectionCache.put(collectionKey, updatedCollection)
+            }
+        }
+    }
+
+    fun <T : Collection<Output>> getCollection(key: Key): T? {
+        return collectionCache.getIfPresent(key) as? T
+    }
+
+    fun putCollection(key: Key, items: Collection<Output>) {
+        collectionCache.put(key, items)
+        items.forEach { item ->
+            itemCache.put(item.id, item)
+            itemKeyToCollectionKey[item.id] = key
+        }
+    }
+
+    fun invalidateItem(key: Key) {
+        itemCache.invalidate(key)
+    }
+
+    fun invalidateCollection(key: Key) {
+        val collection = collectionCache.getIfPresent(key)
+        collection?.forEach { item ->
+            invalidateItem(item.id)
+        }
+        collectionCache.invalidate(key)
+    }
+
+    fun invalidateAll() {
+        collectionCache.invalidateAll()
+        itemCache.invalidateAll()
+    }
+
+    fun size(): Long {
+        return itemCache.size() + collectionCache.size()
+    }
+}

gradle.properties

@@ -8,7 +8,7 @@ org.gradle.jvmargs=-XX:MaxMetaspaceSize=2G
 
 # POM file
 GROUP=org.mobilenativefoundation.store
-VERSION_NAME=5.0.0-alpha06
+VERSION_NAME=5.0.0-beta01
 POM_PACKAGING=pom
 POM_DESCRIPTION = Store5 is a Kotlin Multiplatform network-resilient repository layer
 

store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/StoreBuilder.kt

@@ -16,8 +16,10 @@
 package org.mobilenativefoundation.store.store5
 
 import kotlinx.coroutines.CoroutineScope
+import org.mobilenativefoundation.store.cache5.Cache
 import org.mobilenativefoundation.store.store5.impl.storeBuilderFromFetcher
 import org.mobilenativefoundation.store.store5.impl.storeBuilderFromFetcherAndSourceOfTruth
+import org.mobilenativefoundation.store.store5.impl.storeBuilderFromFetcherSourceOfTruthAndMemoryCache
 
 /**
  * Main entry point for creating a [Store].
@@ -69,6 +71,17 @@ interface StoreBuilder<Key : Any, Output : Any> {
         fun <Key : Any, Input : Any, Output : Any> from(
             fetcher: Fetcher<Key, Input>,
             sourceOfTruth: SourceOfTruth<Key, Input>
-        ): StoreBuilder<Key, Output> = storeBuilderFromFetcherAndSourceOfTruth(fetcher = fetcher, sourceOfTruth = sourceOfTruth)
+        ): StoreBuilder<Key, Output> =
+            storeBuilderFromFetcherAndSourceOfTruth(fetcher = fetcher, sourceOfTruth = sourceOfTruth)
+
+        fun <Key : Any, Network : Any, Output : Any, Local : Any> from(
+            fetcher: Fetcher<Key, Network>,
+            sourceOfTruth: SourceOfTruth<Key, Local>,
+            memoryCache: Cache<Key, Output>,
+        ): StoreBuilder<Key, Output> = storeBuilderFromFetcherSourceOfTruthAndMemoryCache(
+            fetcher,
+            sourceOfTruth,
+            memoryCache
+        )
     }
 }

store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/StoreReadRequest.kt

@@ -23,7 +23,7 @@ package org.mobilenativefoundation.store.store5
  *  starting the stream from the local [com.dropbox.android.external.store4.impl.SourceOfTruth] and memory cache
  *
  */
-data class StoreReadRequest<Key> private constructor(
+data class StoreReadRequest<out Key> private constructor(
     val key: Key,
     private val skippedCaches: Int,
     val refresh: Boolean = false,

store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealMutableStoreBuilder.kt

@@ -2,6 +2,8 @@ package org.mobilenativefoundation.store.store5.impl
 
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.GlobalScope
+import org.mobilenativefoundation.store.cache5.Cache
+import org.mobilenativefoundation.store.cache5.CacheBuilder
 import org.mobilenativefoundation.store.store5.Bookkeeper
 import org.mobilenativefoundation.store.store5.Converter
 import org.mobilenativefoundation.store.store5.Fetcher
@@ -24,9 +26,16 @@ fun <Key : Any, Network : Any, Output : Any, Local : Any> mutableStoreBuilderFro
     sourceOfTruth: SourceOfTruth<Key, Local>,
 ): MutableStoreBuilder<Key, Network, Output, Local> = RealMutableStoreBuilder(fetcher, sourceOfTruth)
 
+fun <Key : Any, Network : Any, Output : Any, Local : Any> mutableStoreBuilderFromFetcherSourceOfTruthAndMemoryCache(
+    fetcher: Fetcher<Key, Network>,
+    sourceOfTruth: SourceOfTruth<Key, Local>,
+    memoryCache: Cache<Key, Output>
+): MutableStoreBuilder<Key, Network, Output, Local> = RealMutableStoreBuilder(fetcher, sourceOfTruth, memoryCache)
+
 internal class RealMutableStoreBuilder<Key : Any, Network : Any, Output : Any, Local : Any>(
     private val fetcher: Fetcher<Key, Network>,
     private val sourceOfTruth: SourceOfTruth<Key, Local>? = null,
+    private val memoryCache: Cache<Key, Output>? = null
 ) : MutableStoreBuilder<Key, Network, Output, Local> {
     private var scope: CoroutineScope? = null
     private var cachePolicy: MemoryPolicy<Key, Output>? = StoreDefaults.memoryPolicy
@@ -62,9 +71,25 @@ internal class RealMutableStoreBuilder<Key : Any, Network : Any, Output : Any, L
         scope = scope ?: GlobalScope,
         sourceOfTruth = sourceOfTruth,
         fetcher = fetcher,
-        memoryPolicy = cachePolicy,
         converter = converter,
-        validator = validator
+        validator = validator,
+        memCache = memoryCache ?: cachePolicy?.let {
+            CacheBuilder<Key, Output>().apply {
+                if (cachePolicy!!.hasAccessPolicy) {
+                    expireAfterAccess(cachePolicy!!.expireAfterAccess)
+                }
+                if (cachePolicy!!.hasWritePolicy) {
+                    expireAfterWrite(cachePolicy!!.expireAfterWrite)
+                }
+                if (cachePolicy!!.hasMaxSize) {
+                    maximumSize(cachePolicy!!.maxSize)
+                }
+
+                if (cachePolicy!!.hasMaxWeight) {
+                    weigher(cachePolicy!!.maxWeight) { key, value -> cachePolicy!!.weigher.weigh(key, value) }
+                }
+            }.build()
+        }
     )
 
     override fun <UpdaterResult : Any> build(

store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStore.kt

@@ -25,12 +25,11 @@ import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.flow.onEach
 import kotlinx.coroutines.flow.onStart
 import kotlinx.coroutines.flow.transform
-import org.mobilenativefoundation.store.cache5.CacheBuilder
+import org.mobilenativefoundation.store.cache5.Cache
 import org.mobilenativefoundation.store.store5.CacheType
 import org.mobilenativefoundation.store.store5.Converter
 import org.mobilenativefoundation.store.store5.ExperimentalStoreApi
 import org.mobilenativefoundation.store.store5.Fetcher
-import org.mobilenativefoundation.store.store5.MemoryPolicy
 import org.mobilenativefoundation.store.store5.SourceOfTruth
 import org.mobilenativefoundation.store.store5.Store
 import org.mobilenativefoundation.store.store5.StoreReadRequest
@@ -47,7 +46,7 @@ internal class RealStore<Key : Any, Network : Any, Output : Any, Local : Any>(
     sourceOfTruth: SourceOfTruth<Key, Local>? = null,
     private val converter: Converter<Network, Output, Local>? = null,
     private val validator: Validator<Output>?,
-    private val memoryPolicy: MemoryPolicy<Key, Output>?
+    private val memCache: Cache<Key, Output>?
 ) : Store<Key, Output> {
     /**
      * This source of truth is either a real database or an in memory source of truth created by
@@ -61,24 +60,6 @@ internal class RealStore<Key : Any, Network : Any, Output : Any, Local : Any>(
             SourceOfTruthWithBarrier(it, converter)
         }
 
-    private val memCache = memoryPolicy?.let {
-        CacheBuilder<Key, Output>().apply {
-            if (memoryPolicy.hasAccessPolicy) {
-                expireAfterAccess(memoryPolicy.expireAfterAccess)
-            }
-            if (memoryPolicy.hasWritePolicy) {
-                expireAfterWrite(memoryPolicy.expireAfterWrite)
-            }
-            if (memoryPolicy.hasMaxSize) {
-                maximumSize(memoryPolicy.maxSize)
-            }
-
-            if (memoryPolicy.hasMaxWeight) {
-                weigher(memoryPolicy.maxWeight) { key, value -> memoryPolicy.weigher.weigh(key, value) }
-            }
-        }.build()
-    }
-
     /**
      * Fetcher controller maintains 1 and only 1 `Multicaster` for a given key to ensure network
      * requests are shared.

store/src/commonMain/kotlin/org/mobilenativefoundation/store/store5/impl/RealStoreBuilder.kt

@@ -4,6 +4,8 @@ package org.mobilenativefoundation.store.store5.impl
 
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.GlobalScope
+import org.mobilenativefoundation.store.cache5.Cache
+import org.mobilenativefoundation.store.cache5.CacheBuilder
 import org.mobilenativefoundation.store.store5.Converter
 import org.mobilenativefoundation.store.store5.Fetcher
 import org.mobilenativefoundation.store.store5.MemoryPolicy
@@ -24,9 +26,16 @@ fun <Key : Any, Input : Any, Output : Any> storeBuilderFromFetcherAndSourceOfTru
     sourceOfTruth: SourceOfTruth<Key, *>,
 ): StoreBuilder<Key, Output> = RealStoreBuilder(fetcher, sourceOfTruth)
 
+fun <Key : Any, Network : Any, Output : Any, Local : Any> storeBuilderFromFetcherSourceOfTruthAndMemoryCache(
+    fetcher: Fetcher<Key, Network>,
+    sourceOfTruth: SourceOfTruth<Key, Local>,
+    memoryCache: Cache<Key, Output>,
+): StoreBuilder<Key, Output> = RealStoreBuilder(fetcher, sourceOfTruth, memoryCache)
+
 internal class RealStoreBuilder<Key : Any, Network : Any, Output : Any, Local : Any>(
     private val fetcher: Fetcher<Key, Network>,
-    private val sourceOfTruth: SourceOfTruth<Key, Local>? = null
+    private val sourceOfTruth: SourceOfTruth<Key, Local>? = null,
+    private val memoryCache: Cache<Key, Output>? = null
 ) : StoreBuilder<Key, Output> {
     private var scope: CoroutineScope? = null
     private var cachePolicy: MemoryPolicy<Key, Output>? = StoreDefaults.memoryPolicy
@@ -57,17 +66,42 @@ internal class RealStoreBuilder<Key : Any, Network : Any, Output : Any, Local :
         scope = scope ?: GlobalScope,
         sourceOfTruth = sourceOfTruth,
         fetcher = fetcher,
-        memoryPolicy = cachePolicy,
         converter = converter,
-        validator = validator
+        validator = validator,
+        memCache = memoryCache ?: cachePolicy?.let {
+            CacheBuilder<Key, Output>().apply {
+                if (cachePolicy!!.hasAccessPolicy) {
+                    expireAfterAccess(cachePolicy!!.expireAfterAccess)
+                }
+                if (cachePolicy!!.hasWritePolicy) {
+                    expireAfterWrite(cachePolicy!!.expireAfterWrite)
+                }
+                if (cachePolicy!!.hasMaxSize) {
+                    maximumSize(cachePolicy!!.maxSize)
+                }
+
+                if (cachePolicy!!.hasMaxWeight) {
+                    weigher(cachePolicy!!.maxWeight) { key, value -> cachePolicy!!.weigher.weigh(key, value) }
+                }
+            }.build()
+        }
     )
 
     override fun <Network : Any, Local : Any> toMutableStoreBuilder(): MutableStoreBuilder<Key, Network, Output, Local> {
         fetcher as Fetcher<Key, Network>
-        return if (sourceOfTruth == null) {
+        return if (sourceOfTruth == null && memoryCache == null) {
             mutableStoreBuilderFromFetcher(fetcher)
+        } else if (memoryCache == null) {
+            mutableStoreBuilderFromFetcherAndSourceOfTruth<Key, Network, Output, Local>(
+                fetcher,
+                sourceOfTruth as SourceOfTruth<Key, Local>
+            )
         } else {
-            mutableStoreBuilderFromFetcherAndSourceOfTruth<Key, Network, Output, Local>(fetcher, sourceOfTruth as SourceOfTruth<Key, Local>)
+            mutableStoreBuilderFromFetcherSourceOfTruthAndMemoryCache(
+                fetcher,
+                sourceOfTruth as SourceOfTruth<Key, Local>,
+                memoryCache
+            )
         }.apply {
             if (this@RealStoreBuilder.scope != null) {
                 scope(this@RealStoreBuilder.scope!!)