graceful shutdown

Author: Alexander Furer

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/GRpcServerRunner.java

@@ -7,7 +7,6 @@
 import lombok.extern.slf4j.Slf4j;
 import org.lognet.springboot.grpc.autoconfigure.GRpcServerProperties;
 import org.lognet.springboot.grpc.context.GRpcServerInitializedEvent;
-import org.lognet.springboot.grpc.context.GRpcServerStoppedEvent;
 import org.springframework.beans.factory.BeanCreationException;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -154,7 +153,6 @@ public void destroy() throws Exception {
         server.getServices().forEach(def->healthStatusManager.clearStatus(def.getServiceDescriptor().getName()));
         Optional.ofNullable(server).ifPresent(Server::shutdown);
         log.info("gRPC server stopped.");
-        applicationContext.publishEvent(new GRpcServerStoppedEvent(applicationContext,server));
     }
 
     private <T> Stream<String> getBeanNamesByTypeWithAnnotation(Class<? extends Annotation> annotationType, Class<T> beanType) throws Exception {

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/ConsulGrpcAutoConfiguration.java

@@ -14,11 +14,12 @@
 @Configuration
 @ConditionalOnClass(ConsulServiceRegistry.class)
 @AutoConfigureAfter({ ConsulServiceRegistryAutoConfiguration.class, GRpcAutoConfiguration.class})
+@ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true)
+@ConditionalOnBean({ConsulServiceRegistry.class, GRpcServerRunner.class})
 public class ConsulGrpcAutoConfiguration{
 
 
-    @ConditionalOnProperty(value = "spring.cloud.service-registry.auto-registration.enabled", matchIfMissing = true)
-    @ConditionalOnBean({ConsulServiceRegistry.class, GRpcServerRunner.class})
+
     @Bean
     public GrpcConsulRegistrar consulRegistrar(ConsulServiceRegistry consulServiceRegistry){
         return new GrpcConsulRegistrar(consulServiceRegistry);

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/autoconfigure/consul/GrpcConsulRegistrar.java

@@ -2,16 +2,15 @@
 
 import com.ecwid.consul.v1.agent.model.NewService;
 import org.lognet.springboot.grpc.context.GRpcServerInitializedEvent;
-import org.lognet.springboot.grpc.context.GRpcServerStoppedEvent;
-import org.lognet.springboot.grpc.context.GrpcServerEvent;
 import org.springframework.cloud.consul.discovery.ConsulDiscoveryProperties;
 import org.springframework.cloud.consul.serviceregistry.ConsulAutoRegistration;
 import org.springframework.cloud.consul.serviceregistry.ConsulRegistration;
 import org.springframework.cloud.consul.serviceregistry.ConsulServiceRegistry;
 import org.springframework.context.ApplicationContext;
+import org.springframework.context.SmartLifecycle;
 import org.springframework.context.event.EventListener;
 
-public class GrpcConsulRegistrar {
+public class GrpcConsulRegistrar implements SmartLifecycle {
 
     private ConsulRegistration registration;
     private ConsulServiceRegistry consulServiceRegistry;
@@ -25,16 +24,9 @@ public void onGrpcServerStarted(GRpcServerInitializedEvent initializedEvent) {
         registration = getRegistration(initializedEvent);
         consulServiceRegistry.register(registration);
     }
-    @EventListener
-    public void onGrpcServerStopped(GRpcServerStoppedEvent initializedEvent) {
-
-        consulServiceRegistry.deregister(registration);
-        consulServiceRegistry.close();
-    }
-
 
 
-    private ConsulRegistration getRegistration(GrpcServerEvent event) {
+    private ConsulRegistration getRegistration(GRpcServerInitializedEvent event) {
         ApplicationContext applicationContext = event.getApplicationContext();
 
 
@@ -47,7 +39,7 @@ private ConsulRegistration getRegistration(GrpcServerEvent event) {
         }
         String appName = "grpc_" + ConsulAutoRegistration.getAppName(properties, applicationContext.getEnvironment());
         grpcService.setName(ConsulAutoRegistration.normalizeForDns(appName));
-        grpcService.setId("grpc_" +ConsulAutoRegistration.getInstanceId(properties, applicationContext));
+        grpcService.setId("grpc_" + ConsulAutoRegistration.getInstanceId(properties, applicationContext));
 
 /*
         service.setTags(createTags(properties));
@@ -65,4 +57,38 @@ private ConsulRegistration getRegistration(GrpcServerEvent event) {
     }
 
 
+    @Override
+    public boolean isAutoStartup() {
+        return false;
+    }
+
+    @Override
+    public void stop(Runnable callback) {
+        stop();
+        callback.run();
+    }
+
+    @Override
+    public void start() {
+
+    }
+
+    @Override
+    public synchronized void stop() {
+
+        consulServiceRegistry.deregister(registration);
+        consulServiceRegistry.close();
+        registration = null;
+
+    }
+
+    @Override
+    public synchronized boolean isRunning() {
+        return null != registration;
+    }
+
+    @Override
+    public int getPhase() {
+        return 0;
+    }
 }

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/context/GRpcServerInitializedEvent.java

@@ -2,8 +2,9 @@
 
 import io.grpc.Server;
 import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationEvent;
 
-public class GRpcServerInitializedEvent extends GrpcServerEvent {
+public class GRpcServerInitializedEvent extends ApplicationEvent {
     private Server server;
 
     public GRpcServerInitializedEvent(ApplicationContext context,Server server) {
@@ -14,6 +15,7 @@ public GRpcServerInitializedEvent(ApplicationContext context,Server server) {
     public ApplicationContext getApplicationContext(){
         return (ApplicationContext) getSource();
     }
+
     public Server getServer(){
         return server;
     }

grpc-spring-boot-starter/src/main/java/org/lognet/springboot/grpc/context/GRpcServerStoppedEvent.java

@@ -1,21 +1,18 @@
 package org.lognet.springboot.grpc;
 
-import com.pszymczyk.consul.junit.ConsulResource;
 import io.grpc.ManagedChannel;
 import io.grpc.ManagedChannelBuilder;
 import io.grpc.examples.GreeterGrpc;
 import io.grpc.examples.GreeterOuterClass;
-import org.junit.AfterClass;
-import org.junit.ClassRule;
 import org.junit.Test;
 import org.junit.runner.RunWith;
 import org.lognet.springboot.grpc.demo.DemoApp;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.cloud.client.ServiceInstance;
 import org.springframework.cloud.client.discovery.DiscoveryClient;
+import org.springframework.context.ConfigurableApplicationContext;
 import org.springframework.test.context.junit4.SpringRunner;
-import org.springframework.util.SocketUtils;
 
 import java.util.List;
 import java.util.concurrent.ExecutionException;
@@ -25,23 +22,30 @@
 
 
 @RunWith(SpringRunner.class)
-@SpringBootTest(classes = DemoApp.class, properties = {"spring.cloud.config.enabled:false"})
+@SpringBootTest(classes = DemoApp.class, properties = {"spring.cloud.config.enabled:false"}
+,webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT
+)
+
 public class ConsulRegistrationTest {
+//    @ClassRule
+//    public static final ConsulResource consul(){
+//        int port = SocketUtils.findAvailableTcpPort();
+//        ConsulResource consulResource = new ConsulResource(port);
+//        System.setProperty("spring.cloud.consul.port",String.valueOf(port));
+//        return consulResource;
+//    }
+//    @AfterClass
+//    public  static void clear(){
+//        System.clearProperty("spring.cloud.consul.port");
+//    }
+
+
 
-    @ClassRule
-    public static final ConsulResource consul(){
-        int port = SocketUtils.findAvailableTcpPort();
-        ConsulResource consulResource = new ConsulResource(port);
-        System.setProperty("spring.cloud.consul.port",String.valueOf(port));
-        return consulResource;
-    }
-    @AfterClass
-    public  static void clear(){
-        System.clearProperty("spring.cloud.consul.port");
-    }
 
     @Autowired
     private DiscoveryClient discoveryClient;
+    @Autowired
+    ConfigurableApplicationContext applicationContext;
 
     @Test
     public void contextLoads() throws ExecutionException, InterruptedException {
@@ -57,5 +61,6 @@ public void contextLoads() throws ExecutionException, InterruptedException {
         final GreeterOuterClass.HelloRequest helloRequest =GreeterOuterClass.HelloRequest.newBuilder().setName("Bob").build();
         final String reply = greeterFutureStub.sayHello(helloRequest).get().getMessage();
         assertNotNull("Replay should not be null",reply);
+        applicationContext.stop();
     }
 }