Improve the error message for conflicting entry points.

RELNOTES=n/a PiperOrigin-RevId: 446074483
google · May 3, 2022 · dfab36d · dfab36d
1 parent 0dfbcaa
commit dfab36d
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 6 deletions.
diff --git a/java/dagger/internal/codegen/base/DiagnosticFormatting.java b/java/dagger/internal/codegen/base/DiagnosticFormatting.java
@@ -52,7 +52,7 @@ public final class DiagnosticFormatting {
    * parameterized) type, and should NOT be used with arbitrary text, especially prose error
    * messages.
    *
-   * <p>TODO(user): Tighten these to take type representations (mirrors and elements) to avoid
+   * <p>TODO(cgruber): Tighten these to take type representations (mirrors and elements) to avoid
    * accidental mis-use by running errors through this method.
    */
   public static String stripCommonTypePrefixes(String type) {

diff --git a/java/dagger/internal/codegen/validation/ComponentValidator.java b/java/dagger/internal/codegen/validation/ComponentValidator.java
@@ -461,7 +461,10 @@ private void reportConflictingEntryPoints(Collection<XMethodElement> methods) {
               == methods.size(),
           "expected each method to be declared on a different type: %s",
           methods);
-      StringBuilder message = new StringBuilder("conflicting entry point declarations:");
+      StringBuilder message = new StringBuilder("Found conflicting entry point declarations. "
+          + "Getter methods on the component with the same name and signature must be for the "
+          + "same binding key since the generated component can only implement the method once. "
+          + "Found:");
       methodSignatureFormatter
           .typedFormatter(component.getType())
           .formatIndentedList(

diff --git a/javatests/dagger/internal/codegen/ConflictingEntryPointsTest.java b/javatests/dagger/internal/codegen/ConflictingEntryPointsTest.java
@@ -71,7 +71,7 @@ public void covariantType() {
     assertThat(compilation)
         .hadErrorContaining(
             message(
-                "conflicting entry point declarations:",
+                "can only implement the method once. Found:",
                 "    Long test.Base1.foo()",
                 "    Number test.Base2.foo()"))
         .inFile(component)
@@ -119,7 +119,7 @@ public void covariantTypeFromGenericSupertypes() {
     assertThat(compilation)
         .hadErrorContaining(
             message(
-                "conflicting entry point declarations:",
+                "can only implement the method once. Found:",
                 "    Long test.Base1.foo()",
                 "    Number test.Base2.foo()"))
         .inFile(component)
@@ -170,7 +170,7 @@ public void differentQualifier() {
     assertThat(compilation)
         .hadErrorContaining(
             message(
-                "conflicting entry point declarations:",
+                "can only implement the method once. Found:",
                 "    Object test.Base1.foo()",
                 "    @Named(\"foo\") Object test.Base2.foo()"))
         .inFile(component)

diff --git a/javatests/dagger/internal/codegen/KeyFactoryTest.java b/javatests/dagger/internal/codegen/KeyFactoryTest.java
@@ -253,7 +253,7 @@ static final class BoxedPrimitiveTypes {
         processingEnv.requireTypeElement(BoxedPrimitiveTypes.class.getCanonicalName());
     XMethodElement integerMethod = getOnlyElement(boxedPrimitiveHolder.getDeclaredMethods());
 
-    // TODO(user): Truth subject for TypeMirror and TypeElement
+    // TODO(cgruber): Truth subject for TypeMirror and TypeElement
     XType intType = intMethod.getReturnType();
     assertThat(isPrimitive(intType)).isTrue();
     XType integerType = integerMethod.getReturnType();