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

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

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

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

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

Opening diff shortly

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

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

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