Move Protobuf serde to separate module (#253)

Author: slinkydeveloper

sdk-common/src/main/java/dev/restate/sdk/common/CoreSerdes.java

@@ -13,9 +13,6 @@
 import com.fasterxml.jackson.core.JsonParser;
 import com.fasterxml.jackson.core.JsonToken;
 import com.google.protobuf.ByteString;
-import com.google.protobuf.InvalidProtocolBufferException;
-import com.google.protobuf.MessageLite;
-import com.google.protobuf.Parser;
 import dev.restate.sdk.common.function.ThrowingBiConsumer;
 import dev.restate.sdk.common.function.ThrowingFunction;
 import java.io.ByteArrayInputStream;
@@ -146,39 +143,6 @@ public byte[] deserialize(byte[] value) {
             return p.getDoubleValue();
           });
 
-  public static <T extends MessageLite> Serde<T> ofProtobuf(Parser<T> parser) {
-    return new Serde<>() {
-      @Override
-      public byte[] serialize(@Nullable T value) {
-        return Objects.requireNonNull(value).toByteArray();
-      }
-
-      @Override
-      public T deserialize(byte[] value) {
-        try {
-          return parser.parseFrom(value);
-        } catch (InvalidProtocolBufferException e) {
-          throw new RuntimeException("Cannot deserialize Protobuf object", e);
-        }
-      }
-
-      // -- We reimplement the ByteString variants here as it might be more efficient to use them.
-      @Override
-      public ByteString serializeToByteString(@Nullable T value) {
-        return Objects.requireNonNull(value).toByteString();
-      }
-
-      @Override
-      public T deserialize(ByteString byteString) {
-        try {
-          return parser.parseFrom(byteString);
-        } catch (InvalidProtocolBufferException e) {
-          throw new RuntimeException("Cannot deserialize Protobuf object", e);
-        }
-      }
-    };
-  }
-
   // --- Helpers for jackson-core
 
   private static final JsonFactory JSON_FACTORY = new JsonFactory();

sdk-serde-protobuf/build.gradle.kts

@@ -0,0 +1,14 @@
+plugins {
+  `java-library`
+  `library-publishing-conventions`
+}
+
+description = "Restate SDK Protobuf integration"
+
+dependencies {
+  compileOnly(coreLibs.jspecify)
+
+  api(coreLibs.protobuf.java)
+
+  implementation(project(":sdk-common"))
+}

sdk-serde-protobuf/src/main/java/dev/restate/sdk/serde/protobuf/ProtobufSerdes.java

@@ -0,0 +1,56 @@
+// Copyright (c) 2023 - Restate Software, Inc., Restate GmbH
+//
+// This file is part of the Restate Java SDK,
+// which is released under the MIT license.
+//
+// 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.serde.protobuf;
+
+import com.google.protobuf.ByteString;
+import com.google.protobuf.InvalidProtocolBufferException;
+import com.google.protobuf.MessageLite;
+import com.google.protobuf.Parser;
+import dev.restate.sdk.common.Serde;
+import java.util.Objects;
+import org.jspecify.annotations.Nullable;
+
+/** Collection of serializers/deserializers for Protobuf */
+public abstract class ProtobufSerdes {
+
+  private ProtobufSerdes() {}
+
+  public static <T extends MessageLite> Serde<T> of(Parser<T> parser) {
+    return new Serde<>() {
+      @Override
+      public byte[] serialize(@Nullable T value) {
+        return Objects.requireNonNull(value).toByteArray();
+      }
+
+      @Override
+      public T deserialize(byte[] value) {
+        try {
+          return parser.parseFrom(value);
+        } catch (InvalidProtocolBufferException e) {
+          throw new RuntimeException("Cannot deserialize Protobuf object", e);
+        }
+      }
+
+      // -- We reimplement the ByteString variants here as it might be more efficient to use them.
+      @Override
+      public ByteString serializeToByteString(@Nullable T value) {
+        return Objects.requireNonNull(value).toByteString();
+      }
+
+      @Override
+      public T deserialize(ByteString byteString) {
+        try {
+          return parser.parseFrom(byteString);
+        } catch (InvalidProtocolBufferException e) {
+          throw new RuntimeException("Cannot deserialize Protobuf object", e);
+        }
+      }
+    };
+  }
+}

sdk-workflow-api/build.gradle.kts

