Make grpc-services.jar optional + remove grpc health service setup

Author: ST-DDT

build.gradle

@@ -79,6 +79,12 @@ allprojects {
     apply plugin: 'com.diffplug.spotless'
     apply plugin: 'io.franzbecker.gradle-lombok'
 
+	java {
+	    toolchain {
+	        languageVersion = JavaLanguageVersion.of(8)
+	    }
+	}
+
     compileJava {
         sourceCompatibility = JavaVersion.VERSION_1_8
         targetCompatibility = JavaVersion.VERSION_1_8
@@ -89,6 +95,13 @@ allprojects {
         '-Xlint:all', '-Xlint:-processing'
     ]
 
+    eclipse {
+        classpath {
+            downloadJavadoc = true
+            downloadSources = true
+        }
+    }
+
     spotless {
         java {
             licenseHeaderFile rootProject.file('extra/spotless/mit-license.java')

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/autoconfigure/GrpcReflectionServiceAutoConfiguration.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.server.autoconfigure;
+
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+import io.grpc.BindableService;
+import io.grpc.protobuf.services.ProtoReflectionService;
+import net.devh.boot.grpc.server.service.GrpcService;
+
+/**
+ * Auto configuration that sets up the proto reflection service.
+ *
+ * @author Daniel Theuke ([email protected])
+ */
+@Configuration
+@ConditionalOnClass(ProtoReflectionService.class)
+@ConditionalOnProperty(prefix = "grpc.server", name = "reflection-service-enabled", matchIfMissing = true)
+@AutoConfigureBefore(GrpcServerFactoryAutoConfiguration.class)
+public class GrpcReflectionServiceAutoConfiguration {
+
+    /**
+     * Creates a new ProtoReflectionService instance.
+     *
+     * @return The newly created bean.
+     */
+    @Bean
+    @GrpcService
+    BindableService protoReflectionService() {
+        return ProtoReflectionService.newInstance();
+    }
+
+}

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/autoconfigure/GrpcServerAutoConfiguration.java

@@ -33,7 +33,6 @@
 import io.grpc.CompressorRegistry;
 import io.grpc.DecompressorRegistry;
 import io.grpc.Server;
-import io.grpc.services.HealthStatusManager;
 import net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration;
 import net.devh.boot.grpc.server.config.GrpcServerProperties;
 import net.devh.boot.grpc.server.interceptor.AnnotationGlobalServerInterceptorConfigurer;
@@ -108,12 +107,6 @@ public GrpcServiceDiscoverer defaultGrpcServiceDiscoverer() {
         return new AnnotationGrpcServiceDiscoverer();
     }
 
-    @ConditionalOnMissingBean
-    @Bean
-    public HealthStatusManager healthStatusManager() {
-        return new HealthStatusManager();
-    }
-
     @ConditionalOnBean(CompressorRegistry.class)
     @Bean
     public GrpcServerConfigurer compressionServerConfigurer(final CompressorRegistry registry) {
@@ -135,7 +128,8 @@ public List<GrpcServerConfigurer> defaultServerConfigurers() {
     @ConditionalOnMissingBean
     @ConditionalOnBean(GrpcServerFactory.class)
     @Bean
-    public GrpcServerLifecycle grpcServerLifecycle(final GrpcServerFactory factory, GrpcServerProperties properties) {
+    public GrpcServerLifecycle grpcServerLifecycle(final GrpcServerFactory factory,
+            final GrpcServerProperties properties) {
         return new GrpcServerLifecycle(factory, properties.getShutdownGracePeriod());
     }
 

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/autoconfigure/GrpcServerMetricAutoConfiguration.java

@@ -40,8 +40,6 @@
 import io.grpc.BindableService;
 import io.grpc.MethodDescriptor;
 import io.grpc.ServiceDescriptor;
-import io.grpc.protobuf.services.ProtoReflectionService;
-import io.grpc.services.HealthStatusManager;
 import io.micrometer.core.instrument.MeterRegistry;
 import lombok.extern.slf4j.Slf4j;
 import net.devh.boot.grpc.server.config.GrpcServerProperties;
@@ -75,20 +73,15 @@ public MetricCollectingServerInterceptor metricCollectingServerInterceptor(final
     @Bean
     @Lazy
     InfoContributor grpcInfoContributor(final GrpcServerProperties properties,
-            final Collection<BindableService> grpcServices, final HealthStatusManager healthStatusManager) {
+            final Collection<BindableService> grpcServices) {
         final Map<String, Object> details = new LinkedHashMap<>();
         details.put("port", properties.getPort());
 
         if (properties.isReflectionServiceEnabled()) {
             // Only expose services via web-info if we do the same via grpc.
             final Map<String, List<String>> services = new TreeMap<>(String.CASE_INSENSITIVE_ORDER);
             details.put("services", services);
-            final List<BindableService> mutableGrpcServiceList = new ArrayList<>(grpcServices);
-            mutableGrpcServiceList.add(ProtoReflectionService.newInstance());
-            if (properties.isHealthServiceEnabled()) {
-                mutableGrpcServiceList.add(healthStatusManager.getHealthService());
-            }
-            for (final BindableService grpcService : mutableGrpcServiceList) {
+            for (final BindableService grpcService : grpcServices) {
                 final ServiceDescriptor serviceDescriptor = grpcService.bindService().getServiceDescriptor();
 
                 final List<String> methods = collectMethodNamesForService(serviceDescriptor);

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/config/GrpcServerProperties.java

@@ -180,14 +180,6 @@ public class GrpcServerProperties {
     @DataSizeUnit(DataUnit.BYTES)
     private DataSize maxInboundMetadataSize = null;
 
-    /**
-     * Whether gRPC health service is enabled or not. Defaults to {@code true}.
-     *
-     * @param healthServiceEnabled Whether gRPC health service is enabled.
-     * @return True, if the health service is enabled. False otherwise.
-     */
-    private boolean healthServiceEnabled = true;
-
     /**
      * Whether proto reflection service is enabled or not. Defaults to {@code true}.
      *

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/serverfactory/AbstractGrpcServerFactory.java

@@ -23,19 +23,12 @@
 import java.util.List;
 import java.util.Set;
 
-import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.util.unit.DataSize;
 
-import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.Lists;
 
 import io.grpc.Server;
 import io.grpc.ServerBuilder;
-import io.grpc.health.v1.HealthCheckResponse;
-import io.grpc.health.v1.HealthGrpc;
-import io.grpc.protobuf.services.ProtoReflectionService;
-import io.grpc.reflection.v1alpha.ServerReflectionGrpc;
-import io.grpc.services.HealthStatusManager;
 import lombok.extern.slf4j.Slf4j;
 import net.devh.boot.grpc.server.config.GrpcServerProperties;
 import net.devh.boot.grpc.server.service.GrpcServiceDefinition;
@@ -56,17 +49,13 @@ public abstract class AbstractGrpcServerFactory<T extends ServerBuilder<T>> impl
     protected final GrpcServerProperties properties;
     protected final List<GrpcServerConfigurer> serverConfigurers;
 
-    @Autowired
-    @VisibleForTesting
-    HealthStatusManager healthStatusManager;
-
     /**
      * Creates a new server factory with the given properties.
      *
      * @param properties The properties used to configure the server.
      * @param serverConfigurers The server configurers to use. Can be empty.
      */
-    public AbstractGrpcServerFactory(final GrpcServerProperties properties,
+    protected AbstractGrpcServerFactory(final GrpcServerProperties properties,
             final List<GrpcServerConfigurer> serverConfigurers) {
         this.properties = requireNonNull(properties, "properties");
         this.serverConfigurers = requireNonNull(serverConfigurers, "serverConfigurers");
@@ -110,17 +99,6 @@ protected void configure(final T builder) {
     protected void configureServices(final T builder) {
         final Set<String> serviceNames = new LinkedHashSet<>();
 
-        // support health check
-        if (this.properties.isHealthServiceEnabled()) {
-            builder.addService(this.healthStatusManager.getHealthService());
-            serviceNames.add(HealthGrpc.getServiceDescriptor().getName());
-        }
-        // gRPC reflection
-        if (this.properties.isReflectionServiceEnabled()) {
-            builder.addService(ProtoReflectionService.newInstance());
-            serviceNames.add(ServerReflectionGrpc.getServiceDescriptor().getName());
-        }
-
         for (final GrpcServiceDefinition service : this.serviceList) {
             final String serviceName = service.getDefinition().getServiceDescriptor().getName();
             if (!serviceNames.add(serviceName)) {
@@ -129,7 +107,6 @@ protected void configureServices(final T builder) {
             log.info("Registered gRPC service: " + serviceName + ", bean: " + service.getBeanName() + ", class: "
                     + service.getBeanClazz().getName());
             builder.addService(service.getDefinition());
-            this.healthStatusManager.setStatus(serviceName, HealthCheckResponse.ServingStatus.SERVING);
         }
     }
 
@@ -186,12 +163,4 @@ public void addService(final GrpcServiceDefinition service) {
         this.serviceList.add(service);
     }
 
-    @Override
-    public void destroy() {
-        for (final GrpcServiceDefinition grpcServiceDefinition : this.serviceList) {
-            final String serviceName = grpcServiceDefinition.getDefinition().getServiceDescriptor().getName();
-            this.healthStatusManager.clearStatus(serviceName);
-        }
-    }
-
 }

grpc-server-spring-boot-autoconfigure/src/main/java/net/devh/boot/grpc/server/serverfactory/GrpcServerFactory.java

@@ -17,8 +17,6 @@
 
 package net.devh.boot.grpc.server.serverfactory;
 
-import org.springframework.beans.factory.DisposableBean;
-
 import io.grpc.Server;
 import net.devh.boot.grpc.server.service.GrpcServiceDefinition;
 
@@ -28,7 +26,7 @@
  * @author Michael ([email protected])
  * @since 5/17/16
  */
-public interface GrpcServerFactory extends DisposableBean {
+public interface GrpcServerFactory {
 
     /**
      * Creates a new grpc server with the stored options. The entire lifecycle management of the server should be
@@ -64,10 +62,4 @@ public interface GrpcServerFactory extends DisposableBean {
      */
     void addService(GrpcServiceDefinition service);
 
-    /**
-     * Destroys this factory. This does not destroy or shutdown any server that was created using this factory.
-     */
-    @Override
-    void destroy();
-
 }

grpc-server-spring-boot-autoconfigure/src/main/resources/META-INF/spring.factories

@@ -1,12 +1,13 @@
 # AutoConfiguration
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
+net.devh.boot.grpc.server.autoconfigure.GrpcAdviceAutoConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcMetadataConsulConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcMetadataEurekaConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcMetadataNacosConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcMetadataZookeeperConfiguration,\
+net.devh.boot.grpc.server.autoconfigure.GrpcReflectionServiceAutoConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcServerAutoConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcServerFactoryAutoConfiguration,\
-net.devh.boot.grpc.server.autoconfigure.GrpcServerSecurityAutoConfiguration,\
 net.devh.boot.grpc.server.autoconfigure.GrpcServerMetricAutoConfiguration,\
-net.devh.boot.grpc.server.autoconfigure.GrpcServerTraceAutoConfiguration,\
-net.devh.boot.grpc.server.autoconfigure.GrpcAdviceAutoConfiguration
+net.devh.boot.grpc.server.autoconfigure.GrpcServerSecurityAutoConfiguration,\
+net.devh.boot.grpc.server.autoconfigure.GrpcServerTraceAutoConfiguration

grpc-server-spring-boot-autoconfigure/src/test/java/net/devh/boot/grpc/server/autoconfigure/AwaitableStreamObserver.java

@@ -0,0 +1,90 @@
+/*
+ * Copyright (c) 2016-2021 Michael Zhang <[email protected]>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package net.devh.boot.grpc.server.autoconfigure;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.CountDownLatch;
+
+import io.grpc.stub.StreamObserver;
+
+class AwaitableStreamObserver<V> implements StreamObserver<V> {
+
+    private final CountDownLatch doneLatch = new CountDownLatch(1);
+    private final List<V> results = new ArrayList<>();
+    private volatile Throwable error;
+
+    @Override
+    public void onNext(final V value) {
+        this.results.add(value);
+    }
+
+    @Override
+    public void onError(final Throwable t) {
+        this.error = t;
+        this.doneLatch.countDown();
+    }
+
+    @Override
+    public void onCompleted() {
+        this.doneLatch.countDown();
+    }
+
+    public V getFirst() throws InterruptedException {
+        this.doneLatch.await();
+        if (this.error != null) {
+            throw new IllegalStateException("Request failed with unexpected error", this.error);
+        }
+        if (this.results.isEmpty()) {
+            throw new IllegalStateException("Requested completed without response");
+        }
+        return this.results.get(0);
+    }
+
+    public V getSingle() throws InterruptedException {
+        this.doneLatch.await();
+        if (this.error != null) {
+            throw new IllegalStateException("Request failed with unexpected error", this.error);
+        }
+        if (this.results.isEmpty()) {
+            throw new IllegalStateException("Requested completed without response");
+        }
+        if (this.results.size() != 1) {
+            throw new IllegalStateException(
+                    "Request completed with more than one response - Got " + this.results.size());
+        }
+        return this.results.get(0);
+    }
+
+    public List<V> getAll() throws InterruptedException {
+        this.doneLatch.await();
+        if (this.error != null) {
+            throw new IllegalStateException("Request failed with unexpected error", this.error);
+        }
+        return this.results;
+    }
+
+    public Throwable getError() throws InterruptedException {
+        this.doneLatch.await();
+        if (this.error == null) {
+            throw new IllegalStateException("Request completed without error");
+        }
+        return this.error;
+    }
+
+}