Renamings

README.md

@@ -28,10 +28,10 @@ Scaffold a project using the build tool of your choice. For example, with Gradle
 gradle init --type java-application
 ```
 
-Add the dependency [sdk-java-blocking](sdk-java-blocking):
+Add the dependency [sdk-api](sdk-api):
 
 ```
-implementation("dev.restate.sdk:sdk-java-blocking:1.0-SNAPSHOT")
+implementation("dev.restate.sdk:sdk-api:1.0-SNAPSHOT")
 ```
 
 Now you need to configure the protobuf plugin to build your Protobuf contracts. For example, with Gradle (Kotlin script):
@@ -61,7 +61,7 @@ protobuf {
   plugins {
     // The Restate plugin depends on the gRPC generated code
     id("grpc") { artifact = "io.grpc:protoc-gen-grpc-java:1.58.0" }
-    id("restate") { artifact = "dev.restate.sdk:protoc-gen-restate-java-blocking:1.0-SNAPSHOT:all@jar" }
+    id("restate") { artifact = "dev.restate.sdk:protoc-gen-restate:1.0-SNAPSHOT:all@jar" }
   }
 
   generateProtoTasks {
@@ -85,10 +85,10 @@ Scaffold a project using the build tool of your choice. For example, with Gradle
 gradle init --type kotlin-application
 ```
 
-Add the dependency [`sdk-kotlin`](sdk-kotlin):
+Add the dependency [`sdk-api-kotlin`](sdk-api-kotlin):
 
 ```
-implementation("dev.restate.sdk:sdk-kotlin:1.0-SNAPSHOT")
+implementation("dev.restate.sdk:sdk-api-kotlin:1.0-SNAPSHOT")
 ```
 
 Now you need to configure the protobuf plugin to build your Protobuf contracts. For example, with Gradle (Kotlin script):

build.gradle.kts

