Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix generated Proguard rules not using valid fully qualified name #626

Merged
merged 7 commits into from
Jun 28, 2024
Merged

Fix generated Proguard rules not using valid fully qualified name #626

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
fafb8e3
Use `ClassName.reflectionName()` instead of `ClassName.toString()` fo…
mhelder Jun 27, 2024
a25f365
Fix existing tests asserting incorrect expected value for generated r…
mhelder Jun 27, 2024
64a2e95
Add test for source files in packages using reserved Kotlin keywords
mhelder Jun 27, 2024
6b1323e
Fix spotless violations
mhelder Jun 28, 2024
a2fed29
Fix one more test
mhelder Jun 28, 2024
5cf5929
Re-trigger CI
mhelder Jun 28, 2024
c1331ff
Use reflectionName for generated adapter rule too
mhelder Jun 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion ...e-gen/src/main/kotlin/dev/zacsweers/moshix/proguardgen/MoshiProguardGenSymbolProcessor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,8 @@ public class MoshiProguardGenSymbolProcessor(private val environment: SymbolProc
val adapterCanonicalName =
ClassName(targetType.packageName, adapterName).canonicalName
for (target in nestedSealedClassNames.sorted()) {
writer.appendLine("-if class $target")
val targetReflectionName = target.reflectionName()
writer.appendLine("-if class $targetReflectionName")
writer.appendLine("-keep class $adapterCanonicalName {")
mhelder marked this conversation as resolved.
Show resolved Hide resolved
// Keep the constructor for Moshi's reflective lookup
val constructorArgs = adapterConstructorParams.joinToString(",")
Expand Down
84 changes: 77 additions & 7 deletions ...n/src/test/kotlin/dev/zacsweers/moshix/proguardgen/MoshiProguardGenSymbolProcessorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,21 +82,22 @@ class MoshiProguardGenSymbolProcessorTest(private val useKSP2: Boolean) {
"moshi-test.BaseType" ->
assertThat(generatedFile.readText().trimIndent())
.isEqualTo(
// $ in multiline strings: https://youtrack.jetbrains.com/issue/KT-2425
"""
# Conditionally keep this adapter for every possible nested subtype that uses it.
-if class test.BaseType.TypeA
-if class test.BaseType${'$'}TypeA
-keep class test.BaseTypeJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
-if class test.BaseType.TypeB
-if class test.BaseType${'$'}TypeB
-keep class test.BaseTypeJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
-if class test.BaseType.TypeC
-if class test.BaseType${'$'}TypeC
-keep class test.BaseTypeJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
-if class test.BaseType.TypeC.TypeCImpl
-if class test.BaseType${'$'}TypeC${'$'}TypeCImpl
-keep class test.BaseTypeJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
Expand All @@ -118,7 +119,6 @@ class MoshiProguardGenSymbolProcessorTest(private val useKSP2: Boolean) {
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import dev.zacsweers.moshix.sealed.annotations.TypeLabel
import dev.zacsweers.moshix.sealed.annotations.NestedSealed
import dev.zacsweers.moshix.sealed.annotations.DefaultObject

@JsonClass(generateAdapter = true, generator = "sealed:type")
Expand Down Expand Up @@ -149,13 +149,14 @@ class MoshiProguardGenSymbolProcessorTest(private val useKSP2: Boolean) {
"moshi-test.Message" ->
assertThat(generatedFile.readText().trimIndent())
.isEqualTo(
// $ in multiline strings: https://youtrack.jetbrains.com/issue/KT-2425
"""
# Conditionally keep this adapter for every possible nested subtype that uses it.
-if class test.Message.Success
-if class test.Message${'$'}Success
-keep class test.MessageJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
-if class test.Message.Unknown
-if class test.Message${'$'}Unknown
-keep class test.MessageJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
Expand All @@ -167,6 +168,75 @@ class MoshiProguardGenSymbolProcessorTest(private val useKSP2: Boolean) {
}
}

@Test
fun `ensure sealed classes in packages with reserved keywords yield valid rules`() {
// https://kotlinlang.org/docs/keyword-reference.html
val hardKeywords = listOf("as", "break", "class")
val softKeywords = listOf("by", "catch", "constructor")
val modifierKeywords = listOf("abstract", "sealed", "tailrec")
val keyWordsToTest = hardKeywords + softKeywords + modifierKeywords

keyWordsToTest.forEach { keyword ->
val source =
kotlin(
"BaseType.kt",
"""
package test.${'`'}$keyword${'`'}
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import dev.zacsweers.moshix.sealed.annotations.TypeLabel
import dev.zacsweers.moshix.sealed.annotations.DefaultObject

@JsonClass(generateAdapter = true, generator = "sealed:type")
sealed class Message {

@TypeLabel("success")
@JsonClass(generateAdapter = true)
data class Success(
@Json(name = "value")
val value: String
) : Message()

@DefaultObject
object Unknown : Message()
}
""".trimIndent(),
)

val compilation = prepareCompilation(source)
val result = compilation.compile()
assertThat(result.exitCode).isEqualTo(ExitCode.OK)
val generatedSourcesDir = compilation.kspSourcesDir
val proguardFiles =
generatedSourcesDir.walkTopDown().filter { it.extension == "pro" }.toList()
check(proguardFiles.isNotEmpty())
for (generatedFile in proguardFiles) {
generatedFile.assertInCorrectPath()
when (generatedFile.nameWithoutExtension) {
"moshi-test.$keyword.Message" ->
assertThat(generatedFile.readText().trimIndent())
.isEqualTo(
// $ in multiline strings: https://youtrack.jetbrains.com/issue/KT-2425
"""
# Conditionally keep this adapter for every possible nested subtype that uses it.
-if class test.$keyword.Message${'$'}Success
-keep class test.$keyword.MessageJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
-if class test.$keyword.Message${'$'}Unknown
-keep class test.$keyword.MessageJsonAdapter {
public <init>(com.squareup.moshi.Moshi);
}
"""
.trimIndent()
)

else -> error("Unrecognized proguard file: $generatedFile")
}
}
}
}

@Test
fun disableProguardGeneration() {
val source =
Expand Down
Loading