Improve locked_by parsing

Author: andystaples

durabletask/entities/entity_instance_id.py

@@ -37,4 +37,4 @@ def parse(entity_id: str) -> Optional["EntityInstanceId"]:
             _, entity, key = entity_id.split("@", 2)
             return EntityInstanceId(entity=entity, key=key)
         except ValueError as ex:
-            raise ValueError("Invalid entity ID format", ex)
+            raise ValueError(f"Invalid entity ID format: {entity_id}", ex)

durabletask/entities/entity_metadata.py

@@ -38,7 +38,7 @@ def __init__(self,
         self.id = id
         self.last_modified = last_modified
         self.backlog_queue_size = backlog_queue_size
-        self.locked_by = locked_by
+        self._locked_by = locked_by
         self.includes_state = includes_state
         self._state = state
 
@@ -81,3 +81,17 @@ def get_state(self, intended_type: Optional[Type[TState]] = None) -> Union[None,
             raise TypeError(
                 f"Could not convert state of type '{type(self._state).__name__}' to '{intended_type.__name__}'"
             ) from ex
+
+    def get_locked_by(self) -> Optional[EntityInstanceId]:
+        """Get the identifier of the worker that currently holds the lock on the entity.
+
+        Returns
+        -------
+        str
+            The identifier of the worker that currently holds the lock on the entity.
+        """
+        if not self._locked_by:
+            return None
+
+        # Will throw ValueError if the format is invalid
+        return EntityInstanceId.parse(self._locked_by)

tests/durabletask-azuremanaged/test_dts_class_based_entities_e2e.py

@@ -63,7 +63,7 @@ def do_nothing(self, _):
         state = c.get_entity(entity_id)
         assert state is not None
         assert state.id == entity_id
-        assert state.locked_by is None
+        assert state.get_locked_by() is None
         assert state.last_modified > datetime.now(timezone.utc)
         assert state.get_state(int) == 1
 

tests/durabletask-azuremanaged/test_dts_function_based_entities_e2e.py

@@ -63,7 +63,7 @@ def empty_entity(ctx: entities.EntityContext, _):
         state = c.get_entity(entity_id)
         assert state is not None
         assert state.id == entity_id
-        assert state.locked_by is None
+        assert state.get_locked_by() is None
         assert state.last_modified > datetime.now(timezone.utc)
         assert state.get_state(int) == 1