Multiplatform Persistence

Slide 1

Slide 1 text

Multiplatform  Persistence

Slide 2

Slide 2 text

No content

Slide 3

Slide 3 text

message Customer { required int32 id = 1; required string name = 2; required string photoUrl = 3; } message Payment { required Money amount = 1; required int32 sender = 2; required int32 recipient = 3; } protos

Slide 4

Slide 4 text

Slide 5

Slide 5 text

public interface AppService { @POST("/2.0/cash/sync-entities") // Observable syncEntities( @Body SyncEntitiesRequest request); }

Slide 6

Slide 6 text

public interface AppService { @POST("/2.0/cash/sync-entities") // Observable syncEntities( @Body SyncEntitiesRequest request); } protos api

Slide 7

Slide 7 text

CREATE TABLE contact ( lookup_key TEXT PRIMARY KEY, display_name TEXT ); CREATE TABLE alias ( hashed_alias TEXT NOT NULL PRIMARY KEY, email TEXT, sms TEXT, customer_id TEXT REFERENCES customer ); CREATE TABLE customer ( customer_id TEXT PRIMARY KEY, photo_url TEXT, customer_display_name TEXT );

Slide 8

Slide 8 text

Slide 9

Slide 9 text

backend db protos api

Slide 10

Slide 10 text

backend presenters db protos api

Slide 11

Slide 11 text

backend presenters viewmodel + viewevent db protos api

Slide 12

Slide 12 text

backend presenters viewmodel + viewevent app db protos api

Slide 13

Slide 13 text

db protos api presenters viewmodel + viewevent app backend val presenter = ActivityPresenter()

Slide 14

Slide 14 text

val presenter = ActivityPresenter() db protos api presenters viewmodel + viewevent app backend entitySyncer.triggerSync( foreground = false, force = false ).subscribe() appService.syncEntities(request) @POST("/2.0/cash/sync-entities") // Observable syncEntities( @Body SyncEntitiesRequest request); paymentQueries.insertPayment( payment.token!!, payment.sender_id, payment.recipient_id, payment.amount ) insertPayment: INSERT OR REPLACE INTO payment (token, sender_id, recipient_id, amount) VALUES (?, ?, ?, ?); fun renderedPayment( paymentToken: String ): Observable entityManager .renderedPayment(token) .map(this::createViewModel) .subscribe(view) presenter.viewModel() .observeOn(AndroidSchedulers.mainThread()) .subscribe(this::renderViewModel)

Slide 15

Slide 15 text

db protos api presenters viewmodel + viewevent app backend

Slide 16

Slide 16 text

interface InstrumentManager { @CheckResult fun withToken( token: String ): Observable } backend

Slide 17

Slide 17 text

internal class RealInstrumentManager @Inject constructor( private val appService: AppService, private val queryWrapper: QueryWrapper, @Io private val ioScheduler: Scheduler ) : InstrumentManager backend

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Slide 20

Slide 20 text

class RealInstrumentManagerTest { @get:Rule private val temporaryDatabase = TemporaryDatabase() @Before fun before() { val appService = FakeAppService() val queryWrapper = temporaryDatabase.queryWrapper instrumentManager = RealInstrumentManager( appService = appService, queryWrapper = queryWrapper, ioScheduler = Schedulers.trampoline() ) } } backend

Slide 21

Slide 21 text

db protos api presenters viewmodel + viewevent app backend

Slide 22

Slide 22 text

db protos api presenters viewmodel + viewevent app backend

Slide 23

Slide 23 text

No content

Slide 24

Slide 24 text

No content

Slide 25

Slide 25 text

No content

Slide 26

Slide 26 text

No content

Slide 27

Slide 27 text

db backend api presenters viewmodel + viewevent app protos

Slide 28

Slide 28 text

protos Wire protobufs

Slide 29

Slide 29 text

db backend presenters viewmodel + viewevent app protos api

Slide 30

Slide 30 text

api Retroﬁt Http protos RxJava

Slide 31

Slide 31 text

backend presenters viewmodel + viewevent app protos api db

Slide 32

Slide 32 text

db SQLite SqlDelight SqlBrite

Slide 33

Slide 33 text

presenters viewmodel + viewevent app protos api backend db

Slide 34

Slide 34 text

backend dagger db api RxJava

Slide 35

Slide 35 text

viewmodel + viewevent app protos api db presenters backend

Slide 36

Slide 36 text

presenters backend viewmodels analytics RxJava

Slide 37

Slide 37 text

viewmodel + viewevent app api db protos presenters backend

Slide 38

Slide 38 text

viewmodel + viewevent app api db protos presenters backend

Slide 39

Slide 39 text

viewmodel + viewevent app api db protos presenters backend

Slide 40

Slide 40 text

protos Wire protobufs

Slide 41

Slide 41 text

protos Wire protobufs parcelable

Slide 42

Slide 42 text

viewmodel + viewevent app api presenters db protos backend

Slide 43

Slide 43 text

viewmodel + viewevent app api presenters protos backend db

Slide 44

Slide 44 text

db SQLite SqlDelight SqlBrite

Slide 45

Slide 45 text

db SqlDelight SqlBrite

Slide 46

Slide 46 text

db SqlBrite SqlDelight

Slide 47

Slide 47 text

db SqlBrite SqlDelight

Slide 48

Slide 48 text

db SqlBrite SqlDelight

Slide 49

Slide 49 text

SqlDelight 1.0

Slide 50

Slide 50 text

SqlDelight 1.0 (alpha)

Slide 51

Slide 51 text

Player.sq: CREATE TABLE player ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, country TEXT NOT NULL ); build/Player.kt: interface Player { val id: Long val name: String val country: String data class Impl( override val id: Long, override val name: String, override val country: String ) : Player }

Slide 52

Slide 52 text

Surface.kt: enum class Surface { OUTDOOR_HARD, INDOOR_HARD, GRASS, CLAY } Tournament.sq: CREATE TABLE tournament ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, surface TEXT AS Surface NOT NULL, year INTEGER NOT NULL ); Tournament.sq: CREATE TABLE tournament ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, surface TEXT AS Surface NOT NULL, year INTEGER NOT NULL );

