Reset processingEnv for BindingGraphPlugins for each round.

wanyingd1996 · Dagger Team · commit 2a6a0b46160e · 2024-03-25T11:44:00.000-07:00
Previously, plugin initialization was performed in processingSteps(), which is only called once at the time when the Processor is created.

RELNOTES=Added `BindingGraphPlugin#onProcessingRoundBegin` for pre processing initialization.
PiperOrigin-RevId: 618910291
diff --git a/java/dagger/hilt/android/processor/internal/viewmodel/ViewModelValidationPlugin.kt b/java/dagger/hilt/android/processor/internal/viewmodel/ViewModelValidationPlugin.kt
@@ -48,9 +48,14 @@ import javax.tools.Diagnostic.Kind
 class ViewModelValidationPlugin : BindingGraphPlugin {
 
   private lateinit var env: XProcessingEnv
+  private lateinit var daggerProcessingEnv: DaggerProcessingEnv
 
   override fun init(processingEnv: DaggerProcessingEnv, options: MutableMap<String, String>) {
-    env = processingEnv.toXProcessingEnv()
+    daggerProcessingEnv = processingEnv
+  }
+
+  override fun onProcessingRoundBegin() {
+    env = daggerProcessingEnv.toXProcessingEnv()
   }
 
   override fun visitGraph(bindingGraph: BindingGraph, diagnosticReporter: DiagnosticReporter) {
@@ -75,7 +80,7 @@ class ViewModelValidationPlugin : BindingGraphPlugin {
           "\nInjection of an @HiltViewModel class is prohibited since it does not create a " +
             "ViewModel instance correctly.\nAccess the ViewModel via the Android APIs " +
             "(e.g. ViewModelProvider) instead." +
-            "\nInjected ViewModel: ${target.key().type()}\n"
+            "\nInjected ViewModel: ${target.key().type()}\n",
         )
       } else if (
         isViewModelAssistedFactory(target) && !isInternalViewModelAssistedFactoryUsage(source)
@@ -86,7 +91,7 @@ class ViewModelValidationPlugin : BindingGraphPlugin {
           "\nInjection of an assisted factory for Hilt ViewModel is prohibited since it " +
             "can not be used to create a ViewModel instance correctly.\nAccess the ViewModel via " +
             "the Android APIs (e.g. ViewModelProvider) instead." +
-            "\nInjected factory: ${target.key().type()}\n"
+            "\nInjected factory: ${target.key().type()}\n",
         )
       }
     }
diff --git a/java/dagger/internal/codegen/ComponentProcessor.java b/java/dagger/internal/codegen/ComponentProcessor.java
@@ -119,6 +119,11 @@ public Iterable<XProcessingStep> processingSteps() {
     return delegate.processingSteps();
   }
 
