chore!: Change H2 Oracle longType and longAutoincType from NUMBER(19) to BIGINT and add CHECK constraint in Oracle and SQLite

joc-a · joc-a · commit 8fa5fab79d7c · 2024-11-26T13:23:45.000+01:00
diff --git a/documentation-website/Writerside/topics/Breaking-Changes.md b/documentation-website/Writerside/topics/Breaking-Changes.md
@@ -44,6 +44,8 @@
   that is also type restricted to `Comparable` (for example, `avg()`) will also require defining a new function. In this event, please
   also leave a comment on [YouTrack](https://youtrack.jetbrains.com/issue/EXPOSED-577) with a use case so the original function signature
   can be potentially reassessed.
+* In H2 Oracle, the `long()` column now maps to data type `BIGINT` instead of `NUMBER(19)`.
+  In Oracle and SQLite, using the long column in a table now also creates a CHECK constraint to ensure that no out-of-range values are inserted.
 
 ## 0.55.0
 * The `DeleteStatement` property `table` is now deprecated in favor of `targetsSet`, which holds a `ColumnSet` that may be a `Table` or `Join`.
diff --git a/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Table.kt b/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/Table.kt
@@ -1698,6 +1698,11 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
                 append("IF NOT EXISTS ")
             }
             append(TransactionManager.current().identity(this@Table))
+
+            // Add CHECK constraint to Long columns in Oracle and SQLite.
+            // It is done here because special handling is necessary based on the dialect.
+            addLongColumnCheckConstraintIfNeeded()
+
             if (columns.isNotEmpty()) {
                 columns.joinTo(this, prefix = " (") { column ->
                     column.descriptionDdl(false)
@@ -1739,7 +1744,8 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
                     }.let {
                         if (currentDialect !is SQLiteDialect && currentDialect !is OracleDialect) {
                             it.filterNot { (name, _) ->
-                                name.startsWith("${generatedSignedCheckPrefix}integer")
+                                name.startsWith("${generatedSignedCheckPrefix}integer") ||
+                                    name.startsWith("${generatedSignedCheckPrefix}long")
                             }
                         } else {
                             it
@@ -1764,6 +1770,34 @@ open class Table(name: String = "") : ColumnSet(), DdlAware {
         return createAutoIncColumnSequence() + createTable + createConstraint
     }
 
+    private fun addLongColumnCheckConstraintIfNeeded() {
+        if (currentDialect is OracleDialect || currentDialect is SQLiteDialect) {
+            columns.filter { it.columnType is LongColumnType }.forEach { column ->
+                val name = column.name
+                val checkName = "${generatedSignedCheckPrefix}long_$name"
+                if (checkConstraints.none { it.first == checkName }) {
+                    column.check(checkName) {
+                        if (currentDialect is SQLiteDialect) {
+                            fun typeOf(value: String) = object : ExpressionWithColumnType<String>() {
+                                override fun toQueryBuilder(queryBuilder: QueryBuilder) = queryBuilder { append("typeof($value)") }
+                                override val columnType: IColumnType<String> = TextColumnType()
+                            }
+
+                            val typeCondition = Expression.build { typeOf(name) eq stringLiteral("integer") }
+                            if (column.columnType.nullable) {
+                                column.isNull() or typeCondition
+                            } else {
+                                typeCondition
+                            }
+                        } else {
+                            it.between(Long.MIN_VALUE, Long.MAX_VALUE)
+                        }
+                    }
+                }
+            }
+        }
+    }
+
     private fun createAutoIncColumnSequence(): List<String> {
         return autoIncColumn?.autoIncColumnType?.sequence?.createStatement().orEmpty()
     }
diff --git a/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/OracleDialect.kt b/exposed-core/src/main/kotlin/org/jetbrains/exposed/sql/vendors/OracleDialect.kt
@@ -33,8 +33,12 @@ internal object OracleDataTypeProvider : DataTypeProvider() {
     override fun integerAutoincType(): String = integerType()
     override fun uintegerType(): String = "NUMBER(10)"
     override fun uintegerAutoincType(): String = "NUMBER(10)"
-    override fun longType(): String = "NUMBER(19)"
-    override fun longAutoincType(): String = "NUMBER(19)"
+    override fun longType(): String = if (currentDialect.h2Mode == H2Dialect.H2CompatibilityMode.Oracle) {
+        "BIGINT"
+    } else {
+        "NUMBER(19)"
+    }
+    override fun longAutoincType(): String = longType()
     override fun ulongType(): String = "NUMBER(20)"
     override fun ulongAutoincType(): String = "NUMBER(20)"
     override fun varcharType(colLength: Int): String = "VARCHAR2($colLength CHAR)"
diff --git a/exposed-java-time/src/test/kotlin/org/jetbrains/exposed/DefaultsTest.kt b/exposed-java-time/src/test/kotlin/org/jetbrains/exposed/DefaultsTest.kt
@@ -273,8 +273,12 @@ class DefaultsTest : DatabaseTestsBase() {
                 "${"t9".inProperCase()} $timeType${testTable.t9.constraintNamePart()} ${tLiteral.itOrNull()}, " +
                 "${"t10".inProperCase()} $timeType${testTable.t10.constraintNamePart()} ${tLiteral.itOrNull()}" +
                 when (testDb) {
-                    TestDB.SQLITE, TestDB.ORACLE ->
-                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})"
+                    TestDB.SQLITE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (typeof(l) = 'integer')"
+                    TestDB.ORACLE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (L BETWEEN ${Long.MIN_VALUE} AND ${Long.MAX_VALUE})"
                     else -> ""
                 } +
                 ")"
diff --git a/exposed-jodatime/src/test/kotlin/org/jetbrains/exposed/JodaTimeDefaultsTest.kt b/exposed-jodatime/src/test/kotlin/org/jetbrains/exposed/JodaTimeDefaultsTest.kt
@@ -210,8 +210,12 @@ class JodaTimeDefaultsTest : DatabaseTestsBase() {
                 "${"t5".inProperCase()} $timeType${testTable.t5.constraintNamePart()} ${tLiteral.itOrNull()}, " +
                 "${"t6".inProperCase()} $timeType${testTable.t6.constraintNamePart()} ${tLiteral.itOrNull()}" +
                 when (testDb) {
-                    TestDB.SQLITE, TestDB.ORACLE ->
-                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})"
+                    TestDB.SQLITE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (typeof(l) = 'integer')"
+                    TestDB.ORACLE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (L BETWEEN ${Long.MIN_VALUE} AND ${Long.MAX_VALUE})"
                     else -> ""
                 } +
                 ")"
diff --git a/exposed-kotlin-datetime/src/test/kotlin/org/jetbrains/exposed/sql/kotlin/datetime/DefaultsTest.kt b/exposed-kotlin-datetime/src/test/kotlin/org/jetbrains/exposed/sql/kotlin/datetime/DefaultsTest.kt
@@ -271,8 +271,12 @@ class DefaultsTest : DatabaseTestsBase() {
                 "${"t9".inProperCase()} $timeType${testTable.t9.constraintNamePart()} ${tLiteral.itOrNull()}, " +
                 "${"t10".inProperCase()} $timeType${testTable.t10.constraintNamePart()} ${tLiteral.itOrNull()}" +
                 when (testDb) {
-                    TestDB.SQLITE, TestDB.ORACLE ->
-                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})"
+                    TestDB.SQLITE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (typeof(l) = 'integer')"
+                    TestDB.ORACLE ->
+                        ", CONSTRAINT chk_t_signed_integer_id CHECK (${"id".inProperCase()} BETWEEN ${Int.MIN_VALUE} AND ${Int.MAX_VALUE})" +
+                            ", CONSTRAINT chk_t_signed_long_l CHECK (L BETWEEN ${Long.MIN_VALUE} AND ${Long.MAX_VALUE})"
                     else -> ""
                 } +
                 ")"
diff --git a/exposed-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/types/NumericColumnTypesTests.kt b/exposed-tests/src/test/kotlin/org/jetbrains/exposed/sql/tests/shared/types/NumericColumnTypesTests.kt
@@ -108,6 +108,37 @@ class NumericColumnTypesTests : DatabaseTestsBase() {
         }
     }
 
