tRPC/json-rpc: normalize usage

- mimic how McpModule works
- make generate code type-safe, so it can't be mixed with normal `rest/mvc` routes
- allow `tRPC` to configure base path
- fix #3895

Author: jknack

modules/jooby-apt/src/main/java/io/jooby/internal/apt/JsonRpcRouter.java

@@ -203,7 +203,7 @@ public String toSourceCode(boolean kt) throws IOException {
         .replace("${imports}", imports)
         .replace("${className}", generateTypeName)
         .replace("${generatedClassName}", generatedClass)
-        .replace("${implements}", "io.jooby.jsonrpc.JsonRpcService, io.jooby.Extension")
+        .replace("${implements}", "io.jooby.jsonrpc.JsonRpcService")
         .replace("${constructors}", constructors(generatedClass, kt))
         .replace("${methods}", trimr(buffer));
   }

modules/jooby-apt/src/main/java/io/jooby/internal/apt/TrpcRoute.java

@@ -61,7 +61,7 @@ private String trpcPath() {
             .flatMap(it -> AnnotationSupport.findAnnotationValue(it, VALUE).stream().findFirst())
             .orElse(method.getSimpleName().toString());
 
-    return Stream.of("trpc", namespace + procedure)
+    return Stream.of(namespace + procedure)
         .map(segment -> segment.startsWith("/") ? segment.substring(1) : segment)
         .collect(Collectors.joining("/", "/", ""));
   }
@@ -86,7 +86,8 @@ public List<String> generateMapping(boolean kt, String routerName) {
             isSuspendFun() ? "" : "app.",
             dslMethod,
             "(",
-            string(path.startsWith("/") ? path : "/" + path),
+            "path + ",
+            string(path),
             ", ",
             context.pipeline(
                 getReturnType().getRawType(), methodReference(kt, thisRef, targetMethod))));

modules/jooby-apt/src/main/java/io/jooby/internal/apt/TrpcRouter.java

@@ -100,12 +100,12 @@ public String toSourceCode(boolean kt) throws IOException {
       buffer.append(indent(4)).append("@Throws(Exception::class)").append(System.lineSeparator());
       buffer
           .append(indent(4))
-          .append("override fun install(app: io.jooby.Jooby) {")
+          .append("override fun install(path: String, app: io.jooby.Jooby) {")
           .append(System.lineSeparator());
     } else {
       buffer
           .append(indent(4))
-          .append("public void install(io.jooby.Jooby app) throws Exception {")
+          .append("public void install(String path, io.jooby.Jooby app) throws Exception {")
           .append(System.lineSeparator());
     }
 
@@ -130,7 +130,7 @@ public String toSourceCode(boolean kt) throws IOException {
         .replace("${imports}", imports)
         .replace("${className}", generateTypeName)
         .replace("${generatedClassName}", generatedClass)
-        .replace("${implements}", "io.jooby.Extension")
+        .replace("${implements}", "io.jooby.trpc.TrpcService")
         .replace("${constructors}", constructors(generatedClass, kt))
         .replace("${methods}", trimr(buffer));
   }

modules/jooby-apt/src/test/java/tests/i3863/Issue3863.java

@@ -24,8 +24,8 @@ public void trpcQuery() throws Exception {
         .withTrpcCode(
             source -> {
               assertThat(source)
-                  .contains("app.get(\"/trpc/users.getUserById\", this::trpcGetUserById);")
-                  .contains("app.post(\"/trpc/users.createUser\", this::trpcCreateUser);");
+                  .contains("app.get(path + \"/users.getUserById\", this::trpcGetUserById);")
+                  .contains("app.post(path + \"/users.createUser\", this::trpcCreateUser);");
             });
   }
 
