Significantly improve error messaging when encountering error types

CHANGELOG.md

@@ -3,6 +3,8 @@
 **Unreleased**
 --------------
 
+- Significantly improve error messaging when encountering error types. All these cases _should_ now also show the location of the error type in source and ease debugging.
+
 0.2.3
 -----
 

compiler/src/main/java/com/squareup/anvil/compiler/ClassScannerKsp.kt

@@ -16,6 +16,7 @@ import com.squareup.anvil.compiler.ClassScannerKsp.GeneratedProperty.ScopeProper
 import com.squareup.anvil.compiler.api.AnvilCompilationException
 import com.squareup.anvil.compiler.codegen.ksp.KSCallable
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
+import com.squareup.anvil.compiler.codegen.ksp.contextualToClassName
 import com.squareup.anvil.compiler.codegen.ksp.fqName
 import com.squareup.anvil.compiler.codegen.ksp.getAllCallables
 import com.squareup.anvil.compiler.codegen.ksp.isAbstract
@@ -24,7 +25,6 @@ import com.squareup.anvil.compiler.codegen.ksp.resolvableAnnotations
 import com.squareup.anvil.compiler.codegen.ksp.resolveKSClassDeclaration
 import com.squareup.anvil.compiler.codegen.ksp.scope
 import com.squareup.anvil.compiler.codegen.ksp.type
