Add to workflow describe

Author: Sushisource

temporalio/client.py

@@ -2411,16 +2411,27 @@ class WorkflowExecutionDescription(WorkflowExecution):
 
     raw_description: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse
     """Underlying protobuf description."""
+    static_summary: Optional[str]
+    """Gets the single-line fixed summary for this workflow execution that may appear in
+       UI/CLI. This can be in single-line Temporal markdown format."""
+    static_details: Optional[str]
+    """Gets the general fixed details for this workflow execution that may appear in UI/CLI.
+       This can be in Temporal markdown format and can span multiple lines."""
 
     @staticmethod
-    def _from_raw_description(
+    async def _from_raw_description(
         description: temporalio.api.workflowservice.v1.DescribeWorkflowExecutionResponse,
         converter: temporalio.converter.DataConverter,
     ) -> WorkflowExecutionDescription:
+        (summ, deets) = await converter._decode_user_metadata(
+            description.execution_config.user_metadata
+        )
         return WorkflowExecutionDescription._from_raw_info(  # type: ignore
             description.workflow_execution_info,
             converter,
             raw_description=description,
+            static_summary=summ,
+            static_details=deets,
         )
 
 
@@ -5199,7 +5210,7 @@ async def cancel_workflow(self, input: CancelWorkflowInput) -> None:
     async def describe_workflow(
         self, input: DescribeWorkflowInput
     ) -> WorkflowExecutionDescription:
-        return WorkflowExecutionDescription._from_raw_description(
+        return await WorkflowExecutionDescription._from_raw_description(
             await self._client.workflow_service.describe_workflow_execution(
                 temporalio.api.workflowservice.v1.DescribeWorkflowExecutionRequest(
                     namespace=self._client.namespace,

tests/worker/test_workflow.py

@@ -46,6 +46,7 @@
 from temporalio.api.workflowservice.v1 import (
     GetWorkflowExecutionHistoryRequest,
     ResetStickyTaskQueueRequest,
+    DescribeWorkflowExecutionRequest
 )
 from temporalio.bridge.proto.workflow_activation import WorkflowActivation
 from temporalio.bridge.proto.workflow_completion import WorkflowActivationCompletion
@@ -6282,3 +6283,7 @@ async def waiting() -> bool:
                     PayloadConverter.default.from_payload(event.user_metadata.summary)
                 )
         assert timer_summs == {"hi!", "timer2"}
+
+        describe_r = await handle.describe()
+        assert describe_r.static_summary == "cool workflow bro"
+        assert describe_r.static_details == "xtremely detailed"