Code samples for testing and mocking Nexus (#771)

* Code samples for testing and mocking Nexus

* Formatting changes from Spotless

* Added two more classes that mock the Nexus Service itself

* Renamed EchoHandler to EchoClient

* Updating gradle wrapper validator

* Changed NexusService name for clarity, modified two tests

* Suppressing two false warnings that turned into build errors

Author: Evanthx

.github/workflows/ci.yml

@@ -8,8 +8,8 @@ jobs:
     name: "Gradle wrapper validation"
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: gradle/wrapper-validation-action@v3
+      - uses: actions/checkout@v6
+      - uses: gradle/actions/wrapper-validation@v5
 
   unittest:
     name: Unit Tests

core/src/main/java/io/temporal/samples/nexus/caller/CallerStarter.java

@@ -4,7 +4,7 @@
 import io.temporal.client.WorkflowClient;
 import io.temporal.client.WorkflowOptions;
 import io.temporal.samples.nexus.options.ClientOptions;
-import io.temporal.samples.nexus.service.NexusService;
+import io.temporal.samples.nexus.service.SampleNexusService;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -26,11 +26,12 @@ public static void main(String[] args) {
     logger.info("Workflow result: {}", echoWorkflow.echo("Nexus Echo 👋"));
     HelloCallerWorkflow helloWorkflow =
         client.newWorkflowStub(HelloCallerWorkflow.class, workflowOptions);
-    execution = WorkflowClient.start(helloWorkflow::hello, "Nexus", NexusService.Language.EN);
+    execution = WorkflowClient.start(helloWorkflow::hello, "Nexus", SampleNexusService.Language.EN);
     logger.info(
         "Started HelloCallerWorkflow workflowId: {} runId: {}",
         execution.getWorkflowId(),
         execution.getRunId());
-    logger.info("Workflow result: {}", helloWorkflow.hello("Nexus", NexusService.Language.ES));
+    logger.info(
+        "Workflow result: {}", helloWorkflow.hello("Nexus", SampleNexusService.Language.ES));
   }
 }

core/src/main/java/io/temporal/samples/nexus/caller/CallerWorker.java