-import com.squareup.kotlinpoet.ksp.toClassName
 import org.jetbrains.kotlin.name.FqName
 
 internal class ClassScannerKsp {
@@ -105,8 +105,8 @@ internal class ClassScannerKsp {
         // Check that the annotation really is present. It should always be the case, but it's
         // a safety net in case the generated properties are out of sync.
         clazz.resolvableAnnotations.any {
-          it.annotationType.resolve()
-            .toClassName().fqName == annotation && (scope == null || it.scope() == scope)
+          it.annotationType
+            .contextualToClassName().fqName == annotation && (scope == null || it.scope() == scope)
         }
       }
       .onEach { clazz ->

compiler/src/main/java/com/squareup/anvil/compiler/KspContributionMerger.kt

@@ -35,9 +35,13 @@ import com.squareup.anvil.compiler.codegen.generatedAnvilSubcomponentClassId
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessor
 import com.squareup.anvil.compiler.codegen.ksp.KSCallable
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
-import com.squareup.anvil.compiler.codegen.ksp.argumentAt
+import com.squareup.anvil.compiler.codegen.ksp.argumentOfTypeAt
 import com.squareup.anvil.compiler.codegen.ksp.atLeastOneAnnotation
 import com.squareup.anvil.compiler.codegen.ksp.classId
+import com.squareup.anvil.compiler.codegen.ksp.classNameArgumentAt
+import com.squareup.anvil.compiler.codegen.ksp.classNameArrayArgumentAt
+import com.squareup.anvil.compiler.codegen.ksp.contextualToClassName
+import com.squareup.anvil.compiler.codegen.ksp.contextualToTypeName
 import com.squareup.anvil.compiler.codegen.ksp.declaringClass
 import com.squareup.anvil.compiler.codegen.ksp.exclude
 import com.squareup.anvil.compiler.codegen.ksp.find
@@ -54,6 +58,7 @@ import com.squareup.anvil.compiler.codegen.ksp.mergeAnnotations
 import com.squareup.anvil.compiler.codegen.ksp.modules
 import com.squareup.anvil.compiler.codegen.ksp.parentScope
 import com.squareup.anvil.compiler.codegen.ksp.replaces
+import com.squareup.anvil.compiler.codegen.ksp.reportableReturnTypeNode
 import com.squareup.anvil.compiler.codegen.ksp.resolvableAnnotations
 import com.squareup.anvil.compiler.codegen.ksp.resolveKSClassDeclaration
 import com.squareup.anvil.compiler.codegen.ksp.returnTypeOrNull
@@ -83,7 +88,6 @@ import com.squareup.kotlinpoet.ksp.addOriginatingKSFile
 import com.squareup.kotlinpoet.ksp.toAnnotationSpec
 import com.squareup.kotlinpoet.ksp.toClassName
 import com.squareup.kotlinpoet.ksp.toKModifier
-import com.squareup.kotlinpoet.ksp.toTypeName
 import com.squareup.kotlinpoet.ksp.writeTo
 import dagger.Binds
 import dagger.Component
@@ -285,7 +289,8 @@ internal class KspContributionMerger(
       )
     }
 
-    val scope = (daggerMergeAnnotations + interfaceMergerAnnotations).first().scope()
+    val scopeHolder = (daggerMergeAnnotations + interfaceMergerAnnotations).first()
+    val scope = scopeHolder.scope()
 
     val creator = mergeComponentAnnotations.ifNotEmpty {
       findCreator(
@@ -299,7 +304,7 @@ internal class KspContributionMerger(
 
     generateMergedClass(
       resolver = resolver,
-      scope = scope.toClassName(),
+      scope = scope.contextualToClassName(scopeHolder),
       mergeAnnotatedClass = mergeAnnotatedClass,
       originatingDeclarations = originatingDeclarations,
       contributedSubcomponentData = contributedSubcomponentData,
@@ -581,17 +586,13 @@ internal class KspContributionMerger(
 
         val boundType = bindingFunction.returnTypeOrNull()!!.resolveKSClassDeclaration()!!
         val isMultibinding =
-          internalBindingMarker.argumentAt("isMultibinding")?.value == true
+          internalBindingMarker.argumentOfTypeAt<Boolean>("isMultibinding") == true
         val qualifierKey =
-          (internalBindingMarker.argumentAt("qualifierKey")?.value as? String?).orEmpty()
-        val rank = (
-          internalBindingMarker.argumentAt("rank")
-            ?.value as? Int?
-          )
-          ?: ContributesBinding.RANK_NORMAL
+          internalBindingMarker.argumentOfTypeAt<String>("qualifierKey").orEmpty()
+        val rank = internalBindingMarker.argumentOfTypeAt<Int>("rank") ?: ContributesBinding.RANK_NORMAL
         val scope = contributedAnnotation.scope()
         ContributedBinding(
-          scope = scope.toClassName(),
+          scope = scope.contextualToClassName(contributedAnnotation),
           isMultibinding = isMultibinding,
           bindingModule = moduleClass.toClassName(),
           originClass = originClass.toClassName(),
@@ -668,9 +669,7 @@ internal class KspContributionMerger(
         fun copyArrayValue(name: String) {
           val varargArguments = annotations
             .mapNotNull { annotation ->
-              @Suppress("UNCHECKED_CAST")
-              (annotation.argumentAt(name)?.value as? List<KSType>?)
-                ?.map(KSType::toClassName)
+              annotation.classNameArrayArgumentAt(name)
             }
             .flatten()
             .ifEmpty { return }
@@ -1216,8 +1215,7 @@ internal class KspContributionMerger(
       !mergeAnnotations.any { annotation ->
         // If any of the parameters are unresolved, we need to defer this class
         arrayOf("modules", "dependencies", "exclude", "includes").forEach { parameter ->
-          @Suppress("UNCHECKED_CAST")
-          (annotation.argumentAt(parameter)?.value as? List<KSType>?)?.let { values ->
+          annotation.argumentOfTypeAt<List<KSType>>(parameter)?.let { values ->
             if (values.any(KSType::isError)) return@any true
           }
         }
@@ -1484,18 +1482,16 @@ private fun checkSameScope(
 private fun KSClassDeclaration.originClass(): KSClassDeclaration {
   val originClassValue = find(internalBindingMarkerFqName.asString())
     .singleOrNull()
-    ?.argumentAt("originClass")
-    ?.value
+    ?.argumentOfTypeAt<KSType>("originClass")
 
-  val originClass = (originClassValue as? KSType?)?.resolveKSClassDeclaration()
+  val originClass = originClassValue?.resolveKSClassDeclaration()
   return originClass ?: this
 }
 
 private fun KSAnnotation.originClass(): KSClassDeclaration? {
-  val originClassValue = argumentAt("originClass")
-    ?.value
+  val originClassValue = argumentOfTypeAt<KSType>("originClass")
 
-  val originClass = (originClassValue as? KSType?)?.resolveKSClassDeclaration()
+  val originClass = originClassValue?.resolveKSClassDeclaration()
   return originClass
 }
 
@@ -1587,7 +1583,7 @@ private fun Creator.extend(
                 .returns(newClassName)
                 .build(),
             )
-          } else if (returnType?.toClassName() == originalComponentClassName) {
+          } else if (returnType?.contextualToClassName(function.reportableReturnTypeNode) == originalComponentClassName) {
             // Handles functions that return the Component class, such as
             // factory create() or builder build()
             addFunction(
@@ -1885,7 +1881,7 @@ private fun generateParentComponent(
         """.trimIndent() +
           parentParentComponent.getAllFunctions().mapNotNull { function ->
             function.qualifiedName?.let {
-              "${it.asString()}(): ${function.returnTypeOrNull()?.toTypeName()}"
+              "${it.asString()}(): ${function.returnTypeOrNull()?.contextualToTypeName(function.reportableReturnTypeNode)}"
             }
           }.joinToString("\n", prefix = "\n"),
         node = origin,
@@ -1942,12 +1938,15 @@ private data class ContributedSubcomponentData(
 
   companion object {
     fun fromAnnotation(annotation: KSAnnotation): ContributedSubcomponentData {
-      val originClass = (annotation.argumentAt("originClass")?.value as KSType).toClassName()
-      val contributor = (annotation.argumentAt("contributor")?.value as KSType?)?.toClassName()
-        .takeUnless { it == NOTHING }
+      val originClass = annotation.classNameArgumentAt("originClass") ?: throw KspAnvilException(
+        message = "Could not find originClass value",
+        node = annotation,
+      )
+      val contributor = annotation.classNameArgumentAt("contributor")
+        ?.takeUnless { it == NOTHING }
       val componentFactory =
-        (annotation.argumentAt("componentFactory")?.value as KSType?)?.toClassName()
-          .takeUnless { it == NOTHING }
+        annotation.classNameArgumentAt("componentFactory")
+          ?.takeUnless { it == NOTHING }
       return ContributedSubcomponentData(
         originClass = originClass,
         contributor = contributor,

compiler/src/main/java/com/squareup/anvil/compiler/codegen/ContributesBindingCodeGen.kt

@@ -31,6 +31,7 @@ import com.squareup.anvil.compiler.codegen.ksp.rank
 import com.squareup.anvil.compiler.codegen.ksp.replaces
 import com.squareup.anvil.compiler.codegen.ksp.resolveBoundType
 import com.squareup.anvil.compiler.codegen.ksp.scope
+import com.squareup.anvil.compiler.codegen.ksp.scopeClassName
 import com.squareup.anvil.compiler.contributesBindingFqName
 import com.squareup.anvil.compiler.internal.reference.asClassName
 import com.squareup.anvil.compiler.internal.reference.classAndInnerClassReferences
@@ -97,7 +98,7 @@ internal object ContributesBindingCodeGen : AnvilApplicabilityChecker {
             .toList()
             .also { it.checkNoDuplicateScopeAndBoundType(clazz) }
             .map {
-              val scope = it.scope().toClassName()
+              val scope = it.scopeClassName()
               val boundTypeDeclaration = it.resolveBoundType(resolver, clazz)
               boundTypeDeclaration.checkNotGeneric(clazz)
               val boundType = boundTypeDeclaration.toClassName()

compiler/src/main/java/com/squareup/anvil/compiler/codegen/ContributesMultibindingCodeGen.kt

@@ -32,6 +32,7 @@ import com.squareup.anvil.compiler.codegen.ksp.replaces
 import com.squareup.anvil.compiler.codegen.ksp.resolvableAnnotations
 import com.squareup.anvil.compiler.codegen.ksp.resolveBoundType
 import com.squareup.anvil.compiler.codegen.ksp.scope
+import com.squareup.anvil.compiler.codegen.ksp.scopeClassName
 import com.squareup.anvil.compiler.contributesMultibindingFqName
 import com.squareup.anvil.compiler.internal.reference.asClassName
 import com.squareup.anvil.compiler.internal.reference.classAndInnerClassReferences
@@ -89,7 +90,7 @@ internal object ContributesMultibindingCodeGen : AnvilApplicabilityChecker {
             .toList()
             .also { it.checkNoDuplicateScopeAndBoundType(clazz) }
             .map {
-              val scope = it.scope().toClassName()
+              val scope = it.scopeClassName()
 
               val boundTypeDeclaration = it.resolveBoundType(resolver, clazz)
               boundTypeDeclaration.checkNotGeneric(clazz)

compiler/src/main/java/com/squareup/anvil/compiler/codegen/ContributesToCodeGen.kt

@@ -28,6 +28,7 @@ import com.squareup.anvil.compiler.codegen.ksp.getKSAnnotationsByType
 import com.squareup.anvil.compiler.codegen.ksp.isAnnotationPresent
 import com.squareup.anvil.compiler.codegen.ksp.isInterface
 import com.squareup.anvil.compiler.codegen.ksp.scope
+import com.squareup.anvil.compiler.codegen.ksp.scopeClassName
 import com.squareup.anvil.compiler.contributesToFqName
 import com.squareup.anvil.compiler.daggerModuleFqName
 import com.squareup.anvil.compiler.internal.createAnvilSpec
@@ -140,7 +141,7 @@ internal object ContributesToCodeGen : AnvilApplicabilityChecker {
           val scopes = clazz.getKSAnnotationsByType(ContributesTo::class)
             .toList()
             .also { it.checkNoDuplicateScope(annotatedType = clazz, isContributeAnnotation = true) }
-            .map { it.scope().toClassName() }
+            .map { it.scopeClassName() }
             .distinct()
             // Give it a stable sort.
             .sortedBy { it.canonicalName }

compiler/src/main/java/com/squareup/anvil/compiler/codegen/KspContributesSubcomponentHandlerSymbolProcessor.kt

@@ -21,6 +21,7 @@ import com.squareup.anvil.compiler.PARENT_COMPONENT
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessor
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
 import com.squareup.anvil.compiler.codegen.ksp.classId
+import com.squareup.anvil.compiler.codegen.ksp.contextualToClassName
 import com.squareup.anvil.compiler.codegen.ksp.declaringClass
 import com.squareup.anvil.compiler.codegen.ksp.exclude
 import com.squareup.anvil.compiler.codegen.ksp.find
@@ -136,7 +137,10 @@ internal class KspContributesSubcomponentHandlerSymbolProcessor(
             .addAnnotation(
               AnnotationSpec
                 .builder(MergeSubcomponent::class)
-                .addMember("scope = %T::class", contribution.scope.toClassName())
+                .addMember(
+                  "scope = %T::class",
+                  contribution.scope.contextualToClassName(contribution.annotation),
+                )
                 .apply {
                   fun addClassArrayMember(
                     name: String,

compiler/src/main/java/com/squareup/anvil/compiler/codegen/dagger/AssistedFactoryCodeGen.kt

@@ -34,6 +34,7 @@ import com.squareup.anvil.compiler.codegen.dagger.AssistedFactoryCodeGen.KspGene
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessor
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessorProvider
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
+import com.squareup.anvil.compiler.codegen.ksp.contextualToTypeName
 import com.squareup.anvil.compiler.codegen.ksp.isAnnotationPresent
 import com.squareup.anvil.compiler.codegen.ksp.isInterface
 import com.squareup.anvil.compiler.codegen.ksp.resolveKSClassDeclaration
@@ -63,7 +64,6 @@ import com.squareup.kotlinpoet.asClassName
 import com.squareup.kotlinpoet.jvm.jvmStatic
 import com.squareup.kotlinpoet.ksp.TypeParameterResolver
 import com.squareup.kotlinpoet.ksp.toClassName
-import com.squareup.kotlinpoet.ksp.toTypeName
 import com.squareup.kotlinpoet.ksp.toTypeParameterResolver
 import com.squareup.kotlinpoet.ksp.toTypeVariableName
 import com.squareup.kotlinpoet.ksp.writeTo
@@ -142,7 +142,9 @@ internal object AssistedFactoryCodeGen : AnvilApplicabilityChecker {
       // Compute for each parameter its key.
       val functionParameterKeys = function.parameterKeys
       val assistedParameterKeys = assistedParameters.map {
-        it.toAssistedParameterKey(it.type.resolve().toTypeName(typeParameterResolver))
+        it.toAssistedParameterKey(
+          it.type.resolve().contextualToTypeName(it.type, typeParameterResolver),
+        )
       }
 
       // The factory function may not have two or more parameters with the same key.
@@ -283,11 +285,11 @@ internal object AssistedFactoryCodeGen : AnvilApplicabilityChecker {
             node = originalDeclaration,
             parameterKeys = originalDeclaration.parameters.mapIndexed { index, param ->
               param.toAssistedParameterKey(
-                parameterTypes[index]!!.toTypeName(typeParameterResolver),
+                parameterTypes[index]!!.contextualToTypeName(param, typeParameterResolver),
               )
             },
             parameterPairs = originalDeclaration.parameters.mapIndexed { index, param ->
-              param to parameterTypes[index]!!.toTypeName(typeParameterResolver)
+              param to parameterTypes[index]!!.contextualToTypeName(param, typeParameterResolver)
             },
           )
         }

compiler/src/main/java/com/squareup/anvil/compiler/codegen/dagger/BindsMethodValidator.kt

@@ -16,9 +16,11 @@ import com.squareup.anvil.compiler.codegen.CheckOnlyCodeGenerator
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessor
 import com.squareup.anvil.compiler.codegen.ksp.AnvilSymbolProcessorProvider
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
+import com.squareup.anvil.compiler.codegen.ksp.contextualToTypeName
 import com.squareup.anvil.compiler.codegen.ksp.getAnnotatedFunctions
 import com.squareup.anvil.compiler.codegen.ksp.getAnnotatedSymbols
 import com.squareup.anvil.compiler.codegen.ksp.isExtensionDeclaration
+import com.squareup.anvil.compiler.codegen.ksp.reportableReturnTypeNode
 import com.squareup.anvil.compiler.codegen.ksp.resolveKSClassDeclaration
 import com.squareup.anvil.compiler.codegen.ksp.returnTypeOrNull
 import com.squareup.anvil.compiler.codegen.ksp.superTypesExcludingAny
@@ -31,7 +33,6 @@ import com.squareup.anvil.compiler.internal.reference.TypeReference
 import com.squareup.anvil.compiler.internal.reference.allSuperTypeClassReferences
 import com.squareup.anvil.compiler.internal.reference.asTypeName
 import com.squareup.anvil.compiler.internal.reference.classAndInnerClassReferences
-import com.squareup.kotlinpoet.ksp.toTypeName
 import dagger.Binds
 import dagger.Module
 import org.jetbrains.kotlin.descriptors.ModuleDescriptor
@@ -136,14 +137,16 @@ internal object BindsMethodValidator : AnvilApplicabilityChecker {
           val superTypeNames =
             bindingParameter
               .resolveSuperTypesExcludingAny()
-              .map { it.toTypeName().toString() }
+              .map { it.contextualToTypeName(bindingParameter).toString() }
               .toList()
 
           throw KspAnvilException(
             message = Errors.bindsParameterMustBeAssignable(
               bindingParameterSuperTypeNames = superTypeNames,
-              returnTypeName = returnType.toTypeName().toString(),
-              parameterType = bindingParameter.toTypeName().toString(),
+              returnTypeName = returnType.contextualToTypeName(
+                function.reportableReturnTypeNode,
+              ).toString(),
+              parameterType = bindingParameter.contextualToTypeName().toString(),
             ),
             node = function,
           )

compiler/src/main/java/com/squareup/anvil/compiler/codegen/dagger/DaggerGenerationUtils.kt

@@ -13,6 +13,7 @@ import com.google.devtools.ksp.symbol.KSValueParameter
 import com.google.devtools.ksp.symbol.Visibility
 import com.squareup.anvil.compiler.assistedFqName
 import com.squareup.anvil.compiler.codegen.ksp.KspAnvilException
+import com.squareup.anvil.compiler.codegen.ksp.contextualToTypeName
 import com.squareup.anvil.compiler.codegen.ksp.getKSAnnotationsByType
 import com.squareup.anvil.compiler.codegen.ksp.isAnnotationPresent
 import com.squareup.anvil.compiler.codegen.ksp.isInterface
@@ -55,7 +56,6 @@ import com.squareup.kotlinpoet.asClassName
 import com.squareup.kotlinpoet.ksp.TypeParameterResolver
 import com.squareup.kotlinpoet.ksp.toAnnotationSpec
 import com.squareup.kotlinpoet.ksp.toClassName
-import com.squareup.kotlinpoet.ksp.toTypeName
 import com.squareup.kotlinpoet.ksp.toTypeParameterResolver
 import dagger.Lazy
 import dagger.assisted.Assisted
@@ -134,7 +134,7 @@ private fun KSValueParameter.toConstructorParameter(
   typeParameterResolver: TypeParameterResolver,
 ): ConstructorParameter {
   val type = type.resolve()
-  val paramTypeName = type.toTypeName(typeParameterResolver)
+  val paramTypeName = type.contextualToTypeName(this, typeParameterResolver)
   val rawType = paramTypeName.requireRawType()
 
   val isWrappedInProvider = rawType == providerClassName
@@ -463,7 +463,7 @@ private fun KSPropertyDeclaration.toMemberInjectParameter(
   val classParams = implementingClass.typeParameters.toTypeParameterResolver()
   val resolvedType = asMemberOf(implementingType)
   // TODO do we want to convert function types to lambdas?
-  val propertyTypeName = resolvedType.toTypeName(classParams)
+  val propertyTypeName = resolvedType.contextualToTypeName(this, classParams)
   val rawType = propertyTypeName.requireRawType()
 
   val isWrappedInProvider = rawType == providerClassName