Merge branch 'main' into vabachu/java-large-payloads

Author: bachuv

CHANGELOG.md

@@ -1,5 +1,9 @@
 ## Unreleased
-* Add work item filtering support for `DurableTaskGrpcWorker` to enable worker-side filtering of orchestration and activity work items ([#275](https://github.com/microsoft/durabletask-java/pull/275)) 
+
+## v1.9.0
+* Fix entity locking deserialization and add Jackson support for EntityInstanceId/EntityMetadata ([#281](https://github.com/microsoft/durabletask-java/pull/281))
+* Durable Entities ([#268](https://github.com/microsoft/durabletask-java/pull/268))
+* Add work item filtering support for `DurableTaskGrpcWorker` to enable worker-side filtering of orchestration and activity work items ([#275](https://github.com/microsoft/durabletask-java/pull/275))
 * Add support for calls to HTTP endpoints ([#271](https://github.com/microsoft/durabletask-java/pull/271))
 * Add getSuspendPostUri and getResumePostUri getters to HttpManagementPayload ([#264](https://github.com/microsoft/durabletask-java/pull/264))
 

azurefunctions/build.gradle

@@ -6,7 +6,7 @@ plugins {
 }
 
 group 'com.microsoft'
-version = '1.8.0'
+version = '1.9.0'
 archivesBaseName = 'durabletask-azure-functions'
 
 def protocVersion = '3.25.8'

azuremanaged/build.gradle

@@ -17,7 +17,7 @@ plugins {
 
 archivesBaseName = 'durabletask-azuremanaged'
 group 'com.microsoft'
-version = '1.8.0'
+version = '1.9.0'
 
 def grpcVersion = '1.78.0'
 def azureCoreVersion = '1.57.1'

client/build.gradle

@@ -10,7 +10,7 @@ plugins {
 }
 
 group 'com.microsoft'
-version = '1.8.0'
+version = '1.9.0'
 archivesBaseName = 'durabletask-client'
 
 def grpcVersion = '1.78.0'

client/src/main/java/com/microsoft/durabletask/DurableTaskGrpcWorker.java

@@ -48,6 +48,7 @@ public final class DurableTaskGrpcWorker implements AutoCloseable {
     private final DataConverter dataConverter;
     private final Duration maximumTimerInterval;
     private final DurableTaskGrpcWorkerVersioningOptions versioningOptions;
+    private final ExceptionPropertiesProvider exceptionPropertiesProvider;
     private final int maxConcurrentEntityWorkItems;
     private final ExecutorService workItemExecutor;
 
@@ -97,6 +98,7 @@ public final class DurableTaskGrpcWorker implements AutoCloseable {
         this.dataConverter = builder.dataConverter != null ? builder.dataConverter : new JacksonDataConverter();
         this.maximumTimerInterval = builder.maximumTimerInterval != null ? builder.maximumTimerInterval : DEFAULT_MAXIMUM_TIMER_INTERVAL;
         this.versioningOptions = builder.versioningOptions;
+        this.exceptionPropertiesProvider = builder.exceptionPropertiesProvider;
         int maxThreads = builder.maxWorkItemThreads > 0 ? builder.maxWorkItemThreads : DEFAULT_MAX_WORK_ITEM_THREADS;
         this.workItemExecutor = new ThreadPoolExecutor(
                 0, maxThreads,
@@ -172,7 +174,8 @@ public void startAndBlock() {
                 this.maximumTimerInterval,
                 logger,
                 this.versioningOptions,
-                true);
+                true,
+                this.exceptionPropertiesProvider);
         TaskActivityExecutor taskActivityExecutor = new TaskActivityExecutor(
                 this.activityFactories,
                 this.dataConverter,
@@ -402,11 +405,8 @@ public void startAndBlock() {
                                 activityRequest.getTaskId());
                         } catch (Throwable e) {
                             activityError = e;
-                            failureDetails = TaskFailureDetails.newBuilder()
-                                .setErrorType(e.getClass().getName())
-                                .setErrorMessage(e.getMessage())
-                                .setStackTrace(StringValue.of(FailureDetails.getFullStackTrace(e)))
-                                .build();
+                            failureDetails = FailureDetails.fromException(
+                                    e, this.exceptionPropertiesProvider).toProto();
                         } finally {
                             activityScope.close();
                             TracingHelper.endSpan(activitySpan, activityError);

client/src/main/java/com/microsoft/durabletask/DurableTaskGrpcWorkerBuilder.java

@@ -25,6 +25,7 @@ public final class DurableTaskGrpcWorkerBuilder {
     DataConverter dataConverter;
     Duration maximumTimerInterval;
     DurableTaskGrpcWorkerVersioningOptions versioningOptions;
+    ExceptionPropertiesProvider exceptionPropertiesProvider;
     int maxConcurrentEntityWorkItems = 1;
     int maxWorkItemThreads;
     private WorkItemFilter workItemFilter;
@@ -314,6 +315,21 @@ public DurableTaskGrpcWorkerBuilder useVersioning(DurableTaskGrpcWorkerVersionin
         return this;
     }
 
+    /**
+     * Sets the {@link ExceptionPropertiesProvider} to use for extracting custom properties from exceptions.
+     * <p>
+     * When set, the provider is invoked whenever an activity or orchestration fails with an exception. The returned
+     * properties are included in the {@link FailureDetails} and can be retrieved via
+     * {@link FailureDetails#getProperties()}.
+     *
+     * @param provider the exception properties provider
+     * @return this builder object
+     */
+    public DurableTaskGrpcWorkerBuilder exceptionPropertiesProvider(ExceptionPropertiesProvider provider) {
+        this.exceptionPropertiesProvider = provider;
+        return this;
+    }
+
     /**
      * Sets explicit work item filters for this worker. When set, only work items matching the filters
      * will be dispatched to this worker by the backend.

client/src/main/java/com/microsoft/durabletask/EntityInstanceId.java

@@ -2,7 +2,17 @@
 // Licensed under the MIT License.
 package com.microsoft.durabletask;
 
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.JsonSerializer;
+import com.fasterxml.jackson.databind.SerializerProvider;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
 import javax.annotation.Nonnull;
+import java.io.IOException;
 import java.util.Locale;
 import java.util.Objects;
 
@@ -11,7 +21,12 @@
  * <p>
  * The name typically corresponds to the entity class/type name, and the key identifies the specific
  * entity instance (e.g., a user ID or account number).
+ * <p>
+ * Serializes to and deserializes from a compact string format {@code @{name}@{key}},
+ * matching the .NET SDK's {@code EntityInstanceId} JSON representation.
  */
+@JsonSerialize(using = EntityInstanceId.Serializer.class)
+@JsonDeserialize(using = EntityInstanceId.Deserializer.class)
 public final class EntityInstanceId implements Comparable<EntityInstanceId> {
     private final String name;
     private final String key;
@@ -116,4 +131,26 @@ public int compareTo(@Nonnull EntityInstanceId other) {
         }
         return this.key.compareTo(other.key);
     }
+
+    /**
+     * Jackson serializer that writes an {@code EntityInstanceId} as a compact {@code "@name@key"} string.
+     */
+    static class Serializer extends JsonSerializer<EntityInstanceId> {
+        @Override
+        public void serialize(EntityInstanceId value, JsonGenerator gen, SerializerProvider serializers)
+                throws IOException {
+            gen.writeString(value.toString());
+        }
+    }
+
+    /**
+     * Jackson deserializer that reads an {@code EntityInstanceId} from a compact {@code "@name@key"} string.
+     */
+    static class Deserializer extends JsonDeserializer<EntityInstanceId> {
+        @Override
+        public EntityInstanceId deserialize(JsonParser p, DeserializationContext ctxt)
+                throws IOException {
+            return EntityInstanceId.fromString(p.getText());
+        }
+    }
 }

client/src/main/java/com/microsoft/durabletask/EntityMetadata.java

@@ -2,6 +2,9 @@
 // Licensed under the MIT License.
 package com.microsoft.durabletask;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+
 import javax.annotation.Nullable;
 import java.time.Instant;
 
@@ -18,8 +21,10 @@ public class EntityMetadata {
     private final Instant lastModifiedTime;
     private final int backlogQueueSize;
     private final String lockedBy;
+    @JsonIgnore
     private final String serializedState;
     private final boolean includesState;
+    @JsonIgnore
     private final DataConverter dataConverter;
     private volatile EntityInstanceId cachedEntityInstanceId;
 
@@ -56,6 +61,7 @@ public class EntityMetadata {
      *
      * @return the instance ID
      */
+    @JsonIgnore
     public String getInstanceId() {
         return this.instanceId;
     }
@@ -65,6 +71,7 @@ public String getInstanceId() {
      *
      * @return the parsed entity instance ID
      */
+    @JsonProperty("entityId")
     public EntityInstanceId getEntityInstanceId() {
         if (this.cachedEntityInstanceId == null) {
             this.cachedEntityInstanceId = EntityInstanceId.fromString(this.instanceId);

client/src/main/java/com/microsoft/durabletask/ExceptionPropertiesProvider.java

@@ -0,0 +1,45 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+package com.microsoft.durabletask;
+
+import javax.annotation.Nullable;
+import java.util.Map;
+
+/**
+ * Provider interface for extracting custom properties from exceptions.
+ * <p>
+ * Implementations of this interface can be registered with a {@link DurableTaskGrpcWorkerBuilder} to include
+ * custom exception properties in {@link FailureDetails} when activities or orchestrations fail.
+ * These properties are then available via {@link FailureDetails#getProperties()}.
+ * <p>
+ * Example usage:
+ * <pre>{@code
+ * DurableTaskGrpcWorker worker = new DurableTaskGrpcWorkerBuilder()
+ *     .exceptionPropertiesProvider(exception -> {
+ *         if (exception instanceof MyCustomException) {
+ *             MyCustomException custom = (MyCustomException) exception;
+ *             Map<String, Object> props = new HashMap<>();
+ *             props.put("errorCode", custom.getErrorCode());
+ *             props.put("retryable", custom.isRetryable());
+ *             return props;
+ *         }
+ *         return null;
+ *     })
+ *     .addOrchestration(...)
+ *     .build();
+ * }</pre>
+ */
+@FunctionalInterface
+public interface ExceptionPropertiesProvider {
+
+    /**
+     * Extracts custom properties from the given exception.
+     * <p>
+     * Return {@code null} or an empty map if no custom properties should be included for this exception.
+     *
+     * @param exception the exception to extract properties from
+     * @return a map of property names to values, or {@code null}
+     */
+    @Nullable
+    Map<String, Object> getExceptionProperties(Exception exception);
+}