Limit the default amount of migration FK violations reported to 100 (#113)

Author: eygraber

README.md

@@ -99,6 +99,12 @@ any violations, an `AndroidxSqliteDriver.ForeignKeyConstraintCheckException` is
 specific constraints that have been violated. This helps catch any inconsistencies in your data that might
 have been introduced during the migration.
 
+> [!IMPORTANT]  
+> By default, the first 100 violations will be parsed out of the result set of 
+> `PRAGMA foreign_key_check` and stored in the `AndroidxSqliteDriver.ForeignKeyConstraintCheckException`.
+> If your use can result in a large number of violations you can adjust the max amount that will be processed via 
+> `AndroidxSqliteConfiguration.maxMigrationForeignKeyConstraintViolationsToReport`.
+
 ## Connection Pooling
 
 By default, one connection will be used for both reading and writing, and only one thread can acquire that connection 

library/src/androidUnitTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteCommonTests.android.kt

@@ -20,6 +20,9 @@ actual class CommonCallbackTest : AndroidxSqliteCallbackTest()
 @RunWith(RobolectricTestRunner::class)
 actual class CommonConcurrencyTest : AndroidxSqliteConcurrencyTest()
 
+@RunWith(RobolectricTestRunner::class)
+actual class CommonCreationTest : AndroidxSqliteCreationTest()
+
 @RunWith(RobolectricTestRunner::class)
 class AndroidGetDatabasePathConcurrencyTest : AndroidxSqliteConcurrencyTest() {
   override fun createDatabaseType(fullDbName: String): AndroidxSqliteDatabaseType.FileProvider {
@@ -45,7 +48,7 @@ actual class CommonDriverOpenFlagsTest : AndroidxSqliteDriverOpenFlagsTest()
 actual class CommonEphemeralTest : AndroidxSqliteEphemeralTest()
 
 @RunWith(RobolectricTestRunner::class)
-actual class CommonMigrationKeyTest : AndroidxSqliteMigrationKeyTest()
+actual class CommonMigrationTest : AndroidxSqliteMigrationTest()
 
 @RunWith(RobolectricTestRunner::class)
 actual class CommonQueryTest : AndroidxSqliteQueryTest()

library/src/commonMain/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteConfiguration.kt

@@ -81,6 +81,13 @@ public class AndroidxSqliteConfiguration(
     SqliteJournalMode.WAL -> 4
     else -> 0
   },
+  /**
+   * The maximum number of foreign key constraint violations to report when
+   * [isForeignKeyConstraintsCheckedAfterCreateOrUpdate] is `true` and `PRAGMA foreign_key_check` fails.
+   *
+   * Defaults to 100.
+   */
+  public val maxMigrationForeignKeyConstraintViolationsToReport: Int = 100,
 ) {
   public fun copy(
     isForeignKeyConstraintsEnabled: Boolean = this.isForeignKeyConstraintsEnabled,
@@ -94,5 +101,6 @@ public class AndroidxSqliteConfiguration(
       journalMode = journalMode,
       sync = sync,
       readerConnectionsCount = readerConnectionsCount,
+      maxMigrationForeignKeyConstraintViolationsToReport = maxMigrationForeignKeyConstraintViolationsToReport,
     )
 }

library/src/commonMain/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteDriver.kt

@@ -92,7 +92,26 @@ public class AndroidxSqliteDriver(
     migrationCallbacks = migrationCallbacks,
   )
 
-  public class ForeignKeyConstraintCheckException(message: String) : Exception(message)
+  public data class ForeignKeyConstraintViolation(
+    val referencingTable: String,
+    val referencingRowId: Int,
+    val referencedTable: String,
+    val referencingConstraintIndex: Int,
+  ) {
+    override fun toString(): String =
+      """
+      |ForeignKeyConstraintViolation:
+      |  Constraint index: $referencingConstraintIndex
+      |  Referencing table: $referencingTable
+      |  Referencing rowId: $referencingRowId
+      |  Referenced table: $referencedTable
+      """.trimMargin()
+  }
+
+  public class ForeignKeyConstraintCheckException(
+    public val violations: List<ForeignKeyConstraintViolation>,
+    message: String,
+  ) : Exception(message)
 
   @Suppress("NonBooleanPropertyPrefixedWithIs")
   private val isFirstInteraction = atomic(true)
@@ -471,29 +490,29 @@ private inline fun SQLiteConnection.withDeferredForeignKeyChecks(
 
     if(configuration.isForeignKeyConstraintsCheckedAfterCreateOrUpdate) {
       prepare("PRAGMA foreign_key_check;").use { check ->
-        val violations = mutableListOf<String>()
-        while(check.step()) {
-          val referencingTable = check.getText(0)
-          val referencingRowId = check.getInt(1)
-          val referencedTable = check.getText(2)
-          val referencingConstraintIndex = check.getInt(3)
-
+        val violations = mutableListOf<AndroidxSqliteDriver.ForeignKeyConstraintViolation>()
+        var count = 0
+        while(check.step() && count++ < configuration.maxMigrationForeignKeyConstraintViolationsToReport) {
           violations.add(
-            """
-            |Constraint index: $referencingConstraintIndex 
-            |Referencing table: $referencingTable
-            |Referencing rowId: $referencingRowId
-            |Referenced table: $referencedTable
-            """.trimMargin(),
+            AndroidxSqliteDriver.ForeignKeyConstraintViolation(
+              referencingTable = check.getText(0),
+              referencingRowId = check.getInt(1),
+              referencedTable = check.getText(2),
+              referencingConstraintIndex = check.getInt(3),
+            ),
           )
         }
 
         if(violations.isNotEmpty()) {
+          val unprintedViolationsCount = violations.size - 5
+          val unprintedDisclaimer = if(unprintedViolationsCount > 0) " ($unprintedViolationsCount not shown)" else ""
+
           throw AndroidxSqliteDriver.ForeignKeyConstraintCheckException(
-            """
-            |The following foreign key constraints are violated:
+            violations = violations,
+            message = """
+            |The following foreign key constraints are violated$unprintedDisclaimer:
             |
-            |${violations.joinToString(separator = "\n\n")}
+            |${violations.take(5).joinToString(separator = "\n\n")}
             """.trimMargin(),
           )
         }

library/src/commonTest/kotlin/com/eygraber/sqldelight/androidx/driver/AndroidxSqliteCommonTests.kt

@@ -7,10 +7,11 @@ import kotlinx.coroutines.CoroutineDispatcher
 
 expect class CommonCallbackTest() : AndroidxSqliteCallbackTest
 expect class CommonConcurrencyTest() : AndroidxSqliteConcurrencyTest
+expect class CommonCreationTest() : AndroidxSqliteCreationTest
 expect class CommonDriverTest() : AndroidxSqliteDriverTest
 expect class CommonDriverOpenFlagsTest() : AndroidxSqliteDriverOpenFlagsTest
 expect class CommonEphemeralTest() : AndroidxSqliteEphemeralTest
-expect class CommonMigrationKeyTest() : AndroidxSqliteMigrationKeyTest
+expect class CommonMigrationTest() : AndroidxSqliteMigrationTest
 expect class CommonQueryTest() : AndroidxSqliteQueryTest
 expect class CommonTransacterTest() : AndroidxSqliteTransacterTest