@@ -36,8 +36,8 @@ public void mixedAnnotation() throws Exception {
             source -> {
               assertThat(source)
                   // tRPC
-                  .contains("app.get(\"/trpc/users.getUserById\", this::trpcGetUserById);")
-                  .contains("app.post(\"/trpc/users.createUser\", this::trpcCreateUser);");
+                  .contains("app.get(path + \"/users.getUserById\", this::trpcGetUserById);")
+                  .contains("app.post(path + \"/users.createUser\", this::trpcCreateUser);");
             })
         .withSourceCode(
             source -> {
@@ -55,10 +55,10 @@ public void mixedMutation() throws Exception {
             source -> {
               assertThat(source)
                   // tRPC
-                  .contains("app.post(\"/trpc/users.createUser\", this::trpcCreateUser);")
-                  .contains("app.post(\"/trpc/users.updateUser\", this::trpcUpdateUser);")
-                  .contains("app.post(\"/trpc/users.patchUser\", this::trpcPatchUser);")
-                  .contains("app.post(\"/trpc/users.deleteUser\", this::trpcDeleteUser);");
+                  .contains("app.post(path + \"/users.createUser\", this::trpcCreateUser);")
+                  .contains("app.post(path + \"/users.updateUser\", this::trpcUpdateUser);")
+                  .contains("app.post(path + \"/users.patchUser\", this::trpcPatchUser);")
+                  .contains("app.post(path + \"/users.deleteUser\", this::trpcDeleteUser);");
             })
         .withSourceCode(
             source -> {
@@ -78,8 +78,8 @@ public void overloadTrpc() throws Exception {
             source -> {
               assertThat(source)
                   // tRPC
-                  .contains("app.get(\"/trpc/users.ping\", this::trpcPing);")
-                  .contains("app.get(\"/trpc/users.ping.since\", this::trpcPingInteger);");
+                  .contains("app.get(path + \"/users.ping\", this::trpcPing);")
+                  .contains("app.get(path + \"/users.ping.since\", this::trpcPingInteger);");
             });
   }
 }

modules/jooby-apt/src/test/java/tests/i3864/Issue3868.java

@@ -20,7 +20,7 @@ public void topLevelAnnotationMakeAllPublicJSONRPC() throws Exception {
               assertThat(source)
                   .contains(
                       "public class DefaultMappingRpc_ implements"
-                          + " io.jooby.jsonrpc.JsonRpcService, io.jooby.Extension {")
+                          + " io.jooby.jsonrpc.JsonRpcService {")
                   .contains("public java.util.List<String> getMethods() {")
                   .contains(
                       "return java.util.List.of(\"default.rpcMethod1\", \"default.rpcMethod2\")")

modules/jooby-jsonrpc/src/main/java/io/jooby/jsonrpc/JsonRpcModule.java

@@ -35,8 +35,12 @@
  * <p>Usage:
  *
  * <pre>{@code
- * install(new JsonRpcDispatcher());
- * services().put(JsonRpcService.class, new MyServiceRpc(new MyService()));
+ * install(new Jackson3Module());
+ *
+ * install(new JsonRpcJackson3Module());
+ *
+ * install(new JsonRpcModule(new MyServiceRpc_()));
+ *
  * }</pre>
  *
  * @author Edgar Espina
@@ -47,11 +51,17 @@ public class JsonRpcModule implements Extension {
   private final Map<String, JsonRpcService> services = new HashMap<>();
   private final String path;
 
-  public JsonRpcModule(String path) {
+  public JsonRpcModule(String path, JsonRpcService service, JsonRpcService... services) {
     this.path = path;
+    registry(service);
+    Arrays.stream(services).forEach(this::registry);
+  }
+
+  public JsonRpcModule(JsonRpcService service, JsonRpcService... services) {
+    this("/rpc", service, services);
   }
 
-  public void add(JsonRpcService service) {
+  private void registry(JsonRpcService service) {
     for (var method : service.getMethods()) {
       this.services.put(method, service);
     }

modules/jooby-jsonrpc/src/main/java/io/jooby/jsonrpc/JsonRpcService.java

@@ -9,6 +9,7 @@
 
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.Context;
+import io.jooby.Jooby;
 
 /**
  * Interface for generated JSON-RPC service glue code (*Rpc classes).
@@ -25,6 +26,15 @@ public interface JsonRpcService {
    */
   List<String> getMethods();
 
+  /**
+   * Registers the JSON-RPC service with the provided Jooby application.
+   *
+   * @param application The Jooby application instance where the JSON-RPC service will be installed.
+   *     Must not be null.
+   * @throws Exception If registration fails.
+   */
+  void install(@NonNull Jooby application) throws Exception;
+
   /**
    * Executes the requested method using the provided context and request data.
    *

modules/jooby-jsonrpc/src/main/java/io/jooby/jsonrpc/package-info.java

@@ -20,8 +20,11 @@
  * <p>Usage:
  *
  * <pre>{@code
- * install(new JsonRpcDispatcher());
- * services().put(JsonRpcService.class, new MyServiceRpc(new MyService()));
+ * install(new Jackson3Module());
+ *
+ * install(new JsonRpcJackson3Module());
+ *
+ * install(new JsonRpcModule(new MyServiceRpc_()));
  * }</pre>
  *
  * @author Edgar Espina

modules/jooby-jsonrpc/src/main/java/module-info.java

@@ -20,8 +20,11 @@
  * <p>Usage:
  *
  * <pre>{@code
- * install(new JsonRpcDispatcher());
- * services().put(JsonRpcService.class, new MyServiceRpc(new MyService()));
+ * install(new Jackson3Module());
+ *
+ * install(new JsonRpcJackson3Module());
+ *
+ * install(new JsonRpcModule(new MyServiceRpc_()));
  * }</pre>
  *
  * @author Edgar Espina

modules/jooby-trpc/src/main/java/io/jooby/trpc/TrpcModule.java

@@ -5,6 +5,9 @@
  */
 package io.jooby.trpc;
 
+import java.util.List;
+import java.util.stream.Stream;
+
 import edu.umd.cs.findbugs.annotations.NonNull;
 import io.jooby.Extension;
 import io.jooby.Jooby;
@@ -28,18 +31,45 @@
  * <pre>{@code
  * {
  * // 1. Install a JSON engine (Prerequisite)
- * install(new JacksonModule());
+ * install(new Jackson3Module())
  *
- * // 2. Install the tRPC extension
- * install(new TrpcModule());
+ * // 2. JSON implementation of protocol
+ * install(new TrpcJackson3Module());
  *
- * // 3. Register your @Trpc annotated controllers
- * mvc(new MovieService_());
+ * // 3. Install the tRPC extension
+ * install(new TrpcModule(MovieServiceTrpc_()));
  * }
  * }</pre>
  */
 public class TrpcModule implements Extension {
 
+  private final String path;
+  private final List<TrpcService> services;
+
+  /**
+   * Creates a new instance of {@code TrpcModule} with the specified base path and tRPC services.
+   *
+   * @param path The base path for all tRPC routes. This is the root URL prefix where all tRPC
+   *     services will be registered. Must not be {@code null}.
+   * @param service The primary tRPC service to register. Must not be {@code null}.
+   * @param services Additional tRPC services to register (if any). Optional and may be omitted.
+   */
+  public TrpcModule(String path, TrpcService service, TrpcService... services) {
+    this.path = path;
+    this.services = Stream.concat(Stream.of(service), Stream.of(services)).toList();
+  }
+
+  /**
+   * Constructs a new {@code TrpcModule} with the default base path: <code>trpc</code> and the
+   * provided services.
+   *
+   * @param service The primary tRPC service to register. Must not be {@code null}.
+   * @param services Additional tRPC services to register (if any). Optional and may be omitted.
+   */
+  public TrpcModule(TrpcService service, TrpcService... services) {
+    this("/trpc", service, services);
+  }
+
   /**
    * Installs the tRPC extension into the Jooby application.
    *
@@ -59,15 +89,19 @@ public class TrpcModule implements Extension {
    */
   @Override
   public void install(@NonNull Jooby app) throws Exception {
-    var services = app.getServices();
+    var registry = app.getServices();
 
     // Ensure a JSON module has provided the necessary parser
-    services.require(TrpcParser.class);
+    registry.require(TrpcParser.class);
 
     // Initialize the custom exception mapping registry
-    services.mapOf(Class.class, TrpcErrorCode.class);
+    registry.mapOf(Class.class, TrpcErrorCode.class);
 
     // Register the specialized JSON-RPC error formatter
     app.error(new TrpcErrorHandler());
+
+    for (var service : services) {
+      service.install(path, app);
+    }
   }
 }