+    @Test
+    fun testLongAcceptsOnlyAllowedRange() {
+        val testTable = object : Table("test_table") {
+            val long = long("long_column")
+        }
+
+        withTables(testTable) { testDb ->
+            val columnName = testTable.long.nameInDatabaseCase()
+            val ddlEnding = when (testDb) {
+                TestDB.SQLITE -> "CHECK (typeof($columnName) = 'integer'))"
+                TestDB.ORACLE -> "CHECK ($columnName BETWEEN ${Long.MIN_VALUE} and ${Long.MAX_VALUE}))"
+                else -> "($columnName ${testTable.long.columnType} NOT NULL)"
+            }
+            assertTrue(testTable.ddl.single().endsWith(ddlEnding, ignoreCase = true))
+
+            testTable.insert { it[long] = Long.MIN_VALUE }
+            testTable.insert { it[long] = Long.MAX_VALUE }
+            assertEquals(2, testTable.select(testTable.long).count())
+
+            val tableName = testTable.nameInDatabaseCase()
+            assertFailAndRollback(message = "Out-of-range error (or CHECK constraint violation for SQLite & Oracle)") {
+                val outOfRangeValue = Long.MIN_VALUE.toBigDecimal() - 1.toBigDecimal()
+                exec("INSERT INTO $tableName ($columnName) VALUES ($outOfRangeValue)")
+            }
+            assertFailAndRollback(message = "Out-of-range error (or CHECK constraint violation for SQLite & Oracle)") {
+                val outOfRangeValue = Long.MAX_VALUE.toBigDecimal() + 1.toBigDecimal()
+                exec("INSERT INTO $tableName ($columnName) VALUES ($outOfRangeValue)")
+            }
+        }
+    }
+
     @Test
     fun testParams() {
         val testTable = object : Table("test_table") {
