WAIT_CANCELLATION_COMPLETED should be default, populate operation_token on cancellation failures (#947)

Author: tconley1428

core/src/worker/workflow/machines/nexus_operation_state_machine.rs

@@ -53,7 +53,7 @@ fsm! {
     ScheduledEventRecorded
       --(NexusOperationTimedOut(NexusOperationTimedOutEventAttributes), on_timed_out)--> TimedOut;
     ScheduledEventRecorded
-      --(NexusOperationStarted(NexusOperationStartedEventAttributes), on_started)--> Started;
+      --(NexusOperationStarted(NexusOperationStartedEventAttributes), shared on_started)--> Started;
 
     Started --(Cancel, shared on_issue_cancel)--> Started;
     Started --(Cancel, shared on_issue_cancel)--> Cancelled;
@@ -113,6 +113,7 @@ pub(super) struct SharedState {
     cancelled_before_sent: bool,
     cancel_sent: bool,
     cancel_type: NexusOperationCancellationType,
+    operation_token: Option<String>,
 }
 
 impl NexusOperationMachine {
@@ -128,6 +129,7 @@ impl NexusOperationMachine {
                 cancelled_before_sent: false,
                 cancel_sent: false,
                 cancel_type: attribs.cancellation_type(),
+                operation_token: None,
             },
         );
         NewMachineWithCommand {
@@ -246,8 +248,10 @@ impl ScheduledEventRecorded {
 
     pub(super) fn on_started(
         self,
+        ss: &mut SharedState,
         sa: NexusOperationStartedEventAttributes,
     ) -> NexusOperationMachineTransition<Started> {
+        ss.operation_token = Some(sa.operation_token.clone());
         NexusOperationMachineTransition::commands([NexusOperationCommand::Start {
             operation_token: sa.operation_token,
         }])
@@ -496,6 +500,7 @@ impl WFMachinesAdapter for NexusOperationMachine {
                         status: Some(resolve_nexus_operation_start::Status::CancelledBeforeStart(
                             self.cancelled_failure(
                                 "Nexus Operation cancelled before scheduled".to_owned(),
+                                &self.shared_state.operation_token,
                             ),
                         )),
                     }
@@ -506,6 +511,7 @@ impl WFMachinesAdapter for NexusOperationMachine {
                             status: Some(nexus_operation_result::Status::Cancelled(
                                 self.cancelled_failure(
                                     "Nexus Operation cancelled before scheduled".to_owned(),
+                                    &self.shared_state.operation_token,
                                 ),
                             )),
                         }),
@@ -584,6 +590,7 @@ impl WFMachinesAdapter for NexusOperationMachine {
                                 status: Some(nexus_operation_result::Status::Cancelled(
                                     self.cancelled_failure(
                                         "Nexus operation cancelled after starting".to_owned(),
+                                        &self.shared_state.operation_token,
                                     ),
                                 )),
                             }),
@@ -610,7 +617,7 @@ impl TryFrom<CommandType> for NexusOperationMachineEvents {
 }
 
 impl NexusOperationMachine {
-    fn cancelled_failure(&self, message: String) -> Failure {
+    fn cancelled_failure(&self, message: String, operation_token: &Option<String>) -> Failure {
         Failure {
             message,
             cause: Some(Box::new(Failure {
@@ -624,7 +631,7 @@ impl NexusOperationMachine {
                     service: self.shared_state.service.clone(),
                     operation: self.shared_state.operation.clone(),
                     operation_id: "".to_string(),
-                    operation_token: "".to_string(),
+                    operation_token: operation_token.clone().unwrap_or_default(),
                 },
             )),
             ..Default::default()

sdk-core-protos/protos/local/temporal/sdk/core/nexus/nexus.proto

@@ -72,15 +72,15 @@ enum NexusTaskCancelReason {
 
 // Controls at which point to report back to lang when a nexus operation is cancelled
 enum NexusOperationCancellationType {
+    // Wait for operation cancellation completion. Default.
+    WAIT_CANCELLATION_COMPLETED = 0;
     // Do not request cancellation of the nexus operation if already scheduled
-    ABANDON = 0;
+    ABANDON = 1;
 
     // Initiate a cancellation request for the Nexus operation and immediately report cancellation
     // to the caller. Note that it doesn't guarantee that cancellation is delivered to the operation if calling workflow exits before the delivery is done.
     // If you want to ensure that cancellation is delivered to the operation, use WAIT_CANCELLATION_REQUESTED.
-    TRY_CANCEL = 1;
+    TRY_CANCEL = 2;
     // Request cancellation of the operation and wait for confirmation that the request was received.
-    WAIT_CANCELLATION_REQUESTED = 2;
-    // Wait for operation cancellation completion. Default.
-    WAIT_CANCELLATION_COMPLETED = 3;
+    WAIT_CANCELLATION_REQUESTED = 3;
 }