Fix entity locking deserialization and add Jackson support for EntityInstanceId/EntityMetadata (#281)

Author: bachuv

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/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/TaskOrchestrationExecutor.java

@@ -1066,6 +1066,30 @@ private void handleEventRaised(HistoryEvent e) {
                             rawResult != null ? rawResult : "(null)"));
                 }
                 this.handleEntityResponseFromEventRaised(matchingTaskRecord, rawResult);
+            } else if (matchingTaskRecord.getDataType() == AutoCloseable.class) {
+                // In the Azure Functions trigger binding code path, entity lock grants arrive as
+                // EventRaised events (not EntityLockGranted proto events). The lock task's data type
+                // is AutoCloseable, which Jackson cannot instantiate because it's an interface.
+                // The lock handle carries no meaningful state — the actual AutoCloseable is created
+                // via thenApply in lockEntities() — so we complete with null and set critical section
+                // state here, mirroring handleEntityLockGranted().
+                String criticalSectionId = eventName;
+                this.isInCriticalSection = true;
+                this.lockedEntityIds = this.pendingLockSets.remove(criticalSectionId);
+                if (this.lockedEntityIds == null) {
+                    throw new NonDeterministicOrchestratorException(
+                            "Lock granted via EventRaised for criticalSectionId=" + criticalSectionId
+                            + " but no pending lock set was found. This indicates a non-deterministic orchestration.");
+                }
+
+                if (!this.isReplaying) {
+                    this.logger.fine(() -> String.format(
+                            "%s: Entity lock granted via EventRaised for criticalSectionId=%s",
+                            this.instanceId,
+                            criticalSectionId));
+                }
+
+                task.complete(null);
             } else {
                 try {
                     Object result = this.dataConverter.deserialize(

client/src/main/java/com/microsoft/durabletask/TypedEntityMetadata.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;
 
 /**
@@ -60,6 +63,7 @@ public final class TypedEntityMetadata<T> extends EntityMetadata {
      * @throws IllegalStateException if state was not included in this metadata
      *         (i.e., {@link #isIncludesState()} returns {@code false})
      */
+    @JsonProperty("state")
     @Nullable
     public T getState() {
         if (!this.isIncludesState()) {
@@ -75,6 +79,7 @@ public T getState() {
      *
      * @return the state type class
      */
+    @JsonIgnore
     public Class<T> getStateType() {
         return this.stateType;
     }

client/src/test/java/com/microsoft/durabletask/EntityInstanceIdTest.java

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 package com.microsoft.durabletask;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.ValueSource;
@@ -212,4 +213,61 @@ void compareTo_sortsList() {
         assertEquals("counter", ids.get(3).getName());
         assertEquals("3", ids.get(3).getKey());
     }
+
+    // region Jackson serialization tests
+
+    @Test
+    void jacksonSerialization_serializesToCompactString() throws Exception {
+        EntityInstanceId id = new EntityInstanceId("Counter", "myKey");
+        ObjectMapper mapper = new ObjectMapper();
+        String json = mapper.writeValueAsString(id);
+        assertEquals("\"@counter@myKey\"", json);
+    }
+
+    @Test
+    void jacksonDeserialization_deserializesFromCompactString() throws Exception {
+        ObjectMapper mapper = new ObjectMapper();
+        EntityInstanceId id = mapper.readValue("\"@counter@myKey\"", EntityInstanceId.class);
+        assertEquals("counter", id.getName());
+        assertEquals("myKey", id.getKey());
+    }
+
+    @Test
+    void jacksonRoundTrip_preservesIdentity() throws Exception {
+        EntityInstanceId original = new EntityInstanceId("BankAccount", "acct-123");
+        ObjectMapper mapper = new ObjectMapper();
+        String json = mapper.writeValueAsString(original);
+        EntityInstanceId deserialized = mapper.readValue(json, EntityInstanceId.class);
+        assertEquals(original, deserialized);
+    }
+
+    @Test
+    void jacksonDeserialization_inPojo_works() throws Exception {
+        // Simulates the CounterPayload scenario where EntityInstanceId is a field
+        String json = "{\"entityId\":\"@counter@c1\",\"value\":42}";
+        ObjectMapper mapper = new ObjectMapper();
+        TestPayload payload = mapper.readValue(json, TestPayload.class);
+        assertEquals("counter", payload.entityId.getName());
+        assertEquals("c1", payload.entityId.getKey());
+        assertEquals(42, payload.value);
+    }
+
+    @Test
+    void jacksonSerialization_inPojo_works() throws Exception {
+        TestPayload payload = new TestPayload();
+        payload.entityId = new EntityInstanceId("Counter", "c1");
+        payload.value = 42;
+        ObjectMapper mapper = new ObjectMapper();
+        String json = mapper.writeValueAsString(payload);
+        assertTrue(json.contains("\"@counter@c1\""));
+        assertTrue(json.contains("\"value\":42"));
+    }
+
+    /** Test POJO that embeds an EntityInstanceId, mirroring CounterPayload. */
+    public static class TestPayload {
+        public EntityInstanceId entityId;
+        public int value;
+    }
+
+    // endregion
 }

client/src/test/java/com/microsoft/durabletask/TaskOrchestrationEntityEventTest.java

@@ -1331,6 +1331,73 @@ void getLockedEntities_outsideCriticalSection_returnsEmpty() {
         assertTrue(hasComplete, "Expected orchestration to complete");
     }
 
+    /**
+     * Regression test: In the Azure Functions trigger binding code path, entity lock grants
+     * arrive as EventRaised events (not EntityLockGranted proto events). The lock task's data
+     * type is AutoCloseable, which Jackson cannot instantiate because it's an interface.
+     * This test verifies that the orchestration completes successfully when the lock grant
+     * arrives via EventRaised (simulating the Azure Functions path).
+     */
+    @Test
+    void lockEntities_lockGrantedViaEventRaised_succeeds() {
+        final String orchestratorName = "LockGrantedViaEventRaisedTest";
+        EntityInstanceId entityId = new EntityInstanceId("Counter", "c1");
+
+        TaskOrchestrationExecutor executor = createExecutor(orchestratorName, ctx -> {
+            AutoCloseable lock = ctx.lockEntities(Arrays.asList(entityId)).await();
+            assertTrue(ctx.isInCriticalSection());
+            assertFalse(ctx.getLockedEntities().isEmpty());
+            try {
+                lock.close();
+            } catch (Exception e) {
+                throw new RuntimeException(e);
+            }
+            ctx.complete("lock-via-event-raised");
+        });
+
+        // First execution: orchestrator calls lockEntities, which produces a lock request action
+        List<HistoryEvent> pastEvents1 = Arrays.asList(
+                orchestratorStarted(),
+                executionStarted(orchestratorName, "null"));
+        List<HistoryEvent> newEvents1 = Collections.singletonList(orchestratorCompleted());
+
+        TaskOrchestratorResult result1 = executor.execute(pastEvents1, newEvents1, null);
+
+        // Extract the criticalSectionId from the lock request action
+        String criticalSectionId = null;
+        try {
+            criticalSectionId = extractLockCriticalSectionId(result1.getActions());
+        } catch (Exception e) {
+            fail("Failed to extract criticalSectionId: " + e.getMessage());
+        }
+        assertNotNull(criticalSectionId, "Expected a lock request action with criticalSectionId");
+
+        // Second execution: replay with lock request in past, lock grant arrives as EventRaised
+        // (simulating the Azure Functions trigger binding path where DTFx sends lock grants
+        // as named events rather than proto EntityLockGranted events)
+        List<HistoryEvent> pastEvents2 = Arrays.asList(
+                orchestratorStarted(),
+                executionStarted(orchestratorName, "null"),
+                eventSentEvent(0),
+                orchestratorCompleted());
+        List<HistoryEvent> newEvents2 = Arrays.asList(
+                orchestratorStarted(),
+                eventRaisedEvent(criticalSectionId, "null"),
+                orchestratorCompleted());
+
+        TaskOrchestratorResult result2 = executor.execute(pastEvents2, newEvents2, null);
+
+        boolean hasComplete = false;
+        for (OrchestratorAction action : result2.getActions()) {
+            if (action.hasCompleteOrchestration()) {
+                String output = action.getCompleteOrchestration().getResult().getValue();
+                assertEquals("\"lock-via-event-raised\"", output);
+                hasComplete = true;
+            }
+        }
+        assertTrue(hasComplete, "Expected orchestration to complete after lock granted via EventRaised");
+    }
+
     @Test
     void lockEntities_varargs_producesLockAction() {
         final String orchestratorName = "VarargsLockTest";