JAMES-2854 ConfigurationPerformer should be bound to a single startable

Loops are supported by injection framework through stubbing. However, this does not play well with the "initialization will follow injection path" strategy: some modules might try to init against "not yet initialized" components that were stubbed by the init strategy. The issue here is that multi-components configuration performers adds additional complexity, and creates dependencies (init A & B at the same time) that lead to failures while modifying some injections. Saying "1 startable = 1 performer" prevents us from this, and fits our usage.
apache · Aug 20, 2019 · 7faac28 · 7faac28
1 parent 2137385
commit 7faac28
Show file tree

Hide file tree

Showing 31 changed files with 107 additions and 253 deletions.
diff --git a/...assandra-guice/src/main/java/org/apache/james/modules/data/CassandraDomainListModule.java b/...assandra-guice/src/main/java/org/apache/james/modules/data/CassandraDomainListModule.java
@@ -18,8 +18,6 @@
  ****************************************************************/
 package org.apache.james.modules.data;
 
-import java.util.List;
-
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.james.backends.cassandra.components.CassandraModule;
 import org.apache.james.domainlist.api.DomainList;
@@ -29,7 +27,6 @@
 import org.apache.james.server.core.configuration.ConfigurationProvider;
 import org.apache.james.utils.ConfigurationPerformer;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Provides;
@@ -59,7 +56,6 @@ public DomainListConfiguration provideDomainListConfiguration(ConfigurationProvi
 
     @Singleton
     public static class CassandraDomainListConfigurationPerformer implements ConfigurationPerformer {
-
         private final DomainListConfiguration configuration;
         private final CassandraDomainList cassandraDomainList;
 
@@ -79,8 +75,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(CassandraDomainList.class);
+        public Class<? extends Startable> forClass() {
+            return CassandraDomainList.class;
         }
     }
 }
diff --git a/...ice/src/main/java/org/apache/james/modules/data/CassandraRecipientRewriteTableModule.java b/...ice/src/main/java/org/apache/james/modules/data/CassandraRecipientRewriteTableModule.java
@@ -18,8 +18,6 @@
  ****************************************************************/
 package org.apache.james.modules.data;
 
-import java.util.List;
-
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.james.backends.cassandra.components.CassandraModule;
 import org.apache.james.lifecycle.api.Startable;
@@ -31,7 +29,6 @@
 import org.apache.james.server.core.configuration.ConfigurationProvider;
 import org.apache.james.utils.ConfigurationPerformer;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Scopes;
@@ -53,7 +50,6 @@ public void configure() {
 
     @Singleton
     public static class CassandraRecipientRewriteTablePerformer implements ConfigurationPerformer {
-
         private final ConfigurationProvider configurationProvider;
         private final CassandraRecipientRewriteTable recipientRewriteTable;
 
@@ -73,8 +69,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(CassandraRecipientRewriteTable.class);
+        public Class<? extends Startable> forClass() {
+            return CassandraRecipientRewriteTable.class;
         }
     }
 

diff --git a/...dra-guice/src/main/java/org/apache/james/modules/data/CassandraUsersRepositoryModule.java b/...dra-guice/src/main/java/org/apache/james/modules/data/CassandraUsersRepositoryModule.java
@@ -18,8 +18,6 @@
  ****************************************************************/
 package org.apache.james.modules.data;
 
-import java.util.List;
-
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.james.backends.cassandra.components.CassandraModule;
 import org.apache.james.lifecycle.api.Startable;
@@ -28,7 +26,6 @@
 import org.apache.james.user.cassandra.CassandraUsersRepository;
 import org.apache.james.utils.ConfigurationPerformer;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Scopes;
@@ -68,8 +65,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(CassandraUsersRepository.class);
+        public Class<? extends Startable> forClass() {
+            return CassandraUsersRepository.class;
         }
     }
 

diff --git a/...ndra-guice/src/main/java/org/apache/james/modules/mailbox/ElasticSearchMailboxModule.java b/...ndra-guice/src/main/java/org/apache/james/modules/mailbox/ElasticSearchMailboxModule.java
@@ -23,7 +23,6 @@
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.util.List;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -53,7 +52,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provides;
 import com.google.inject.Scopes;