@@ -17,12 +17,6 @@ plugins {
 val protobufVersion = coreLibs.versions.protobuf.get()
 val restateVersion = libs.versions.restate.get()
 
-val testReport =
-    tasks.register<TestReport>("testReport") {
-      destinationDirectory.set(file("${layout.buildDirectory}/reports/tests/test"))
-      testResults.setFrom(subprojects.mapNotNull { it.tasks.findByPath("test") })
-    }
-
 allprojects {
   apply(plugin = "com.diffplug.spotless")
   apply(plugin = "com.github.jk1.dependency-license-report")
@@ -117,6 +111,12 @@ subprojects {
     options.errorprone.excludedPaths.set(".*/build/generated/.*")
   }
 
+  val testReport =
+      tasks.register<TestReport>("testReport") {
+        destinationDirectory.set(file("${layout.buildDirectory}/reports/tests/test"))
+        testResults.setFrom(subprojects.mapNotNull { it.tasks.findByPath("test") })
+      }
+
   // Test platform and reporting
   tasks.withType<Test> {
     useJUnitPlatform()

examples/build.gradle.kts

@@ -8,10 +8,10 @@ plugins {
 }
 
 dependencies {
-  implementation(project(":sdk-java-blocking"))
+  implementation(project(":sdk-api"))
   implementation(project(":sdk-lambda"))
   implementation(project(":sdk-http-vertx"))
-  implementation(project(":sdk-kotlin"))
+  implementation(project(":sdk-api-kotlin"))
   implementation(project(":sdk-serde-jackson"))
 
   implementation(coreLibs.protobuf.java)
@@ -35,7 +35,7 @@ dependencies {
 
 val pluginJar =
     file(
-        "${project.rootProject.rootDir}/protoc-gen-restate-java-blocking/build/libs/protoc-gen-restate-java-blocking-${project.version}-all.jar")
+        "${project.rootProject.rootDir}/protoc-gen-restate/build/libs/protoc-gen-restate-${project.version}-all.jar")
 
 protobuf {
   plugins {
@@ -52,7 +52,7 @@ protobuf {
 
   generateProtoTasks {
     ofSourceSet("main").forEach {
-      it.dependsOn(":protoc-gen-restate-java-blocking:shadowJar")
+      it.dependsOn(":protoc-gen-restate:shadowJar")
       it.plugins {
         id("grpc")
         id("grpckt")

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

@@ -8,9 +8,9 @@
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
 package dev.restate.sdk.examples;
 
-import dev.restate.sdk.blocking.RestateContext;
-import dev.restate.sdk.core.CoreSerdes;
-import dev.restate.sdk.core.StateKey;
+import dev.restate.sdk.RestateContext;
+import dev.restate.sdk.common.CoreSerdes;
+import dev.restate.sdk.common.StateKey;
 import dev.restate.sdk.examples.generated.*;
 import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder;
 import org.apache.logging.log4j.LogManager;

examples/src/main/java/dev/restate/sdk/examples/VanillaGrpcCounter.java

@@ -9,10 +9,10 @@
 package dev.restate.sdk.examples;
 
 import com.google.protobuf.Empty;
-import dev.restate.sdk.blocking.RestateBlockingService;
-import dev.restate.sdk.blocking.RestateContext;
-import dev.restate.sdk.core.CoreSerdes;
-import dev.restate.sdk.core.StateKey;
+import dev.restate.sdk.RestateBlockingService;
+import dev.restate.sdk.RestateContext;
+import dev.restate.sdk.common.CoreSerdes;
+import dev.restate.sdk.common.StateKey;
 import dev.restate.sdk.examples.generated.*;
 import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder;
 import io.grpc.stub.StreamObserver;

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

@@ -9,8 +9,8 @@
 package dev.restate.sdk.examples
 
 import com.google.protobuf.Empty
-import dev.restate.sdk.core.CoreSerdes
-import dev.restate.sdk.core.StateKey
+import dev.restate.sdk.common.CoreSerdes
+import dev.restate.sdk.common.StateKey
 import dev.restate.sdk.examples.generated.*
 import dev.restate.sdk.http.vertx.RestateHttpEndpointBuilder
 import dev.restate.sdk.kotlin.RestateCoroutineService

protoc-gen-restate-java-blocking/build.gradle.kts → protoc-gen-restate/build.gradle.kts

@@ -7,17 +7,17 @@ plugins {
   `library-publishing-conventions`
 }
 
-description = "Protoc plugin to generate interfaces compatible with dev.restate:sdk-java-blocking"
+description = "Protoc plugin to generate interfaces compatible with dev.restate:sdk-api"
 
 dependencies {
   compileOnly(coreLibs.javax.annotation.api)
   implementation("com.salesforce.servicelibs:jprotoc:1.2.2") {
     exclude("javax.annotation", "javax.annotation-api")
   }
-  implementation(project(":sdk-core"))
+  implementation(project(":sdk-api-common"))
 }
 
-application { mainClass.set("dev.restate.sdk.blocking.gen.JavaBlockingGen") }
+application { mainClass.set("dev.restate.sdk.gen.JavaGen") }
 
 tasks.named<ShadowJar>("shadowJar") {
   // Override the default jar

protoc-gen-restate-java-blocking/src/main/java/dev/restate/sdk/blocking/gen/CodeGenUtils.java → protoc-gen-restate/src/main/java/dev/restate/sdk/gen/CodeGenUtils.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.blocking.gen;
+package dev.restate.sdk.gen;
 
 import com.google.common.html.HtmlEscapers;
 import com.google.protobuf.DescriptorProtos;

protoc-gen-restate-java-blocking/src/main/java/dev/restate/sdk/blocking/gen/JavaBlockingGen.java → protoc-gen-restate/src/main/java/dev/restate/sdk/gen/JavaGen.java

@@ -6,9 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.blocking.gen;
-
-import static dev.restate.sdk.blocking.gen.CodeGenUtils.*;
+package dev.restate.sdk.gen;
 
 import com.google.protobuf.DescriptorProtos;
 import com.google.protobuf.compiler.PluginProtos;
@@ -23,7 +21,7 @@
 import java.util.stream.Collectors;
 import java.util.stream.IntStream;
 
-public class JavaBlockingGen extends Generator {
+public class JavaGen extends Generator {
 
   @Override
   protected List<PluginProtos.CodeGeneratorResponse.Feature> supportedFeatures() {
@@ -93,15 +91,15 @@ private ServiceContext buildServiceContext(
     DescriptorProtos.SourceCodeInfo.Location serviceLocation =
         locations.stream()
             .filter(
-                locationPathMatcher(
+                CodeGenUtils.locationPathMatcher(
                     DescriptorProtos.FileDescriptorProto.SERVICE_FIELD_NUMBER, serviceIndex))
             .findFirst()
             .orElseGet(DescriptorProtos.SourceCodeInfo.Location::getDefaultInstance);
     serviceContext.javadoc =
-        getJavadoc(
-            getComments(serviceLocation),
+        CodeGenUtils.getJavadoc(
+            CodeGenUtils.getComments(serviceLocation),
             serviceProto.getOptions().getDeprecated(),
-            SERVICE_INDENDATION);
+            CodeGenUtils.SERVICE_INDENDATION);
 
     for (int methodIndex = 0; methodIndex < serviceProto.getMethodCount(); methodIndex++) {
       serviceContext.methods.add(
@@ -118,34 +116,34 @@ private MethodContext buildMethodContext(
       int serviceIndex,
       int methodIndex) {
     MethodContext methodContext = new MethodContext();
-    methodContext.methodName = mixedLower(methodProto.getName());
+    methodContext.methodName = CodeGenUtils.mixedLower(methodProto.getName());
     // This is needed to avoid clashes with generated oneWay and delayed methods.
     methodContext.topLevelClientMethodName =
         (methodContext.methodName.equals("oneWay") || methodContext.methodName.equals("delayed"))
-            ? "call" + firstUppercase(methodContext.methodName)
+            ? "call" + CodeGenUtils.firstUppercase(methodContext.methodName)
             : methodContext.methodName;
     methodContext.inputType = typeMap.toJavaTypeName(methodProto.getInputType());
-    methodContext.isInputEmpty = isGoogleProtobufEmpty(methodProto.getInputType());
+    methodContext.isInputEmpty = CodeGenUtils.isGoogleProtobufEmpty(methodProto.getInputType());
     methodContext.outputType = typeMap.toJavaTypeName(methodProto.getOutputType());
-    methodContext.isOutputEmpty = isGoogleProtobufEmpty(methodProto.getOutputType());
+    methodContext.isOutputEmpty = CodeGenUtils.isGoogleProtobufEmpty(methodProto.getOutputType());
     methodContext.deprecated = methodProto.getOptions().getDeprecated();
 
     // Resolve javadoc
     DescriptorProtos.SourceCodeInfo.Location serviceLocation =
         locations.stream()
             .filter(
-                locationPathMatcher(
+                CodeGenUtils.locationPathMatcher(
                     DescriptorProtos.FileDescriptorProto.SERVICE_FIELD_NUMBER,
                     serviceIndex,
                     DescriptorProtos.ServiceDescriptorProto.METHOD_FIELD_NUMBER,
                     methodIndex))
             .findFirst()
             .orElseGet(DescriptorProtos.SourceCodeInfo.Location::getDefaultInstance);
     methodContext.javadoc =
-        getJavadoc(
-            getComments(serviceLocation),
+        CodeGenUtils.getJavadoc(
+            CodeGenUtils.getComments(serviceLocation),
             methodProto.getOptions().getDeprecated(),
-            METHOD_INDENDATION);
+            CodeGenUtils.METHOD_INDENDATION);
 
     return methodContext;
   }
@@ -216,15 +214,15 @@ public String methodNameUpperUnderscore() {
     }
 
     public String methodDescriptorGetter() {
-      return mixedLower("get_" + methodName + "_method");
+      return CodeGenUtils.mixedLower("get_" + methodName + "_method");
     }
   }
 
   public static void main(String[] args) {
     if (args.length == 0) {
-      ProtocPlugin.generate(List.of(new JavaBlockingGen()), List.of(Ext.serviceType));
+      ProtocPlugin.generate(List.of(new JavaGen()), List.of(Ext.serviceType));
     } else {
-      ProtocPlugin.debug(List.of(new JavaBlockingGen()), List.of(Ext.serviceType), args[0]);
+      ProtocPlugin.debug(List.of(new JavaGen()), List.of(Ext.serviceType), args[0]);
     }
   }
 }

protoc-gen-restate-java-blocking/src/main/resources/blockingStub.mustache → protoc-gen-restate/src/main/resources/blockingStub.mustache

@@ -2,9 +2,9 @@
 package {{packageName}};
 {{/packageName}}
 
-import dev.restate.sdk.blocking.RestateContext;
-import dev.restate.sdk.blocking.Awaitable;
-import dev.restate.sdk.core.syscalls.Syscalls;
+import dev.restate.sdk.RestateContext;
+import dev.restate.sdk.Awaitable;
+import dev.restate.sdk.common.syscalls.Syscalls;
 import java.time.Duration;
 import static {{packageName}}.{{serviceName}}Grpc.getServiceDescriptor;
 
@@ -93,15 +93,15 @@ public class {{className}} {
     }
 
 {{{javadoc}}}
-    public static abstract class {{serviceName}}RestateImplBase implements dev.restate.sdk.blocking.RestateBlockingService {
+    public static abstract class {{serviceName}}RestateImplBase implements dev.restate.sdk.RestateBlockingService {
 
         {{#methods}}
         {{#deprecated}}
         @java.lang.Deprecated
         {{/deprecated}}
 {{{javadoc}}}
-        public {{#isOutputEmpty}}void{{/isOutputEmpty}}{{^isOutputEmpty}}{{outputType}}{{/isOutputEmpty}} {{methodName}}(RestateContext context{{^isInputEmpty}}, {{inputType}} request{{/isInputEmpty}}) throws dev.restate.sdk.core.TerminalException {
-            throw new dev.restate.sdk.core.TerminalException(dev.restate.sdk.core.TerminalException.Code.UNIMPLEMENTED);
+        public {{#isOutputEmpty}}void{{/isOutputEmpty}}{{^isOutputEmpty}}{{outputType}}{{/isOutputEmpty}} {{methodName}}(RestateContext context{{^isInputEmpty}}, {{inputType}} request{{/isInputEmpty}}) throws dev.restate.sdk.common.TerminalException {
+            throw new dev.restate.sdk.common.TerminalException(dev.restate.sdk.common.TerminalException.Code.UNIMPLEMENTED);
         }
 
         {{/methods}}

sdk-api-common/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+  `java-library`
+  `library-publishing-conventions`
+}
+
+description = "Common interfaces of the Restate SDK"
+
+dependencies {
+  api(coreLibs.protobuf.java)
+  api(coreLibs.grpc.api)
+
+  testImplementation(testingLibs.junit.jupiter)
+  testImplementation(testingLibs.assertj)
+}

sdk-core/src/main/java/dev/restate/sdk/core/AbortedExecutionException.java → sdk-api-common/src/main/java/dev/restate/sdk/common/AbortedExecutionException.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 /** You MUST NOT catch this exception. */
 public final class AbortedExecutionException extends Throwable {

sdk-core/src/main/java/dev/restate/sdk/core/BindableBlockingService.java → sdk-api-common/src/main/java/dev/restate/sdk/common/BindableBlockingService.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 import io.grpc.BindableService;
 

sdk-core/src/main/java/dev/restate/sdk/core/BindableNonBlockingService.java → sdk-api-common/src/main/java/dev/restate/sdk/common/BindableNonBlockingService.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 import io.grpc.BindableService;
 

sdk-core/src/main/java/dev/restate/sdk/core/CoreSerdes.java → sdk-api-common/src/main/java/dev/restate/sdk/common/CoreSerdes.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 import com.google.protobuf.ByteString;
 import com.google.protobuf.InvalidProtocolBufferException;

sdk-core/src/main/java/dev/restate/sdk/core/InvocationId.java → sdk-api-common/src/main/java/dev/restate/sdk/common/InvocationId.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 import io.grpc.Context;
 

sdk-core/src/main/java/dev/restate/sdk/core/Serde.java → sdk-api-common/src/main/java/dev/restate/sdk/common/Serde.java

@@ -6,11 +6,11 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 import com.google.protobuf.ByteString;
 import com.google.protobuf.UnsafeByteOperations;
-import dev.restate.sdk.core.function.ThrowingFunction;
+import dev.restate.sdk.common.function.ThrowingFunction;
 import java.util.Objects;
 import javax.annotation.Nullable;
 

sdk-core/src/main/java/dev/restate/sdk/core/StateKey.java → sdk-api-common/src/main/java/dev/restate/sdk/common/StateKey.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 /**
  * This class holds information about state's name and its type tag to be used for serializing and

sdk-core/src/main/java/dev/restate/sdk/core/TerminalException.java → sdk-api-common/src/main/java/dev/restate/sdk/common/TerminalException.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core;
+package dev.restate.sdk.common;
 
 /** When thrown in a Restate service method, it will complete the invocation with an error. */
 public class TerminalException extends RuntimeException {

sdk-core/src/main/java/dev/restate/sdk/core/function/ThrowingFunction.java → sdk-api-common/src/main/java/dev/restate/sdk/common/function/ThrowingFunction.java

@@ -6,7 +6,7 @@
 // You can find a copy of the license in file LICENSE in the root
 // directory of this repository or package, or at
 // https://github.com/restatedev/sdk-java/blob/main/LICENSE
-package dev.restate.sdk.core.function;
+package dev.restate.sdk.common.function;
 
 import java.util.function.Function;