Aspect support - add providesAspect() to meta data

- Aspects provides/requires working with the annotation only
- Fix a service loading catching expected exception

Author: rbygrave

blackbox-aspect/pom.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <parent>
+    <artifactId>avaje-inject-parent</artifactId>
+    <groupId>io.avaje</groupId>
+    <version>8.11</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+
+  <artifactId>blackbox-aspect</artifactId>
+
+  <properties>
+    <maven.compiler.source>17</maven.compiler.source>
+    <maven.compiler.target>17</maven.compiler.target>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-inject</artifactId>
+      <version>${project.version}</version>
+      <scope>provided</scope>
+    </dependency>
+
+    <!-- annotation processor -->
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>avaje-inject-generator</artifactId>
+      <version>${project.version}</version>
+      <scope>provided</scope>
+    </dependency>
+
+  </dependencies>
+
+</project>

blackbox-aspect/src/main/java/org/example/external/aspect/MyExternalAspect.java

@@ -0,0 +1,15 @@
+package org.example.external.aspect;
+
+import io.avaje.inject.aop.Aspect;
+import org.example.external.aspect.sub.MyAspectImplementation;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Aspect(target = MyAspectImplementation.class)
+@Target(ElementType.METHOD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface MyExternalAspect {
+}

blackbox-aspect/src/main/java/org/example/external/aspect/package-info.java

@@ -0,0 +1,4 @@
+@InjectModule(name = "example-external-aspect")
+package org.example.external.aspect;
+
+import io.avaje.inject.InjectModule;

blackbox-aspect/src/main/java/org/example/external/aspect/sub/MyAspectImplementation.java

@@ -0,0 +1,29 @@
+package org.example.external.aspect.sub;
+
+import io.avaje.inject.Component;
+import io.avaje.inject.aop.AspectProvider;
+import io.avaje.inject.aop.Invocation;
+import io.avaje.inject.aop.MethodInterceptor;
+import org.example.external.aspect.MyExternalAspect;
+
+import java.lang.reflect.Method;
+import java.util.Arrays;
+
+@Component
+public class MyAspectImplementation implements AspectProvider<MyExternalAspect>, MethodInterceptor {
+
+  @Override
+  public MethodInterceptor interceptor(Method method, MyExternalAspect aspectAnnotation) {
+    return this;
+  }
+
+  @Override
+  public void invoke(Invocation invoke) throws Throwable {
+    System.out.println("before args: " + Arrays.toString(invoke.arguments()) + " method: " + invoke.method());
+    try {
+      invoke.invoke();
+    } finally {
+      System.out.println("after method: " + invoke.method());
+    }
+  }
+}

blackbox-test-inject/pom.xml

@@ -18,6 +18,12 @@
 
   <dependencies>
 
+    <dependency>
+      <groupId>io.avaje</groupId>
+      <artifactId>blackbox-aspect</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-inject</artifactId>

blackbox-test-inject/src/main/java/org/example/myapp/HelloServiceProxy.java

@@ -0,0 +1,13 @@
+package org.example.myapp;
+
+import io.avaje.inject.Component;
+import org.example.external.aspect.MyExternalAspect;
+
+@Component
+public class SomeExternalAspectUser {
+
+  @MyExternalAspect
+  public String hello() {
+    return "hello";
+  }
+}

blackbox-test-inject/src/main/java/org/example/myapp/SomeExternalAspectUser.java

@@ -0,0 +1,18 @@
+package org.example.myapp;
+
+import io.avaje.inject.BeanScope;
+import io.avaje.inject.test.TestBeanScope;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class SomeExternalAspectUserTest {
+
+  @Test
+  void hello() {
+    try (BeanScope scope = TestBeanScope.builder().build()) {
+      var some = scope.get(SomeExternalAspectUser.class);
+      assertThat(some.hello()).isEqualTo("hello");
+    }
+  }
+}

blackbox-test-inject/src/test/java/org/example/myapp/SomeExternalAspectUserTest.java

@@ -119,6 +119,10 @@ String autoProvides() {
     return typeReader.autoProvides();
   }
 
+  String providesAspect() {
+    return typeReader.providesAspect();
+  }
+
   Set<GenericType> allGenericTypes() {
     if (allGenericTypes != null) {
       return allGenericTypes;

inject-generator/src/main/java/io/avaje/inject/generator/BeanReader.java

@@ -2,9 +2,7 @@
 
 import io.avaje.inject.spi.Module;
 
-import java.util.HashSet;
-import java.util.ServiceLoader;
-import java.util.Set;
+import java.util.*;
 
 /**
  * The types provided by other modules in the classpath at compile time.
@@ -16,16 +14,22 @@ final class ExternalProvider {
   private final Set<String> providedTypes = new HashSet<>();
 
   void init() {
-    for (final Module module :
-        ServiceLoader.load(Module.class, ExternalProvider.class.getClassLoader())) {
-      for (final Class<?> provide : module.provides()) {
-        providedTypes.add(provide.getCanonicalName());
-      }
-      for (final Class<?> provide : module.autoProvides()) {
-        providedTypes.add(provide.getCanonicalName());
-      }
-      for (final Class<?> provide : module.autoProvidesAspects()) {
-        providedTypes.add(Constants.ASPECT_PROVIDER + "<" + provide.getCanonicalName() + ">");
+    ServiceLoader<Module> load = ServiceLoader.load(Module.class, ExternalProvider.class.getClassLoader());
+    Iterator<Module> iterator = load.iterator();
+    while (iterator.hasNext()) {
+      try {
+        Module module = iterator.next();
+        for (final Class<?> provide : module.provides()) {
+          providedTypes.add(provide.getCanonicalName());
+        }
+        for (Class<?> provide : module.autoProvides()) {
+          providedTypes.add(provide.getCanonicalName());
+        }
+        for (final Class<?> provide : module.autoProvidesAspects()) {
+          providedTypes.add(Constants.ASPECT_PROVIDER + "<" + provide.getCanonicalName() + ">");
+        }
+      } catch (ServiceConfigurationError expected) {
+        // ignore expected error reading the module that we are also writing
       }
     }
   }

inject-generator/src/main/java/io/avaje/inject/generator/ExternalProvider.java

@@ -21,6 +21,7 @@ final class MetaData {
   private final String name;
   private String method;
   private boolean wired;
+  private String providesAspect;
 
   /**
    * The interfaces and class annotations the bean has (to register into lists).
@@ -38,12 +39,14 @@ final class MetaData {
   private String autoProvides;
   private boolean generateProxy;
   private boolean usesExternalDependency;
+  private String externalDependency;
 
   MetaData(DependencyMeta meta) {
     this.type = meta.type();
     this.name = trimName(meta.name());
     this.shortType = Util.shortName(type);
     this.method = meta.method();
+    this.providesAspect = meta.providesAspect();
     this.provides = asList(meta.provides());
     this.dependsOn = Stream.of(meta.dependsOn()).map(Dependency::new).collect(Collectors.toList());
     this.autoProvides = meta.autoProvides();
@@ -120,6 +123,7 @@ private List<String> asList(String[] content) {
   void update(BeanReader beanReader) {
     this.provides = beanReader.provides();
     this.dependsOn = beanReader.dependsOn();
+    this.providesAspect = beanReader.providesAspect();
     this.autoProvides = beanReader.autoProvides();
     this.generateProxy = beanReader.isGenerateProxy();
   }
@@ -140,6 +144,10 @@ String autoProvides() {
     return autoProvides;
   }
 
+  String providesAspect() {
+    return providesAspect;
+  }
+
   /**
    * Return the top level package for the bean and the interfaces it implements.
    */
@@ -164,7 +172,7 @@ void buildMethod(Append append) {
       return;
     }
     if (usesExternalDependency) {
-      append.append("  // uses external dependency").append(NEWLINE);
+      append.append("  // uses external dependency ").append(externalDependency).append(NEWLINE);
     }
     append.append("  @DependencyMeta(type=\"").append(type).append("\"");
     if (name != null) {
@@ -173,7 +181,9 @@ void buildMethod(Append append) {
     if (hasMethod()) {
       append.append(", method=\"").append(method).append("\"");
     }
-    if (!provides.isEmpty()) {
+    if (!providesAspect.isEmpty()) {
+      append.append(", providesAspect=\"").append(providesAspect).append("\"");
+    } else if (!provides.isEmpty()) {
       appendProvides(append, "provides", provides);
     }
     if (!dependsOn.isEmpty()) {
@@ -227,10 +237,15 @@ void setAutoProvides(String autoProvides) {
     this.autoProvides = autoProvides;
   }
 
+  void setProvidesAspect(String providesAspect) {
+    this.providesAspect = providesAspect;
+  }
+
   /**
    * This depends on a dependency that comes from another module in the classpath.
    */
-  void markWithExternalDependency() {
+  void markWithExternalDependency(String name) {
     usesExternalDependency = true;
+    externalDependency = name;
   }
 }

inject-generator/src/main/java/io/avaje/inject/generator/MetaData.java

@@ -17,9 +17,8 @@ final class MetaDataOrdering {
   private final Map<String, ProviderList> providers = new HashMap<>();
   private final List<DependencyLink> circularDependencies = new ArrayList<>();
   private final Set<String> missingDependencyTypes = new LinkedHashSet<>();
-  private final Set<String> autoRequires = new TreeSet<>();  
+  private final Set<String> autoRequires = new TreeSet<>();
   private final Set<String> autoRequiresAspects = new TreeSet<>();
-  
 
   MetaDataOrdering(Collection<MetaData> values, ProcessingContext context, ScopeInfo scopeInfo) {
     this.context = context;
@@ -186,18 +185,19 @@ private int processQueueRound(boolean includeExternal) {
 
   private boolean allDependenciesWired(MetaData queuedMeta, boolean includeExternal) {
     for (Dependency dependency : queuedMeta.dependsOn()) {
-      if (!Util.isProvider(dependency.name())) {
+      final var dependencyName = dependency.name();
+      if (!Util.isProvider(dependencyName)) {
         // check non-provider dependency is satisfied
-        ProviderList providerList = providers.get(dependency.name());
+        ProviderList providerList = providers.get(dependencyName);
         if (providerList == null) {
           if (!scopeInfo.providedByOther(dependency)) {
-            if (includeExternal && context.externallyProvided(dependency.name())) {
-              if (Util.isAspectProvider(dependency.name())) {
-                autoRequiresAspects.add(Util.extractAspectType(dependency.name()));
+            if (includeExternal && context.externallyProvided(dependencyName)) {
+              if (Util.isAspectProvider(dependencyName)) {
+                autoRequiresAspects.add(Util.extractAspectType(dependencyName));
               } else {
-                autoRequires.add(dependency.name());
+                autoRequires.add(dependencyName);
               }
-              queuedMeta.markWithExternalDependency();
+              queuedMeta.markWithExternalDependency(dependencyName);
             } else {
               return false;
             }

inject-generator/src/main/java/io/avaje/inject/generator/MetaDataOrdering.java

@@ -135,6 +135,7 @@ MetaData createMeta() {
     metaData.setDependsOn(dependsOn);
     metaData.setProvides(typeReader == null ? Collections.emptyList() : typeReader.provides());
     metaData.setAutoProvides(typeReader == null ? null : typeReader.autoProvides());
+    metaData.setProvidesAspect(typeReader == null ? "" : typeReader.providesAspect());
     return metaData;
   }