StoreRoom #338

digitalbuddha · 2018-05-25T02:47:20Z

closes #215

This PR is a working implementation of a Store that can use a RoomPersister. While not in its final form I wanted to open the pr to get feedback. I'll annotate the important parts.

Example usage (will move to readme)
example usage:

@Entity
data class User(
        @PrimaryKey(autoGenerate = true)
        var uid: Int = 0,
        val name: String)

@Dao
interface UserDao {
    @Query("SELECT name FROM user")
    fun loadAll(): Flowable<List<String>>

    @Insert
    fun insertAll(vararg users: User)

}

@Database(entities = arrayOf(User::class), version = 1)
abstract class AppDatabase : RoomDatabase() {
    abstract fun userDao(): UserDao
}

val db = Room.databaseBuilder(SampleApp.appContext!!, AppDatabase::class.java, "db").build()


val store = RoomInternalStore(
        Fetcher<User, String> { Single.just(User(name = "Mike")) },
        object : RoomPersister<User, List<String>, String> {

            override fun read(key: String): Observable<List<String>> {
                return db.userDao().loadAll().toObservable()
            }

            override fun write(key: String, user: User) {
                db.userDao().insertAll(user)
            } 
        })

digitalbuddha · 2018-05-25T02:48:24Z

app/src/main/java/com/nytimes/android/sample/SampleApp.kt

