Reactive routing via cdi provider (helidon-io#3050)

danielkec · web-flow · commit 71eecc8ca4d6 · 2021-06-04T09:36:00.000+02:00
* Reactive routing via cdi provider

Signed-off-by: Daniel Kec &lt;daniel.kec@oracle.com&gt;
diff --git a/docs/mp/guides/38_se_services.adoc b/docs/mp/guides/38_se_services.adoc
@@ -0,0 +1,96 @@
+///////////////////////////////////////////////////////////////////////////////
+
+    Copyright (c) 2021 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.
+
+///////////////////////////////////////////////////////////////////////////////
+
+= Reusing Helidon SE services
+:h1Prefix: MP
+:description: Helidon Reactive Routing
+:keywords: helidon, guide, routing
+:helidon-uc-flavor: MP
+:helidon-lc-flavor: mp
+
+This guide shows how reuse Helidon SE Service in your Helidon MP application.
+
+== What You Need
+
+|===
+|About 10 minutes
+|<<about/03_prerequisites.adoc,Helidon Prerequisites>>
+|<<mp/guides/02_quickstart.adoc,A Helidon MP application, such as Helidon MP Quickstart>>
+|===
+
+Helidon MP supports <<mp/jaxrs/10_reactive-routing.adoc, Reactive routing>> which brings possibility for reusing
+`io.helidon.webserver.Service` implementations in Helidon MP. Such feature can be quite useful for common
+solutions for filtering, auditing, logging or augmenting REST endpoints in hybrid Helidon SE/MP environment.
+
+Let's define simple Helidon SE Service for adding special header to every REST response:
+
+[source,java]
+----
+public class CoolingService implements Service, Handler {
+
+    public static final String COOL_HEADER_NAME = "Cool-Header";
+    public static final String COOLING_VALUE = "This is way cooler response than ";
+
+    @Override
+    public void update(Routing.Rules rules) {
+        rules.any(this);
+    }
+
+    @Override
+    public void accept(ServerRequest req, ServerResponse res) {
+        res.headers().add(COOL_HEADER_NAME, COOLING_VALUE);
+        req.next();
+    }
+}
+----
+
+Its easy to use it with Helidon SE:
+
+[source,java]
+----
+WebServer.builder(Routing.builder()
+                    // register service with routing path
+                    .register("/cool", new CoolingService())
+                    .build())
+                .config(config)
+                .addMediaSupport(JsonpSupport.create())
+                .build()
+                .start();
+----
+
+And not much harder to use it with Helidon MP:
+
+[source,java]
+----
+@ApplicationScoped
+public class MyBean {
+
+    @Produces
+    @ApplicationScoped
+    @RoutingPath("/cool")
+    public Service coolService() {
+        return new CoolingService();
+    }
+
+}
+----
+
+You can leverage annotations:
+
+* @RoutingPath - path of the WebServer service
+* @RoutingName - select routing when <<mp/jaxrs/02_server-configuration.adoc#conf-additional-ports,serving requests on multiple ports>>
diff --git a/docs/mp/jaxrs/02_server-configuration.adoc b/docs/mp/jaxrs/02_server-configuration.adoc
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
-    Copyright (c) 2018, 2020 Oracle and/or its affiliates.
+    Copyright (c) 2018, 2021 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.
@@ -100,7 +100,7 @@ server:
           resource-path: "keystore.p12"
 ----
 
-== Configuring additional ports
+== Configuring additional ports [[conf-additional-ports]]
 
 Helidon MP can expose multiple ports, with the following limitations:
 
diff --git a/docs/mp/jaxrs/10_reactive-routing.adoc b/docs/mp/jaxrs/10_reactive-routing.adoc
@@ -1,6 +1,6 @@
 ///////////////////////////////////////////////////////////////////////////////
 
-    Copyright (c) 2019, 2020 Oracle and/or its affiliates.
+    Copyright (c) 2019, 2021 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.
@@ -51,7 +51,7 @@ You can assign a reactive service to a named routing (and as a result to a named
 either an annotation or configuration (or both to override the value from annotation).
 
 ===== Annotation `@RoutingName`
-You can annotated a service with this annotation to assign it to a specific named routing,
+You can annotate a service bean with this annotation to assign it to a specific named routing,
 that is (most likely) going to be bound to a specific port.
 
 The annotation has two attributes:
@@ -74,10 +74,11 @@ is not configured.
 
 ===== Configuration override of routing name
 
-For each service class you can define the routing name and its required flag by specifying a configuration
-option `class-name.routing-name.name` and `class-name.routing-name.required`.
+For each service bean you can define the routing name and its required flag by specifying a configuration
+option `bean-class-name.routing-name.name` and `bean-class-name.routing-name.required`.
+For service beans produced with producer method replace `bean-class-name` with `class-name.producer-method-name`.
 
-Example (YAML) configuration for a class `io.helidon.examples.AdminService` that changes the
+Example (YAML) configuration for a service bean `io.helidon.examples.AdminService` that changes the
 routing name to `management` and its required flag to `false`:
 
 [source,yaml]
diff --git a/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingConfiguration.java b/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingConfiguration.java
@@ -0,0 +1,66 @@
+/*
+ * Copyright (c) 2021 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.microprofile.server;
+
+import javax.enterprise.inject.spi.Annotated;
+
+import io.helidon.config.Config;
+
+class RoutingConfiguration {
+    private String routingName = RoutingName.DEFAULT_NAME;
+    private String routingPath = null;
+    private boolean required = false;
+    private final String contextConfigKey;
+
+    RoutingConfiguration(Annotated annotated, String contextConfigKey) {
+        RoutingName rn = annotated.getAnnotation(RoutingName.class);
+        RoutingPath rp = annotated.getAnnotation(RoutingPath.class);
+        this.contextConfigKey = contextConfigKey;
+        if (rn != null) {
+            this.routingName = rn.value();
+            this.required = rn.required();
+        }
+        if (rp != null) {
+            this.routingPath = rp.value();
+        }
+    }
+
+    String routingName(Config config) {
+        return config.get(contextConfigKey)
+                .get(RoutingName.CONFIG_KEY_NAME)
+                .asString()
+                .orElse(routingName);
+    }
+
+    String routingPath(Config config) {
+        return config.get(contextConfigKey)
+                .get(RoutingPath.CONFIG_KEY_PATH)
+                .asString()
+                .orElse(routingPath);
+    }
+
+    boolean required(Config config) {
+        return config.get(contextConfigKey)
+                .get(RoutingName.CONFIG_KEY_REQUIRED)
+                .asBoolean()
+                .orElse(required);
+    }
+
+    String configContext() {
+        return contextConfigKey;
+    }
+}
diff --git a/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingName.java b/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingName.java
@@ -19,6 +19,8 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
 import static java.lang.annotation.ElementType.TYPE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
@@ -54,7 +56,7 @@
  *  required: false
  * </pre>
  */
-@Target(TYPE)
+@Target({TYPE, METHOD, FIELD})
 @Retention(RUNTIME)
 @Documented
 public @interface RoutingName {
diff --git a/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingPath.java b/microprofile/server/src/main/java/io/helidon/microprofile/server/RoutingPath.java
@@ -19,6 +19,8 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.METHOD;
 import static java.lang.annotation.ElementType.TYPE;
 import static java.lang.annotation.RetentionPolicy.RUNTIME;
 
@@ -56,7 +58,7 @@
  *     {@link javax.enterprise.context.ApplicationScoped} and {@link javax.enterprise.context.Dependent} scopes</li>
  * </ul>
  */
-@Target(TYPE)
+@Target({TYPE, METHOD, FIELD})
 @Retention(RUNTIME)
 @Documented
 public @interface RoutingPath {
@@ -67,6 +69,7 @@
 
     /**
      * Path of this WebServer service. Use the same path as would be used with {@link io.helidon.webserver.Routing.Rules}.
+     *
      * @return path to register the service on.
      */
     String value();
diff --git a/microprofile/server/src/main/java/io/helidon/microprofile/server/ServerCdiExtension.java b/microprofile/server/src/main/java/io/helidon/microprofile/server/ServerCdiExtension.java
@@ -17,9 +17,13 @@
 package io.helidon.microprofile.server;
 
 import java.lang.management.ManagementFactory;
+import java.lang.reflect.Field;
+import java.lang.reflect.Method;
 import java.nio.file.Path;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.IdentityHashMap;
 import java.util.LinkedList;
 import java.util.List;
 import java.util.Map;
@@ -44,6 +48,9 @@
 import javax.enterprise.inject.spi.BeanManager;
 import javax.enterprise.inject.spi.DeploymentException;
 import javax.enterprise.inject.spi.Extension;
+import javax.enterprise.inject.spi.ProcessManagedBean;
+import javax.enterprise.inject.spi.ProcessProducerField;
+import javax.enterprise.inject.spi.ProcessProducerMethod;
 
 import io.helidon.common.Prioritized;
 import io.helidon.common.configurable.ServerThreadPoolSupplier;
@@ -95,6 +102,9 @@ public class ServerCdiExtension implements Extension {
     private volatile boolean started;
     private final List<JerseySupport> jerseySupports = new LinkedList<>();
 
+    private final Map<Bean<?>, RoutingConfiguration> serviceBeans
+            = Collections.synchronizedMap(new IdentityHashMap<>());
+
     private void buildTime(@Observes @BuildTimeStart Object event) {
         // update the status of server, as we may have been started without a builder being used
         // such as when cdi.Main or SeContainerInitializer are used
@@ -119,6 +129,23 @@ private void registerKpiMetricsDeferrableRequestHandlers(
         jaxRsApplications.forEach(it -> registerKpiMetricsDeferrableRequestContextSetterHandler(jaxRs, it));
     }
 
+    private void recordMethodProducedServices(@Observes ProcessProducerMethod<? extends Service, ?> ppm) {
+        Method m = ppm.getAnnotatedProducerMethod().getJavaMember();
+        String contextKey = m.getDeclaringClass().getName() + "." + m.getName();
+        serviceBeans.put(ppm.getBean(), new RoutingConfiguration(ppm.getAnnotated(), contextKey));
+    }
+
+    private void recordFieldProducedServices(@Observes ProcessProducerField<? extends Service, ?> ppf) {
+        Field f = ppf.getAnnotatedProducerField().getJavaMember();
+        String contextKey = f.getDeclaringClass().getName() + "." + f.getName();
+        serviceBeans.put(ppf.getBean(), new RoutingConfiguration(ppf.getAnnotated(), contextKey));
+    }
+
+    private void recordBeanServices(@Observes ProcessManagedBean<? extends Service> pmb) {
+        Class<? extends Service> cls = pmb.getAnnotatedBeanClass().getJavaClass();
+        serviceBeans.put(pmb.getBean(), new RoutingConfiguration(pmb.getAnnotated(), cls.getName()));
+    }
+
     private void registerKpiMetricsDeferrableRequestContextSetterHandler(JaxRsCdiExtension jaxRs,
             JaxRsApplication applicationMeta) {
         Optional<String> contextRoot = jaxRs.findContextRoot(config, applicationMeta);
@@ -392,9 +419,8 @@ private void registerWebServerServices(BeanManager beanManager) {
 
         for (Bean<?> bean : beans) {
             Bean<Object> objBean = (Bean<Object>) bean;
-            Class<?> aClass = objBean.getBeanClass();
             Service service = (Service) objBean.create(context);
-            registerWebServerService(aClass, service);
+            registerWebServerService(serviceBeans.remove(bean), service);
         }
     }
 
@@ -413,40 +439,15 @@ private static int priority(Class<?> aClass) {
         return (null == prio) ? Prioritized.DEFAULT_PRIORITY : prio.value();
     }
 
-    private void registerWebServerService(Class<?> serviceClass,
-                                          Service service) {
+    private void registerWebServerService(RoutingConfiguration routingConf, Service service) {
 
-        RoutingPath rp = serviceClass.getAnnotation(RoutingPath.class);
-        RoutingName rn = serviceClass.getAnnotation(RoutingName.class);
+        String path = routingConf.routingPath(config);
+        String routingName = routingConf.routingName(config);
+        boolean routingNameRequired = routingConf.required(config);
 
-        String path = (null == rp) ? null : rp.value();
-        String routingName = (null == rn) ? null : rn.value();
-        boolean routingNameRequired = (null != rn) && rn.required();
-
-        // can override routing path from configuration
-        path = config.get(serviceClass.getName()
-                                  + "."
-                                  + RoutingPath.CONFIG_KEY_PATH)
-                .asString()
-                .orElse(path);
-
-        // can override routing name from configuration
-        routingName = config.get(serviceClass.getName()
-                                         + "."
-                                         + RoutingName.CONFIG_KEY_NAME)
-                .asString()
-                .orElse(routingName);
-
-        // also whether the routing name is required can be overridden
-        routingNameRequired = config.get(serviceClass.getName()
-                                                 + "."
-                                                 + RoutingName.CONFIG_KEY_REQUIRED)
-                .asBoolean()
-                .orElse(routingNameRequired);
-
-        Routing.Rules routing = findRouting(serviceClass.getName(),
-                                            routingName,
-                                            routingNameRequired);
+        Routing.Rules routing = findRouting(routingConf.configContext(),
+                routingName,
+                routingNameRequired);
 
         if ((null == path) || "/".equals(path)) {
             routing.register(service);
@@ -500,7 +501,7 @@ public Routing.Builder serverRoutingBuilder() {
 
     /**
      * Helidon webserver routing builder that can be used to add routes to a named socket
-     *  of the webserver.
+     * of the webserver.
      *
      * @param name name of the named routing (should match a named socket configuration)
      * @return builder for routing of the named route
@@ -520,6 +521,7 @@ public void defaultExecutorService(Supplier<? extends ExecutorService> defaultEx
 
     /**
      * Current host the server is running on.
+     *
      * @return host of this server
      */
     public String host() {
diff --git a/microprofile/server/src/test/java/io/helidon/microprofile/server/JerseyPropertiesTest.java b/microprofile/server/src/test/java/io/helidon/microprofile/server/JerseyPropertiesTest.java
diff --git a/microprofile/server/src/test/java/io/helidon/microprofile/server/ProducedRouteTest.java b/microprofile/server/src/test/java/io/helidon/microprofile/server/ProducedRouteTest.java
diff --git a/microprofile/server/src/test/resources/META-INF/beans.xml b/microprofile/server/src/test/resources/META-INF/beans.xml
