gRPC MP Implementation

bom/pom.xml

@@ -100,6 +100,16 @@
                 <artifactId>helidon-grpc-core</artifactId>
                 <version>${helidon.version}</version>
             </dependency>
+            <dependency>
+                <groupId>io.helidon.microprofile.grpc</groupId>
+                <artifactId>helidon-microprofile-grpc-core</artifactId>
+                <version>${helidon.version}</version>
+            </dependency>
+            <dependency>
+                <groupId>io.helidon.microprofile.grpc</groupId>
+                <artifactId>helidon-microprofile-grpc-server</artifactId>
+                <version>${helidon.version}</version>
+            </dependency>
             <!-- Micronaut integrations -->
             <dependency>
                 <groupId>io.helidon.integrations.micronaut</groupId>

docs/src/main/java/io/helidon/docs/se/grpc/ServerSnippets.java

@@ -23,7 +23,7 @@
 import com.google.protobuf.Descriptors;
 import io.grpc.stub.StreamObserver;
 
-import static io.helidon.webserver.grpc.ResponseHelper.complete;
+import static io.helidon.grpc.core.ResponseHelper.complete;
 
 @SuppressWarnings("ALL")
 class ServerSnippets {

examples/webserver/protocols/src/main/java/io/helidon/examples/webserver/protocols/ProtocolsMain.java

@@ -34,8 +34,8 @@
 
 import io.grpc.stub.StreamObserver;
 
+import static io.helidon.grpc.core.ResponseHelper.complete;
 import static io.helidon.http.Method.GET;
-import static io.helidon.webserver.grpc.ResponseHelper.complete;
 
 /**
  * Example showing supported protocols.

grpc/core/pom.xml

@@ -26,13 +26,41 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>helidon-grpc-core</artifactId>
-    <name>Helidon gRPC related modules</name>
+    <name>Helidon gRPC Core</name>
 
     <dependencies>
         <dependency>
             <groupId>io.helidon.common</groupId>
             <artifactId>helidon-common</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.common</groupId>
+            <artifactId>helidon-common-config</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.common</groupId>
+            <artifactId>helidon-common-configurable</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-metadata</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.common</groupId>
+            <artifactId>helidon-common-context</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.http</groupId>
+            <artifactId>helidon-http</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.helidon.tracing</groupId>
+            <artifactId>helidon-tracing</artifactId>
+        </dependency>
         <dependency>
             <groupId>io.grpc</groupId>
             <artifactId>grpc-api</artifactId>

webserver/grpc/src/main/java/io/helidon/webserver/grpc/CollectingObserver.java → grpc/core/src/main/java/io/helidon/grpc/core/CollectingObserver.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2022, 2023 Oracle and/or its affiliates.
+ * Copyright (c) 2022, 2024 Oracle and/or its affiliates.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.helidon.webserver.grpc;
+package io.helidon.grpc.core;
 
 import java.util.Objects;
 import java.util.Optional;
@@ -25,69 +25,69 @@
 import io.grpc.stub.StreamObserver;
 
 /**
- * A {@link StreamObserver}.
+ * Utility {@link StreamObserver} mostly used for testing.
  *
- * @param <T> ToDo: Add JavaDoc
- * @param <V> ToDo: Add JavaDoc
- * @param <U> ToDo: Add JavaDoc
- * @param <A> ToDo: Add JavaDoc
- * @param <R> ToDo: Add JavaDoc
+ * @param <T> the type of input elements to the reduction operation
+ * @param <A> the mutable accumulation type of the reduction operation
+ * @param <R> the result type of the reduction operation
+ * @param <U> the type of values observed
+ * @param <V> the request type before conversion
  */
 public class CollectingObserver<T, V, U, A, R> implements StreamObserver<V> {
+
     private final Collector<T, A, R> collector;
     private final StreamObserver<U> responseObserver;
     private final Function<V, T> requestConverter;
     private final Function<R, U> responseConverter;
     private final Consumer<Throwable> errorHandler;
-
     private final A accumulator;
 
     /**
-     * ToDo: Add JavaDoc.
+     * Constructor.
      *
-     * @param collector        ToDo: Add JavaDoc
-     * @param responseObserver ToDo: Add JavaDoc
+     * @param collector the collector
+     * @param observer the observer
      */
-    public CollectingObserver(Collector<T, A, R> collector, StreamObserver<U> responseObserver) {
-        this(collector, responseObserver, null, null, null);
+    public CollectingObserver(Collector<T, A, R> collector, StreamObserver<U> observer) {
+        this(collector, observer, null, null, null);
     }
 
     /**
-     * ToDo: Add JavaDoc.
+     * Constructor.
      *
-     * @param collector        ToDo: Add JavaDoc
-     * @param responseObserver ToDo: Add JavaDoc
-     * @param errorHandler     ToDo: Add JavaDoc
+     * @param collector the collector
+     * @param observer the observer
+     * @param errorHandler the error handler
      */
     public CollectingObserver(Collector<T, A, R> collector,
-                              StreamObserver<U> responseObserver,
+                              StreamObserver<U> observer,
                               Consumer<Throwable> errorHandler) {
-        this(collector, responseObserver, null, null, errorHandler);
+        this(collector, observer, null, null, errorHandler);
     }
 
     /**
-     * ToDo: Add JavaDoc.
+     * Constructor.
      *
-     * @param collector         ToDo: Add JavaDoc
-     * @param responseObserver  ToDo: Add JavaDoc
-     * @param requestConverter  ToDo: Add JavaDoc
-     * @param responseConverter ToDo: Add JavaDoc
+     * @param collector the collector
+     * @param observer the observer
+     * @param requestConverter the request converter
+     * @param responseConverter the response converterr
      */
     public CollectingObserver(Collector<T, A, R> collector,
-                              StreamObserver<U> responseObserver,
+                              StreamObserver<U> observer,
                               Function<V, T> requestConverter,
                               Function<R, U> responseConverter) {
-        this(collector, responseObserver, requestConverter, responseConverter, null);
+        this(collector, observer, requestConverter, responseConverter, null);
     }
 
     /**
-     * ToDo: Add JavaDoc.
+     * Constructor.
      *
-     * @param collector         ToDo: Add JavaDoc
-     * @param observer          ToDo: Add JavaDoc
-     * @param requestConverter  ToDo: Add JavaDoc
-     * @param responseConverter ToDo: Add JavaDoc
-     * @param errorHandler      ToDo: Add JavaDoc
+     * @param collector the collector
+     * @param observer the observer
+     * @param requestConverter the request converter
+     * @param responseConverter the response converter
+     * @param errorHandler the error handler
      */
     @SuppressWarnings("unchecked")
     public CollectingObserver(Collector<T, A, R> collector,
@@ -99,8 +99,7 @@ public CollectingObserver(Collector<T, A, R> collector,
         this.responseObserver = Objects.requireNonNull(observer, "The observer parameter cannot be null");
         this.requestConverter = Optional.ofNullable(requestConverter).orElse(v -> (T) v);
         this.responseConverter = Optional.ofNullable(responseConverter).orElse(r -> (U) r);
-        this.errorHandler = Optional.ofNullable(errorHandler).orElse(t -> {
-        });
+        this.errorHandler = Optional.ofNullable(errorHandler).orElse(t -> {});
         this.accumulator = collector.supplier().get();
     }
 

grpc/core/src/main/java/io/helidon/grpc/core/ContextKeys.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2019, 2024 Oracle and/or its affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.helidon.grpc.core;
+
+import java.lang.reflect.Method;
+
+import io.grpc.Context;
+import io.grpc.Metadata;
+
+/**
+ * A collection of common gRPC {@link Context.Key} and
+ * {@link Metadata.Key} instances.
+ */
+public final class ContextKeys {
+    /**
+     * The {@link Metadata.Key} to use to obtain the authorization data.
+     */
+    public static final Metadata.Key<String> AUTHORIZATION =
+            Metadata.Key.of("Authorization", Metadata.ASCII_STRING_MARSHALLER);
+
+    /**
+     * The gRPC context key to use to obtain the Helidon {@link io.helidon.common.context.Context}
+     * from the gRPC {@link Context}.
+     */
+    public static final Context.Key<io.helidon.common.context.Context> HELIDON_CONTEXT =
+            Context.key(io.helidon.common.context.Context.class.getCanonicalName());
+
+    /**
+     * The {@link Context.Key} to use to obtain the actual underlying rpc {@link Method}.
+     */
+    public static final Context.Key<Method> SERVICE_METHOD = Context.key(Method.class.getName());
+
+    /**
+     * Private constructor for utility class.
+     */
+    private ContextKeys() {
+    }
+}