Handle invalid JVM names in JavaPoet side of XPoet [384600605]

Fixed

Bug

Status Update

No update yet.

Description

da...@google.com

created issue #1

Dec 17, 2024 03:52AM

With the changes for XPoet to build both JavaPoet and KotlinPoet specs it means that when Room is processing function that lead to invalid JVM method names, it will cause the JavaPoet side to throw an exception even if the XProcessingConfig.excludeMethodsWithInvalidJvmSourceNames is turned ON for Kotlin code generation.

An example case where Room will encounter these is with internal functions that it needs to override.

Caused by: java.lang.IllegalArgumentException: not a valid name: deleteAllBooksSuspend$room-testapp-kotlin_withKspGenKotlinDebugAndroidTest
	at com.squareup.javapoet.Util.checkArgument(Util.java:53)
	at com.squareup.javapoet.MethodSpec$Builder.setName(MethodSpec.java:315)
	at com.squareup.javapoet.MethodSpec$Builder.<init>(MethodSpec.java:310)
	at com.squareup.javapoet.MethodSpec$Builder.<init>(MethodSpec.java:294)
	at com.squareup.javapoet.MethodSpec.methodBuilder(MethodSpec.java:188)
	at androidx.room.compiler.processing.MethodSpecHelper.overriding(JavaPoetExt.kt:175)
	at androidx.room.compiler.processing.MethodSpecHelper.overridingWithFinalParams(JavaPoetExt.kt:148)
	at androidx.room.compiler.codegen.XFunSpec$Companion.overridingBuilder(XFunSpec.kt:166)
	at androidx.room.compiler.codegen.XFunSpec$Companion.overridingBuilder$default(XFunSpec.kt:158)
	at androidx.room.writer.DaoWriter.overrideWithoutAnnotations(DaoWriter.kt:676)
	at androidx.room.writer.DaoWriter.createPreparedQueryMethod(DaoWriter.kt:435)
	at androidx.room.writer.DaoWriter.createTypeSpecBuilder(DaoWriter.kt:154)
	at androidx.room.writer.TypeWriter.write(TypeWriter.kt:70)
	at androidx.room.DatabaseProcessingStep.process(DatabaseProcessingStep.kt:103)

Comments

ap...@google.com <ap...@google.com> #2Jan 2, 2025 11:52PM

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> Jan 23, 2025 06:17PM

Marked as fixed.

na...@google.com <na...@google.com> #3Jan 29, 2025 06:11PM

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

sp...@gmail.com <sp...@gmail.com> #4Jan 29, 2025 07:45PM

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

ap...@google.com <ap...@google.com> #5Jan 29, 2025 11:39PM

Project: platform/frameworks/support
Branch: androidx-main
Author: Daniel Santiago Rivera <danysantiago@google.com>
Link: https://android-review.googlesource.com/3469309

Sanitize DAO Java method names mangled by value classes.

Expand for full commit details

Sanitize DAO Java method names mangled by value classes. 
 
Bug: 384600605 
Bug: 388299754 
Test: DaoKotlinCodeGenTest.kt 
Change-Id: I805ae6828bf45de82f4bcec55af4528ccd16d00a

Files:

M room/room-compiler-processing/src/main/java/androidx/room/compiler/processing/util/NamingUtils.kt
M room/room-compiler/src/test/kotlin/androidx/room/writer/DaoKotlinCodeGenTest.kt
M room/room-compiler/src/test/test-data/kotlinCodeGen/dataClassRowAdapter_valueClassConverter.kt

Hash: 93666e398595454b46279c8ea2b8e746363971eb
Date: Wed Jan 29 15:54:02 2025

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

The following release(s) address this bug.It is possible this bug has only been partially addressed:

androidx.core:core-viewtree:1.0.0-rc01
androidx.room:room-compiler:2.7.0-beta01
androidx.room:room-compiler-processing:2.7.0-beta01

Issue 384600605