Use string for custom status

durabletask/task.py

@@ -70,13 +70,13 @@ def is_replaying(self) -> bool:
         pass
 
     @abstractmethod
-    def set_custom_status(self, custom_status: Any) -> None:
+    def set_custom_status(self, custom_status: str) -> None:
         """Set the orchestration instance's custom status.
 
         Parameters
         ----------
-        custom_status: Any
-            A JSON-serializable custom status value to set.
+        custom_status: str
+            A custom status string to set.
         """
         pass
 

durabletask/worker.py

@@ -8,6 +8,7 @@
 import os
 import random
 import threading
+import warnings
 from concurrent.futures import ThreadPoolExecutor
 from datetime import datetime, timedelta
 from threading import Event, Thread
@@ -1093,10 +1094,17 @@ def current_utc_datetime(self, value: datetime):
     def is_replaying(self) -> bool:
         return self._is_replaying
 
-    def set_custom_status(self, custom_status: Any) -> None:
-        self._encoded_custom_status = (
-            shared.to_json(custom_status) if custom_status is not None else None
-        )
+    def set_custom_status(self, custom_status: str) -> None:
+        if custom_status is not None and not isinstance(custom_status, str):
+            warnings.warn(
+                "Passing a non-str value to set_custom_status is deprecated and will be "
+                "removed in a future version. Serialize your value to a JSON string before calling.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+            self._encoded_custom_status = shared.to_json(custom_status)
+        else:
+            self._encoded_custom_status = custom_status
 
     def create_timer(self, fire_at: Union[datetime, timedelta]) -> task.Task:
         return self.create_timer_internal(fire_at)

tests/durabletask/test_orchestration_e2e.py

@@ -594,7 +594,7 @@ def empty_orchestrator(ctx: task.OrchestrationContext, _):
     assert state.runtime_status == client.OrchestrationStatus.COMPLETED
     assert state.serialized_input is None
     assert state.serialized_output is None
-    assert state.serialized_custom_status == '"foobaz"'
+    assert state.serialized_custom_status == 'foobaz'
 
 
 def test_now_with_sequence_ordering():

tests/durabletask/test_orchestration_e2e_async.py

@@ -481,4 +481,4 @@ def empty_orchestrator(ctx: task.OrchestrationContext, _):
     assert state.runtime_status == OrchestrationStatus.COMPLETED
     assert state.serialized_input is None
     assert state.serialized_output is None
-    assert state.serialized_custom_status == '"foobaz"'
+    assert state.serialized_custom_status == 'foobaz'