@@ -86,7 +84,6 @@ void createIndex() throws IOException {
     }
 
     static class ElasticSearchMailboxIndexCreationPerformer implements ConfigurationPerformer {
-
         private final MailboxIndexCreator mailboxIndexCreator;
 
         @Inject
@@ -104,8 +101,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(MailboxIndexCreator.class);
+        public Class<? extends Startable> forClass() {
+            return MailboxIndexCreator.class;
         }
     }
 

diff --git a/...uice/src/main/java/org/apache/james/modules/mailbox/ElasticSearchQuotaSearcherModule.java b/...uice/src/main/java/org/apache/james/modules/mailbox/ElasticSearchQuotaSearcherModule.java
@@ -23,7 +23,6 @@
 
 import java.io.FileNotFoundException;
 import java.io.IOException;
-import java.util.List;
 
 import javax.inject.Inject;
 
@@ -45,7 +44,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Provides;
 import com.google.inject.Singleton;
@@ -95,8 +93,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(ElasticSearchQuotaIndexCreator.class);
+        public Class<? extends Startable> forClass() {
+            return ElasticSearchQuotaIndexCreator.class;
         }
     }
 

diff --git a/...assandra-guice/src/main/java/org/apache/james/modules/metrics/CassandraMetricsModule.java b/...assandra-guice/src/main/java/org/apache/james/modules/metrics/CassandraMetricsModule.java
@@ -19,14 +19,11 @@
 
 package org.apache.james.modules.metrics;
 
-import java.util.List;
-
 import org.apache.james.lifecycle.api.Startable;
 import org.apache.james.utils.ConfigurationPerformer;
 
 import com.codahale.metrics.MetricRegistry;
 import com.datastax.driver.core.Session;
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Scopes;
@@ -44,7 +41,7 @@ protected void configure() {
             .to(CassandraMetricsInjector.class);
     }
 
-    public static class CassandraMetricsInjector implements ConfigurationPerformer {
+    public static class CassandraMetricsInjector implements ConfigurationPerformer, Startable {
 
         private final MetricRegistry metricRegistry;
         private final Session session;
@@ -64,8 +61,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of();
+        public Class<? extends Startable> forClass() {
+            return CassandraMetricsInjector.class;
         }
     }
 }
diff --git a/...assandra-guice/src/test/java/org/apache/james/CassandraMessageIdManagerInjectionTest.java b/...assandra-guice/src/test/java/org/apache/james/CassandraMessageIdManagerInjectionTest.java
@@ -22,8 +22,6 @@
 import static org.apache.james.CassandraJamesServerMain.ALL_BUT_JMX_CASSANDRA_MODULE;
 import static org.assertj.core.api.Assertions.assertThatCode;
 
-import java.util.List;
-
 import javax.inject.Inject;
 
 import org.apache.james.lifecycle.api.Startable;
@@ -35,7 +33,6 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.multibindings.Multibinder;
 
 class CassandraMessageIdManagerInjectionTest {
@@ -60,7 +57,7 @@ void messageIdManagerShouldBeInjected(GuiceJamesServer server) {
         assertThatCode(server::start).doesNotThrowAnyException();
     }
 
-    public static class CallMe implements ConfigurationPerformer {
+    public static class CallMe implements ConfigurationPerformer, Startable {
         @Inject
         public CallMe(MessageIdManager messageIdManager) {
         }
@@ -71,8 +68,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of();
+        public Class<? extends Startable> forClass() {
+            return CallMe.class;
         }
     }
 }
diff --git a/...e/cassandra-ldap-guice/src/main/java/org/apache/james/data/LdapUsersRepositoryModule.java b/...e/cassandra-ldap-guice/src/main/java/org/apache/james/data/LdapUsersRepositoryModule.java
@@ -18,8 +18,6 @@
  ****************************************************************/
 package org.apache.james.data;
 
-import java.util.List;
-
 import org.apache.commons.configuration2.ex.ConfigurationException;
 import org.apache.james.lifecycle.api.Startable;
 import org.apache.james.server.core.configuration.ConfigurationProvider;
@@ -28,7 +26,6 @@
 import org.apache.james.user.ldap.ReadOnlyUsersLDAPRepository;
 import org.apache.james.utils.ConfigurationPerformer;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Provides;
@@ -76,8 +73,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(ReadOnlyUsersLDAPRepository.class);
+        public Class<? extends Startable> forClass() {
+            return ReadOnlyUsersLDAPRepository.class;
         }
     }
 

