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

Gracefully handle module name resolution in KSP #947

Merged
merged 5 commits into from
Apr 5, 2024
Merged

Gracefully handle module name resolution in KSP #947

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
561c001
Gracefully handle module name resolution in KSP
ZacSweers Apr 3, 2024
f95f9a6
Don't generate if mangled without available mangling
ZacSweers Apr 3, 2024
0e15a90
Merge branch 'main' into z/betterModuleName
ZacSweers Apr 3, 2024
ac35388
Update message
ZacSweers Apr 4, 2024
8611e7d
Merge branch 'main' into z/betterModuleName
ZacSweers Apr 5, 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
48 changes: 36 additions & 12 deletions .../src/main/java/com/squareup/anvil/compiler/codegen/dagger/ProvidesMethodFactoryCodeGen.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import com.google.devtools.ksp.symbol.ClassKind
import com.google.devtools.ksp.symbol.KSAnnotated
import com.google.devtools.ksp.symbol.KSClassDeclaration
import com.google.devtools.ksp.symbol.KSFunctionDeclaration
import com.google.devtools.ksp.symbol.KSNode
import com.google.devtools.ksp.symbol.KSPropertyDeclaration
import com.google.devtools.ksp.symbol.Visibility
import com.squareup.anvil.compiler.api.AnvilApplicabilityChecker
Expand Down Expand Up @@ -117,16 +118,32 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
val containingFile = clazz.containingFile!!
// TODO we need a public API for this in KSP
// https://github.com/google/ksp/issues/1621
val mangledNameSuffix = (resolver as ResolverImpl).module
.mangledNameSuffix()
var supportsMangledNames: Boolean = false
var mangledNameSuffix: String = ""
try {
mangledNameSuffix = (resolver as ResolverImpl).module
.mangledNameSuffix()
supportsMangledNames = true
} catch (_: ClassNotFoundException) {
// TODO in KSP2 this isn't supported at the moment. See above issue.
}
(functions + properties)
.forEach { declaration ->
generateFactoryClass(
mangledNameSuffix,
className,
clazz.classKind == ClassKind.OBJECT,
declaration,
).writeTo(env.codeGenerator, aggregating = false, listOf(containingFile))
if (declaration.isMangled && !supportsMangledNames) {
env.logger.error(
"Could not determine mangled name suffix. This will be fixed in a future " +
"release, but a temporary workaround is to make this declaration public.",
declaration.reportableNode as? KSNode,
)
} else {
generateFactoryClass(
declaration.isMangled,
mangledNameSuffix,
className,
clazz.classKind == ClassKind.OBJECT,
declaration,
).writeTo(env.codeGenerator, aggregating = false, listOf(containingFile))
}
}
}
return emptyList()
Expand Down Expand Up @@ -180,6 +197,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
type = typeName,
isNullable = type.isMarkedNullable,
isPublishedApi = function.isAnnotationPresent<PublishedApi>(),
reportableNode = function,
)
}

Expand All @@ -197,6 +215,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
type = typeName,
isNullable = type.isMarkedNullable,
isPublishedApi = property.isAnnotationPresent<PublishedApi>(),
reportableNode = property,
)
}
}
Expand Down Expand Up @@ -263,6 +282,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
declaration: CallableReference,
): GeneratedFileWithSources {
val spec = generateFactoryClass(
declaration.isMangled,
module.mangledNameSuffix(),
clazz.asClassName(),
clazz.isObject(),
Expand Down Expand Up @@ -325,6 +345,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
type = typeName,
isNullable = type.isNullable(),
isPublishedApi = function.isAnnotatedWith(publishedApiFqName),
reportableNode = function,
)
}

Expand All @@ -342,6 +363,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
type = typeName,
isNullable = type.isNullable(),
isPublishedApi = property.isAnnotatedWith(publishedApiFqName),
reportableNode = property,
)
}
}
Expand All @@ -357,6 +379,7 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
}

private fun generateFactoryClass(
isMangled: Boolean,
mangledNameSuffix: String,
moduleClass: ClassName,
isInObject: Boolean,
Expand All @@ -371,10 +394,6 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
// but not for names which just start with those letters, like `issues`.
val useGetPrefix = isProperty && !isWordPrefixRegex.matches(declarationName)

val isMangled = !isProperty &&
declaration.isInternal &&
!declaration.isPublishedApi

val packageName = moduleClass.packageName.safePackageString()
val className = buildString {
append(moduleClass.generateClassName().simpleNames.joinToString("_"))
Expand Down Expand Up @@ -565,7 +584,12 @@ internal object ProvidesMethodFactoryCodeGen : AnvilApplicabilityChecker {
val type: TypeName,
val isNullable: Boolean,
val isPublishedApi: Boolean,
val reportableNode: Any,
) {
val isMangled: Boolean get() = !isProperty &&
isInternal &&
!isPublishedApi

companion object // For extension
}
}