Failing test for ModuleOrdering that skips the extra test module(s) (#760)

* Failing test for ModuleOrdering that skips the extra test module(s)

Test components in src/test that are not annotated with @TestScope go into an extra module. This module is ignored/skipped by the compiled module ordering.

A fix for this is desired.

* Add ModuleOrdering.supportsExpected() such that we only use compiled module ordering when ...

When it supports the modules that are being used. When it does not then fall back to the default ordering mechanism.

* Opps, need to set factoryOrder variable there ...

* [test] Add test injecting BeanScope into a test component

---------

Co-authored-by: Josiah Noel <[email protected]>

Author: rbygrave

blackbox-test-inject/src/test/java/org/example/myapp/other/InjectTestOnlyComponentTest.java

@@ -0,0 +1,29 @@
+package org.example.myapp.other;
+
+import io.avaje.inject.test.InjectTest;
+import jakarta.inject.Inject;
+import org.junit.jupiter.api.Test;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@InjectTest
+public class InjectTestOnlyComponentTest {
+
+  @Inject WireOther myTestOnlyComponent;
+  @Inject WireOther2 myTestOnlyComponent2;
+  @Inject WireOther3 withBeanScope;
+
+  @Test
+  void test() {
+    assertThat(myTestOnlyComponent).isNotNull();
+    assertThat(myTestOnlyComponent.component).isNotNull();
+    assertThat(myTestOnlyComponent.plugin).isNotNull();
+
+    assertThat(myTestOnlyComponent2).isNotNull();
+    assertThat(myTestOnlyComponent2.component).isNotNull();
+    assertThat(myTestOnlyComponent2.plugin).isNotNull();
+
+    assertThat(withBeanScope).isNotNull();
+    assertThat(withBeanScope.beanScope).isNotNull();
+  }
+}

blackbox-test-inject/src/test/java/org/example/myapp/other/WireOther2.java

@@ -0,0 +1,19 @@
+package org.example.myapp.other;
+
+import io.avaje.inject.PostConstruct;
+import jakarta.inject.Singleton;
+import org.example.external.aspect.PluginProvidedClass;
+import org.other.one.OtherComponent;
+
+@Singleton
+public class WireOther2 {
+  OtherComponent component;
+  PluginProvidedClass plugin;
+
+  @PostConstruct
+  public void postConstruct(OtherComponent component, PluginProvidedClass plugin) {
+    this.component = component;
+    this.plugin = plugin;
+  }
+
+}

blackbox-test-inject/src/test/java/org/example/myapp/other/WireOther3.java

@@ -0,0 +1,18 @@
+package org.example.myapp.other;
+
+import io.avaje.inject.BeanScope;
+import io.avaje.inject.PostConstruct;
+import jakarta.inject.Singleton;
+import org.example.external.aspect.PluginProvidedClass;
+import org.other.one.OtherComponent;
+
+@Singleton
+public class WireOther3 {
+  BeanScope beanScope;
+
+  @PostConstruct
+  public void postConstruct(BeanScope beanScope) {
+    this.beanScope = beanScope;
+  }
+
+}

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

@@ -76,7 +76,17 @@ private void writeStartClass() {
 
   private void writeBuildMethods() {
     writer.append(
-      "\n"
+        "\n"
+        + "  @Override\n"
+        + "  public boolean supportsExpected(List<AvajeModule> modules) {\n"
+        + "    if (modules.size() != sortedModules.length) {\n"
+        + "      return false;\n"
+        + "    }\n"
+        + "    return modules.stream()\n"
+        + "            .map(m -> m.getClass().getTypeName())\n"
+        + "            .allMatch(k -> INDEXES.containsKey(k));\n"
+        + "  }\n"
+        + "\n"
         + "  @Override\n"
         + "  public List<AvajeModule> factories() {\n"
         + "    return List.of(sortedModules);\n"

inject/src/main/java/io/avaje/inject/DBeanScopeBuilder.java

@@ -6,13 +6,7 @@
 
 import java.lang.System.Logger.Level;
 import java.lang.reflect.Type;
-import java.util.ArrayList;
-import java.util.Arrays;
-import java.util.HashMap;
-import java.util.LinkedHashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.function.Consumer;
 import java.util.function.Supplier;
 
@@ -257,10 +251,13 @@ public BeanScope build() {
 
     // sort factories by dependsOn
     ModuleOrdering factoryOrder = new FactoryOrder(parent, includeModules, !suppliedBeans.isEmpty());
+    var modules = serviceLoader.modules();
     if (factoryOrder.isEmpty()) {
       // prefer generated ModuleOrdering if provided
-      factoryOrder = serviceLoader.moduleOrdering().orElse(factoryOrder);
-      serviceLoader.modules().forEach(factoryOrder::add);
+      factoryOrder = serviceLoader.moduleOrdering()
+        .filter(o -> o.supportsExpected(modules))
+        .orElse(factoryOrder);
+      modules.forEach(factoryOrder::add);
     }
 
     final var moduleNames = factoryOrder.orderModules();

inject/src/main/java/io/avaje/inject/spi/ModuleOrdering.java

@@ -8,6 +8,18 @@
  */
 public interface ModuleOrdering extends InjectExtension {
 
+  /**
+   * Return true if ordering supports the modules passed in.
+   */
+  default boolean supportsExpected(List<AvajeModule> modules) {
+    return true;
+  }
+
+  /**
+   * Accept a module for ordering
+   */
+  void add(AvajeModule module);
+
   /**
    * Order the factories, returning the ordered list of module names.
    */
@@ -23,8 +35,4 @@ public interface ModuleOrdering extends InjectExtension {
    */
   boolean isEmpty();
 
-  /**
-   * Accept a module for ordering
-   */
-  void add(AvajeModule module);
 }