-
Notifications
You must be signed in to change notification settings - Fork 35
/
Database.kt
416 lines (367 loc) · 15.5 KB
/
Database.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
/*
* Copyright 2020 Google LLC.
*
* This code may only be used under the BSD style license found at
* http://polymer.github.io/LICENSE.txt
*
* Code distributed by Google as part of this project is also subject to an additional IP rights
* grant found at
* http://polymer.github.io/PATENTS.txt
*/
package arcs.core.storage.driver
import arcs.core.crdt.CrdtEntity
import arcs.core.crdt.CrdtSet
import arcs.core.crdt.CrdtSingleton
import arcs.core.crdt.extension.toCrdtEntityData
import arcs.core.data.Capabilities
import arcs.core.data.Schema
import arcs.core.storage.CapabilitiesResolver
import arcs.core.storage.Driver
import arcs.core.storage.DriverFactory
import arcs.core.storage.DriverProvider
import arcs.core.storage.Reference
import arcs.core.storage.StorageKey
import arcs.core.storage.StorageKeyParser
import arcs.core.storage.database.Database
import arcs.core.storage.database.DatabaseClient
import arcs.core.storage.database.DatabaseData
import arcs.core.storage.database.DatabaseManager
import arcs.core.storage.referencemode.toCrdtSetData
import arcs.core.storage.referencemode.toCrdtSingletonData
import arcs.core.storage.referencemode.toReferenceSet
import arcs.core.storage.referencemode.toReferenceSingleton
import arcs.core.util.Random
import arcs.core.util.TaggedLog
import arcs.core.util.guardedBy
import kotlin.reflect.KClass
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
/** Protocol to be used with the database driver for persistent databases. */
const val DATABASE_DRIVER_PROTOCOL = "db"
/** Protocol to be used with the database driver for in-memory databases. */
const val MEMORY_DATABASE_DRIVER_PROTOCOL = "memdb"
/**
* Default database name for [DatabaseDriver] usage, and referencing using [DatabaseStorageKey]s.
*/
const val DATABASE_NAME_DEFAULT = "arcs"
/** [StorageKey] implementation for a piece of data managed by the [DatabaseDriver]. */
sealed class DatabaseStorageKey(
open val unique: String,
open val entitySchemaHash: String,
open val dbName: String,
protocol: String
) : StorageKey(protocol) {
override fun toKeyString(): String = "$entitySchemaHash@$dbName/$unique"
override fun childKeyWithComponent(component: String): StorageKey = when (this) {
is Persistent -> Persistent("$unique/$component", entitySchemaHash, dbName)
is Memory -> Memory("$unique/$component", entitySchemaHash, dbName)
}
protected fun checkValidity() {
require(DATABASE_NAME_PATTERN.matches(dbName)) {
"$dbName is an invalid database name, must match the pattern: $DATABASE_NAME_PATTERN"
}
require(ENTITY_SCHEMA_HASH_PATTERN.matches(entitySchemaHash)) {
"$entitySchemaHash is an invalid entity schema hash, must match the pattern: " +
ENTITY_SCHEMA_HASH_PATTERN
}
}
/** [DatabaseStorageKey] for values to be stored on-disk. */
data class Persistent(
override val unique: String,
override val entitySchemaHash: String,
override val dbName: String = DATABASE_NAME_DEFAULT
) : DatabaseStorageKey(unique, entitySchemaHash, dbName, DATABASE_DRIVER_PROTOCOL) {
init { checkValidity() }
override fun toString() = super.toString()
}
/** [DatabaseStorageKey] for values to be stored in-memory. */
data class Memory(
override val unique: String,
override val entitySchemaHash: String,
override val dbName: String = DATABASE_NAME_DEFAULT
) : DatabaseStorageKey(unique, entitySchemaHash, dbName, MEMORY_DATABASE_DRIVER_PROTOCOL) {
init { checkValidity() }
override fun toString() = super.toString()
}
companion object {
private val DATABASE_NAME_PATTERN = "[a-zA-Z][a-zA-Z0-1_-]*".toRegex()
private val ENTITY_SCHEMA_HASH_PATTERN = "[a-fA-F0-9]+".toRegex()
private val DB_STORAGE_KEY_PATTERN =
"^($ENTITY_SCHEMA_HASH_PATTERN)@($DATABASE_NAME_PATTERN)/(.+)\$".toRegex()
init {
// When DatabaseStorageKey is imported, this will register its parser with the storage
// key parsers.
registerParser()
}
/** Registers the [DatabaseStorageKey] for parsing with the [StorageKeyParser]. */
/* internal */
fun registerParser() {
StorageKeyParser.addParser(DATABASE_DRIVER_PROTOCOL, ::persistentFromString)
StorageKeyParser.addParser(MEMORY_DATABASE_DRIVER_PROTOCOL, ::memoryFromString)
}
/* internal */
fun persistentFromString(rawKeyString: String): Persistent = fromString(rawKeyString)
/* internal */
fun memoryFromString(rawKeyString: String): Memory = fromString(rawKeyString)
private inline fun <reified T : DatabaseStorageKey> fromString(rawKeyString: String): T {
val match = requireNotNull(DB_STORAGE_KEY_PATTERN.matchEntire(rawKeyString)) {
"Not a valid DatabaseStorageKey: $rawKeyString"
}
val entitySchemaHash = match.groupValues[1]
val dbName = match.groupValues[2]
val unique = match.groupValues[3]
return when (T::class) {
Persistent::class -> Persistent(unique, entitySchemaHash, dbName)
Memory::class -> Memory(unique, entitySchemaHash, dbName)
else -> throw IllegalArgumentException(
"Unsupported DatabaseStorageKey type: ${T::class}"
)
} as T
}
}
}
/** [DriverProvider] which provides a [DatabaseDriver]. */
object DatabaseDriverProvider : DriverProvider {
/**
* Whether or not the [DatabaseDriverProvider] has been configured with a [DatabaseManager] and
* a schema lookup function.
*/
val isConfigured: Boolean
get() = _manager != null
private var _manager: DatabaseManager? = null
/** The configured [DatabaseManager]. */
val manager: DatabaseManager
get() = requireNotNull(_manager) { ERROR_MESSAGE_CONFIGURE_NOT_CALLED }
/**
* Function which will be used to determine, at runtime, which [Schema] to associate with its
* hash value embedded in a [DatabaseStorageKey].
*/
private var schemaLookup: (String) -> Schema? = {
throw IllegalStateException(ERROR_MESSAGE_CONFIGURE_NOT_CALLED)
}
override fun willSupport(storageKey: StorageKey): Boolean =
storageKey is DatabaseStorageKey && schemaLookup(storageKey.entitySchemaHash) != null
override suspend fun <Data : Any> getDriver(
storageKey: StorageKey,
dataClass: KClass<Data>
): Driver<Data> {
val databaseKey = requireNotNull(storageKey as? DatabaseStorageKey) {
"Unsupported StorageKey: $storageKey for DatabaseDriverProvider"
}
requireNotNull(schemaLookup(databaseKey.entitySchemaHash)) {
"Unsupported DatabaseStorageKey: No Schema found with hash: " +
databaseKey.entitySchemaHash
}
require(
dataClass == CrdtEntity.Data::class ||
dataClass == CrdtSet.DataImpl::class ||
dataClass == CrdtSingleton.DataImpl::class
) {
"Unsupported data type: $dataClass, must be one of: CrdtEntity.Data, " +
"CrdtSet.DataImpl, or CrdtSingleton.DataImpl"
}
return DatabaseDriver(
databaseKey,
dataClass,
schemaLookup,
manager.getDatabase(databaseKey.dbName, databaseKey is DatabaseStorageKey.Persistent)
).register()
}
/**
* Configures the [DatabaseDriverProvider] with the given [schemaLookup] and registers it
* with the [DriverFactory].
*/
fun configure(databaseManager: DatabaseManager, schemaLookup: (String) -> Schema?) = apply {
this._manager = databaseManager
this.schemaLookup = schemaLookup
DatabaseStorageKey.registerParser()
DriverFactory.register(this)
CapabilitiesResolver.registerKeyCreator(
DATABASE_DRIVER_PROTOCOL,
Capabilities.Persistent
) { storageKeyOptions ->
DatabaseStorageKey.Persistent(
storageKeyOptions.location,
storageKeyOptions.entitySchema.hash
)
}
}
private const val ERROR_MESSAGE_CONFIGURE_NOT_CALLED =
"DatabaseDriverProvider.configure(databaseFactory, schemaLookup) has not been called"
}
/** [Driver] implementation capable of managing data stored in a SQL database. */
@Suppress("RemoveExplicitTypeArguments")
class DatabaseDriver<Data : Any>(
override val storageKey: DatabaseStorageKey,
private val dataClass: KClass<Data>,
private val schemaLookup: (String) -> Schema?,
/* internal */
val database: Database
) : Driver<Data>, DatabaseClient {
/* internal */ var receiver: (suspend (data: Data, version: Int) -> Unit)? = null
/* internal */ var clientId: Int = -1
private val localDataMutex = Mutex()
private var localData: Data? by guardedBy<Data?>(localDataMutex, null)
private var localVersion: Int? by guardedBy<Int?>(localDataMutex, null)
private val schema: Schema
get() = checkNotNull(schemaLookup(storageKey.entitySchemaHash)) {
"Schema not found for hash: ${storageKey.entitySchemaHash}"
}
private val log = TaggedLog { this.toString() }
override var token: String? = null
private set
/* internal */
suspend fun register(): DatabaseDriver<Data> = apply {
clientId = database.addClient(this)
log.debug { "Registered with clientId = $clientId" }
}
@Suppress("UNCHECKED_CAST")
override suspend fun registerReceiver(
token: String?,
receiver: suspend (data: Data, version: Int) -> Unit
) {
this.receiver = receiver
val (pendingReceiverData, pendingReceiverVersion) = localDataMutex.withLock {
var dataAndVersion = localData?.takeIf { this.token != token } to localVersion
// If we didn't have any data, try and fetch it from the database.
if (dataAndVersion.first == null || dataAndVersion.second == null) {
log.debug { "registerReceiver($token) - no local data, fetching from database" }
database.get(
storageKey,
when (dataClass) {
CrdtEntity.Data::class -> DatabaseData.Entity::class
CrdtSingleton.DataImpl::class -> DatabaseData.Singleton::class
CrdtSet.DataImpl::class -> DatabaseData.Collection::class
else -> throw IllegalStateException("Illegal dataClass: $dataClass")
},
schema
)?.also {
dataAndVersion = when (it) {
is DatabaseData.Entity ->
it.rawEntity.toCrdtEntityData(it.versionMap) { refable ->
// Use the storage reference if it is one.
if (refable is Reference) refable
else CrdtEntity.Reference.buildReference(refable)
}
is DatabaseData.Singleton ->
it.reference.toCrdtSingletonData(it.versionMap)
is DatabaseData.Collection ->
it.values.toCrdtSetData(it.versionMap)
} as Data to it.databaseVersion
}
}
dataAndVersion
}
if (pendingReceiverData == null || pendingReceiverVersion == null) return
log.debug {
"""
registerReceiver($token) - calling receiver(
$pendingReceiverData,
$pendingReceiverVersion
)
""".trimIndent()
}
receiver(pendingReceiverData, pendingReceiverVersion)
}
@Suppress("UNCHECKED_CAST")
override suspend fun send(data: Data, version: Int): Boolean {
log.debug {
"""
send(
$data,
$version
)
""".trimIndent()
}
// Prep the data for storage.
val databaseData = when (data) {
is CrdtEntity.Data -> DatabaseData.Entity(
data.toRawEntity(),
schema,
version,
data.versionMap
)
is CrdtSingleton.Data<*> -> {
val referenceData = requireNotNull(data as? CrdtSingleton.Data<Reference>) {
"Data must be CrdtSingleton.Data<Reference>"
}
DatabaseData.Singleton(
referenceData.toReferenceSingleton(),
schema,
version,
referenceData.versionMap
)
}
is CrdtSet.Data<*> -> {
val referenceData = requireNotNull(data as? CrdtSet.Data<Reference>) {
"Data must be CrdtSet.Data<Reference>"
}
DatabaseData.Collection(
referenceData.toReferenceSet(),
schema,
version,
referenceData.versionMap
)
}
else -> throw UnsupportedOperationException(
"Unsupported type for DatabaseDriver: ${data::class}"
)
}
// Store the prepped data.
return (database.insertOrUpdate(storageKey, databaseData, clientId) == version).also {
// If the update was successful, update our local data/version.
if (it) localDataMutex.withLock {
localData = data
localVersion = version
}
}
}
@Suppress("UNCHECKED_CAST")
override suspend fun onDatabaseUpdate(
data: DatabaseData,
version: Int,
originatingClientId: Int?
) {
// Convert the raw DatabaseData into the appropriate CRDT data model
val actualData = when (data) {
is DatabaseData.Singleton -> data.reference.toCrdtSingletonData(data.versionMap)
is DatabaseData.Collection -> data.values.toCrdtSetData(data.versionMap)
is DatabaseData.Entity -> data.rawEntity.toCrdtEntityData(data.versionMap) {
if (it is Reference) it
else CrdtEntity.Reference.buildReference(it)
}
} as Data
// Stash it locally.
localDataMutex.withLock {
localData = actualData
localVersion = version
}
if (originatingClientId == clientId) return
log.debug {
"""
onDatabaseUpdate(
$data,
version: $version,
originatingClientId: $originatingClientId
)
""".trimIndent()
}
// Let the receiver know about it.
bumpToken()
receiver?.invoke(actualData, version)
}
override suspend fun onDatabaseDelete(originatingClientId: Int?) {
localDataMutex.withLock {
localData = null
localVersion = null
}
if (originatingClientId == clientId) return
log.debug { "onDatabaseDelete(originatingClientId: $originatingClientId)" }
bumpToken()
}
override fun toString(): String = "DatabaseDriver($storageKey, $clientId)"
/* internal */ suspend fun getLocalData(): Data? = localDataMutex.withLock { localData }
private fun bumpToken() {
token = Random.nextInt().toString()
}
}