Add blocked state to callbacks, pending nexus operation and cancellation (#470)

Author: rodrigozhou

openapi/openapiv2.json

@@ -6959,6 +6959,10 @@
           "type": "string",
           "format": "date-time",
           "description": "The time when the next attempt is scheduled."
+        },
+        "blockedReason": {
+          "type": "string",
+          "description": "If the state is BLOCKED, blocked reason provides additional information."
         }
       },
       "description": "CallbackInfo contains the state of an attached workflow callback."
@@ -6971,10 +6975,11 @@
         "CALLBACK_STATE_SCHEDULED",
         "CALLBACK_STATE_BACKING_OFF",
         "CALLBACK_STATE_FAILED",
-        "CALLBACK_STATE_SUCCEEDED"
+        "CALLBACK_STATE_SUCCEEDED",
+        "CALLBACK_STATE_BLOCKED"
       ],
       "default": "CALLBACK_STATE_UNSPECIFIED",
-      "description": "State of a callback.\n\n - CALLBACK_STATE_UNSPECIFIED: Default value, unspecified state.\n - CALLBACK_STATE_STANDBY: Callback is standing by, waiting to be triggered.\n - CALLBACK_STATE_SCHEDULED: Callback is in the queue waiting to be executed or is currently executing.\n - CALLBACK_STATE_BACKING_OFF: Callback has failed with a retryable error and is backing off before the next attempt.\n - CALLBACK_STATE_FAILED: Callback has failed.\n - CALLBACK_STATE_SUCCEEDED: Callback has succeeded."
+      "description": "State of a callback.\n\n - CALLBACK_STATE_UNSPECIFIED: Default value, unspecified state.\n - CALLBACK_STATE_STANDBY: Callback is standing by, waiting to be triggered.\n - CALLBACK_STATE_SCHEDULED: Callback is in the queue waiting to be executed or is currently executing.\n - CALLBACK_STATE_BACKING_OFF: Callback has failed with a retryable error and is backing off before the next attempt.\n - CALLBACK_STATE_FAILED: Callback has failed.\n - CALLBACK_STATE_SUCCEEDED: Callback has succeeded.\n - CALLBACK_STATE_BLOCKED: Callback is blocked (eg: by circuit breaker)."
     },
     "v1CancelExternalWorkflowExecutionFailedCause": {
       "type": "string",
@@ -8999,6 +9004,10 @@
           "type": "string",
           "format": "date-time",
           "description": "The time when the next attempt is scheduled."
+        },
+        "blockedReason": {
+          "type": "string",
+          "description": "If the state is BLOCKED, blocked reason provides additional information."
         }
       },
       "description": "NexusOperationCancellationInfo contains the state of a nexus operation cancellation."
@@ -9011,10 +9020,11 @@
         "NEXUS_OPERATION_CANCELLATION_STATE_BACKING_OFF",
         "NEXUS_OPERATION_CANCELLATION_STATE_SUCCEEDED",
         "NEXUS_OPERATION_CANCELLATION_STATE_FAILED",
-        "NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT"
+        "NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT",
+        "NEXUS_OPERATION_CANCELLATION_STATE_BLOCKED"
       ],
       "default": "NEXUS_OPERATION_CANCELLATION_STATE_UNSPECIFIED",