+  @Override
+  public void preRound(XProcessingEnv env, XRoundEnv roundEnv) {
+    delegate.onProcessingRoundBegin();
+  }
+
   @Override
   public void postRound(XProcessingEnv env, XRoundEnv roundEnv) {
     delegate.postRound(env, roundEnv);
diff --git a/java/dagger/internal/codegen/DelegateComponentProcessor.java b/java/dagger/internal/codegen/DelegateComponentProcessor.java
@@ -108,15 +108,19 @@ public void initialize(
     DaggerDelegateComponentProcessor_Injector.factory()
         .create(env, plugins, legacyPlugins)
         .inject(this);
+    validationBindingGraphPlugins.initializePlugins();
+    externalBindingGraphPlugins.initializePlugins();
   }
 
   public Iterable<XProcessingStep> processingSteps() {
-    validationBindingGraphPlugins.initializePlugins();
-    externalBindingGraphPlugins.initializePlugins();
 
     return processingSteps;
   }
 
+  public void onProcessingRoundBegin() {
+    externalBindingGraphPlugins.onProcessingRoundBegin();
+  }
+
   public void postRound(XProcessingEnv env, XRoundEnv roundEnv) {
     if (!roundEnv.isProcessingOver()) {
       try {
diff --git a/java/dagger/internal/codegen/KspComponentProcessor.java b/java/dagger/internal/codegen/KspComponentProcessor.java
@@ -58,6 +58,11 @@ public Iterable<XProcessingStep> processingSteps() {
     return delegate.processingSteps();
   }
 
+  @Override
+  public void preRound(XProcessingEnv env, XRoundEnv roundEnv) {
+    delegate.onProcessingRoundBegin();
+  }
+
   @Override
   public void postRound(XProcessingEnv env, XRoundEnv roundEnv) {
     delegate.postRound(env, roundEnv);
diff --git a/java/dagger/internal/codegen/validation/ExternalBindingGraphPlugins.java b/java/dagger/internal/codegen/validation/ExternalBindingGraphPlugins.java
@@ -84,6 +84,10 @@ private void initializePlugin(BindingGraphPlugin plugin) {
     plugin.init(SpiModelBindingGraphConverter.toSpiModel(processingEnv), filteredOptions);
   }
 
+  public void onProcessingRoundBegin() {
+    plugins.forEach(BindingGraphPlugin::onProcessingRoundBegin);
+  }
+
   private void initializeLegacyPlugin(dagger.spi.BindingGraphPlugin plugin) {
     plugin.initFiler(toJavac(filer));
     plugin.initTypes(toJavac(processingEnv).getTypeUtils()); // ALLOW_TYPES_ELEMENTS
diff --git a/java/dagger/spi/model/BindingGraphPlugin.java b/java/dagger/spi/model/BindingGraphPlugin.java
@@ -59,6 +59,14 @@ default String pluginName() {
     return getClass().getCanonicalName();
   }
 
+  /**
+   * Runs before each round of Dagger annotation processing.
+   *
+   * <p>If using the plugin to process elements that need resetting at the beginning of each
+   * processing round, use this function to perform the setup.
+   */
+  default void onProcessingRoundBegin() {}
+
   /**
    * Perform any extra work after the plugin finished all its visiting. This will be called once per
    * instance of this plugin, after all graphs were {@linkplain #visitGraph(BindingGraph,

Original file line number	Diff line number	Diff line change
`@@ -48,9 +48,14 @@ import javax.tools.Diagnostic.Kind`
`48`	`48`	`class ViewModelValidationPlugin : BindingGraphPlugin {`
`49`	`49`
`50`	`50`	`private lateinit var env: XProcessingEnv`
	`51`	`+ private lateinit var daggerProcessingEnv: DaggerProcessingEnv`
`51`	`52`
`52`	`53`	`override fun init(processingEnv: DaggerProcessingEnv, options: MutableMap<String, String>) {`
`53`		`- env = processingEnv.toXProcessingEnv()`
	`54`	`+ daggerProcessingEnv = processingEnv`
	`55`	`+ }`
	`56`	`+`
	`57`	`+ override fun onProcessingRoundBegin() {`
	`58`	`+ env = daggerProcessingEnv.toXProcessingEnv()`
`54`	`59`	`}`
`55`	`60`
`56`	`61`	`override fun visitGraph(bindingGraph: BindingGraph, diagnosticReporter: DiagnosticReporter) {`
`@@ -75,7 +80,7 @@ class ViewModelValidationPlugin : BindingGraphPlugin {`
`75`	`80`	`"\nInjection of an @HiltViewModel class is prohibited since it does not create a " +`
`76`	`81`	`"ViewModel instance correctly.\nAccess the ViewModel via the Android APIs " +`
`77`	`82`	`"(e.g. ViewModelProvider) instead." +`
`78`		`- "\nInjected ViewModel: ${target.key().type()}\n"`
	`83`	`+ "\nInjected ViewModel: ${target.key().type()}\n",`
`79`	`84`	`)`
`80`	`85`	`} else if (`
`81`	`86`	`isViewModelAssistedFactory(target) && !isInternalViewModelAssistedFactoryUsage(source)`
`@@ -86,7 +91,7 @@ class ViewModelValidationPlugin : BindingGraphPlugin {`
`86`	`91`	`"\nInjection of an assisted factory for Hilt ViewModel is prohibited since it " +`
`87`	`92`	`"can not be used to create a ViewModel instance correctly.\nAccess the ViewModel via " +`
`88`	`93`	`"the Android APIs (e.g. ViewModelProvider) instead." +`
`89`		`- "\nInjected factory: ${target.key().type()}\n"`
	`94`	`+ "\nInjected factory: ${target.key().type()}\n",`
`90`	`95`	`)`
`91`	`96`	`}`
`92`	`97`	`}`