Follow-up changes to the EarlyEntryPoint API

This CL changes the usage of @EarlyEntryPoint from being an addition to @entrypoint to being a replacement for @entrypoint.

It also adds the @beta annotation to the API.

RELNOTES=N/A
PiperOrigin-RevId: 359399064

java/dagger/hilt/android/BUILD

@@ -121,10 +121,11 @@ android_library(
         "EarlyEntryPoints.java",
     ],
     exported_plugins = [
-        "//java/dagger/hilt/android/processor/internal/earlyentrypoint:processor",
+        "//java/dagger/hilt/processor/internal/aggregateddeps:plugin",
     ],
     deps = [
         ":package_info",
+        "//:dagger_with_compiler",
         "//java/dagger/hilt:entry_point",
         "//java/dagger/hilt/internal:component_manager",
         "//java/dagger/hilt/internal:preconditions",

java/dagger/hilt/android/EarlyEntryPoint.java

@@ -18,6 +18,7 @@
 
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
+import dagger.internal.Beta;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
@@ -31,25 +32,29 @@
  *
  * <h1>Usage:
  *
- * <p>To use, annotate an existing entry point with {@link EarlyEntryPoint} as shown below:
+ * <p>To enable an existing entry point to be called early in a Hilt test, replace its
+ * {@link dagger.hilt.EntryPoint} annotation with {@link EarlyEntryPoint}. (Note that,
+ * {@link EarlyEntryPoint} is only allowed on entry points installed in the
+ * {@link dagger.hilt.components.SingletonComponent}).
  *
  * <pre>{@code
- * @EarlyEntryPoint
- * @EntryPoint
+ * @EarlyEntryPoint  // <- This replaces @EntryPoint
  * @InstallIn(SingletonComponent.class)
  * interface FooEntryPoint {
  *   Foo getFoo();
  * }
  * }</pre>
  *
- * <p>Then, replace any usages of {@link EntryPoints} with {@link EarlyEntryPoints}, as shown below:
+ * <p>Then, replace any of the corresponding usages of {@link dagger.hilt.EntryPoints} with
+ * {@link EarlyEntryPoints}, as shown below:
  *
  * <pre>{@code
  * // EarlyEntryPoints.get() must be used with entry points annotated with @EarlyEntryPoint
  * // This entry point can now be called at any point during a test, e.g. in Application.onCreate().
  * Foo foo = EarlyEntryPoints.get(appContext, FooEntryPoint.class).getFoo();
  * }</pre>
  */
+@Beta
 @Retention(RUNTIME) // Needs to be runtime for checks in EntryPoints and EarlyEntryPoints.
 @Target(ElementType.TYPE)
 public @interface EarlyEntryPoint {}

java/dagger/hilt/android/EarlyEntryPoints.java

@@ -21,10 +21,12 @@
 import dagger.hilt.internal.GeneratedComponentManagerHolder;
 import dagger.hilt.internal.Preconditions;
 import dagger.hilt.internal.TestSingletonComponentManager;
+import dagger.internal.Beta;
 import java.lang.annotation.Annotation;
 import javax.annotation.Nonnull;
 
 /** Static utility methods for accessing entry points annotated with {@link EarlyEntryPoint}. */
+@Beta
 public final class EarlyEntryPoints {
 
   /**

java/dagger/hilt/android/processor/BUILD

@@ -43,7 +43,6 @@ gen_maven_artifact(
         "//java/dagger/hilt/android/processor/internal/androidentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/bindvalue:bind_value_processor_lib",
         "//java/dagger/hilt/android/processor/internal/customtestapplication:processor_lib",
-        "//java/dagger/hilt/android/processor/internal/earlyentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:validation_plugin_lib",
         "//java/dagger/hilt/android/processor/internal/uninstallmodules:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:processor_lib",

java/dagger/hilt/processor/BUILD

@@ -27,7 +27,6 @@ java_library(
         "//java/dagger/hilt/android/processor/internal/androidentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/bindvalue:bind_value_processor_lib",
         "//java/dagger/hilt/android/processor/internal/customtestapplication:processor_lib",
-        "//java/dagger/hilt/android/processor/internal/earlyentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/uninstallmodules:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:validation_plugin_lib",
@@ -64,7 +63,6 @@ gen_maven_artifact(
         "//java/dagger/hilt/android/processor/internal/androidentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/bindvalue:bind_value_processor_lib",
         "//java/dagger/hilt/android/processor/internal/customtestapplication:processor_lib",
-        "//java/dagger/hilt/android/processor/internal/earlyentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:validation_plugin_lib",
         "//java/dagger/hilt/android/processor/internal/uninstallmodules:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:processor_lib",

java/dagger/hilt/processor/internal/aggregateddeps/AggregatedDepsProcessor.java

@@ -65,6 +65,7 @@ public final class AggregatedDepsProcessor extends BaseProcessor {
   private static final ImmutableSet<ClassName> ENTRY_POINT_ANNOTATIONS =
       ImmutableSet.of(
           ClassNames.ENTRY_POINT,
+          ClassNames.EARLY_ENTRY_POINT,
           ClassNames.GENERATED_ENTRY_POINT,
           ClassNames.COMPONENT_ENTRY_POINT);
 
@@ -308,6 +309,28 @@ private void processEntryPoint(
         element);
     TypeElement entryPoint = asType(element);
 
+    if (entryPointAnnotation.equals(ClassNames.EARLY_ENTRY_POINT)) {
+      ImmutableSet<ClassName> components = Components.getComponents(getElementUtils(), element);
+      ProcessorErrors.checkState(
+          components.equals(ImmutableSet.of(ClassNames.SINGLETON_COMPONENT)),
+          element,
+          "@EarlyEntryPoint can only be installed into the SingletonComponent. Found: %s",
+          components);
+
+      Optional<TypeElement> optionalTestElement =
+          Processors.getOriginatingTestElement(element, getElementUtils());
+      ProcessorErrors.checkState(
+          !optionalTestElement.isPresent(),
+          element,
+          "@EarlyEntryPoint-annotated entry point, %s, cannot be nested in (or originate from) "
+              + "a @HiltAndroidTest-annotated class, %s. This requirement is to avoid confusion "
+              + "with other, test-specific entry points.",
+          asType(element).getQualifiedName().toString(),
+          optionalTestElement
+              .map(testElement -> testElement.getQualifiedName().toString())
+              .orElse(""));
+    }
+
     generateAggregatedDeps(
         entryPointAnnotation.equals(ClassNames.COMPONENT_ENTRY_POINT)
             ? "componentEntryPoints"

java/dagger/hilt/processor/internal/aggregateddeps/PkgPrivateEntryPointGenerator.java

@@ -19,7 +19,6 @@
 import com.squareup.javapoet.AnnotationSpec;
 import com.squareup.javapoet.JavaFile;
 import com.squareup.javapoet.TypeSpec;
-import dagger.hilt.processor.internal.ClassNames;
 import dagger.hilt.processor.internal.Processors;
 import java.io.IOException;
 import javax.annotation.processing.ProcessingEnvironment;
@@ -70,10 +69,6 @@ void generate() throws IOException {
           AnnotationSpec.get(metadata.getOptionalInstallInAnnotationMirror().get()));
     }
 
-    if (Processors.hasAnnotation(metadata.getTypeElement(), ClassNames.EARLY_ENTRY_POINT)) {
-      entryPointInterfaceBuilder.addAnnotation(ClassNames.EARLY_ENTRY_POINT);
-    }
-
     JavaFile.builder(
             metadata.generatedClassName().packageName(), entryPointInterfaceBuilder.build())
         .build()

javatests/artifacts/hilt-android/simple/app/src/sharedTest/java/dagger/hilt/android/simple/BaseTestApplication.java

@@ -29,7 +29,6 @@
 /** A custom application used to test @EarlyEntryPoint */
 public class BaseTestApplication extends Application {
   @EarlyEntryPoint
-  @EntryPoint
   @InstallIn(SingletonComponent.class)
   interface EarlyFooEntryPoint {
     Foo earlyFoo();

javatests/dagger/hilt/android/EarlyEntryPointCustomApplicationClasses.java

@@ -16,7 +16,6 @@
 
 package dagger.hilt.android;
 
-import dagger.hilt.EntryPoint;
 import dagger.hilt.InstallIn;
 import dagger.hilt.components.SingletonComponent;
 import javax.inject.Inject;
@@ -26,9 +25,8 @@
 public final class EarlyEntryPointCustomApplicationClasses {
   private EarlyEntryPointCustomApplicationClasses() {}
 
-  // @EarlyEntryPoints cannot be nested in tests, so we have to put everything here.
+  // @EarlyEntryPoint cannot be nested in tests, so we've separated it out into this class.
   @EarlyEntryPoint
-  @EntryPoint
   @InstallIn(SingletonComponent.class)
   interface EarlyFooEntryPoint {
     Foo foo();

javatests/dagger/hilt/android/EarlyEntryPointHiltAndroidAppRuntimeClasses.java

@@ -38,8 +38,8 @@ interface FooEntryPoint {
     Foo foo();
   }
 
+  // @EarlyEntryPoint cannot be nested in tests, so we've separated it out into this class.
   @EarlyEntryPoint
-  @EntryPoint
   @InstallIn(SingletonComponent.class)
   interface EarlyFooEntryPoint {
     Foo foo();

javatests/dagger/hilt/android/EarlyEntryPointHiltAndroidTestRuntimeClasses.java

@@ -33,17 +33,15 @@
 public final class EarlyEntryPointHiltAndroidTestRuntimeClasses {
   private EarlyEntryPointHiltAndroidTestRuntimeClasses() {}
 
-  // @EarlyEntryPoints cannot be nested in tests, so we have to put everything here.
+  // @EarlyEntryPoint cannot be nested in tests, so we've separated it out into this class.
   @EarlyEntryPoint
-  @EntryPoint
   @InstallIn(SingletonComponent.class)
   interface EarlyFooEntryPoint {
     Foo foo();
   }
 
-  // @EarlyEntryPoints cannot be nested in tests, so we have to put everything here.
+  // @EarlyEntryPoint cannot be nested in tests, so we've separated it out into this class.
   @EarlyEntryPoint
-  @EntryPoint
   @InstallIn(SingletonComponent.class)
   interface EarlyMySubcomponentBuilderEntryPoint {
     MySubcomponent.Builder mySubcomponentBuilder();

javatests/dagger/hilt/android/processor/AndroidCompilers.java

@@ -22,7 +22,6 @@
 import com.google.testing.compile.Compiler;
 import dagger.hilt.android.processor.internal.androidentrypoint.AndroidEntryPointProcessor;
 import dagger.hilt.android.processor.internal.customtestapplication.CustomTestApplicationProcessor;
-import dagger.hilt.android.processor.internal.earlyentrypoint.EarlyEntryPointProcessor;
 import dagger.hilt.android.processor.internal.uninstallmodules.UninstallModulesProcessor;
 import dagger.hilt.processor.internal.aggregateddeps.AggregatedDepsProcessor;
 import dagger.hilt.processor.internal.definecomponent.DefineComponentProcessor;
@@ -69,7 +68,6 @@ private static ImmutableList<Processor> defaultProcessors() {
         new AndroidEntryPointProcessor(),
         new ComponentProcessor(),
         new DefineComponentProcessor(),
-        new EarlyEntryPointProcessor(),
         new GeneratesRootInputProcessor(),
         new OriginatingElementProcessor(),
         new CustomTestApplicationProcessor(),

javatests/dagger/hilt/android/processor/BUILD

@@ -22,7 +22,6 @@ java_library(
     deps = [
         "//java/dagger/hilt/android/processor/internal/androidentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/customtestapplication:processor_lib",
-        "//java/dagger/hilt/android/processor/internal/earlyentrypoint:processor_lib",
         "//java/dagger/hilt/android/processor/internal/uninstallmodules:processor_lib",
         "//java/dagger/hilt/android/processor/internal/viewmodel:processor_lib",
         "//java/dagger/hilt/processor/internal/aggregateddeps:processor_lib",

javatests/dagger/hilt/android/processor/internal/aggregateddeps/BUILD

@@ -40,6 +40,25 @@ compiler_test(
     ],
 )
 
+compiler_test(
+    name = "EarlyEntryPointProcessorTest",
+    srcs = ["EarlyEntryPointProcessorTest.java"],
+    compiler_deps = [
+        "//java/dagger/hilt:entry_point",
+        "//java/dagger/hilt:install_in",
+        "//java/dagger/hilt/android:early_test_entry_point",
+        "//java/dagger/hilt/android/components",
+        "//java/dagger/hilt/android/testing:hilt_android_test",
+        "@androidsdk//:platforms/android-30/android.jar",
+    ],
+    deps = [
+        "@google_bazel_common//third_party/java/compile_testing",
+        "@google_bazel_common//third_party/java/junit",
+        "@google_bazel_common//third_party/java/truth",
+        "//javatests/dagger/hilt/android/processor:android_compilers",
+    ],
+)
+
 java_library(
     name = "InstallInModule",
     srcs = ["InstallInModule.java"],