-      "description": "State of a Nexus operation cancellation.\n\n - NEXUS_OPERATION_CANCELLATION_STATE_UNSPECIFIED: Default value, unspecified state.\n - NEXUS_OPERATION_CANCELLATION_STATE_SCHEDULED: Cancellation request is in the queue waiting to be executed or is currently executing.\n - NEXUS_OPERATION_CANCELLATION_STATE_BACKING_OFF: Cancellation request has failed with a retryable error and is backing off before the next attempt.\n - NEXUS_OPERATION_CANCELLATION_STATE_SUCCEEDED: Cancellation request succeeded.\n - NEXUS_OPERATION_CANCELLATION_STATE_FAILED: Cancellation request failed with a non-retryable error.\n - NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT: The associated operation timed out - exceeded the user supplied schedule-to-close timeout."
+      "description": "State of a Nexus operation cancellation.\n\n - NEXUS_OPERATION_CANCELLATION_STATE_UNSPECIFIED: Default value, unspecified state.\n - NEXUS_OPERATION_CANCELLATION_STATE_SCHEDULED: Cancellation request is in the queue waiting to be executed or is currently executing.\n - NEXUS_OPERATION_CANCELLATION_STATE_BACKING_OFF: Cancellation request has failed with a retryable error and is backing off before the next attempt.\n - NEXUS_OPERATION_CANCELLATION_STATE_SUCCEEDED: Cancellation request succeeded.\n - NEXUS_OPERATION_CANCELLATION_STATE_FAILED: Cancellation request failed with a non-retryable error.\n - NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT: The associated operation timed out - exceeded the user supplied schedule-to-close timeout.\n - NEXUS_OPERATION_CANCELLATION_STATE_BLOCKED: Cancellation request is blocked (eg: by circuit breaker)."
     },
     "v1NexusOperationCompletedEventAttributes": {
       "type": "object",
@@ -9377,6 +9387,10 @@
           "type": "string",
           "format": "int64",
           "description": "The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the\nDescribeWorkflowExecution response with workflow history."
+        },
+        "blockedReason": {
+          "type": "string",
+          "description": "If the state is BLOCKED, blocked reason provides additional information."
         }
       },
       "description": "PendingNexusOperationInfo contains the state of a pending Nexus operation."
@@ -9387,10 +9401,11 @@
         "PENDING_NEXUS_OPERATION_STATE_UNSPECIFIED",
         "PENDING_NEXUS_OPERATION_STATE_SCHEDULED",
         "PENDING_NEXUS_OPERATION_STATE_BACKING_OFF",
-        "PENDING_NEXUS_OPERATION_STATE_STARTED"
+        "PENDING_NEXUS_OPERATION_STATE_STARTED",
+        "PENDING_NEXUS_OPERATION_STATE_BLOCKED"
       ],
       "default": "PENDING_NEXUS_OPERATION_STATE_UNSPECIFIED",
