#13 - Support priority of @primary and @secondary across modules

rbygrave · rbygrave · commit 57820ee3a0ba · 2018-11-29T22:19:20.000+13:00
diff --git a/src/main/java/io/dinject/BeanEntry.java b/src/main/java/io/dinject/BeanEntry.java
@@ -5,6 +5,26 @@
  */
 public class BeanEntry<T> {
 
+  /**
+   * An explicitly supplied bean. See BootContext.
+   */
+  public static final int SUPPLIED = 2;
+
+  /**
+   * An <code>@Primary</code> bean.
+   */
+  public static final int PRIMARY = 1;
+
+  /**
+   * A normal priority bean.
+   */
+  public static final int NORMAL = 0;
+
+  /**
+   * A <code>@Secondary</code> bean.
+   */
+  public static final int SECONDARY = -1;
+
   private final int priority;
 
   private final T bean;
@@ -40,4 +60,48 @@ public T getBean() {
   public String getName() {
     return name;
   }
+
+  /**
+   * Return true if this entry has Supplied priority.
+   */
+  public boolean isSupplied() {
+    return priority == SUPPLIED;
+  }
+
+  /**
+   * Return true if this entry has Primary priority.
+   */
+  public boolean isPrimary() {
+    return priority == PRIMARY;
+  }
+
+  /**
+   * Return true if this entry has Secondary priority.
+   */
+  public boolean isSecondary() {
+    return priority == SECONDARY;
+  }
+
+  @Override
+  public String toString() {
+    StringBuilder sb = new StringBuilder();
+    sb.append("{bean:").append(bean);
+    if (name != null) {
+      sb.append(", name:").append(name);
+    }
+    switch (priority) {
+      case SUPPLIED:
+        sb.append(", Supplied");
+        break;
+      case PRIMARY:
+        sb.append(", @Primary");
+        break;
+      case SECONDARY:
+        sb.append(", @Secondary");
+        break;
+      default:
+        sb.append(", Normal");
+    }
+    return sb.append("}").toString();
+  }
 }
diff --git a/src/main/java/io/dinject/BootContext.java b/src/main/java/io/dinject/BootContext.java
@@ -180,7 +180,7 @@ public BootContext withBeans(Object... beans) {
   public BeanContext load() {
 
     // sort factories by dependsOn
-    FactoryOrder factoryOrder = new FactoryOrder(includeModules);
+    FactoryOrder factoryOrder = new FactoryOrder(includeModules, !suppliedBeans.isEmpty());
     ServiceLoader.load(BeanContextFactory.class).forEach(factoryOrder::add);
 
     Set<String> moduleNames = factoryOrder.orderFactories();
@@ -307,15 +307,17 @@ void shutdown() {
   static class FactoryOrder {
 
     private final Set<String> includeModules;
+    private final boolean suppliedBeans;
 
     private final Set<String> moduleNames = new LinkedHashSet<>();
     private final List<BeanContextFactory> factories = new ArrayList<>();
     private final List<FactoryState> queue = new ArrayList<>();
 
     private final Map<String,FactoryList> providesMap = new HashMap<>();
 
-    FactoryOrder(Set<String> includeModules) {
+    FactoryOrder(Set<String> includeModules, boolean suppliedBeans) {
       this.includeModules = includeModules;
+      this.suppliedBeans = suppliedBeans;
     }
 
     void add(BeanContextFactory factory) {
@@ -382,7 +384,14 @@ private void processQueue() {
         count = processQueuedFactories();
       } while (count > 0);
 
-      if (!queue.isEmpty()) {
+      if (suppliedBeans) {
+        // just push everything left assuming supplied beans
+        // will satisfy the required dependencies
+        for (FactoryState factoryState : queue) {
+          push(factoryState);
+        }
+
+      } else  if (!queue.isEmpty()) {
         StringBuilder sb = new StringBuilder();
         for (FactoryState factory : queue) {
           sb.append("module ").append(factory.getName()).append(" has unsatisfied dependencies - ");
diff --git a/src/main/java/io/dinject/core/Builder.java b/src/main/java/io/dinject/core/Builder.java
@@ -1,6 +1,7 @@
 package io.dinject.core;
 
 import io.dinject.BeanContext;
+import io.dinject.BeanEntry;
 
 import java.util.List;
 import java.util.Optional;
@@ -115,9 +116,9 @@ public interface Builder {
   <T> List<T> getList(Class<T> interfaceType);
 
   /**
-   * Get a named dependency allowing it to be null.
+   * Get a candidate dependency allowing it to be null.
    */
-  <T> T getMaybe(Class<T> cls, String name);
+  <T> BeanEntry<T> candidate(Class<T> cls, String name);
 
   /**
    * Build and return the bean context.
diff --git a/src/main/java/io/dinject/core/DBeanContext.java b/src/main/java/io/dinject/core/DBeanContext.java
@@ -69,10 +69,8 @@ public <T> BeanEntry<T> candidate(Class<T> type, String name) {
     return entrySort.get();
   }
 
-  @SuppressWarnings("unchecked")
   @Override
   public <T> T getBean(Class<T> beanClass, String name) {
-
     BeanEntry<T> candidate = candidate(beanClass, name);
     return (candidate == null) ? null : candidate.getBean();
   }
@@ -132,46 +130,58 @@ public void close() {
     }
   }
 
-  private static class EntrySort<T> {
+  static class EntrySort<T> {
 
+    private BeanEntry<T> supplied;
     private BeanEntry<T> primary;
     private int primaryCount;
     private BeanEntry<T> secondary;
     private int secondaryCount;
     private BeanEntry<T> normal;
     private int normalCount;
 
-    void add(BeanEntry<T> candidate) {
+    private final List<BeanEntry<T>> all = new ArrayList<>();
 
-      if (candidate != null) {
-        if (candidate.getPriority() == Flag.PRIMARY) {
-          primary = candidate;
-          primaryCount++;
-        } else if (candidate.getPriority() == Flag.SECONDARY) {
-          secondary = candidate;
-          secondaryCount++;
-        } else {
-          normal = candidate;
-          normalCount++;
-        }
+    void add(BeanEntry<T> candidate) {
+      if (candidate == null) {
+        return;
+      }
+      if (candidate.isSupplied()) {
+        // a supplied bean trumps all
+        supplied = candidate;
+        return;
+      }
+      all.add(candidate);
+      if (candidate.isPrimary()) {
+        primary = candidate;
+        primaryCount++;
+      } else if (candidate.isSecondary()) {
+        secondary = candidate;
+        secondaryCount++;
+      } else {
+        normal = candidate;
+        normalCount++;
       }
     }
 
     BeanEntry<T> get() {
+      if (supplied != null) {
+        return supplied;
+      }
       if (primaryCount > 1) {
-        throw new IllegalStateException("Multiple @Primary beans when only expecting one? Last was: " + primary);
+        throw new IllegalStateException("Multiple @Primary beans when only expecting one? Beans: " + all);
       }
       if (primaryCount == 1) {
         return primary;
       }
       if (normalCount > 1) {
-        throw new IllegalStateException("Multiple beans when only expecting one? Maybe use @Primary or @Secondary? Last was: " + normal);
+        throw new IllegalStateException("Multiple beans when only expecting one? Maybe use @Primary or @Secondary? Beans: " + all);
       }
       if (normalCount == 1) {
         return normal;
       }
       if (secondaryCount > 1) {
-        throw new IllegalStateException("Multiple @Secondary beans when only expecting one? Last was: " + primary);
+        throw new IllegalStateException("Multiple @Secondary beans when only expecting one? Beans: " + all);
       }
       return secondary;
     }
diff --git a/src/main/java/io/dinject/core/DBeanMap.java b/src/main/java/io/dinject/core/DBeanMap.java
@@ -7,9 +7,10 @@
 import java.util.List;
 import java.util.Map;
 
-import static io.dinject.core.Flag.NORMAL;
-import static io.dinject.core.Flag.PRIMARY;
-import static io.dinject.core.Flag.SECONDARY;
+import static io.dinject.BeanEntry.NORMAL;
+import static io.dinject.BeanEntry.PRIMARY;
+import static io.dinject.BeanEntry.SECONDARY;
+import static io.dinject.BeanEntry.SUPPLIED;
 
 /**
  * Map of types (class types, interfaces and annotations) to a DContextEntry where the
@@ -51,7 +52,7 @@ private void addSuppliedBean(Object bean) {
     Named annotation = suppliedClass.getAnnotation(Named.class);
     String name = (annotation == null) ? null : annotation.value();
 
-    DContextEntryBean entryBean = DContextEntryBean.of(bean, name, PRIMARY);
+    DContextEntryBean entryBean = DContextEntryBean.of(bean, name, SUPPLIED);
     beans.computeIfAbsent(suppliedType.getCanonicalName(), s -> new DContextEntry()).add(entryBean);
     for (Class<?> anInterface : suppliedClass.getInterfaces()) {
       beans.computeIfAbsent(anInterface.getCanonicalName(), s -> new DContextEntry()).add(entryBean);
diff --git a/src/main/java/io/dinject/core/DBuilder.java b/src/main/java/io/dinject/core/DBuilder.java
@@ -1,6 +1,7 @@
 package io.dinject.core;
 
 import io.dinject.BeanContext;
+import io.dinject.BeanEntry;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -137,36 +138,31 @@ public <T> List<T> getList(Class<T> interfaceType) {
   }
 
   @Override
-  public <T> T getMaybe(Class<T> beanClass, String name) {
+  public <T> BeanEntry<T> candidate(Class<T> cls, String name) {
 
-    T bean;
     if (suppliedBeanMap != null) {
-      bean = suppliedBeanMap.getBean(beanClass, name);
-      if (bean != null) {
-        return bean;
+      BeanEntry<T> entry = suppliedBeanMap.candidate(cls, name);
+      if (entry != null) {
+        return entry;
       }
     }
 
-    // look locally first
-    bean = beanMap.getBean(beanClass, name);
-    if (bean != null) {
-      return bean;
-    }
-
-    // look in child context
+    DBeanContext.EntrySort<T> entrySort = new DBeanContext.EntrySort<>();
+    entrySort.add(beanMap.candidate(cls, name));
     for (BeanContext childContext : children.values()) {
-      bean = childContext.getBean(beanClass);
-      if (bean != null) {
-        return bean;
-      }
+      entrySort.add(childContext.candidate(cls, name));
     }
 
     if (parent != null) {
       // look in parent context (cross-module dependency)
-      return parent.getMaybe(beanClass, name);
+      entrySort.add(parent.candidate(cls, name));
     }
+    return entrySort.get();
+  }
 
-    return null;
+  private <T> T getMaybe(Class<T> beanClass, String name) {
+    BeanEntry<T> entry = candidate(beanClass, name);
+    return (entry == null) ? null : entry.getBean();
   }
 
   @Override
diff --git a/src/main/java/io/dinject/core/DContextEntryBean.java b/src/main/java/io/dinject/core/DContextEntryBean.java
@@ -59,11 +59,11 @@ Object getIfMatchWithDefault(String name) {
   }
 
   boolean isPrimary() {
-    return flag == Flag.PRIMARY;
+    return flag == BeanEntry.PRIMARY;
   }
 
   boolean isSecondary() {
-    return flag == Flag.SECONDARY;
+    return flag == BeanEntry.SECONDARY;
   }
 
   @SuppressWarnings("unchecked")
diff --git a/src/main/java/io/dinject/core/Flag.java b/src/main/java/io/dinject/core/Flag.java
diff --git a/src/test/java/io/dinject/BootContextTest.java b/src/test/java/io/dinject/BootContextTest.java
@@ -15,7 +15,7 @@ public class BootContextTest {
   @Test
   public void noDepends() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("1", null, null));
     factoryOrder.add(bc("2", null, null));
     factoryOrder.add(bc("3", null, null));
@@ -27,7 +27,7 @@ public void noDepends() {
   @Test
   public void name_depends() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("two", null, "one"));
     factoryOrder.add(bc("one", null, null));
     factoryOrder.orderFactories();
@@ -38,7 +38,7 @@ public void name_depends() {
   @Test
   public void name_depends4() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("1", null, "3"));
     factoryOrder.add(bc("2", null, "4"));
     factoryOrder.add(bc("3", null, "4"));
@@ -52,7 +52,7 @@ public void name_depends4() {
   @Test
   public void nameFeature_depends() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("1", "a", "3"));
     factoryOrder.add(bc("2", null, "4,a"));
     factoryOrder.add(bc("3", null, "4"));
@@ -66,7 +66,7 @@ public void nameFeature_depends() {
   @Test
   public void feature_depends() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("two", null, "myfeature"));
     factoryOrder.add(bc("one", "myfeature", null));
     factoryOrder.orderFactories();
@@ -77,7 +77,7 @@ public void feature_depends() {
   @Test
   public void feature_depends2() {
 
-    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet());
+    BootContext.FactoryOrder factoryOrder = new BootContext.FactoryOrder(Collections.emptySet(), true);
     factoryOrder.add(bc("two", null, "myfeature"));
     factoryOrder.add(bc("one", "myfeature", null));
     factoryOrder.add(bc("three", "myfeature", null));

Original file line number	Diff line number	Diff line change
`@@ -59,11 +59,11 @@ Object getIfMatchWithDefault(String name) {`
`59`	`59`	`}`
`60`	`60`
`61`	`61`	`boolean isPrimary() {`
`62`		`- return flag == Flag.PRIMARY;`
	`62`	`+ return flag == BeanEntry.PRIMARY;`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`boolean isSecondary() {`
`66`		`- return flag == Flag.SECONDARY;`
	`66`	`+ return flag == BeanEntry.SECONDARY;`
`67`	`67`	`}`
`68`	`68`
`69`	`69`	`@SuppressWarnings("unchecked")`