+    }
+
+    private fun RoomSample() {
+        var foo = store.get("")


see SampleRoomStore.kt for the implementation of this store, biggest takeaway is the ability to treat each store subscription as an endless stream backed by a Room Query. Now anytime you subscribe to get if someone calls store.fresh or if another get call busts through the cache, we will emit to all of the previous get/fresh subscribers. Store becomes truly reactive when backed by room

digitalbuddha · 2018-05-25T02:50:53Z

app/src/main/java/com/nytimes/android/sample/SampleRoomStore.kt

+
+
+// File: User.java
+@Entity


Simple implementation of a RoomDB as a proof of concept

digitalbuddha · 2018-05-25T02:52:27Z

app/src/main/java/com/nytimes/android/sample/SampleRoomStore.kt

+
+val db = Room.databaseBuilder(SampleApp.appContext!!, AppDatabase::class.java, "db").build()
+
+val persister = object : RoomPersister<User, List<String>, String>() {


A new persister needed to be created that is exposed as an observable rather than a single. The RoomPersister takes a third param as you can have the freedom to have different queries for reading and writing. In this example writing is always done by adding a single user to the DB while read returns the list of all users. Another use case is writing a User but only reading a part of the user

digitalbuddha · 2018-05-25T02:53:00Z

app/src/main/java/com/nytimes/android/sample/SampleRoomStore.kt

+
+
+//store
+class SampleRoomStore(fetcher: Fetcher<User, String>,


Nothing crazy here besides a few interface changes that lead to a RoomInternalStore. TODO: create builders for instantiation

digitalbuddha · 2018-05-25T02:53:42Z

store/src/main/java/com/nytimes/android/external/store3/base/BasePersister.java

+
+
+
+public interface BasePersister {


Since we now have RoomPersister and Persister I made a marker interface for use with StoreUtil for things like checking stale policy or clearing the persister

digitalbuddha · 2018-05-25T02:54:14Z

store/src/main/java/com/nytimes/android/external/store3/base/impl/CacheFactory.java

@@ -58,4 +59,50 @@ private CacheFactory() {
                    .build();
        }
    }
+
+    public static <Key, Parsed> Cache<Key, Observable<Parsed>> createRoomCache(MemoryPolicy memoryPolicy) {


needed a new cache implementation that holds observables rather than singles to keep the "live query" setup

You can keep it simple and have a method level generic for the singles/maybes/observables.

private static <Key, Value> Cache<Key, Value> createBaseCache(MemoryPolicy memoryPolicy)

digitalbuddha · 2018-05-25T02:55:32Z

store/src/main/java/com/nytimes/android/external/store3/base/impl/room/RoomInternalStore.java

+ * @param <Parsed> data type after parsing
+ *                 <p>
+ */
+public class RoomInternalStore<Raw, Parsed, Key> implements RoomStore<Parsed, Key> {


RoomInternalStore is the meat of it. Notice that we don't need stream or getRefreshing as both of those can be achieved by Room without the need of the helpers. Update a query that a RoomPersister is listening to and get will refresh on its own. If not preferable users can transform the get back into a single

Most logic in this class stayed the same but changed to use Observable rather than Single

digitalbuddha · 2018-05-25T02:56:53Z

store/src/main/java/com/nytimes/android/external/store3/base/room/RoomPersister.java

+ *
+ * @param <Raw> data type before parsing
+ */
+public abstract class RoomPersister<Raw, Parsed, Key> implements RoomDiskRead<Parsed, Key>, RoomDiskWrite<Raw, Key>, BasePersister {


Parsers are unnecessary since the DB read query can be a "parsed" version of whatever the written "raw" data is

digitalbuddha · 2018-05-25T14:18:22Z

I'll migrate tests as well to make sure the Room impl works as well as the regular one. I'll also mark this implementation as experimental

brianPlummer · 2018-05-25T14:21:31Z

app/build.gradle

 apply plugin: 'com.getkeepsafe.dexcount'
-
+apply plugin: 'kotlin-kapt'


brianPlummer · 2018-05-25T14:27:52Z

buildsystem/dependencies.gradle

        buildTools           : '27.0.3',
        kotlin               : '1.1.2-5',

        // UI libs.
-        supportLibs          : '25.1.1',
+        supportLibs          : '26.1.0',


should be 27 as well...

brianPlummer · 2018-05-25T14:30:21Z

app/src/main/java/com/nytimes/android/sample/SampleApp.kt

+
+        var appContext: Context? = null
+    }
+}


format and remove EL for this file..

brianPlummer · 2018-05-25T14:30:45Z

app/build.gradle

-    implementation 'com.nytimes.android:cache3:3.0.1'
-    implementation 'com.nytimes.android:middleware3:3.0.1'
-    implementation 'com.nytimes.android:filesystem3:3.0.1'
+    implementation project(':store')


might need to flip before checking in....

will do once I can push the new snapshot thanks!

brianPlummer · 2018-05-25T14:31:30Z

LGTM besides the nitpicks :)

…ntal

…ntal

digitalbuddha · 2018-05-26T02:43:50Z

Added prelimanary tests, marked RoomStore as Experimental and added tests, bump rev up to 3.1.0

Pr is ready to merge IMO.

Follow up from me will be a blog post, more tests and a cleanup of the example that is currently living in SampleApp

@tiwiz wake up and review my code :-D

alexio · 2018-05-29T18:48:37Z

app/src/main/java/com/nytimes/android/sample/SampleApp.kt

+                .subscribe { again() }
+    }
+
+    private fun again() {


Change to more descriptive name?

alexio · 2018-05-29T19:06:53Z

app/src/main/java/com/nytimes/android/sample/SampleRoomStore.kt

+    abstract fun userDao(): UserDao
+}
+
+val db = Room.databaseBuilder(SampleApp.appContext!!, AppDatabase::class.java, "db").build()


Reimplement to avoid using the !! operator?
Can be as simple as creating a builder that just takes a context.

alexio · 2018-05-29T19:07:56Z

app/src/main/java/com/nytimes/android/sample/SampleApp.kt

+    }
+
+    companion object {
+        var appContext: Context? = null


Not great, lets avoid having objects create a static reference to themselves?

alexio

Some code quality request changes.

trietbui85 · 2018-06-23T01:58:18Z

app/build.gradle

+}
+
+configurations.all {
+    resolutionStrategy.force 'com.android.support:support-v4:26.1.0'


It seems we're still using support lib v26.1.0 while there is latest one v27.1.1. Any plan to upgrade?

Mike Nakhimovich added 4 commits May 24, 2018 17:18

roomStore

7c74b34

kt the app class

67a353a

refactor

907d230

fix compilation

395fd42

digitalbuddha commented May 25, 2018

View reviewed changes

tiwiz approved these changes May 25, 2018

View reviewed changes

Update .travis.yml

7c669f9

brianPlummer reviewed May 25, 2018

View reviewed changes

app/build.gradle

apply plugin: 'com.getkeepsafe.dexcount'

apply plugin: 'kotlin-kapt'

Copy link

Contributor

brianPlummer May 25, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woohoo!

This was referenced May 25, 2018

Observe changes in disk without invalidating cache #337

Closed

Store 4 design document #334

Open

brianPlummer reviewed May 25, 2018

View reviewed changes

Mike Nakhimovich added 4 commits May 25, 2018 22:32

migrate relevant tests to RoomStore, mark new Room API with @experime…

1a77719

…ntal

Merge remote-tracking branch 'origin/store4' into store4

27234de

pr feedback

5804e19

bump minor rev up

b1a7b94

Mike Nakhimovich added 2 commits May 25, 2018 22:48

cleanup store

39eab81

create factory, clean up example

c1b7ead

digitalbuddha changed the title ~~Room Store~~ StoreRoom May 28, 2018

tiwiz approved these changes May 29, 2018

View reviewed changes

wdziemia approved these changes May 29, 2018

View reviewed changes

alexio reviewed May 29, 2018

View reviewed changes

alexio suggested changes May 29, 2018

View reviewed changes

pr comments

8ee3d09

alexio approved these changes May 30, 2018

View reviewed changes

tiwiz merged commit 6ac40cd into nytimes:feature/rx2 May 30, 2018

trietbui85 reviewed Jun 23, 2018

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

StoreRoom #338

StoreRoom #338

digitalbuddha commented May 25, 2018 •

edited

digitalbuddha May 25, 2018 •

edited

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

alexio May 29, 2018 •

edited

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

digitalbuddha May 25, 2018

digitalbuddha commented May 25, 2018

brianPlummer May 25, 2018

brianPlummer May 25, 2018

brianPlummer May 25, 2018

brianPlummer May 25, 2018

digitalbuddha May 26, 2018

brianPlummer commented May 25, 2018

digitalbuddha commented May 26, 2018

alexio May 29, 2018

alexio May 29, 2018

alexio May 29, 2018

alexio left a comment

trietbui85 Jun 23, 2018


		val db = Room.databaseBuilder(SampleApp.appContext!!, AppDatabase::class.java, "db").build()

		val persister = object : RoomPersister<User, List<String>, String>() {



		//store
		class SampleRoomStore(fetcher: Fetcher<User, String>,

		apply plugin: 'com.getkeepsafe.dexcount'

		apply plugin: 'kotlin-kapt'

StoreRoom #338

StoreRoom #338

Conversation

digitalbuddha commented May 25, 2018 • edited

digitalbuddha May 25, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexio May 29, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

digitalbuddha commented May 25, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brianPlummer commented May 25, 2018

digitalbuddha commented May 26, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexio left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

digitalbuddha commented May 25, 2018 •

edited

digitalbuddha May 25, 2018 •

edited

alexio May 29, 2018 •

edited