-      "description": "State of a pending Nexus operation.\n\n - PENDING_NEXUS_OPERATION_STATE_UNSPECIFIED: Default value, unspecified state.\n - PENDING_NEXUS_OPERATION_STATE_SCHEDULED: Operation is in the queue waiting to be executed or is currently executing.\n - PENDING_NEXUS_OPERATION_STATE_BACKING_OFF: Operation has failed with a retryable error and is backing off before the next attempt.\n - PENDING_NEXUS_OPERATION_STATE_STARTED: Operation was started and will complete asynchronously."
+      "description": "State of a pending Nexus operation.\n\n - PENDING_NEXUS_OPERATION_STATE_UNSPECIFIED: Default value, unspecified state.\n - PENDING_NEXUS_OPERATION_STATE_SCHEDULED: Operation is in the queue waiting to be executed or is currently executing.\n - PENDING_NEXUS_OPERATION_STATE_BACKING_OFF: Operation has failed with a retryable error and is backing off before the next attempt.\n - PENDING_NEXUS_OPERATION_STATE_STARTED: Operation was started and will complete asynchronously.\n - PENDING_NEXUS_OPERATION_STATE_BLOCKED: Operation is blocked (eg: by circuit breaker)."
     },
     "v1PendingWorkflowTaskInfo": {
       "type": "object",

openapi/openapiv3.yaml

@@ -4983,6 +4983,7 @@ components:
             - CALLBACK_STATE_BACKING_OFF
             - CALLBACK_STATE_FAILED
             - CALLBACK_STATE_SUCCEEDED
+            - CALLBACK_STATE_BLOCKED
           type: string
           format: enum
         attempt:
@@ -5003,6 +5004,9 @@ components:
           type: string
           description: The time when the next attempt is scheduled.
           format: date-time
+        blockedReason:
+          type: string
+          description: If the state is BLOCKED, blocked reason provides additional information.
       description: CallbackInfo contains the state of an attached workflow callback.
     CallbackInfo_Trigger:
       type: object
@@ -6582,6 +6586,7 @@ components:
             - NEXUS_OPERATION_CANCELLATION_STATE_SUCCEEDED
             - NEXUS_OPERATION_CANCELLATION_STATE_FAILED
             - NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT
+            - NEXUS_OPERATION_CANCELLATION_STATE_BLOCKED
           type: string
           format: enum
         attempt:
@@ -6602,6 +6607,9 @@ components:
           type: string
           description: The time when the next attempt is scheduled.
           format: date-time
+        blockedReason:
+          type: string
+          description: If the state is BLOCKED, blocked reason provides additional information.
       description: NexusOperationCancellationInfo contains the state of a nexus operation cancellation.
     NexusOperationCompletedEventAttributes:
       type: object
@@ -6928,6 +6936,7 @@ components:
             - PENDING_NEXUS_OPERATION_STATE_SCHEDULED
             - PENDING_NEXUS_OPERATION_STATE_BACKING_OFF
             - PENDING_NEXUS_OPERATION_STATE_STARTED
+            - PENDING_NEXUS_OPERATION_STATE_BLOCKED
           type: string
           format: enum
         attempt:
@@ -6955,6 +6964,9 @@ components:
           description: |-
             The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the
              DescribeWorkflowExecution response with workflow history.
+        blockedReason:
+          type: string
+          description: If the state is BLOCKED, blocked reason provides additional information.
       description: PendingNexusOperationInfo contains the state of a pending Nexus operation.
     PendingWorkflowTaskInfo:
       type: object

temporal/api/enums/v1/common.proto

@@ -69,6 +69,8 @@ enum CallbackState {
     CALLBACK_STATE_FAILED = 4;
     // Callback has succeeded.
     CALLBACK_STATE_SUCCEEDED = 5;
+    // Callback is blocked (eg: by circuit breaker).
+    CALLBACK_STATE_BLOCKED = 6;
 }
 
 // State of a pending Nexus operation.
@@ -81,6 +83,8 @@ enum PendingNexusOperationState {
     PENDING_NEXUS_OPERATION_STATE_BACKING_OFF = 2;
     // Operation was started and will complete asynchronously.
     PENDING_NEXUS_OPERATION_STATE_STARTED = 3;
+    // Operation is blocked (eg: by circuit breaker).
+    PENDING_NEXUS_OPERATION_STATE_BLOCKED = 4;
 }
 
 // State of a Nexus operation cancellation.
@@ -97,4 +101,6 @@ enum NexusOperationCancellationState {
     NEXUS_OPERATION_CANCELLATION_STATE_FAILED = 4;
     // The associated operation timed out - exceeded the user supplied schedule-to-close timeout.
     NEXUS_OPERATION_CANCELLATION_STATE_TIMED_OUT = 5;
+    // Cancellation request is blocked (eg: by circuit breaker).
+    NEXUS_OPERATION_CANCELLATION_STATE_BLOCKED = 6;
 }

temporal/api/workflow/v1/message.proto

@@ -258,6 +258,9 @@ message CallbackInfo {
     temporal.api.failure.v1.Failure last_attempt_failure = 7;
     // The time when the next attempt is scheduled.
     google.protobuf.Timestamp next_attempt_schedule_time = 8;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 9;
 }
 
 // PendingNexusOperationInfo contains the state of a pending Nexus operation.
@@ -300,6 +303,9 @@ message PendingNexusOperationInfo {
     // The event ID of the NexusOperationScheduled event. Can be used to correlate an operation in the
     // DescribeWorkflowExecution response with workflow history.
     int64 scheduled_event_id = 13;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 14;
 }
 
 // NexusOperationCancellationInfo contains the state of a nexus operation cancellation.
@@ -319,4 +325,7 @@ message NexusOperationCancellationInfo {
     temporal.api.failure.v1.Failure last_attempt_failure = 5;
     // The time when the next attempt is scheduled.
     google.protobuf.Timestamp next_attempt_schedule_time = 6;
+
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 7;
 }