@@ -19,6 +19,7 @@ dependencies {
   implementation(jacksonLibs.jackson.annotations)
   implementation(jacksonLibs.jackson.jsr310)
   implementation(project(":sdk-serde-jackson"))
+  implementation(project(":sdk-serde-protobuf"))
 
   testImplementation(testingLibs.junit.jupiter)
   testImplementation(testingLibs.assertj)

sdk-workflow-api/src/main/java/dev/restate/sdk/workflow/impl/WorkflowImpl.java

@@ -17,6 +17,7 @@
 import dev.restate.sdk.common.*;
 import dev.restate.sdk.common.syscalls.ComponentDefinition;
 import dev.restate.sdk.serde.jackson.JacksonSerdes;
+import dev.restate.sdk.serde.protobuf.ProtobufSerdes;
 import dev.restate.sdk.workflow.WorkflowContext;
 import dev.restate.sdk.workflow.WorkflowExecutionState;
 import dev.restate.sdk.workflow.generated.*;
@@ -32,27 +33,27 @@ public class WorkflowImpl implements BindableComponent<Component.Options> {
   static final Serde<WorkflowExecutionState> WORKFLOW_EXECUTION_STATE_SERDE =
       JacksonSerdes.of(WorkflowExecutionState.class);
   static final Serde<GetStateResponse> GET_STATE_RESPONSE_SERDE =
-      CoreSerdes.ofProtobuf(GetStateResponse.parser());
+      ProtobufSerdes.of(GetStateResponse.parser());
   static final Serde<SetStateRequest> SET_STATE_REQUEST_SERDE =
-      CoreSerdes.ofProtobuf(SetStateRequest.parser());
+      ProtobufSerdes.of(SetStateRequest.parser());
   static final Serde<WaitDurablePromiseCompletionRequest>
       WAIT_DURABLE_PROMISE_COMPLETION_REQUEST_SERDE =
-          CoreSerdes.ofProtobuf(WaitDurablePromiseCompletionRequest.parser());
+          ProtobufSerdes.of(WaitDurablePromiseCompletionRequest.parser());
   static final Serde<MaybeDurablePromiseCompletion> MAYBE_DURABLE_PROMISE_COMPLETION_SERDE =
-      CoreSerdes.ofProtobuf(MaybeDurablePromiseCompletion.parser());
+      ProtobufSerdes.of(MaybeDurablePromiseCompletion.parser());
   static final Serde<CompleteDurablePromiseRequest> COMPLETE_DURABLE_PROMISE_REQUEST_SERDE =
-      CoreSerdes.ofProtobuf(CompleteDurablePromiseRequest.parser());
+      ProtobufSerdes.of(CompleteDurablePromiseRequest.parser());
   static final Serde<GetOutputResponse> GET_OUTPUT_RESPONSE_SERDE =
-      CoreSerdes.ofProtobuf(GetOutputResponse.parser());
+      ProtobufSerdes.of(GetOutputResponse.parser());
   private static final Serde<SetOutputRequest> SET_OUTPUT_REQUEST_SERDE =
-      CoreSerdes.ofProtobuf(SetOutputRequest.parser());
+      ProtobufSerdes.of(SetOutputRequest.parser());
   private static final Serde<DurablePromiseCompletion> DURABLE_PROMISE_COMPLETION_SERDE =
-      CoreSerdes.ofProtobuf(DurablePromiseCompletion.parser());
+      ProtobufSerdes.of(DurablePromiseCompletion.parser());
 
   private static final Serde<Set<String>> DURABLEPROMISE_LISTENER_SERDE =
       JacksonSerdes.of(new TypeReference<>() {});
   private static final StateKey<MethodOutput> OUTPUT_KEY =
-      StateKey.of("_output", CoreSerdes.ofProtobuf(MethodOutput.parser()));
+      StateKey.of("_output", ProtobufSerdes.of(MethodOutput.parser()));
 
   private static final StateKey<WorkflowExecutionState> WORKFLOW_EXECUTION_STATE_KEY =
       StateKey.of("_workflow_execution_state", WORKFLOW_EXECUTION_STATE_SERDE);

settings.gradle.kts

@@ -18,6 +18,7 @@ include(
     "sdk-api-kotlin",
     "sdk-core",
     "sdk-serde-jackson",
+    "sdk-serde-protobuf",
     "sdk-http-vertx",
     "sdk-lambda",
     "sdk-testing",