improved logic/design pattern on Microservice deployment

Author: spectralcodex

administration-microservice/src/main/java/io/vertx/easyerp/microservice/administration/AdministrationService.java

@@ -5,15 +5,8 @@
 import io.vertx.codegen.annotations.VertxGen;
 import io.vertx.core.AsyncResult;
 import io.vertx.core.Handler;
-import io.vertx.core.json.JsonObject;
-import io.vertx.core.logging.Logger;
-import io.vertx.core.logging.LoggerFactory;
-import io.vertx.easyerp.microservice.administration.impl.AdministrationImpl;
 import io.vertx.easyerp.microservice.administration.jpojo.User;
 
-import java.sql.ResultSet;
-import java.util.Optional;
-
 /**
  * A service interface managing Users.
  * <p>

administration-microservice/src/main/java/io/vertx/easyerp/microservice/administration/AdministrationVerticle.java

@@ -3,46 +3,92 @@
 import io.vertx.core.DeploymentOptions;
 import io.vertx.core.Future;
 import io.vertx.core.Promise;
-import io.vertx.easyerp.microservice.administration.api.RestAdministrationAPIVerticle;
+import io.vertx.core.json.JsonObject;
+import io.vertx.core.logging.Logger;
+import io.vertx.core.logging.LoggerFactory;
+import io.vertx.easyerp.microservice.administration.api.AdministrationRestAPIVerticle;
 import io.vertx.easyerp.microservice.administration.impl.AdministrationImpl;
 import io.vertx.easyerp.microservice.common.BaseMicroserviceVerticle;
+import static io.vertx.easyerp.microservice.common.config.ConfigRetrieverHelper.configurationRetriever;
 import io.vertx.serviceproxy.ProxyHelper;
 
 public class AdministrationVerticle extends BaseMicroserviceVerticle {
+ private static final long SCAN_PERIOD = 20000L;
+ private static final String PATH = "/conf/vertx.conf";
+ private final static Logger logger = LoggerFactory.getLogger(AdministrationVerticle.class);
 
  @Override
  public void start(Promise<Void> startPromise) throws Exception {
  super.start();
 
- // create the service instance
- AdministrationService service = new AdministrationImpl(vertx, config());
-
- // register the service proxy on event bus NB: must change from ProxyHelper to ServiceBinder
- ProxyHelper.registerService(AdministrationService.class, vertx, service, service.SERVICE_ADDRESS);
-
- /* ping database and-then publish the service in the discovery infrastructure
- */
- pingPersistence(service)
- .compose(databaseOK -> publishEventBusService(service.SERVICE_NAME, service.SERVICE_ADDRESS, AdministrationService.class))
- .compose(servicePublised -> deployRestService(service))
- .onComplete(startPromise);
+ //Smuggling the service instance
+ loadConfigsAndRegisterService(PATH)
+ /* ping database and-then publish the service in the discovery infrastructure
+ */
+ .compose(loadOk -> pingPersistence(loadOk))
+ .compose(databaseOK -> publishEventBusService(AdministrationService.SERVICE_NAME, AdministrationService.SERVICE_ADDRESS, databaseOK))
+ .compose(servicePublisedOk -> deployRestService(servicePublisedOk))
+ .onComplete(startPromise);
  }
 
- private Future<Void> pingPersistence(AdministrationService service){
+ /**
+ * Ping the persistence backend to see if its up
+ *
+ * @param service instance
+ * @return service instance to be used in next stage
+ */
+ private Future<AdministrationService> pingPersistence(final AdministrationService service){
  Promise<Void> initPromise = Promise.promise();
  service.initializePersistence(initPromise);
  return initPromise.future().map(r->{
  ///Perform some init db operations here
- return null;
+ return service;
  });
 
  }
 
+ /**
+ * Deploy the admin microservice
+ *
+ * @param service instance
+ * @return
+ */
  private Future<Void> deployRestService(AdministrationService service){
  Promise<String> promise = Promise.promise();
- vertx.deployVerticle(new RestAdministrationAPIVerticle(service),
+ vertx.deployVerticle(new AdministrationRestAPIVerticle(service),
  new DeploymentOptions().setConfig(config()),
  promise);
- return promise.future().map(r->null);
+ return promise.future().map(
+ ret -> null
+ );
+ }
+
+
+ /**
+ * Load configurations, create and register the service for propagation
+ *
+ * @param path configuration file path
+ * @return service instance to be use in next stage
+ */
+ private Future<AdministrationService> loadConfigsAndRegisterService(final String path) {
+ Promise<JsonObject> initConfigPromise = Promise.promise();
+
+ //get environmental variables using the path provided
+ configurationRetriever
+ .usingScanPeriod(SCAN_PERIOD)
+ .withFileStore(path)
+ .createConfig(vertx)
+ .onComplete(initConfigPromise);
+ return initConfigPromise.future().map(conf -> {
+
+ // create the service instance
+ final AdministrationService service = new AdministrationImpl(vertx, config().mergeIn(conf));
+
+ // register the service proxy on event bus NB: must change from ProxyHelper to ServiceBinder
+ ProxyHelper.registerService(AdministrationService.class, vertx, service, service.SERVICE_ADDRESS);
+
+ logger.info("Initializing config:::" + config());
+ return service;
+ });
  }
 }

administration-microservice/src/main/java/io/vertx/easyerp/microservice/administration/api/RestAdministrationAPIVerticle.java renamed to administration-microservice/src/main/java/io/vertx/easyerp/microservice/administration/api/AdministrationRestAPIVerticle.java

@@ -1,7 +1,6 @@
 package io.vertx.easyerp.microservice.administration.api;
 
-import io.vertx.core.AsyncResult;
-import io.vertx.core.Future;
+
 import io.vertx.core.Promise;
 import io.vertx.core.json.DecodeException;
 import io.vertx.core.json.JsonObject;
@@ -12,9 +11,8 @@
 import io.vertx.ext.web.RoutingContext;
 import io.vertx.ext.web.handler.BodyHandler;
 
-public class RestAdministrationAPIVerticle extends RestAPIVerticle {
+public class AdministrationRestAPIVerticle extends RestAPIVerticle {
  public static final String SERVICE_NAME = "administration-rest-api";
-
  private static final String API_ADD_USER = "/add";
  private static final String API_RETRIEVE_USER_BY_ID = "/user";
  private static final String API_RETRIEVE_ALL_USER = "/users";
@@ -25,7 +23,7 @@ public class RestAdministrationAPIVerticle extends RestAPIVerticle {
 
  private final AdministrationService service;
 
- public RestAdministrationAPIVerticle(AdministrationService service) {
+ public AdministrationRestAPIVerticle(AdministrationService service) {
  this.service = service;
  }
 
@@ -67,6 +65,4 @@ private void apiRetrieveUser(RoutingContext context) {
  String userId = context.request().getParam("userId");
  service.retrieveUser(userId, resultHandlerNonEmpty(context));
  }
-
-
 }