Add support for timeouts

Author: sleipnir

README.md

@@ -17,7 +17,8 @@ JVM User Language Support for [Spawn](https://github.com/eigr/spawn).
 4. [Using Actors](#using-actors)
     - [Call Named Actors](#call-named-actors)
     - [Call Unnamed Actors](#call-unnamed-actors)
-    - [Async and other options](#async-calls-and-other-options)
+    - [Async](#async)
+    - [Timeouts](#timeouts)
 5. [Deploy](#deploy)
     - [Defining an ActorSystem](#defining-an-actorsytem)
     - [Defining an ActorHost](#defining-an-actorhost)
@@ -92,7 +93,7 @@ The second thing we have to do is add the spawn dependency to the project.
 <dependency>
    <groupId>com.github.eigr</groupId>
    <artifactId>spawn-java-std-sdk</artifactId>
-   <version>v0.6.2</version>
+   <version>v0.6.5</version>
 </dependency>
 ```
 We're also going to configure a few things for our application build to work, including compiling the protobuf files. 
@@ -126,7 +127,7 @@ See below a full example of the pom.xml file:
       <dependency>
          <groupId>com.github.eigr</groupId>
          <artifactId>spawn-java-std-sdk</artifactId>
-         <version>v0.6.2</version>
+         <version>v0.6.5</version>
       </dependency>
       <dependency>
          <groupId>ch.qos.logback</groupId>
@@ -837,8 +838,8 @@ Domain.Request msg = Domain.Request.newBuilder()
        .setLanguage("erlang")
        .build();
 
-Optional<Object> maybeResponse = joeActor.invoke("setLanguage", msg, Domain.Reply.class);
-Domain.Reply reply = (Domain.Reply)maybeResponse.get();
+Optional<Domain.Reply> maybeResponse = joeActor.invoke("setLanguage", msg, Domain.Reply.class);
+Domain.Reply reply = maybeResponse.get();
 ```
 
 More detailed in complete main class:
@@ -874,7 +875,7 @@ public class App {
               .build();
 
       Optional<Object> maybeResponse = joeActor.invoke("setLanguage", msg, Domain.Reply.class);
-      Domain.Reply reply = (Domain.Reply)maybeResponse.get();
+      Domain.Reply reply = maybeResponse.get();
    }
 }
 ```
@@ -920,8 +921,8 @@ Domain.Request msg = Domain.Request.newBuilder()
        .setLanguage("erlang")
        .build();
 
-Optional<Object> maybeResponse = mike.invoke("setLanguage", msg, Domain.Reply.class);
-Domain.Reply reply = (Domain.Reply)maybeResponse.get();
+Optional<Domain.Reply> maybeResponse = mike.invoke("setLanguage", msg, Domain.Reply.class);
+Domain.Reply reply = maybeResponse.get();
 ```
 
 The important part of the code above is the following snippet:
@@ -934,7 +935,7 @@ These tells Spawn that this actor will actually be named at runtime. The name pa
 in this case is just a reference to "abs_actor" Actor that will be used later 
 so that we can actually create an instance of the real Actor.
 
-### Async calls and other options
+### Async
 
 Basically Spawn can perform actor functions in two ways. Synchronously, where the callee waits for a response, 
 or asynchronously, where the callee doesn't care about the return value of the call. 
@@ -947,6 +948,45 @@ Therefore, to call an actor's function asynchronously, just use the invokeAsync
 mike.invokeAsync("setLanguage", msg);
 ```
 
+### Timeouts
+
+It is possible to change the request waiting timeout using the invocation options as below:
+
+```Java
+package io.eigr.spawn.java.demo;
+
+import io.eigr.spawn.api.ActorRef;
+import io.eigr.spawn.api.InvocationOpts;
+import io.eigr.spawn.api.Spawn;
+import io.eigr.spawn.api.TransportOpts;
+import io.eigr.spawn.java.demo.domain.Domain;
+
+import java.util.Optional;
+
+public class App {
+   public static void main(String[] args) throws Exception {
+      Spawn spawnSystem = new Spawn.SpawnSystem()
+              .create("spawn-system")
+              .withActor(Joe.class)
+              .build();
+
+      spawnSystem.start();
+
+      ActorRef joeActor = spawnSystem.createActorRef("spawn-system", "joe");
+
+      Domain.Request msg = Domain.Request.newBuilder()
+              .setLanguage("erlang")
+              .build();
+
+      InvocationOpts opts = InvocationOpts.builder()
+              .timeoutSeconds(Duration.ofSeconds(30))
+              .build();
+      
+      Optional<Domain.Reply> maybeResponse = joeActor.invoke("setLanguage", msg, Domain.Reply.class, opts);
+   }
+}
+```
+
 ## Deploy
 
 See [Getting Started](https://github.com/eigr/spawn#getting-started) section from the main Spawn repository for more 

pom.xml

@@ -4,7 +4,7 @@
     <groupId>io.eigr.spawn</groupId>
     <artifactId>spawn-java-std-sdk</artifactId>
     <packaging>jar</packaging>
-    <version>0.6.2</version>
+    <version>0.6.5</version>
     <name>spawn-java-std-sdk</name>
     <url>http://maven.apache.org</url>
 

src/main/java/io/eigr/spawn/api/ActorRef.java

@@ -12,6 +12,8 @@
 import io.eigr.spawn.internal.transport.client.SpawnClient;
 
 import java.time.Duration;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
 import java.util.Optional;
 
@@ -216,6 +218,7 @@ public <T extends GeneratedMessageV3> void invokeAsync(String action, Invocation
                 .async(true)
                 .delay(opts.getDelay())
                 .scheduledTo(opts.getScheduledTo())
+                .timeoutSeconds(opts.getTimeoutSeconds())
                 .build();
 
         invokeActor(action, Empty.getDefaultInstance(), null, Optional.ofNullable(mergedOpts));
@@ -251,6 +254,7 @@ public <T extends GeneratedMessageV3, S extends GeneratedMessageV3> void invokeA
                 .async(true)
                 .delay(opts.getDelay())
                 .scheduledTo(opts.getScheduledTo())
+                .timeoutSeconds(opts.getTimeoutSeconds())
                 .build();
 
         invokeActor(action, value, null, Optional.of(mergedOpts));
@@ -286,6 +290,7 @@ private <T extends GeneratedMessageV3, S extends GeneratedMessageV3> Optional<T>
 
         Protocol.InvocationRequest.Builder invocationRequestBuilder = Protocol.InvocationRequest.newBuilder();
 
+        Map<String, String> metadata = new HashMap<>();
         if (options.isPresent()) {
             InvocationOpts opts = options.get();
             invocationRequestBuilder.setAsync(opts.isAsync());
@@ -295,6 +300,8 @@ private <T extends GeneratedMessageV3, S extends GeneratedMessageV3> Optional<T>
             } else if (opts.getScheduledTo().isPresent()) {
                 invocationRequestBuilder.setScheduledTo(opts.getScheduleTimeInLong());
             }
+
+            metadata.put("request-timeout", String.valueOf(opts.getTimeout()));
         }
 
         final ActorOuterClass.Actor actorRef = ActorOuterClass.Actor.newBuilder()
@@ -303,11 +310,14 @@ private <T extends GeneratedMessageV3, S extends GeneratedMessageV3> Optional<T>
 
         Any commandArg = Any.pack(argument);
 
+
+
         invocationRequestBuilder
                 .setSystem(ActorOuterClass.ActorSystem.newBuilder().setName(this.actorId.getSystem()).build())
                 .setActor(actorRef)
                 .setActionName(cmd)
                 .setValue(commandArg)
+                .putAllMetadata(metadata)
                 .build();
 
         Protocol.InvocationResponse resp = this.client.invoke(invocationRequestBuilder.build());

src/main/java/io/eigr/spawn/api/InvocationOpts.java

@@ -5,6 +5,7 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+import java.time.Duration;
 import java.time.LocalDateTime;
 import java.time.temporal.ChronoUnit;
 import java.util.Optional;
@@ -18,6 +19,9 @@ public class InvocationOpts {
     @Builder.Default
     private boolean async = false;
 
+    @Builder.Default
+    private Duration timeoutSeconds = Duration.ofSeconds(10);
+
     @Builder.Default
     private Optional<Long> delay = Optional.empty();
 
@@ -32,4 +36,8 @@ public long getScheduleTimeInLong() {
 
         return 0;
     }
+
+    public long getTimeout() {
+        return this.timeoutSeconds.toMillis();
+    }
 }

src/test/java/io/eigr/spawn/SpawnTest.java

@@ -1,5 +1,6 @@
 package io.eigr.spawn;
 
+import io.eigr.spawn.api.InvocationOpts;
 import io.eigr.spawn.api.Spawn;
 import io.eigr.spawn.api.ActorRef;
 import io.eigr.spawn.api.TransportOpts;
@@ -8,6 +9,7 @@
 import org.junit.Before;
 import org.junit.Test;
 
+import java.time.Duration;
 import java.util.Optional;
 
 import static org.junit.Assert.assertEquals;