Error message improvements (#189)

Author: GoodforGod

aop/aop-annotation-processor/src/main/java/ru/tinkoff/kora/aop/annotation/processor/AopAnnotationProcessor.java

@@ -135,7 +135,7 @@ private TypeElement findTypeElement(Element element) {
                 return null;
             }
             if (element.getModifiers().contains(Modifier.FINAL)) {
-                this.errors.add(new ProcessingError("Aspects can be applied only to non final classes, but " + element.getSimpleName() + " is final", element));
+                this.errors.add(new ProcessingError("Aspects can't be applied to final classes, but " + element.getSimpleName() + " is final", element));
                 return null;
             }
             var typeElement = (TypeElement) element;
@@ -153,8 +153,12 @@ private TypeElement findTypeElement(Element element) {
             this.errors.add(new ProcessingError("Aspects can be applied only to classes or methods, got %s".formatted(element.getKind()), element));
             return null;
         }
-        if (element.getModifiers().contains(Modifier.FINAL) || element.getModifiers().contains(Modifier.PRIVATE)) {
-            this.errors.add(new ProcessingError("Aspects can be applied only to non final non private methods", element));
+        if (element.getModifiers().contains(Modifier.FINAL)) {
+            this.errors.add(new ProcessingError("Aspects can't be applied to final methods, but method " + element.getEnclosingElement().getSimpleName() + "#" + element.getSimpleName() + "() is final", element));
+            return null;
+        }
+        if (element.getModifiers().contains(Modifier.PRIVATE)) {
+            this.errors.add(new ProcessingError("Aspects can't be applied to private methods, but method " + element.getEnclosingElement().getSimpleName() + "#" + element.getSimpleName() + "() is private", element));
             return null;
         }
         return this.findTypeElement(element.getEnclosingElement());

aop/aop-symbol-processor/src/main/kotlin/ru/tinkoff/kora/aop/symbol/processor/AopSymbolProcessor.kt

@@ -112,11 +112,11 @@ class AopSymbolProcessor(
                     }
                     ClassKind.CLASS -> {
                         if (declaration.isAbstract()) {
-                            errors.add(ProcessingError("Aspects can not be applied to abstract classes, but $declaration is not abstract", declaration))
+                            errors.add(ProcessingError("Aspects can't be applied to abstract classes, but $declaration is abstract", declaration))
                             return null
                         }
                         if (!declaration.isOpen()) {
-                            errors.add(ProcessingError("Aspects can be applied only to non final classes, but $declaration is not open", declaration))
+                            errors.add(ProcessingError("Aspects can be applied only to open classes, but $declaration is not open", declaration))
                             return null
                         }
                         val constructor = findAopConstructor(declaration)
@@ -131,7 +131,7 @@ class AopSymbolProcessor(
             }
             is KSFunctionDeclaration -> {
                 return if (!declaration.isOpen()) {
-                    errors.add(ProcessingError("Aspects can be applied only to non final functions, but function ${declaration.parentDeclaration}#$declaration is not open", declaration))
+                    errors.add(ProcessingError("Aspects applied only to open functions, but function ${declaration.parentDeclaration}#$declaration is not open", declaration))
                     return null
                 } else if (declaration.parentDeclaration is KSClassDeclaration) {
                     findKsClassDeclaration(declaration.parentDeclaration as KSClassDeclaration)
@@ -148,6 +148,7 @@ class AopSymbolProcessor(
 
 @KspExperimental
 class AopSymbolProcessorProvider : SymbolProcessorProvider {
+
     override fun create(
         environment: SymbolProcessorEnvironment
     ): SymbolProcessor {

json/json-annotation-processor/src/main/java/ru/tinkoff/kora/json/annotation/processor/reader/ReaderTypeMetaParser.java

@@ -33,14 +33,14 @@ public ReaderTypeMetaParser(ProcessingEnvironment env, KnownType knownTypes) {
 
     public JsonClassReaderMeta parse(TypeElement jsonClass, TypeMirror typeMirror) throws ProcessingErrorException {
         if (jsonClass.getKind() != ElementKind.CLASS && jsonClass.getKind() != ElementKind.RECORD) {
-            throw new IllegalArgumentException("Should not be called for non class elements");
+            throw new ProcessingErrorException("JsonReader can't be called for non class elements: " + jsonClass, jsonClass);
         }
         if (jsonClass.getModifiers().contains(Modifier.ABSTRACT)) {
-            throw new IllegalArgumentException("Should not be called for abstract elements");
+            throw new ProcessingErrorException("JsonReader can't be called for abstract classes: " + jsonClass, jsonClass);
         }
         var jsonConstructor = this.findJsonConstructor(jsonClass);
         if (jsonConstructor == null) {
-            throw new ProcessingErrorException("Class: %s\nTo generate json reader class must have one public constructor or constructor annotated with any of @Json/@JsonReader"
+            throw new ProcessingErrorException("Class: %s\nIn order to generate JsonReader class must have one public constructor or constructor annotated with any of @Json/@JsonReader"
                 .formatted(jsonClass),
                 jsonClass
             );

kora-app-annotation-processor/src/main/java/ru/tinkoff/kora/kora/app/annotation/processor/GraphBuilder.java

@@ -149,7 +149,12 @@ public static ProcessingState processProcessing(ProcessingContext ctx, RoundEnvi
                     }
                     if (results.size() > 1) {
                         var deps = templates.stream().map(Objects::toString).collect(Collectors.joining("\n")).indent(2);
-                        throw new ProcessingErrorException("More than one component matches dependency claim " + dependencyClaim.type() + ":\n" + deps, declaration.source());
+                        if(dependencyClaim.tags().isEmpty()) {
+                            throw new ProcessingErrorException("More than one component matches dependency claim " + dependencyClaim.type() + ":\n" + deps, declaration.source());
+                        } else {
+                            var tagMsg = dependencyClaim.tags().stream().collect(Collectors.joining(", ", "@Tag(", ")"));
+                            throw new ProcessingErrorException("More than one component matches dependency claim " + dependencyClaim.type() + " with tag " + tagMsg + " :\n" + deps, declaration.source());
+                        }
                     }
                     throw exception;
                 }
@@ -205,9 +210,14 @@ public static ProcessingState processProcessing(ProcessingContext ctx, RoundEnvi
                 var msg = new StringBuilder();
                 var claimTypeName = TypeName.get(dependencyClaim.type()).annotated(List.of());
                 if (dependencyClaim.tags().isEmpty()) {
-                    msg.append(String.format("Required dependency was not found: %s", claimTypeName));
+                    msg.append(String.format("Required dependency type was not found and can't be auto created: %s.\n" +
+                                             "Please check class for @%s annotation or that required module with component is plugged in.",
+                        claimTypeName, CommonClassNames.component.simpleName()));
                 } else {
-                    msg.append(String.format("Required dependency was not found: %s %s", dependencyClaim.tags().stream().collect(Collectors.joining(", ", "@Tag(", ")")), claimTypeName));
+                    var tagMsg = dependencyClaim.tags().stream().collect(Collectors.joining(", ", "@Tag(", ")"));
+                    msg.append(String.format("Required dependency type was not found and can't be auto created: %s with tag %s.\n" +
+                                             "Please check class for @%s annotation or that required module with component is plugged in.",
+                        claimTypeName, tagMsg, CommonClassNames.component.simpleName()));
                 }
                 for (var hint : hints) {
                     msg.append("\n  Hint: ").append(hint.message());

kora-app-annotation-processor/src/test/java/ru/tinkoff/kora/kora/app/annotation/processor/DependencyTest.java

@@ -250,11 +250,11 @@ final class TestClass1 {}
 
         assertThat(compileResult.isFailed()).isTrue();
         assertThat(compileResult.errors()).hasSize(1);
-        assertThat(compileResult.errors().get(0).getMessage(Locale.ENGLISH))
-            .contains("Required dependency was not found: ")
-            .contains("@Tag(ru.tinkoff.kora.kora.app.annotation.processor.packageForDependencyTest.testDiscoveredFinalClassDependencyTaggedDependencyNoTagOnClass.ExampleApplication.TestClass1) ")
-            .contains("ru.tinkoff.kora.kora.app.annotation.processor.packageForDependencyTest.testDiscoveredFinalClassDependencyTaggedDependencyNoTagOnClass.ExampleApplication.TestClass1")
-        ;
+        assertThat(compileResult.errors().get(0).getMessage(Locale.ENGLISH)).startsWith(
+            """
+                Required dependency type was not found and can't be auto created: ru.tinkoff.kora.kora.app.annotation.processor.packageForDependencyTest.testDiscoveredFinalClassDependencyTaggedDependencyNoTagOnClass.ExampleApplication.TestClass1 with tag @Tag(ru.tinkoff.kora.kora.app.annotation.processor.packageForDependencyTest.testDiscoveredFinalClassDependencyTaggedDependencyNoTagOnClass.ExampleApplication.TestClass1).
+                  Please check class for @Component annotation or that required module with component is plugged in.
+                """);
     }
 
     @Test

kora-app-annotation-processor/src/test/java/ru/tinkoff/kora/kora/app/annotation/processor/KoraAppProcessorTest.java

@@ -154,7 +154,8 @@ void unresolvedDependency() {
         assertThatThrownBy(() -> testClass(AppWithUnresolvedDependency.class))
             .isInstanceOfSatisfying(CompilationErrorException.class, e -> SoftAssertions.assertSoftly(s -> {
                 s.assertThat(e.getMessage()).isEqualTo("""
-                    Required dependency was not found: ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithUnresolvedDependency.Class3
+                    Required dependency type was not found and can't be auto created: ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithUnresolvedDependency.Class3.
+                      Please check class for @Component annotation or that required module with component is plugged in.
                       Requested at: ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithUnresolvedDependency.class2(ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithUnresolvedDependency.Class3)""");
                 s.assertThat(e.diagnostics.get(0).getPosition()).isEqualTo(327);
                 s.assertThat(e.diagnostics.get(0).getLineNumber()).isEqualTo(14);
@@ -195,17 +196,17 @@ void appWithFactory() throws Throwable {
         testClass(AppWithFactories9.class).init().block();
         assertThatThrownBy(() -> testClass(AppWithFactories10.class))
             .isInstanceOf(CompilationErrorException.class)
-            .hasMessageStartingWith("Required dependency was not found: java.io.Closeable")
+            .hasMessageStartingWith("Required dependency type was not found and can't be auto created: java.io.Closeable")
             .asInstanceOf(type(CompilationErrorException.class))
             .extracting(CompilationErrorException::getDiagnostics, list(Diagnostic.class))
             .anySatisfy(d -> {
                 assertThat(d.getKind()).isEqualTo(Diagnostic.Kind.ERROR);
                 assertThat(d.getMessage(Locale.ENGLISH)).isEqualTo("""
-                    Required dependency was not found: java.io.Closeable
+                    Required dependency type was not found and can't be auto created: java.io.Closeable.
+                      Please check class for @Component annotation or that required module with component is plugged in.
                       Requested at: ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithFactories10.mock1(java.io.Closeable)
                     """.trim());
-            })
-        ;
+            });
 //        assertThatThrownBy(() -> testClass(AppWithFactories11.class))
 //            .isInstanceOf(CompilationErrorException.class)
 //            .hasMessageContaining("Required dependency was not found and candidate class ru.tinkoff.kora.kora.app.annotation.processor.app.AppWithFactories11.GenericClass<java.lang.String> is not final")

kora-app-symbol-processor/src/main/kotlin/ru/tinkoff/kora/kora/app/ksp/GraphBuilder.kt

@@ -198,7 +198,18 @@ object GraphBuilder {
                     }
                 }
                 val hints = ctx.dependencyHintProvider.findHints(dependencyClaim.type, dependencyClaim.tags)
-                val msg = StringBuilder("Required dependency type ${dependencyClaim.type.toTypeName()} was not found and can't be autocreated.")
+                val msg = if(dependencyClaim.tags.isEmpty()) {
+                    StringBuilder(
+                        "Required dependency type was not found and can't be auto created: ${dependencyClaim.type.toTypeName()}.\n" +
+                            "Please check class for @${CommonClassNames.component.canonicalName} annotation or that required module with component is plugged in."
+                    )
+                } else {
+                    val tagMsg = dependencyClaim.tags.joinToString(", ", "@Tag(", ")")
+                    StringBuilder(
+                        "Required dependency type was not found and can't be auto created: ${dependencyClaim.type.toTypeName()} with tag ${tagMsg}.\n" +
+                            "Please check class for @${CommonClassNames.component.canonicalName} annotation or that required module with component is plugged in."
+                    )
+                }
                 for (hint in hints) {
                     msg.append("\n  Hint: ").append(hint.message())
                 }

kora-app-symbol-processor/src/main/kotlin/ru/tinkoff/kora/kora/app/ksp/declaration/ComponentDeclaration.kt

@@ -135,7 +135,7 @@ sealed interface ComponentDeclaration {
         fun fromDependency(ctx: ProcessingContext, classDeclaration: KSClassDeclaration): DiscoveredAsDependencyComponent {
             val constructor = classDeclaration.primaryConstructor
             if (constructor == null) {
-                throw ProcessingErrorException("No primary constructor to parse component", classDeclaration)
+                throw ProcessingErrorException("No primary constructor to parse component for: $classDeclaration", classDeclaration)
             }
             val type = classDeclaration.asType(listOf())
             if (type.isError) {

kora-app-symbol-processor/src/test/kotlin/ru/tinkoff/kora/kora/app/ksp/KoraAppKspTest.kt

@@ -206,7 +206,7 @@ class KoraAppKspTest {
             .isInstanceOfSatisfying(CompilationErrorException::class.java) { e ->
                 SoftAssertions.assertSoftly { s: SoftAssertions ->
                     s.assertThat(e.messages)
-                        .anyMatch { it.contains("Required dependency type ru.tinkoff.kora.kora.app.ksp.app.AppWithUnresolvedDependency.Class3 was not found and can't be autocreated") }
+                        .anyMatch { it.contains("Required dependency type was not found and can't be auto created: ru.tinkoff.kora.kora.app.ksp.app.AppWithUnresolvedDependency.Class3") }
                 }
             }
     }
@@ -257,7 +257,7 @@ class KoraAppKspTest {
             .isInstanceOfSatisfying(CompilationErrorException::class.java) { e ->
                 SoftAssertions.assertSoftly { s: SoftAssertions ->
                     s.assertThat(e.messages).anyMatch {
-                        it.contains("Required dependency type java.io.Closeable was not found and can't be autocreated")
+                        it.contains("Required dependency type was not found and can't be auto created: java.io.Closeable")
                     }
                 }
             }