Bump Protocol V5 (#461)

Author: slinkydeveloper

sdk-core/src/main/java/dev/restate/sdk/core/statemachine/ServiceProtocol.java

@@ -13,9 +13,9 @@
 
 public class ServiceProtocol {
   public static final Protocol.ServiceProtocolVersion MIN_SERVICE_PROTOCOL_VERSION =
-      Protocol.ServiceProtocolVersion.V4;
+      Protocol.ServiceProtocolVersion.V5;
   public static final Protocol.ServiceProtocolVersion MAX_SERVICE_PROTOCOL_VERSION =
-      Protocol.ServiceProtocolVersion.V4;
+      Protocol.ServiceProtocolVersion.V5;
 
   static final String CONTENT_TYPE = "content-type";
 
@@ -37,6 +37,9 @@ static Protocol.ServiceProtocolVersion parseServiceProtocolVersion(String versio
     if (version.equals("application/vnd.restate.invocation.v4")) {
       return Protocol.ServiceProtocolVersion.V4;
     }
+    if (version.equals("application/vnd.restate.invocation.v5")) {
+      return Protocol.ServiceProtocolVersion.V5;
+    }
     return Protocol.ServiceProtocolVersion.SERVICE_PROTOCOL_VERSION_UNSPECIFIED;
   }
 
@@ -53,6 +56,9 @@ static String serviceProtocolVersionToHeaderValue(Protocol.ServiceProtocolVersio
     if (Objects.requireNonNull(version) == Protocol.ServiceProtocolVersion.V4) {
       return "application/vnd.restate.invocation.v4";
     }
+    if (Objects.requireNonNull(version) == Protocol.ServiceProtocolVersion.V5) {
+      return "application/vnd.restate.invocation.v5";
+    }
     throw new IllegalArgumentException(
         String.format("Service protocol version '%s' has no header value", version.getNumber()));
   }

sdk-core/src/main/java/dev/restate/sdk/core/statemachine/Util.java

@@ -63,7 +63,7 @@ static Protocol.ErrorMessage toErrorMessage(
     StringWriter sw = new StringWriter();
     PrintWriter pw = new PrintWriter(sw);
     throwable.printStackTrace(pw);
-    msg.setDescription(sw.toString());
+    msg.setStacktrace(sw.toString());
 
     // Add journal entry info
     if (currentCommandIndex >= 0) {

sdk-core/src/main/service-protocol/dev/restate/service/protocol.proto

@@ -21,15 +21,17 @@ enum ServiceProtocolVersion {
   // Added
   // * Entry retry mechanism: ErrorMessage.next_retry_delay, StartMessage.retry_count_since_last_stored_entry and StartMessage.duration_since_last_stored_entry
   V2 = 2;
-  // Added
-  // * New entry to cancel invocations: CancelInvocationEntryMessage
-  // * New entry to retrieve the invocation id: GetCallInvocationIdEntryMessage
-  // * New field to set idempotency key for Call entries
-  // * New entry to attach to existing invocation: AttachInvocationEntryMessage
-  // * New entry to get output of existing invocation: GetInvocationOutputEntryMessage
+  // **Yanked**
   V3 = 3;
-  // Immutable journal.
+  // **Yanked**
   V4 = 4;
+  // Immutable journal. Added:
+  // * New command to cancel invocations
+  // * Both Call and Send commands now return an additional notification to return the invocation id
+  // * New field to set idempotency key for Call/Send commands
+  // * New command to attach to existing invocation
+  // * New command to get output of existing invocation
+  V5 = 5;
 }
 
 // --- Core frames ---
@@ -94,8 +96,8 @@ message ErrorMessage {
   uint32 code = 1;
   // Contains a concise error message, e.g. Throwable#getMessage() in Java.
   string message = 2;
-  // Contains a verbose error description, e.g. the exception stacktrace.
-  string description = 3;
+  // The exception stacktrace, if available.
+  string stacktrace = 3;
 
   // Command that caused the failure. This may be outside the current stored journal size.
   // If no specific entry caused the failure, the current replayed/processed entry can be used.

sdk-core/src/test/java/dev/restate/sdk/core/AssertUtils.java

@@ -56,15 +56,15 @@ public static Consumer<? super MessageLite> exactErrorMessage(Throwable e) {
                 .returns(e.getMessage(), Protocol.ErrorMessage::getMessage)
                 .returns(
                     TerminalException.INTERNAL_SERVER_ERROR_CODE, Protocol.ErrorMessage::getCode)
-                .extracting(Protocol.ErrorMessage::getDescription, STRING)
+                .extracting(Protocol.ErrorMessage::getStacktrace, STRING)
                 .startsWith(e.getClass().getName()));
   }
 
   public static Consumer<? super MessageLite> errorDescriptionStartingWith(String str) {
     return errorMessage(
         msg ->
             assertThat(msg)
-                .extracting(Protocol.ErrorMessage::getDescription, STRING)
+                .extracting(Protocol.ErrorMessage::getStacktrace, STRING)
                 .startsWith(str));
   }
 
@@ -73,7 +73,7 @@ public static Consumer<? super MessageLite> protocolExceptionErrorMessage(int co
         msg ->
             assertThat(msg)
                 .returns(code, Protocol.ErrorMessage::getCode)
-                .extracting(Protocol.ErrorMessage::getDescription, STRING)
+                .extracting(Protocol.ErrorMessage::getStacktrace, STRING)
                 .startsWith(ProtocolException.class.getCanonicalName()));
   }
 

sdk-core/src/test/java/dev/restate/sdk/core/StateTestSuite.java

@@ -100,7 +100,7 @@ public Stream<TestDefinitions.TestDefinition> definitions() {
                     errorMessage(
                         errorMessage ->
                             assertThat(errorMessage)
-                                .extracting(Protocol.ErrorMessage::getDescription, STRING)
+                                .extracting(Protocol.ErrorMessage::getStacktrace, STRING)
                                 .startsWith(NullPointerException.class.getName()))))
             .named("Set null state"));
   }