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

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

Marked as fixed.

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

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.

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

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")
}

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

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"

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