Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove the AfterVersion type without the driver #3091

Merged
merged 1 commit into from
Apr 16, 2022
Merged

Remove the AfterVersion type without the driver #3091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 2 additions & 9 deletions ...rs/android-driver/src/main/java/app/cash/sqldelight/driver/android/AndroidSqliteDriver.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@ import androidx.sqlite.db.framework.FrameworkSQLiteOpenHelperFactory
import app.cash.sqldelight.Query
import app.cash.sqldelight.Transacter
import app.cash.sqldelight.db.AfterVersion
import app.cash.sqldelight.db.AfterVersionWithDriver
import app.cash.sqldelight.db.SqlCursor
import app.cash.sqldelight.db.SqlDriver
import app.cash.sqldelight.db.SqlPreparedStatement
import app.cash.sqldelight.db.migrateWithCallbacks
import app.cash.sqldelight.db.toAfterVersionWithDriver

private val DEFAULT_CACHE_SIZE = 20

Expand Down Expand Up @@ -183,18 +181,13 @@ class AndroidSqliteDriver private constructor(

open class Callback(
private val schema: SqlDriver.Schema,
vararg callbacks: AfterVersionWithDriver,
vararg callbacks: AfterVersion,
) : SupportSQLiteOpenHelper.Callback(schema.version) {
private val callbacks = callbacks

constructor(
schema: SqlDriver.Schema
) : this(schema, *emptyArray<AfterVersionWithDriver>())

constructor(
schema: SqlDriver.Schema,
vararg callbacks: AfterVersion
) : this(schema, *callbacks.map { it.toAfterVersionWithDriver() }.toTypedArray())
) : this(schema, *emptyArray<AfterVersion>())

override fun onCreate(db: SupportSQLiteDatabase) {
schema.create(AndroidSqliteDriver(openHelper = null, database = db, cacheSize = 1))
Expand Down
34 changes: 2 additions & 32 deletions runtime/src/commonMain/kotlin/app/cash/sqldelight/db/SqlDriver.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,46 +108,16 @@ interface SqlDriver : Closeable {
}
}

/**
* Represents a block of code [block] that should be executed during a migration after the migration
* has finished migrating to [afterVersion].
*/
class AfterVersion(
internal val afterVersion: Int,
internal val block: () -> Unit
)

/**
* Represents a block of code [block] that should be executed during a migration after the migration
* has finished migrating to [afterVersion]. Unlike [AfterVersion], this version's lambda accepts a
* [SqlDriver] as a parameter to make migrations easier.
*/
class AfterVersionWithDriver(
class AfterVersion(
internal val afterVersion: Int,
internal val block: (SqlDriver) -> Unit
)

/**
* Wrap an [AfterVersion] as an [AfterVersionWithDriver].
*/
fun AfterVersion.toAfterVersionWithDriver() =
AfterVersionWithDriver(afterVersion) { block() }

/**
* Run [SqlDriver.Schema.migrate] normally but execute [callbacks] during the migration whenever
* it finished upgrading to a version specified by [AfterVersion.afterVersion]. This method
* takes [AfterVersion] callbacks, which receive no parameters when invoked.
*/
fun SqlDriver.Schema.migrateWithCallbacks(
driver: SqlDriver,
oldVersion: Int,
newVersion: Int,
vararg callbacks: AfterVersion
) {
val wrappedCallbacks = callbacks.map { it.toAfterVersionWithDriver() }.toTypedArray()
migrateWithCallbacks(driver, oldVersion, newVersion, *wrappedCallbacks)
}

/**
* Run [SqlDriver.Schema.migrate] normally but execute [callbacks] during the migration whenever
* it finished upgrading to a version specified by [AfterVersion.afterVersion]. This method
Expand All @@ -157,7 +127,7 @@ fun SqlDriver.Schema.migrateWithCallbacks(
driver: SqlDriver,
oldVersion: Int,
newVersion: Int,
vararg callbacks: AfterVersionWithDriver
vararg callbacks: AfterVersion
) {
var lastVersion = oldVersion

Expand Down
86 changes: 10 additions & 76 deletions ...ion-migration-callbacks/src/test/java/app/cash/sqldelight/integration/IntegrationTests.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package app.cash.sqldelight.integration

import app.cash.sqldelight.db.AfterVersion
import app.cash.sqldelight.db.AfterVersionWithDriver
import app.cash.sqldelight.db.migrateWithCallbacks
import app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteDriver
import app.cash.sqldelight.driver.jdbc.sqlite.JdbcSqliteDriver.Companion.IN_MEMORY
Expand All @@ -15,29 +14,9 @@ class IntegrationTests {
driver = database,
oldVersion = 0,
newVersion = QueryWrapper.Schema.version,
AfterVersion(1) { database.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { database.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { database.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
)

val queryWrapper = QueryWrapper(database)
val values = queryWrapper.testQueries.selectAll().executeAsList()
assertThat(values).containsExactly(
Test2(new_value = "hello", new_value2 = "sup"),
Test2(new_value = "hello2", new_value2 = "sup2"),
Test2(new_value = "hello3", new_value2 = "sup3"),
)
}

@Test fun migrationCallbacksWithParameter() {
val database = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
QueryWrapper.Schema.migrateWithCallbacks(
driver = database,
oldVersion = 0,
newVersion = QueryWrapper.Schema.version,
AfterVersionWithDriver(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersionWithDriver(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersionWithDriver(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
AfterVersion(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
)

val queryWrapper = QueryWrapper(database)
Expand All @@ -60,33 +39,9 @@ class IntegrationTests {
driver = database,
oldVersion = 2,
newVersion = QueryWrapper.Schema.version,
AfterVersion(1) { database.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { database.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { database.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
)

val queryWrapper = QueryWrapper(database)
val values = queryWrapper.testQueries.selectAll().executeAsList()
assertThat(values).containsExactly(
Test2(new_value = "hello2", new_value2 = "sup2"),
Test2(new_value = "hello3", new_value2 = "sup3"),
)
}

@Test fun migrationCallbackLessThanOldVersionNotCalledWithParameter() {
val database = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
QueryWrapper.Schema.migrate(
driver = database,
oldVersion = 0,
newVersion = 2
)
QueryWrapper.Schema.migrateWithCallbacks(
driver = database,
oldVersion = 2,
newVersion = QueryWrapper.Schema.version,
AfterVersionWithDriver(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersionWithDriver(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersionWithDriver(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
AfterVersion(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
)

val queryWrapper = QueryWrapper(database)
Expand All @@ -103,31 +58,10 @@ class IntegrationTests {
driver = database,
oldVersion = 0,
newVersion = QueryWrapper.Schema.version,
AfterVersion(1) { database.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { database.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { database.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
AfterVersion(4) { database.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello4', 'sup4')", 0) },
)

val queryWrapper = QueryWrapper(database)
val values = queryWrapper.testQueries.selectAll().executeAsList()
assertThat(values).containsExactly(
Test2(new_value = "hello", new_value2 = "sup"),
Test2(new_value = "hello2", new_value2 = "sup2"),
Test2(new_value = "hello3", new_value2 = "sup3"),
)
}

@Test fun migrationCallbackGreaterThanNewVersionNotCalledWithParameter() {
val database = JdbcSqliteDriver(JdbcSqliteDriver.IN_MEMORY)
QueryWrapper.Schema.migrateWithCallbacks(
driver = database,
oldVersion = 0,
newVersion = QueryWrapper.Schema.version,
AfterVersionWithDriver(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersionWithDriver(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersionWithDriver(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
AfterVersionWithDriver(4) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello4', 'sup4')", 0) },
AfterVersion(1) { it.execute(null, "INSERT INTO test (value) VALUES('hello')", 0) },
AfterVersion(2) { it.execute(null, "INSERT INTO test2 (value, value2) VALUES('hello2', 'sup2')", 0) },
AfterVersion(3) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello3', 'sup3')", 0) },
AfterVersion(4) { it.execute(null, "INSERT INTO test2 (new_value, new_value2) VALUES('hello4', 'sup4')", 0) },
)

val queryWrapper = QueryWrapper(database)
Expand Down