Implement Shared handlers annotation for virtual objects (#288)

Author: slinkydeveloper

examples/src/main/java/my/restate/sdk/examples/Counter.java

@@ -9,7 +9,9 @@
 package my.restate.sdk.examples;
 
 import dev.restate.sdk.ObjectContext;
+import dev.restate.sdk.SharedObjectContext;
 import dev.restate.sdk.annotation.Handler;
+import dev.restate.sdk.annotation.Shared;
 import dev.restate.sdk.annotation.VirtualObject;
 import dev.restate.sdk.common.CoreSerdes;
 import dev.restate.sdk.common.StateKey;
@@ -36,8 +38,9 @@ public void add(ObjectContext ctx, Long request) {
     ctx.set(TOTAL, newValue);
   }
 
+  @Shared
   @Handler
-  public Long get(ObjectContext ctx) {
+  public Long get(SharedObjectContext ctx) {
     return ctx.get(TOTAL).orElse(0L);
   }
 

examples/src/main/kotlin/my/restate/sdk/examples/CounterKt.kt

@@ -9,10 +9,12 @@
 package my.restate.sdk.examples
 
 import dev.restate.sdk.annotation.Handler
+import dev.restate.sdk.annotation.Shared
 import dev.restate.sdk.annotation.VirtualObject
 import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder
 import dev.restate.sdk.kotlin.KtStateKey
 import dev.restate.sdk.kotlin.ObjectContext
+import dev.restate.sdk.kotlin.SharedObjectContext
 import kotlinx.serialization.Serializable
 import org.apache.logging.log4j.LogManager
 import org.apache.logging.log4j.Logger
@@ -40,7 +42,8 @@ class CounterKt {
   }
 
   @Handler
-  suspend fun get(ctx: ObjectContext): Long {
+  @Shared
+  suspend fun get(ctx: SharedObjectContext): Long {
     return ctx.get(TOTAL) ?: 0L
   }
 

sdk-api-gen/src/main/java/dev/restate/sdk/gen/ElementConverter.java

@@ -10,6 +10,7 @@
 
 import dev.restate.sdk.Context;
 import dev.restate.sdk.ObjectContext;
+import dev.restate.sdk.SharedObjectContext;
 import dev.restate.sdk.annotation.Exclusive;
 import dev.restate.sdk.annotation.Shared;
 import dev.restate.sdk.annotation.Workflow;
@@ -233,6 +234,8 @@ private void validateMethodSignature(
       case SHARED:
         if (serviceType == ServiceType.WORKFLOW) {
           validateFirstParameterType(WorkflowSharedContext.class, element);
+        } else if (serviceType == ServiceType.VIRTUAL_OBJECT) {
+          validateFirstParameterType(SharedObjectContext.class, element);
         } else {
           messager.printMessage(
               Diagnostic.Kind.ERROR,

sdk-api-gen/src/main/resources/templates/BindableService.hbs

@@ -13,7 +13,7 @@ public class {{generatedClassSimpleName}} implements dev.restate.sdk.common.Bind
     public {{generatedClassSimpleName}}({{originalClassFqcn}} bindableService, dev.restate.sdk.Service.Options options) {
         this.service = dev.restate.sdk.Service.{{#if isObject}}virtualObject{{else}}service{{/if}}(SERVICE_NAME)
             {{#handlers}}
-                .with(
+                .{{#if isShared}}withShared{{else if isExclusive}}withExclusive{{else}}with{{/if}}(
                 dev.restate.sdk.Service.HandlerSignature.of("{{name}}", {{{inputSerdeDecl}}}, {{{outputSerdeDecl}}}),
                 (ctx, req) -> {
                 {{#if outputEmpty}}

sdk-api-gen/src/test/java/dev/restate/sdk/CodegenTest.java

@@ -12,10 +12,8 @@
 import static dev.restate.sdk.core.TestDefinitions.testInvocation;
 
 import com.google.protobuf.ByteString;
-import dev.restate.sdk.annotation.Exclusive;
-import dev.restate.sdk.annotation.Handler;
+import dev.restate.sdk.annotation.*;
 import dev.restate.sdk.annotation.Service;
-import dev.restate.sdk.annotation.VirtualObject;
 import dev.restate.sdk.common.CoreSerdes;
 import dev.restate.sdk.common.Target;
 import dev.restate.sdk.core.ProtoUtils;
@@ -39,6 +37,12 @@ static class ObjectGreeter {
     String greet(ObjectContext context, String request) {
       return request;
     }
+
+    @Handler
+    @Shared
+    String sharedGreet(SharedObjectContext context, String request) {
+      return request;
+    }
   }
 
   @VirtualObject
@@ -113,6 +117,10 @@ public Stream<TestDefinitions.TestDefinition> definitions() {
             .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
             .onlyUnbuffered()
             .expectingOutput(outputMessage("Francesco"), END_MESSAGE),
+        testInvocation(ObjectGreeter::new, "sharedGreet")
+            .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
+            .onlyUnbuffered()
+            .expectingOutput(outputMessage("Francesco"), END_MESSAGE),
         testInvocation(ObjectGreeterImplementedFromInterface::new, "greet")
             .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
             .onlyUnbuffered()

sdk-api-kotlin-gen/src/main/kotlin/dev/restate/sdk/kotlin/gen/KElementConverter.kt

@@ -23,6 +23,7 @@ import dev.restate.sdk.gen.model.PayloadType
 import dev.restate.sdk.gen.model.Service
 import dev.restate.sdk.kotlin.Context
 import dev.restate.sdk.kotlin.ObjectContext
+import dev.restate.sdk.kotlin.SharedObjectContext
 import java.util.regex.Pattern
 import kotlin.reflect.KClass
 
@@ -128,7 +129,7 @@ class KElementConverter(private val logger: KSPLogger, private val builtIns: KSB
     }
 
     val isAnnotatedWithShared =
-        function.isAnnotationPresent(dev.restate.sdk.annotation.Service::class)
+        function.isAnnotationPresent(dev.restate.sdk.annotation.Shared::class)
     val isAnnotatedWithExclusive =
         function.isAnnotationPresent(dev.restate.sdk.annotation.Exclusive::class)
 
@@ -190,8 +191,13 @@ class KElementConverter(private val logger: KSPLogger, private val builtIns: KSB
     }
     when (handlerType) {
       HandlerType.SHARED ->
-          logger.error(
-              "The annotation @Shared is not supported by the service type $serviceType", function)
+          if (serviceType == ServiceType.VIRTUAL_OBJECT) {
+            validateFirstParameterType(SharedObjectContext::class, function)
+          } else {
+            logger.error(
+                "The annotation @Shared is not supported by the service type $serviceType",
+                function)
+          }
       HandlerType.EXCLUSIVE ->
           if (serviceType == ServiceType.VIRTUAL_OBJECT) {
             validateFirstParameterType(ObjectContext::class, function)

sdk-api-kotlin-gen/src/main/resources/templates/BindableService.hbs

@@ -11,7 +11,7 @@ class {{generatedClassSimpleName}}(
 
     val service: dev.restate.sdk.kotlin.Service = dev.restate.sdk.kotlin.Service.{{#if isObject}}virtualObject{{else}}service{{/if}}(SERVICE_NAME, options) {
         {{#handlers}}
-            handler(dev.restate.sdk.kotlin.Service.HandlerSignature("{{name}}", {{{inputSerdeDecl}}}, {{{outputSerdeDecl}}})) { ctx, req ->
+            {{#if isShared}}sharedHandler{{else if isExclusive}}exclusiveHandler{{else}}handler{{/if}}(dev.restate.sdk.kotlin.Service.HandlerSignature("{{name}}", {{{inputSerdeDecl}}}, {{{outputSerdeDecl}}})) { ctx, req ->
             {{#if inputEmpty}}bindableService.{{name}}(ctx){{else}}bindableService.{{name}}(ctx, req){{/if}}
             }
         {{/handlers}}

sdk-api-kotlin-gen/src/test/kotlin/dev/restate/sdk/kotlin/CodegenTest.kt

@@ -9,10 +9,8 @@
 package dev.restate.sdk.kotlin
 
 import com.google.protobuf.ByteString
-import dev.restate.sdk.annotation.Exclusive
-import dev.restate.sdk.annotation.Handler
+import dev.restate.sdk.annotation.*
 import dev.restate.sdk.annotation.Service
-import dev.restate.sdk.annotation.VirtualObject
 import dev.restate.sdk.common.CoreSerdes
 import dev.restate.sdk.common.Target
 import dev.restate.sdk.core.ProtoUtils.*
@@ -36,6 +34,12 @@ class CodegenTest : TestDefinitions.TestSuite {
     suspend fun greet(context: ObjectContext, request: String): String {
       return request
     }
+
+    @Handler
+    @Shared
+    suspend fun sharedGreet(context: SharedObjectContext, request: String): String {
+      return request
+    }
   }
 
   @VirtualObject
@@ -104,6 +108,10 @@ class CodegenTest : TestDefinitions.TestSuite {
             .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
             .onlyUnbuffered()
             .expectingOutput(outputMessage("Francesco"), END_MESSAGE),
+        testInvocation({ ObjectGreeter() }, "sharedGreet")
+            .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
+            .onlyUnbuffered()
+            .expectingOutput(outputMessage("Francesco"), END_MESSAGE),
         testInvocation({ ObjectGreeterImplementedFromInterface() }, "greet")
             .withInput(startMessage(1, "slinkydeveloper"), inputMessage("Francesco"))
             .onlyUnbuffered()

sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/Service.kt

@@ -9,10 +9,7 @@
 package dev.restate.sdk.kotlin
 
 import com.google.protobuf.ByteString
-import dev.restate.sdk.common.BindableService
-import dev.restate.sdk.common.Serde
-import dev.restate.sdk.common.ServiceType
-import dev.restate.sdk.common.TerminalException
+import dev.restate.sdk.common.*
 import dev.restate.sdk.common.syscalls.*
 import kotlin.coroutines.CoroutineContext
 import kotlinx.coroutines.CoroutineScope
@@ -65,18 +62,31 @@ private constructor(
   class VirtualObjectBuilder internal constructor(private val name: String) {
     private val handlers: MutableMap<String, Handler<*, *, ObjectContext>> = mutableMapOf()
 
-    fun <REQ, RES> handler(
+    fun <REQ, RES> sharedHandler(
         sig: HandlerSignature<REQ, RES>,
         runner: suspend (ObjectContext, REQ) -> RES
     ): VirtualObjectBuilder {
-      handlers[sig.name] = Handler(sig, runner)
+      handlers[sig.name] = Handler(sig, HandlerType.SHARED, runner)
       return this
     }
 
-    inline fun <reified REQ, reified RES> handler(
+    inline fun <reified REQ, reified RES> sharedHandler(
         name: String,
         noinline runner: suspend (ObjectContext, REQ) -> RES
-    ) = this.handler(HandlerSignature(name, KtSerdes.json(), KtSerdes.json()), runner)
+    ) = this.sharedHandler(HandlerSignature(name, KtSerdes.json(), KtSerdes.json()), runner)
+
+    fun <REQ, RES> exclusiveHandler(
+        sig: HandlerSignature<REQ, RES>,
+        runner: suspend (ObjectContext, REQ) -> RES
+    ): VirtualObjectBuilder {
+      handlers[sig.name] = Handler(sig, HandlerType.EXCLUSIVE, runner)
+      return this
+    }
+
+    inline fun <reified REQ, reified RES> exclusiveHandler(
+        name: String,
+        noinline runner: suspend (ObjectContext, REQ) -> RES
+    ) = this.exclusiveHandler(HandlerSignature(name, KtSerdes.json(), KtSerdes.json()), runner)
 
     fun build(options: Options) = Service(this.name, true, this.handlers, options)
   }
@@ -88,7 +98,7 @@ private constructor(
         sig: HandlerSignature<REQ, RES>,
         runner: suspend (Context, REQ) -> RES
     ): ServiceBuilder {
-      handlers[sig.name] = Handler(sig, runner)
+      handlers[sig.name] = Handler(sig, HandlerType.SHARED, runner)
       return this
     }
 
@@ -102,6 +112,7 @@ private constructor(
 
   class Handler<REQ, RES, CTX : Context>(
       private val handlerSignature: HandlerSignature<REQ, RES>,
+      private val handlerType: HandlerType,
       private val runner: suspend (CTX, REQ) -> RES,
   ) : InvocationHandler<Options> {
 
@@ -112,6 +123,7 @@ private constructor(
     fun toHandlerDefinition() =
         HandlerDefinition(
             handlerSignature.name,
+            handlerType,
             handlerSignature.requestSerde.schema(),
             handlerSignature.responseSerde.schema(),
             this)

sdk-api-kotlin/src/main/kotlin/dev/restate/sdk/kotlin/api.kt

@@ -247,7 +247,7 @@ suspend inline fun <reified T : Any> Context.awakeable(): Awakeable<T> {
  * This interface extends [Context] adding access to the virtual object instance key-value state
  * storage.
  */
-sealed interface ObjectContext : Context {
+sealed interface SharedObjectContext : Context {
 
   /** @return the key of this object */
   fun key(): String
@@ -267,6 +267,13 @@ sealed interface ObjectContext : Context {
    * @return the immutable collection of known state keys.
    */
   suspend fun stateKeys(): Collection<String>
+}
+
+/**
+ * This interface extends [Context] adding access to the virtual object instance key-value state
+ * storage.
+ */
+sealed interface ObjectContext : SharedObjectContext {
 
   /**
    * Sets the given value under the given key, serializing the value using the [StateKey.serde].