Compilation errors when using Room in an android library module (AAR) [68118746]

Fixed

Bug

Status Update

No update yet.

Description

[Deleted User]

created issue #1

Oct 23, 2017 06:27AM

Component used: android.arch.persistence.room
Version used: 1.0.0-beta2
Devices/Android versions reproduced on:

Consider the following code, added in an android library module (AAR):

@Entity(tableName = "my_table")
public class MyTable {
@PrimaryKey
@NonNull
public String id;
}

@Dao
public interface MyTableDao {
@Query("SELECT * FROM my_table WHERE id = :id")
LiveData<List<MyTable>> sampleQuery(String id);
}

The actual database is instantiated in the app module. When compiling, I receive the following error:

Error:Each bind variable in the query must have a matching method parameter. Cannot find method parameters for :id.
Error:Unused parameter: arg0

Renaming ":id" to ":arg0" in the query fixes the issue. It seems that AAR packages lose the parameter names, and this causes Room to fail to bind the parameters correctly. A similar issue happens when an entity constructor has a parameter ("Error:Entities and Pojos must have a usable public constructor. You can have an empty constructor or a constructor whose parameters match the fields (by name and type).").

Comments

yb...@google.com <yb...@google.com> #2Oct 23, 2017 04:20PM

since these are in public API (:/) we need to do this in 1.2

wo...@gmail.com <wo...@gmail.com> #3Jan 20, 2018 11:22PM

since it is already marked as deprecated, we can probably do it by now.

wo...@gmail.com <wo...@gmail.com> #4Jan 31, 2018 12:22PM

Opening diff shortly

mm...@commonsware.com <mm...@commonsware.com> #5Jan 31, 2018 12:25PM

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

commit d576cbdc911cba16638a44fd8223391a90a07ef7
Author: Mike Nakhimovich <digitalbuddha@users.noreply.github.com>
Date: Tue Aug 11 09:30:34 2020

[GH] Hide deprecated internal API.

## Proposed Changes

* `RoomDatabase.java` has protected `mCallbacks` field which is leaking in the API docs, we should @Hide it.

## Testing

Test: Ran unit tests locally

## Issues Fixed

Fixes: 76109329

This is an imported pull request from

https://github.com/androidx/androidx/pull/61.

Resolves #61
Github-Pr-Head-Sha: 6440daa3a63752c7f9d5ba2a390248cd85bc634f
GitOrigin-RevId: fe92d8466a59b44b218b6ca3cbd57dcda17992f7

Change-Id: Id599cdf5b02b32bdae0166266fb7da967598fe92

A room/runtime/api/current.ignore
M room/runtime/api/current.txt
M room/runtime/api/public_plus_experimental_current.txt
M room/runtime/api/restricted_current.txt
M room/runtime/src/main/java/androidx/room/RoomDatabase.java

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

wo...@gmail.com <wo...@gmail.com> #6Jan 31, 2018 12:52PM

Sure, here we go:

https://github.com/PaulWoitaschek/RoomMultiModuleBug

yb...@google.com <yb...@google.com> #7Feb 15, 2018 05:13PM

Assigned to yb...@google.com.

this is actually a limitation of java where we cannot read the parameter names for classes coming from dependencies :/

we've fixed this for kotlin in 1.1 -alpha2. For java, we'll need to introduce a new annotation to specify names :/.

wo...@gmail.com <wo...@gmail.com> #8Feb 15, 2018 07:26PM

Nice, when will this come out?

Currently I'm heading towards sqldelight for all module entities and would like to switch back to room before our next release.

yb...@google.com <yb...@google.com> #9Feb 15, 2018 07:31PM

if you are using kotlin, it will come out in a couple of hours.
for java, might take longer

yb...@google.com <yb...@google.com> #10Feb 15, 2018 07:31PM

s/might/will

wo...@gmail.com <wo...@gmail.com> #11Feb 15, 2018 07:33PM

Nice, thanks for adressing this :)

Nope, no java in here ;)

yb...@google.com <yb...@google.com> #12Feb 15, 2018 09:37PM

1,1-alpha2 is out now, lmk if it works.

wo...@gmail.com <wo...@gmail.com> #13Feb 16, 2018 10:08AM