diff --git a/...a-rabbitmq-guice/src/main/java/org/apache/james/modules/event/RabbitMQEventBusModule.java b/...a-rabbitmq-guice/src/main/java/org/apache/james/modules/event/RabbitMQEventBusModule.java
@@ -19,8 +19,6 @@
 
 package org.apache.james.modules.event;
 
-import java.util.List;
-
 import org.apache.james.event.json.EventSerializer;
 import org.apache.james.lifecycle.api.Startable;
 import org.apache.james.mailbox.events.EventBus;
@@ -29,7 +27,6 @@
 import org.apache.james.mailbox.events.RegistrationKey;
 import org.apache.james.mailbox.events.RetryBackoffConfiguration;
 import org.apache.james.utils.ConfigurationPerformer;
-import org.parboiled.common.ImmutableList;
 
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
@@ -68,8 +65,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(RabbitMQEventBus.class);
+        public Class<? extends Startable> forClass() {
+            return RabbitMQEventBus.class;
         }
     }
 }
diff --git a/...iner/guice/configuration/src/main/java/org/apache/james/utils/ConfigurationPerformer.java b/...iner/guice/configuration/src/main/java/org/apache/james/utils/ConfigurationPerformer.java
@@ -19,8 +19,6 @@
 
 package org.apache.james.utils;
 
-import java.util.List;
-
 import org.apache.james.lifecycle.api.Startable;
 
 public interface ConfigurationPerformer {
@@ -30,11 +28,9 @@ public interface ConfigurationPerformer {
     /**
      * In order to initialize components in the right order, every
      * {@link ConfigurationPerformer} is supposed to declare which
-     * classes it will initialize.
+     * class it will initialize.
      *
-     * @return the list of Classes that this object will initialize.
-     *  The list should never be empty.
+     * @return the Class that this object will initialize.
      */
-    List<Class<? extends Startable>> forClasses();
-
+    Class<? extends Startable> forClass();
 }
diff --git a/...rter/src/main/java/org/apache/james/modules/server/ElasticSearchMetricReporterModule.java b/...rter/src/main/java/org/apache/james/modules/server/ElasticSearchMetricReporterModule.java
@@ -20,7 +20,6 @@
 package org.apache.james.modules.server;
 
 import java.io.FileNotFoundException;
-import java.util.List;
 
 import org.apache.commons.configuration2.Configuration;
 import org.apache.commons.configuration2.ex.ConfigurationException;
@@ -32,7 +31,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Provides;
@@ -87,7 +85,6 @@ private boolean isMetricEnable(Configuration propertiesReader) {
 
     @Singleton
     public static class ESMetricReporterStarter implements ConfigurationPerformer {
-
         private final ESMetricReporter esMetricReporter;
 
         @Inject
@@ -101,8 +98,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(ESMetricReporter.class);
+        public Class<? extends Startable> forClass() {
+            return ESMetricReporter.class;
         }
     }
 

diff --git a/...er/guice/guice-common/src/main/java/org/apache/james/modules/server/DNSServiceModule.java b/...er/guice/guice-common/src/main/java/org/apache/james/modules/server/DNSServiceModule.java
@@ -18,15 +18,12 @@
  ****************************************************************/
 package org.apache.james.modules.server;
 
-import java.util.List;
-
 import org.apache.james.dnsservice.api.DNSService;
 import org.apache.james.dnsservice.dnsjava.DNSJavaService;
 import org.apache.james.lifecycle.api.Startable;
 import org.apache.james.server.core.configuration.ConfigurationProvider;
 import org.apache.james.utils.ConfigurationPerformer;
 
-import com.google.common.collect.ImmutableList;
 import com.google.inject.AbstractModule;
 import com.google.inject.Inject;
 import com.google.inject.Scopes;
@@ -66,8 +63,8 @@ public void initModule() {
         }
 
         @Override
-        public List<Class<? extends Startable>> forClasses() {
-            return ImmutableList.of(DNSJavaService.class);
+        public Class<? extends Startable> forClass() {
+            return DNSJavaService.class;
         }
     }
 }