Slide 53

Slide 53 text

build/Tournament.sq: interface Tournament { val id: Long val name: String val surface: Surface val year: Long class Adapter( internal val surfaceAdapter: ColumnAdapter ) data class Impl( override val id: Long, override val name: String, override val surface: Surface, override val year: Long ) : Tournament } build/Tournament.sq: interface Tournament { val id: Long val name: String val surface: Surface val year: Long class Adapter( internal val surfaceAdapter: ColumnAdapter ) data class Impl( override val id: Long, override val name: String, override val surface: Surface, override val year: Long ) : Tournament } build/Tournament.sq: interface Tournament { val id: Long val name: String val surface: Surface val year: Long class Adapter( internal val surfaceAdapter: ColumnAdapter ) data class Impl( override val id: Long, override val name: String, override val surface: Surface, override val year: Long ) : Tournament }

Slide 54

Slide 54 text

com.squareup.sqldelight:runtime:1.0.0 interface ColumnAdapter { fun decode(databaseValue: S): T fun encode(value: T): S }

Slide 55

Slide 55 text

com.squareup.sqldelight:runtime:1.0.0 class EnumColumnAdapter> inline fun > EnumColumnAdapter() : EnumColumnAdapter { return EnumColumnAdapter(enumValues()) }

Slide 56

Slide 56 text

src/YourCode.kt: val queryWrapper = QueryWrapper( database = database, tournamentAdapter = Tournament.Adapter( surfaceAdapter = EnumColumnAdapter()A )A ) src/YourCode.kt: val queryWrapper = QueryWrapper( database = database, tournamentAdapter = Tournament.Adapter( surfaceAdapter = EnumColumnAdapter()A )A )

Slide 57

Slide 57 text

com.squareup.sqldelight:runtime:1.0.0 interface SqlDatabase { fun getConnection(): SqlDatabaseConnection fun close() }

Slide 58

Slide 58 text

db app Tennis

Slide 59

Slide 59 text

db app Tennis

Slide 60

Slide 60 text

db app db:android

Slide 61

Slide 61 text

db apply plugin: 'org.jetbrains.kotlin.platform.common' apply plugin: 'com.squareup.sqldelight'

Slide 62

Slide 62 text

db expect class DatabaseFactory { fun create(): SqlDatabase }

Slide 63

Slide 63 text

db app db:android

Slide 64

Slide 64 text

apply plugin: 'com.android.library' apply plugin: 'kotlin-platform-android' dependencies { expectedBy project(':db') implementation “com.squareup.sqldelight:android-driver:1.0.0-alpha5” } db:android

Slide 65

Slide 65 text

db:android actual class DatabaseFactory( private val context: Context ) { actual fun create(): SqlDatabase { return QueryWrapper.create(context, "tennis.db") } }

Slide 66

Slide 66 text

db app db:android

Slide 67

Slide 67 text

db fun QueryWrapper.Helper.create( databaseFactory: DatabaseFactory ): QueryWrapper { val queryWrapper = QueryWrapper( database = databaseFactory.create(), tournamentAdapter = Tournament.Adapter( surfaceAdapter = EnumColumnAdapter() ) ) }

Slide 68

Slide 68 text

db app db:android

Slide 69

Slide 69 text