Thanks. It's partly fixed. I updated my sample project:

https://github.com/PaulWoitaschek/RoomMultiModuleBug

The property names on the data classes do now work. The dao interface parameter names don't work and still have to be called arg0 etc.:

https://github.com/PaulWoitaschek/RoomMultiModuleBug/blob/master/library/src/main/java/de/paul_woitaschek/roombug/library/LibraryDao.kt#L10

wo...@gmail.com <wo...@gmail.com> #14Feb 16, 2018 10:31AM

It looks like you can use the metadata annotation for interfaces too.

For example if I have this simple dao interface:

https://gist.github.com/PaulWoitaschek/e26d0e4f53460710c8caba9e995eb06d

It will producte the following Metadata annotation in byte code:
d2={"Lcom/yazio/android/misc/repo/MyDao;", "", "get", "Ljava/io/File;", "id", "", "production sources for module app"})

So all the information we need is there.

yb...@google.com <yb...@google.com> #15Feb 21, 2018 06:39PM

thanks. i'll take a look at it.

yb...@google.com <yb...@google.com> #16Feb 21, 2018 06:48PM

ugh my bad, i totally missed the part about parsing dao methods :/ .

yb...@google.com <yb...@google.com> #17Mar 1, 2018 07:43AM

Marked as fixed.

fixed in 1.1 alpha 3

wo...@gmail.com <wo...@gmail.com> #18Mar 7, 2018 08:10AM

Works, thank you!

be...@gmail.com <be...@gmail.com> #19Mar 7, 2018 08:44AM

Hi, I have used "1.1.0-alpha3" but the problem still happened. When I builded the project, there showed some error like this:

错误: Each bind variable in the query must have a matching method parameter. Cannot find method parameters for :userIds.
错误: Unused parameter: arg0
错误: Each bind variable in the query must have a matching method parameter. Cannot find method parameters for :first, :last.
错误: Unused parameters: arg0,arg1
4 个错误

Here is my project

https://github.com/beyondbright/AndroidArchitectureSample

Did I miss something? Please help me. Thanks.

wo...@gmail.com <wo...@gmail.com> #20Mar 7, 2018 09:47AM

Yes, you need to use kotlin if you want that. The information gets not contained in the way it works right now for java.

Maybe reopen the issue till it's fixed for java too, Yigit?

be...@gmail.com <be...@gmail.com> #21Mar 7, 2018 09:49AM

Everything was OK before I put the UserDao into the library module.

be...@gmail.com <be...@gmail.com> #22Mar 7, 2018 10:06AM

Sorry. I know it now. But I use java not kotlin.

I can not use room in our project because of the issue. There are some modules in our project and I have to put the Dao into the library module.

Really hope it works for java.

ka...@beehyv.com <ka...@beehyv.com> #23Dec 20, 2019 07:04AM

I am using the java module 2.2.2 and still getting the same errors. However when I build again, it goes away, but having to build the module multiple times is really annoying.

yb...@google.com <yb...@google.com> Dec 20, 2019 04:39PM

Reassigned to da...@google.com.

ra...@gmail.com <ra...@gmail.com> #24Jul 20, 2021 08:53PM

Still the same problem in 2021. Always need to compile twice. This bug is not "fixed" (for Java)!

da...@google.com <da...@google.com> #25Jul 26, 2021 03:19PM

Use javac -parameters compiler flag so parameter names are compiled into the .class files and Room is able to read them when inspecting compiled code.

See https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javac.html#:~:text=the%20-Xlint%3Anone%20option.-,-parameters,-Stores%20formal%20parameter

fa...@gmail.com <fa...@gmail.com> #26Jul 28, 2022 01:43PM

I have the same problem again using Kotlin 1.7.10.
Does anyone know if this bug just appeared again?

mo...@mindtickle.com <mo...@mindtickle.com> #27Jan 17, 2024 09:03AM

yes, I'm facing this issue on kotlin version 1.9.20 as well. Has anyone found any solution for this other than naming arguments to arg0 etc?

du...@gmail.com <du...@gmail.com> #28Mar 21, 2024 03:57AM

I am also facing this problem with Kotlin 1.9.23, please help to check. I don't want to rename to arg0, arg1,...