@@ -21,7 +21,7 @@ public static void main(String[] args) {
         WorkflowImplementationOptions.newBuilder()
             .setNexusServiceOptions(
                 Collections.singletonMap(
-                    "NexusService",
+                    "SampleNexusService",
                     NexusServiceOptions.newBuilder().setEndpoint("my-nexus-endpoint-name").build()))
             .build(),
         EchoCallerWorkflowImpl.class,

core/src/main/java/io/temporal/samples/nexus/caller/EchoCallerWorkflowImpl.java

@@ -1,15 +1,15 @@
 package io.temporal.samples.nexus.caller;
 
-import io.temporal.samples.nexus.service.NexusService;
+import io.temporal.samples.nexus.service.SampleNexusService;
 import io.temporal.workflow.NexusOperationOptions;
 import io.temporal.workflow.NexusServiceOptions;
 import io.temporal.workflow.Workflow;
 import java.time.Duration;
 
 public class EchoCallerWorkflowImpl implements EchoCallerWorkflow {
-  NexusService nexusService =
+  SampleNexusService sampleNexusService =
       Workflow.newNexusServiceStub(
-          NexusService.class,
+          SampleNexusService.class,
           NexusServiceOptions.newBuilder()
               .setOperationOptions(
                   NexusOperationOptions.newBuilder()
@@ -19,6 +19,6 @@ public class EchoCallerWorkflowImpl implements EchoCallerWorkflow {
 
   @Override
   public String echo(String message) {
-    return nexusService.echo(new NexusService.EchoInput(message)).getMessage();
+    return sampleNexusService.echo(new SampleNexusService.EchoInput(message)).getMessage();
   }
 }

core/src/main/java/io/temporal/samples/nexus/caller/HelloCallerWorkflow.java

@@ -1,11 +1,11 @@
 package io.temporal.samples.nexus.caller;
 
-import io.temporal.samples.nexus.service.NexusService;
+import io.temporal.samples.nexus.service.SampleNexusService;
 import io.temporal.workflow.WorkflowInterface;
 import io.temporal.workflow.WorkflowMethod;
 
 @WorkflowInterface
 public interface HelloCallerWorkflow {
   @WorkflowMethod
-  String hello(String message, NexusService.Language language);
+  String hello(String message, SampleNexusService.Language language);
 }

core/src/main/java/io/temporal/samples/nexus/caller/HelloCallerWorkflowImpl.java

@@ -1,16 +1,16 @@
 package io.temporal.samples.nexus.caller;
 
-import io.temporal.samples.nexus.service.NexusService;
+import io.temporal.samples.nexus.service.SampleNexusService;
 import io.temporal.workflow.NexusOperationHandle;
 import io.temporal.workflow.NexusOperationOptions;
 import io.temporal.workflow.NexusServiceOptions;
 import io.temporal.workflow.Workflow;
 import java.time.Duration;
 
 public class HelloCallerWorkflowImpl implements HelloCallerWorkflow {
-  NexusService nexusService =
+  SampleNexusService sampleNexusService =
       Workflow.newNexusServiceStub(
-          NexusService.class,
+          SampleNexusService.class,
           NexusServiceOptions.newBuilder()
               .setOperationOptions(
                   NexusOperationOptions.newBuilder()
@@ -19,10 +19,10 @@ public class HelloCallerWorkflowImpl implements HelloCallerWorkflow {
               .build());
 
   @Override
-  public String hello(String message, NexusService.Language language) {
-    NexusOperationHandle<NexusService.HelloOutput> handle =
+  public String hello(String message, SampleNexusService.Language language) {
+    NexusOperationHandle<SampleNexusService.HelloOutput> handle =
         Workflow.startNexusOperation(
-            nexusService::hello, new NexusService.HelloInput(message, language));
+            sampleNexusService::hello, new SampleNexusService.HelloInput(message, language));
     // Optionally wait for the operation to be started. NexusOperationExecution will contain the
     // operation token in case this operation is asynchronous.
     handle.getExecution().get();

core/src/main/java/io/temporal/samples/nexus/handler/EchoClient.java

@@ -0,0 +1,7 @@
+package io.temporal.samples.nexus.handler;
+
+import io.temporal.samples.nexus.service.SampleNexusService;
+
+public interface EchoClient {
+  SampleNexusService.EchoOutput echo(SampleNexusService.EchoInput input);
+}

core/src/main/java/io/temporal/samples/nexus/handler/EchoClientImpl.java

@@ -0,0 +1,12 @@
+package io.temporal.samples.nexus.handler;
+
+import io.temporal.samples.nexus.service.SampleNexusService;
+
+// Note that this is a class, not a Temporal worker. This is to demonstrate that Nexus services can
+// simply call a class instead of a worker for fast operations that don't need retry handling.
+public class EchoClientImpl implements EchoClient {
+  @Override
+  public SampleNexusService.EchoOutput echo(SampleNexusService.EchoInput input) {
+    return new SampleNexusService.EchoOutput(input.getMessage());
+  }
+}

core/src/main/java/io/temporal/samples/nexus/handler/HandlerWorker.java

@@ -15,7 +15,7 @@ public static void main(String[] args) {
 
     Worker worker = factory.newWorker(DEFAULT_TASK_QUEUE_NAME);
     worker.registerWorkflowImplementationTypes(HelloHandlerWorkflowImpl.class);
-    worker.registerNexusServiceImplementation(new NexusServiceImpl());
+    worker.registerNexusServiceImplementation(new SampleNexusServiceImpl());
 
     factory.start();
   }

core/src/main/java/io/temporal/samples/nexus/handler/HelloHandlerWorkflow.java

@@ -1,11 +1,11 @@
 package io.temporal.samples.nexus.handler;
 
-import io.temporal.samples.nexus.service.NexusService;
+import io.temporal.samples.nexus.service.SampleNexusService;
 import io.temporal.workflow.WorkflowInterface;
 import io.temporal.workflow.WorkflowMethod;
 
 @WorkflowInterface
 public interface HelloHandlerWorkflow {
   @WorkflowMethod
-  NexusService.HelloOutput hello(NexusService.HelloInput input);
+  SampleNexusService.HelloOutput hello(SampleNexusService.HelloInput input);
 }