val queryWrapper = QueryWrapper.create(DatabaseFactory(this)) app

Slide 70

Slide 70 text

val queryWrapper = QueryWrapper.create(DatabaseFactory(this)) queryWrapper.playerQueries.insert( id = 1, name = "Novak Djokovic", country = "Serbia" ) app

Slide 71

Slide 71 text

db app db:android

Slide 72

Slide 72 text

db app db:android iosApp db:native

Slide 73

Slide 73 text

db:native apply plugin: ‘kotlin-platform-native’ dependencies { expectedBy project(‘:db') implementation “co.touchlab.knarch:knarch:0.7-alpha4" implementation "com.squareup.sqldelight:sqldelightruntimeios" implementation "com.squareup.sqldelight:sqldelightmultiplatformdriverios" }

Slide 74

Slide 74 text

actual class DatabaseFactory { actual fun create(): SqlDatabase { val context = DefaultSystemContext() val factory = IosNativeOpenHelperFactory(context) return QueryWrapper.create( name = "tennis.db", openHelperFactory = factory ) } } db:native

Slide 75

Slide 75 text

db app db:android iosApp db:native

Slide 76

Slide 76 text

iosApp let database = DbQueryWrapperHelper().create( databaseFactory: DbDatabaseFactory() )A

Slide 77

Slide 77 text

let database = DbQueryWrapperHelper().create( databaseFactory: DbDatabaseFactory() )A database.playerQueries .insert( id: 1, name: "Novak Djokovic", country: "Serbia" ) iosApp

Slide 78

Slide 78 text

db app db:android iosApp db:native

Slide 79

Slide 79 text

db val federer = 3L queryWrapper.playerQueries.insert( id = federer, name = "Roger Federer", country = "Switzerland" ) insert: INSERT INTO player (id, name, country) VALUES (?, ?, ?);

Slide 80

Slide 80 text

db CREATE TABLE match ( tournament INTEGER NOT NULL REFERENCES tournament, player1 INTEGER NOT NULL REFERENCES player, player2 INTEGER NOT NULL REFERENCES player, winner INTEGER NOT NULL REFERENCES player, CHECK (winner == player1 OR winner == player2), CHECK (player1 <> player2), PRIMARY KEY (player1, player2, tournament) );

Slide 81

Slide 81 text

db queryWrapper.tournamentQueries.insert( id = 2, name = "ATP World Tour Masters 1000 Miami", surface = OUTDOOR_HARD, year = 2017 ) queryWrapper.matchQueries.insert( tournament = 2, player1 = rafa, player2 = federer, winner = federer )

Slide 82

Slide 82 text

db headToHead: SELECT player1.name AS player1Name, player2.name AS player2Name, count(nullif(match.winner = player1.id, 0)) AS player1Wins, count(nullif(match.winner = player2.id, 0)) AS player2Wins FROM match JOIN player AS player1 ON (player1.name = :firstPlayerName AND (player1.id = match.player1 OR player1.id = match.player2) ) JOIN player AS player2 ON (player2.name = :secondPlayerName AND (player2.id = match.player1 OR player2.id = match.player2) ) ;

Slide 83

Slide 83 text

Match.sq: headToHead: SELECT ... db build/HeadToHead.kt: interface HeadToHead { val player1Name: String val player2Name: String val player1Wins: Long val player2Wins: Long }

Slide 84

Slide 84 text

Match.sq: headToHead: SELECT ... db build/MatchQueries.kt: class MatchQueries { fun headToHead( firstPlayerName: String, secondPlayerName: String ): Query }

Slide 85

Slide 85 text

Match.sq: headToHead: SELECT ... db build/MatchQueries.kt: class MatchQueries { fun headToHead( firstPlayerName: String, secondPlayerName: String, mapper: ( player1Name: String, player2Name: String, player1Wins: Long, player2Wins: Long ) -> T ): Query

Slide 86

Slide 86 text

com.squareup.sqldelight:runtime:1.0.0 open class Query { fun addListener(listener: Listener) fun removeListener(listener: Listener) fun executeAsList(): List fun executeAsOne(): RowType fun executeAsOneOrNull(): RowType? interface Listener { fun queryResultsChanged() } } com.squareup.sqldelight:runtime:1.0.0 open class Query { fun addListener(listener: Listener) fun removeListener(listener: Listener) fun executeAsList(): List fun executeAsOne(): RowType fun executeAsOneOrNull(): RowType? interface Listener { fun queryResultsChanged() } }

Slide 87

Slide 87 text

db backend protos api presenters viewmodel + viewevent app interface InstrumentManager { @CheckResult fun withToken( token: String ): Observable }

Slide 88

Slide 88 text

iosApp db:native db app db:android

Slide 89

Slide 89 text

iosApp db:native db app db:android

Slide 90

Slide 90 text

com.squareup.sqldelight:rxjava2-extensions:1.0.0 fun Query.asObservable( scheduler: Scheduler = Schedulers.io() ) : Observable>

Slide 91

Slide 91 text

com.squareup.sqldelight:rxjava2-extensions:1.0.0 fun Query.asObservable( scheduler: Scheduler = Schedulers.io() ) : Observable> fun Observable>.mapToOne(): Observable fun Observable>.mapToOneOrDefault( defaultValue: T ) : Observable fun Observable>.mapToOptional() : Observable> fun Observable>.mapToList(): Observable> fun Observable>.mapToOneNonNull(): Observable

Slide 92

Slide 92 text

iosApp db:native db app db:android

Slide 93

Slide 93 text

implementation “com.squareup.sqldelight:rxjava2-extensions:1.0.0-alpha5” app

Slide 94

Slide 94 text

app queryWrapper.matchQueries.headToHead("Roger Federer", "Rafael Nadal") .asObservable(Schedulers.io()) .mapToList()

Slide 95

Slide 95 text

iosApp db:native db app db:android

Slide 96

Slide 96 text

iosApp struct HeadToHead { var player1Name: String var player2Name: String var player1Wins: NSNumber var player2Wins: NSNumber }

Slide 97

Slide 97 text

iosApp func createHeadToHead( player1Name: String, player2Name: String, player1Wins: NSNumber, player2Wins: NSNumber ) -> HeadToHead { return HeadToHead( player1Name: player1Name, player2Name: player2Name, player1Wins: player1Wins, player2Wins: player2Wins ) }

Slide 98

Slide 98 text

iosApp let headToHead = (database.matchQueries .headToHead( firstPlayerName: "Rafael Nadal", secondPlayerName: "Roger Federer", mapper: createHeadToHead ) .executeAsOne() as! HeadToHead)

Slide 99

Slide 99 text

iosApp let headToHead = (database.matchQueries .headToHead( firstPlayerName: "Rafael Nadal", secondPlayerName: "Roger Federer", mapper: createHeadToHead ) .executeAsOne() as! HeadToHead)

Slide 100

Slide 100 text

iosApp db:native db app db:android

Slide 101

Slide 101 text

db class QueryTests { @Test fun headToHeadTest() { val headToHead = queryWrapper.matchQueries.headToHead( firstPlayerName = "Rafael Nadal", secondPlayerName = "Roger Federer" ).executeAsOne() assertEquals(headToHead.player1Name, "Rafael Nadal") assertEquals(headToHead.player1Wins, 23) assertEquals(headToHead.player2Name, "Roger Federer") assertEquals(headToHead.player2Wins, 15) } }

Slide 102

Slide 102 text

SqlDelight 1.0 (alpha)

Slide 103

Slide 103 text

Migrations

Slide 104

Slide 104 text

Migrations CREATE TABLE player ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, country TEXT NOT NULL );

Slide 105

Slide 105 text

Migrations CREATE TABLE player ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, country TEXT NOT NULL, ranking INTEGER NOT NULL );

Slide 106

Slide 106 text

Migrations CREATE TABLE player ( id INTEGER NOT NULL PRIMARY KEY, name TEXT NOT NULL, country TEXT NOT NULL, ranking INTEGER NOT NULL ); Execution failed for task ':db:verifySqlDelightMigration'. > Error migrating from 1.db, fresh database looks different from migration database: /tables[player]/columns[player.ranking] - ADDED

Slide 107

Slide 107 text

Migrations 1.sqm: ALTER TABLE player ADD COLUMN ranking INTEGER NOT NULL DEFAULT 0;

Slide 108

Slide 108 text

Shorthands Tournament.sq: insertTournament: INSERT INTO tournament VALUES ?; build/TournamentQueries.sq: class TournamentQueries() { fun insertTournament(tournament: Tournament): Long }

Slide 109

Slide 109 text

Shorthands Tournament.sq: selectForSurface: SELECT * FROM tournament WHERE surface IN ?; build/TournamentQueries.sq: class TournamentQueries() { fun selectForSurface( surface: Collection ): Query }

Slide 110

Slide 110 text

Testing dependencies { implementation “com.squareup.sqldelight:android-driver:1.0.0-alpha5” testImplementation “com.squareup.sqldelight:sqlite-driver:1.0.0-alpha5” }

Slide 111

Slide 111 text

Testing dependencies { implementation “com.squareup.sqldelight:android-driver:1.0.0-alpha5” testImplementation “com.squareup.sqldelight:sqlite-driver:1.0.0-alpha5” } val database = SqliteJdbcOpenHelper() QueryWrapper.Helper.onCreate(database.getConnection())