`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

Project: platform/frameworks/support
Branch: androidx-master-dev

commit b90079595f33f58fece04026a97faa0d243acdb1
Author: Yuichi Araki <yaraki@google.com>
Date: Wed Sep 18 16:55:49 2019

Change the way to detect mismatch between POJO and query

This fixes cursor mismatch warnings with expandProjection.

Bug: 140759491
Test: QueryMethodProcessorTest
Change-Id: I7659002e5e0d1ef60fc1af2a625c0c36da0664d8

M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt
M room/compiler/src/test/kotlin/androidx/room/processor/QueryMethodProcessorTest.kt
M room/compiler/src/test/kotlin/androidx/room/testing/TestProcessor.kt

https://android-review.googlesource.com/1123258

https://goto.google.com/android-sha1/b90079595f33f58fece04026a97faa0d243acdb1

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

The following changes were cherrypicked through Coastguard (

https://android-build.googleplex.com/coastguard/)
Release Track: (

https://android-build.googleplex.com/coastguard/dashboard/6093116828680192/#/cherrypickHistory/all)
Created: 2019-10-14 17:23:42.610596+00:00
Changes: aosp/1123258

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

Project: platform/frameworks/support
Branch: androidx-master-dev

commit bdde5a1a970ddc9007b28de4aa29d60ffa588f08
Author: Yigit Boyar <yboyar@google.com>
Date: Thu Apr 16 16:47:05 2020

Re-factor how errors are dismissed when query is re-written

This CL changes how we handle errors/warnings if query is
re-written.
There was a bug in expandProjection where we would report warnings
for things that Room already fixes automatically (

b/140759491

).
The solution to that problem (I7659002e5e0d1ef60fc1af2a625c0c36da0664d8)
solved it by deferring validating of columns until after re-write
decision is made. Unfortunately, this required changing PojoRowAdapter
to have a dummy mapping until it is validating, make it hard to use
as it does have a non-null mapping which is not useful.

This CL partially reverts that change and instead rely on the log
deferring logic we have in Context. This way, we don't need to break
the stability of PojoRowAdapter while still having the ability to
drop warnings that room fixes. This will also play nicer when we
have different query re-writing options that can use more information
about the query results.

Bug: 153387066
Bug: 140759491
Test: existing tests pass
Change-Id: I2ec967c763d33d7a3ff02c1a13c6953b460d1e5f

M room/compiler/src/main/kotlin/androidx/room/log/RLog.kt
M room/compiler/src/main/kotlin/androidx/room/processor/QueryMethodProcessor.kt
M room/compiler/src/main/kotlin/androidx/room/solver/TypeAdapterStore.kt
M room/compiler/src/main/kotlin/androidx/room/solver/query/result/PojoRowAdapter.kt

https://android-review.googlesource.com/1288456

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

Does this change mean that after manually closing the database, we can rely on the fact that db will no longer be reopened by Room for any query?
Asking in context of implementing backup/restore feature in the app.

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.