Merge pull request #743 from CJSCommonPlatform/fix-shuttering-then-catchup

Fix problem of shuttering being called twice on catchup

Author: mapingo

CHANGELOG.md

@@ -5,6 +5,12 @@ on [Keep a CHANGELOG](http://keepachangelog.com/). This project adheres to
 
 ## [Unreleased]
 
+## [6.0.0-M37] - 2019-06-25
+### Changed
+- Shuttering executors no longer register themselves but are discovered at system startup and registered
+### Fixed
+- Shuttering is no longer called twice when shuttering for catchup
+
 ## [6.0.0-M36] - 2019-06-21
 ### Added
 - Observers for the shutter then catchup process

event-subscription/src/main/java/uk/gov/justice/subscription/YamlFileFinder.java

@@ -20,7 +20,7 @@ public class YamlFileFinder {
     private static final String EVENT_SOURCE_FILE_NAME = "yaml/event-sources.yaml";
 
     @Inject
-    Logger logger;
+    private Logger logger;
 
     /**
      * Find all yaml/subscriptions-descriptor.yaml resources on the classpath
@@ -47,7 +47,7 @@ private List<URL> findOnClasspath(final String name) throws IOException {
                 .getClassLoader()
                 .getResources(name));
 
-        logger.info(format("Found %s resources on the classpath for %s", urls.size(), name));
+        logger.debug(format("Found %s resources on the classpath for %s", urls.size(), name));
 
         return urls;
     }

event-subscription/src/test/java/uk/gov/justice/subscription/YamlFileFinderTest.java

@@ -48,6 +48,6 @@ public void shouldFindAllEventSourcesOnTheClasspathWhichHaveTheCorrectName() thr
     public void shouldLogFoundResources() throws Exception {
         yamlFileFinder.getSubscriptionsDescriptorsPaths();
 
-        verify(logger).info("Found 1 resources on the classpath for yaml/subscriptions-descriptor.yaml");
+        verify(logger).debug("Found 1 resources on the classpath for yaml/subscriptions-descriptor.yaml");
     }
 }

framework-bom/pom.xml

@@ -63,6 +63,11 @@
                 <artifactId>framework-api-rest-client</artifactId>
                 <version>${framework-api.version}</version>
             </dependency>
+            <dependency>
+                <groupId>uk.gov.justice.services</groupId>
+                <artifactId>framework-utilities</artifactId>
+                <version>${cpp.framework.version}</version>
+            </dependency>
             <dependency>
                 <groupId>uk.gov.justice.services</groupId>
                 <artifactId>common</artifactId>

framework-system/framework-management/pom.xml

@@ -31,6 +31,11 @@
             <artifactId>jmx-command-handling</artifactId>
             <version>${project.version}</version>
         </dependency>
+        <dependency>
+            <groupId>uk.gov.justice.services</groupId>
+            <artifactId>framework-utilities</artifactId>
+            <version>${project.version}</version>
+        </dependency>
 
         <!-- Test Dependencies -->
         <dependency>

framework-system/framework-management/src/main/java/uk/gov/justice/services/management/shuttering/observers/shuttering/ShutterCommandApiObserver.java

@@ -2,13 +2,14 @@
 
 import uk.gov.justice.services.management.shuttering.events.ShutteringProcessStartedEvent;
 import uk.gov.justice.services.management.shuttering.process.CommandApiShutteringBean;
+import uk.gov.justice.services.management.shuttering.startup.ShutteringExecutor;
 
-import javax.annotation.PostConstruct;
 import javax.enterprise.event.Observes;
 import javax.inject.Inject;
 
 import org.slf4j.Logger;
 
+@ShutteringExecutor
 public class ShutterCommandApiObserver {
 
     @Inject
@@ -20,16 +21,11 @@ public class ShutterCommandApiObserver {
     @Inject
     private Logger logger;
 
-    @PostConstruct
-    public void registerAsShutterable() {
-        shutteringRegistry.registerAsShutterable(getClass());
-    }
-
     public void onShutteringProcessStarted(@Observes final ShutteringProcessStartedEvent shutteringProcessStartedEvent) {
 
         logger.info("Shuttering Command API");
 
-        commandApiShutteringBean.shutter(shutteringProcessStartedEvent.getTarget());
+        commandApiShutteringBean.shutter();
 
         logger.info("Shuttering of Command API complete");
 

framework-system/framework-management/src/main/java/uk/gov/justice/services/management/shuttering/observers/shuttering/ShutteringRegistry.java

@@ -2,6 +2,7 @@
 
 
 import static java.lang.String.format;
+import static java.util.stream.Collectors.toList;
 import static uk.gov.justice.services.management.shuttering.observers.shuttering.ShutteringRegistry.ShutteringState.SHUTTERING_COMPLETE;
 import static uk.gov.justice.services.management.shuttering.observers.shuttering.ShutteringRegistry.ShutteringState.SHUTTERING_REQUESTED;
 
@@ -53,12 +54,16 @@ public void shutteringStarted() {
 
     public void markShutteringCompleteFor(final Class<?> shutterable, final SystemCommand target) {
 
+
+        logger.info("Marking shuttering complete for " + shutterable.getSimpleName());
         shutteringStateMap.put(shutterable, SHUTTERING_COMPLETE);
 
         if (allShutteringComplete()) {
+
+            logger.info("All shuttering complete: " + allShutterables.stream().map(Class::getSimpleName).collect(toList()));
             shutteringStateMap.clear();
             shutteringCompleteEventFirer.fire(new ShutteringCompleteEvent(target, clock.now()));
-        }
+        } 
     }
 
     public void clear() {

framework-system/framework-management/src/main/java/uk/gov/justice/services/management/shuttering/observers/unshuttering/UnshutterCommandApiObserver.java

@@ -2,37 +2,33 @@
 
 import uk.gov.justice.services.management.shuttering.events.UnshutteringProcessStartedEvent;
 import uk.gov.justice.services.management.shuttering.process.CommandApiShutteringBean;
+import uk.gov.justice.services.management.shuttering.startup.UnshutteringExecutor;
 
-import javax.annotation.PostConstruct;
 import javax.enterprise.event.Observes;
 import javax.inject.Inject;
 
 import org.slf4j.Logger;
 
+@UnshutteringExecutor
 public class UnshutterCommandApiObserver {
 
     @Inject
     private CommandApiShutteringBean commandApiShutteringBean;
 
     @Inject
-    private UnshutteringRegistry shutteringRegistry;
+    private UnshutteringRegistry unshutteringRegistry;
 
     @Inject
     private Logger logger;
 
-    @PostConstruct
-    public void registerAsUnshutterable() {
-        shutteringRegistry.registerAsUnshutterable(getClass());
-    }
-
     public void onUnshutteringProcessStarted(@Observes final UnshutteringProcessStartedEvent unshutteringProcessStartedEvent) {
 
         logger.info("Unshuttering Command API");
 
-        commandApiShutteringBean.unshutter(unshutteringProcessStartedEvent.getTarget());
+        commandApiShutteringBean.unshutter();
 
         logger.info("Unshuttering of Command API complete");
 
-        shutteringRegistry.markUnshutteringCompleteFor(getClass(), unshutteringProcessStartedEvent.getTarget());
+        unshutteringRegistry.markUnshutteringCompleteFor(getClass(), unshutteringProcessStartedEvent.getTarget());
     }
 }

framework-system/framework-management/src/main/java/uk/gov/justice/services/management/shuttering/observers/unshuttering/UnshutteringRegistry.java

@@ -1,6 +1,7 @@
 package uk.gov.justice.services.management.shuttering.observers.unshuttering;
 
 import static java.lang.String.format;
+import static java.util.stream.Collectors.toList;
 import static uk.gov.justice.services.management.shuttering.observers.unshuttering.UnshutteringRegistry.UnshutteringState.UNSHUTTERING_COMPLETE;
 import static uk.gov.justice.services.management.shuttering.observers.unshuttering.UnshutteringRegistry.UnshutteringState.UNSHUTTERING_REQUESTED;
 
@@ -37,24 +38,26 @@ enum UnshutteringState {
     @Inject
     private Logger logger;
 
-    private final List<Class<?>> allUnshutterables = new ArrayList<>();
+    private final List<Class<?>> allUnshutteringExecutors = new ArrayList<>();
     private final ConcurrentMap<Class<?>, UnshutteringState> unshutteringStateMap = new ConcurrentHashMap<>();
 
-    public void registerAsUnshutterable(final Class<?> unshutterable) {
+    public void registerAsUnshutterable(final Class<?> unshutteringExecutorClass) {
 
-        logger.info(format("Registering %s as unshutterable", unshutterable.getSimpleName()));
-        allUnshutterables.add(unshutterable);
+        logger.info(format("Registering %s as unshuttering executor", unshutteringExecutorClass.getSimpleName()));
+        allUnshutteringExecutors.add(unshutteringExecutorClass);
     }
 
     public void unshutteringStarted() {
-        allUnshutterables.forEach(unshutterableClass -> unshutteringStateMap.put(unshutterableClass, UNSHUTTERING_REQUESTED));
+        allUnshutteringExecutors.forEach(unshutterableClass -> unshutteringStateMap.put(unshutterableClass, UNSHUTTERING_REQUESTED));
     }
 
     public void markUnshutteringCompleteFor(final Class<?> unshutterable, final SystemCommand target) {
 
+        logger.info("Marking unshuttering complete for " + unshutterable.getSimpleName());
         unshutteringStateMap.put(unshutterable, UNSHUTTERING_COMPLETE);
 
         if (allUnshutteringComplete()) {
+            logger.info("All unshuttering complete: " + allUnshutteringExecutors.stream().map(Class::getSimpleName).collect(toList()));
             unshutteringStateMap.clear();
             unshutteringCompleteEventFirer.fire(new UnshutteringCompleteEvent(target, clock.now()));
         }

framework-system/framework-management/src/main/java/uk/gov/justice/services/management/shuttering/process/CommandApiShutteringBean.java

@@ -2,18 +2,13 @@
 
 import static javax.transaction.Transactional.TxType.REQUIRED;
 
-import uk.gov.justice.services.common.util.UtcClock;
-import uk.gov.justice.services.jmx.command.SystemCommand;
-import uk.gov.justice.services.management.shuttering.events.ShutteringCompleteEvent;
-import uk.gov.justice.services.management.shuttering.events.UnshutteringCompleteEvent;
 import uk.gov.justice.services.messaging.jms.EnvelopeSenderSelector;
 import uk.gov.justice.services.shuttering.domain.ShutteredCommand;
 import uk.gov.justice.services.shuttering.persistence.ShutteringRepository;
 
 import java.util.stream.Stream;
 
 import javax.ejb.Stateless;
-import javax.enterprise.event.Event;
 import javax.inject.Inject;
 import javax.transaction.Transactional;
 
@@ -29,30 +24,17 @@ public class CommandApiShutteringBean {
     @Inject
     private ShutteredCommandSender shutteredCommandSender;
 
-    @Inject
-    private Event<ShutteringCompleteEvent> shutteringCompleteEventFirer;
-
-    @Inject
-    private Event<UnshutteringCompleteEvent> unshutteringCompleteEventFirer;
-
-    @Inject
-    private UtcClock clock;
-
-    public void shutter(final SystemCommand target) {
+    public void shutter() {
         envelopeSenderSelector.setShuttered(true);
-
-        shutteringCompleteEventFirer.fire(new ShutteringCompleteEvent(target, clock.now()));
     }
 
     @Transactional(REQUIRED)
-    public void unshutter(final SystemCommand target) {
+    public void unshutter() {
 
         try (final Stream<ShutteredCommand> shutteredCommandStream = shutteringRepository.streamShutteredCommands()) {
             shutteredCommandStream.forEach(shutteredCommandSender::sendAndDelete);
         }
 
         envelopeSenderSelector.setShuttered(false);
-
-        unshutteringCompleteEventFirer.fire(new UnshutteringCompleteEvent(target, clock.now()));
     }
 }