GH-315 - Avoid processing infrastructure beans in observability infrastructure.

We now skip infrastructure role beans during the processing of beans that could be subject to inter-module interaction observability. Previously, we could accidentally trigger a dependency cycle if the ModuleTracingBeanPostProcessor triggered the initial creation of AutoConfigurationPackages as that would then trigger the PostProcessor in turn which would try to lookup the ACP bean again to determine whether it should post process that to apply observability.

Author: odrotbohm

spring-modulith-observability/src/main/java/org/springframework/modulith/observability/ModuleTracingBeanPostProcessor.java

@@ -27,8 +27,9 @@
 import org.springframework.aop.support.DefaultPointcutAdvisor;
 import org.springframework.aop.support.StaticMethodMatcher;
 import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanDefinition;
 import org.springframework.beans.factory.config.BeanPostProcessor;
-import org.springframework.modulith.core.ApplicationModules;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.modulith.runtime.ApplicationModulesRuntime;
 import org.springframework.util.Assert;
 
@@ -45,6 +46,7 @@ public class ModuleTracingBeanPostProcessor extends ModuleTracingSupport impleme
 	private final ApplicationModulesRuntime runtime;
 	private final Supplier<Tracer> tracer;
 	private final Map<String, Advisor> advisors;
+	private final ConfigurableListableBeanFactory factory;
 
 	/**
 	 * Creates a new {@link ModuleTracingBeanPostProcessor} for the given {@link ApplicationModulesRuntime} and
@@ -53,14 +55,16 @@ public class ModuleTracingBeanPostProcessor extends ModuleTracingSupport impleme
 	 * @param runtime must not be {@literal null}.
 	 * @param tracer must not be {@literal null}.
 	 */
-	public ModuleTracingBeanPostProcessor(ApplicationModulesRuntime runtime, Supplier<Tracer> tracer) {
+	public ModuleTracingBeanPostProcessor(ApplicationModulesRuntime runtime, Supplier<Tracer> tracer,
+			ConfigurableListableBeanFactory factory) {
 
 		Assert.notNull(runtime, "ApplicationModulesRuntime must not be null!");
 		Assert.notNull(tracer, "Tracer must not be null!");
 
 		this.runtime = runtime;
 		this.tracer = tracer;
 		this.advisors = new HashMap<>();
+		this.factory = factory;
 	}
 
 	/*
@@ -70,13 +74,13 @@ public ModuleTracingBeanPostProcessor(ApplicationModulesRuntime runtime, Supplie
 	@Override
 	public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
 
-		Class<?> type = runtime.getUserClass(bean, beanName);
+		var type = runtime.getUserClass(bean, beanName);
 
-		if (!runtime.isApplicationClass(type) || !type.isInstance(bean)) {
+		if (!type.isInstance(bean) || isInfrastructureBean(beanName) || !runtime.isApplicationClass(type)) {
 			return bean;
 		}
 
-		ApplicationModules modules = runtime.get();
+		var modules = runtime.get();
 
 		return modules.getModuleByType(type.getName())
 				.map(DefaultObservedModule::new)
@@ -91,6 +95,12 @@ public Object postProcessAfterInitialization(Object bean, String beanName) throw
 				}).orElse(bean);
 	}
 
+	private boolean isInfrastructureBean(String beanName) {
+
+		return factory.containsBean(beanName) &&
+				factory.getBeanDefinition(beanName).getRole() == BeanDefinition.ROLE_INFRASTRUCTURE;
+	}
+
 	private Advisor getOrBuildAdvisor(ObservedModule module, ObservedModuleType type) {
 
 		return advisors.computeIfAbsent(module.getName(), __ -> {

spring-modulith-observability/src/main/java/org/springframework/modulith/observability/autoconfigure/ModuleObservabilityAutoConfiguration.java

@@ -25,6 +25,7 @@
 import io.micrometer.tracing.Tracer;
 
 import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.context.annotation.Bean;
@@ -42,8 +43,8 @@ class ModuleObservabilityAutoConfiguration {
 
 	@Bean
 	static ModuleTracingBeanPostProcessor moduleTracingBeanPostProcessor(ApplicationModulesRuntime runtime,
-			ObjectProvider<Tracer> tracer) {
-		return new ModuleTracingBeanPostProcessor(runtime, () -> tracer.getObject());
+			ObjectProvider<Tracer> tracer, ConfigurableListableBeanFactory factory) {
+		return new ModuleTracingBeanPostProcessor(runtime, () -> tracer.getObject(), factory);
 	}
 
 	@Bean

spring-modulith-runtime/src/main/java/org/springframework/modulith/runtime/autoconfigure/SpringBootApplicationRuntime.java

@@ -16,6 +16,7 @@
 package org.springframework.modulith.runtime.autoconfigure;
 
 import java.util.Arrays;
+import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -38,6 +39,7 @@ class SpringBootApplicationRuntime implements ApplicationRuntime {
 
 	private final ApplicationContext context;
 	private Class<?> mainApplicationClass;
+	private List<String> resolvedAutoConfigurationPackages;
 
 	/**
 	 * Creates a new {@link SpringBootApplicationRuntime} for the given {@link ApplicationContext}.
@@ -113,6 +115,15 @@ private boolean computeIsApplicationClass(String fqn, Class<?> applicationClass)
 		}
 
 		return fqn.startsWith(applicationClass.getPackage().getName())
-				|| AutoConfigurationPackages.get(context).stream().anyMatch(pkg -> fqn.startsWith(pkg));
+				|| getAutoConfigurationPackages().stream().anyMatch(pkg -> fqn.startsWith(pkg));
+	}
+
+	private List<String> getAutoConfigurationPackages() {
+
+		if (resolvedAutoConfigurationPackages == null) {
+			this.resolvedAutoConfigurationPackages = AutoConfigurationPackages.get(context);
+		}
+
+		return resolvedAutoConfigurationPackages;
 	}
 }