`Room.inTransaction()` opens the database [325432967]

Fixed

Bug

Status Update

No update yet.

Description

st...@patreon.com

created issue #1

Feb 15, 2024 11:21PM

Component useds: androidx.room:room-ktx, androidx.room:room-testing Version used: 2.6.1 Devices/Android versions reproduced on: Robolectric

The definition of Room.inTransaction() is:

open fun inTransaction(): Boolean {
    return openHelper.writableDatabase.inTransaction()
}

This opens the db even if it wasn't previously open and doesn't close it. This is almost always going to be fine in production, but in tests it can cause a db leak, which is especially painful since it's called by room-internal code.

Since it's open, in my project I simply overrode it to be

override fun inTransaction(): Boolean {
    if (!isOpenInternal) return false
    return super.inTransaction()
}

which resolved the issue and is similar to a check that most, but not all, room-internal code does anyway.

Would be great to have this catch in the framework though, to prevent this issue for others

Comments

da...@google.com <da...@google.com> #2Feb 16, 2024 01:05PM

For Kotlin 2.0 and KSP 2.0 the Cannot change attributes of configuration ':composeApp:debugFrameworkIosX64' after it has been locked for mutation really seems like a KSP issue. You should file a bug in their repository with a sample app if possible.

If you downgrade to Kotlin 1.9 then things 'should' work, there are example apps out there with such configuration, like the following one: https://github.com/realityexpander/KMP_Room/tree/main

el...@google.com <el...@google.com> Feb 4, 2025 12:12AM

Reassigned to da...@google.com.

da...@google.com <da...@google.com> Feb 5, 2025 08:00PM

Accepted by da...@google.com.

ap...@google.com <ap...@google.com> #3Feb 5, 2025 08:48PM

Yes this does seem like a KSP issue however it only starts happening when room is added to the project. As the template project compiles just fine.

Will try to use the example provided by you to check if it fixes the issue.

da...@google.com <da...@google.com> Feb 5, 2025 08:56PM

Marked as fixed.

pr...@google.com <pr...@google.com> #4Feb 12, 2025 06:40PM

Note that this issue happens when applying the Compose, KSP and Room Plugin together in Kotlin 2.0.x, the workaround for now is to not use the Room Gradle Plugin and instead specify the schema location vis KSP arguments:

// In the build.gradle
ksp {
    arg("room.schemaLocation", "${projectDir}/schemas")
}

jo...@gmail.com <jo...@gmail.com> #5Feb 12, 2025 08:10PM

Hi, I encountered a similar problem and was able to resolve it by updating the dependencies

room = "2.7.0-alpha08"
ksp = "2.0.20-1.0.25"

compose-plugin = "1.6.11"
kotlin = "2.0.20"

da...@google.com <da...@google.com> #6Feb 18, 2025 08:57PM

Thats right, an explicit close() call will make it so that Room won't re-open itself, and if it is attempted to do so to some other call it will cause a crash.