temporalio 0.1.1 → 0.2.0

data/bridge/sdk-core/core/src/worker/workflow/machines/mod.rs

@@ -1,324 +0,0 @@
-mod workflow_machines;
-
-mod activity_state_machine;
-mod cancel_external_state_machine;
-mod cancel_workflow_state_machine;
-mod child_workflow_state_machine;
-mod complete_workflow_state_machine;
-mod continue_as_new_workflow_state_machine;
-mod fail_workflow_state_machine;
-mod local_activity_state_machine;
-mod modify_workflow_properties_state_machine;
-mod patch_state_machine;
-mod signal_external_state_machine;
-mod timer_state_machine;
-mod upsert_search_attributes_state_machine;
-mod workflow_task_state_machine;
-
-#[cfg(test)]
-mod transition_coverage;
-
-pub(crate) use workflow_machines::WorkflowMachines;
-
-use crate::{telemetry::VecDisplayer, worker::workflow::WFMachinesError};
-use activity_state_machine::ActivityMachine;
-use cancel_external_state_machine::CancelExternalMachine;
-use cancel_workflow_state_machine::CancelWorkflowMachine;
-use child_workflow_state_machine::ChildWorkflowMachine;
-use complete_workflow_state_machine::CompleteWorkflowMachine;
-use continue_as_new_workflow_state_machine::ContinueAsNewWorkflowMachine;
-use fail_workflow_state_machine::FailWorkflowMachine;
-use local_activity_state_machine::LocalActivityMachine;
-use modify_workflow_properties_state_machine::ModifyWorkflowPropertiesMachine;
-use patch_state_machine::PatchMachine;
-use rustfsm::{MachineError, StateMachine};
-use signal_external_state_machine::SignalExternalMachine;
-use std::{
-    convert::{TryFrom, TryInto},
-    fmt::{Debug, Display},
-};
-use temporal_sdk_core_protos::temporal::api::{
-    command::v1::Command as ProtoCommand,
-    enums::v1::{CommandType, EventType},
-    history::v1::HistoryEvent,
-};
-use timer_state_machine::TimerMachine;
-use upsert_search_attributes_state_machine::UpsertSearchAttributesMachine;
-use workflow_machines::MachineResponse;
-use workflow_task_state_machine::WorkflowTaskMachine;
-
-#[cfg(test)]
-use transition_coverage::add_coverage;
-
-#[enum_dispatch::enum_dispatch]
-#[allow(clippy::enum_variant_names, clippy::large_enum_variant)]
-enum Machines {
-    ActivityMachine,
-    CancelExternalMachine,
-    CancelWorkflowMachine,
-    ChildWorkflowMachine,
-    CompleteWorkflowMachine,
-    ContinueAsNewWorkflowMachine,
-    FailWorkflowMachine,
-    LocalActivityMachine,
-    PatchMachine,
-    SignalExternalMachine,
-    TimerMachine,
-    WorkflowTaskMachine,
-    UpsertSearchAttributesMachine,
-    ModifyWorkflowPropertiesMachine,
-}
-
-/// Extends [rustfsm::StateMachine] with some functionality specific to the temporal SDK.
-///
-/// Formerly known as `EntityStateMachine` in Java.
-#[enum_dispatch::enum_dispatch(Machines)]
-trait TemporalStateMachine {
-    fn handle_command(
-        &mut self,
-        command_type: CommandType,
-    ) -> Result<Vec<MachineResponse>, WFMachinesError>;
-
-    /// Returns true if this machine is compatible with the provided event. Provides a way to know
-    /// ahead of time if it's worth trying to call [TemporalStateMachine::handle_event] without
-    /// requiring mutable access.
-    fn matches_event(&self, event: &HistoryEvent) -> bool;
-
-    /// Tell the state machine to handle some event. Returns a list of responses that can be used
-    /// to update the overall state of the workflow. EX: To issue outgoing WF activations.
-    fn handle_event(
-        &mut self,
-        event: HistEventData,
-    ) -> Result<Vec<MachineResponse>, WFMachinesError>;
-
-    /// Attempt to cancel the command associated with this state machine, if it is cancellable
-    fn cancel(&mut self) -> Result<Vec<MachineResponse>, WFMachinesError>;
-
-    /// Should return true if the command was cancelled before we sent it to the server. Always
-    /// returns false for non-cancellable machines
-    fn was_cancelled_before_sent_to_server(&self) -> bool;
-
-    /// Returns true if the state machine is in a final state
-    fn is_final_state(&self) -> bool;
-
-    /// Returns a friendly name for the type of this machine
-    fn name(&self) -> &str;
-}
-
-impl<SM> TemporalStateMachine for SM
-where
-    SM: StateMachine + WFMachinesAdapter + Cancellable + OnEventWrapper + Clone + 'static,
-    <SM as StateMachine>::Event: TryFrom<HistEventData> + TryFrom<CommandType> + Display,
-    WFMachinesError: From<<<SM as StateMachine>::Event as TryFrom<HistEventData>>::Error>,
-    <SM as StateMachine>::Command: Debug + Display,
-    <SM as StateMachine>::State: Display,
-    <SM as StateMachine>::Error: Into<WFMachinesError> + 'static + Send + Sync,
-{
-    fn handle_command(
-        &mut self,
-        command_type: CommandType,
-    ) -> Result<Vec<MachineResponse>, WFMachinesError> {
-        debug!(
-            command_type = ?command_type,
-            machine_name = %self.name(),
-            state = %self.state(),
-            "handling command"
-        );
-        if let Ok(converted_command) = command_type.try_into() {
-            match OnEventWrapper::on_event_mut(self, converted_command) {
-                Ok(c) => process_machine_commands(self, c, None),
-                Err(MachineError::InvalidTransition) => {
-                    Err(WFMachinesError::Nondeterminism(format!(
-                        "Unexpected command producing an invalid transition {:?} in state {}",
-                        command_type,
-                        self.state()
-                    )))
-                }
-                Err(MachineError::Underlying(e)) => Err(e.into()),
-            }
-        } else {
-            Err(WFMachinesError::Nondeterminism(format!(
-                "Unexpected command {:?} generated by a {:?} machine",
-                command_type,
-                self.name()
-            )))
-        }
-    }
-
-    fn matches_event(&self, event: &HistoryEvent) -> bool {
-        self.matches_event(event)
-    }
-
-    fn handle_event(
-        &mut self,
-        event_dat: HistEventData,
-    ) -> Result<Vec<MachineResponse>, WFMachinesError> {
-        trace!(
-            event = %event_dat.event,
-            machine_name = %self.name(),
-            state = %self.state(),
-            "handling event"
-        );
-        let event_info = EventInfo {
-            event_id: event_dat.event.event_id,
-            event_type: event_dat.event.event_type(),
-        };
-        let converted_event: <Self as StateMachine>::Event = event_dat.try_into()?;
-
-        match OnEventWrapper::on_event_mut(self, converted_event) {
-            Ok(c) => process_machine_commands(self, c, Some(event_info)),
-            Err(MachineError::InvalidTransition) => Err(WFMachinesError::Fatal(format!(
-                "{} in state {} says the transition is invalid during event {:?}",
-                self.name(),
-                self.state(),
-                event_info
-            ))),
-            Err(MachineError::Underlying(e)) => Err(e.into()),
-        }
-    }
-
-    fn cancel(&mut self) -> Result<Vec<MachineResponse>, WFMachinesError> {
-        let res = self.cancel();
-        res.map_err(|e| match e {
-            MachineError::InvalidTransition => WFMachinesError::Fatal(format!(
-                "Invalid transition while attempting to cancel {} in {}",
-                self.name(),
-                self.state(),
-            )),
-            MachineError::Underlying(e) => e.into(),
-        })
-    }
-
-    fn was_cancelled_before_sent_to_server(&self) -> bool {
-        self.was_cancelled_before_sent_to_server()
-    }
-
-    fn is_final_state(&self) -> bool {
-        self.has_reached_final_state()
-    }
-
-    fn name(&self) -> &str {
-        self.name()
-    }
-}
-
-fn process_machine_commands<SM>(
-    machine: &mut SM,
-    commands: Vec<SM::Command>,
-    event_info: Option<EventInfo>,
-) -> Result<Vec<MachineResponse>, WFMachinesError>
-where
-    SM: TemporalStateMachine + StateMachine + WFMachinesAdapter,
-    <SM as StateMachine>::Event: Display,
-    <SM as StateMachine>::Command: Debug + Display,
-    <SM as StateMachine>::State: Display,
-{
-    if !commands.is_empty() {
-        trace!(commands=%commands.display(), state=%machine.state(),
-               machine_name=%TemporalStateMachine::name(machine), "Machine produced commands");
-    }
-    let mut machine_responses = vec![];
-    for cmd in commands {
-        machine_responses.extend(machine.adapt_response(cmd, event_info)?);
-    }
-    Ok(machine_responses)
-}
-
-/// This trait exists to bridge [StateMachine]s and the [WorkflowMachines] instance. It has access
-/// to the machine's concrete types while hiding those details from [WorkflowMachines]
-trait WFMachinesAdapter: StateMachine {
-    /// A command that this [StateMachine] instance just produced, and maybe the event being
-    /// processed, perform any handling that needs inform the [WorkflowMachines] instance of some
-    /// action to be taken in response to that command.
-    fn adapt_response(
-        &self,
-        my_command: Self::Command,
-        event_info: Option<EventInfo>,
-    ) -> Result<Vec<MachineResponse>, WFMachinesError>;
-
-    /// Returns true if this machine is compatible with the provided event. Provides a way to know
-    /// ahead of time if it's worth trying to call [TemporalStateMachine::handle_event] without
-    /// requiring mutable access.
-    fn matches_event(&self, event: &HistoryEvent) -> bool;
-}
-
-/// Wraps a history event with extra relevant data that a machine might care about while the event
-/// is being applied to it.
-#[derive(Debug, derive_more::Display)]
-#[display(fmt = "{event}")]
-struct HistEventData {
-    event: HistoryEvent,
-    /// Is the current workflow task under replay or not during application of this event?
-    replaying: bool,
-    /// Is the current workflow task the last task in history?
-    current_task_is_last_in_history: bool,
-}
-
-#[derive(Debug, Copy, Clone)]
-struct EventInfo {
-    event_id: i64,
-    event_type: EventType,
-}
-
-trait Cancellable: StateMachine {
-    /// Cancel the machine / the command represented by the machine.
-    ///
-    /// # Panics
-    /// * If the machine is not cancellable. It's a logic error on our part to call it on such
-    ///   machines.
-    fn cancel(&mut self) -> Result<Vec<MachineResponse>, MachineError<Self::Error>> {
-        // It's a logic error on our part if this is ever called on a machine that can't actually
-        // be cancelled
-        panic!("Machine {} cannot be cancelled", self.name())
-    }
-
-    /// Should return true if the command was cancelled before we sent it to the server
-    fn was_cancelled_before_sent_to_server(&self) -> bool {
-        false
-    }
-}
-
-/// We need to wrap calls to [StateMachine::on_event_mut] to track coverage, or anything else
-/// we'd like to do on every call.
-pub(crate) trait OnEventWrapper: StateMachine
-where
-    <Self as StateMachine>::State: Display,
-    <Self as StateMachine>::Event: Display,
-    Self: Clone,
-{
-    fn on_event_mut(
-        &mut self,
-        event: Self::Event,
-    ) -> Result<Vec<Self::Command>, MachineError<Self::Error>> {
-        #[cfg(test)]
-        let from_state = self.state().to_string();
-        #[cfg(test)]
-        let converted_event_str = event.to_string();
-
-        let res = StateMachine::on_event_mut(self, event);
-        if res.is_ok() {
-            #[cfg(test)]
-            add_coverage(
-                self.name().to_owned(),
-                from_state,
-                self.state().to_string(),
-                converted_event_str,
-            );
-        }
-        res
-    }
-}
-
-impl<SM> OnEventWrapper for SM
-where
-    SM: StateMachine,
-    <Self as StateMachine>::State: Display,
-    <Self as StateMachine>::Event: Display,
-    Self: Clone,
-{
-}
-
-struct NewMachineWithCommand {
-    command: ProtoCommand,
-    machine: Machines,
-}

data/bridge/sdk-core/core/src/worker/workflow/machines/modify_workflow_properties_state_machine.rs

@@ -1,179 +0,0 @@
-use super::{workflow_machines::MachineResponse, NewMachineWithCommand};
-use crate::worker::workflow::{
-    machines::{Cancellable, EventInfo, HistEventData, WFMachinesAdapter},
-    WFMachinesError,
-};
-use rustfsm::{fsm, TransitionResult};
-use temporal_sdk_core_protos::{
-    coresdk::workflow_commands::ModifyWorkflowProperties,
-    temporal::api::{
-        command::v1::Command,
-        enums::v1::{CommandType, EventType},
-        history::v1::HistoryEvent,
-    },
-};
-
-fsm! {
-    pub(super) name ModifyWorkflowPropertiesMachine;
-    command ModifyWorkflowPropertiesMachineCommand;
-    error WFMachinesError;
-    shared_state SharedState;
-
-    Created --(CommandScheduled) --> CommandIssued;
-    CommandIssued --(CommandRecorded) --> Done;
-}
-
-/// Instantiates an ModifyWorkflowPropertiesMachine and packs it together with the command to
-/// be sent to server.
-pub(super) fn modify_workflow_properties(
-    lang_cmd: ModifyWorkflowProperties,
-) -> NewMachineWithCommand {
-    let sm = ModifyWorkflowPropertiesMachine {
-        state: Created {}.into(),
-        shared_state: (),
-    };
-    let cmd = Command {
-        command_type: CommandType::ModifyWorkflowProperties as i32,
-        attributes: Some(lang_cmd.into()),
-    };
-    NewMachineWithCommand {
-        command: cmd,
-        machine: sm.into(),
-    }
-}
-
-type SharedState = ();
-
-#[derive(Debug, derive_more::Display)]
-pub(super) enum ModifyWorkflowPropertiesMachineCommand {}
-
-#[derive(Debug, Default, Clone, derive_more::Display)]
-pub(super) struct Created {}
-
-#[derive(Debug, Default, Clone, derive_more::Display)]
-pub(super) struct CommandIssued {}
-
-#[derive(Debug, Default, Clone, derive_more::Display)]
-pub(super) struct Done {}
-
-impl WFMachinesAdapter for ModifyWorkflowPropertiesMachine {
-    fn adapt_response(
-        &self,
-        _my_command: Self::Command,
-        _event_info: Option<EventInfo>,
-    ) -> Result<Vec<MachineResponse>, Self::Error> {
-        Err(Self::Error::Nondeterminism(
-            "ModifyWorkflowProperties does not use state machine commands".to_string(),
-        ))
-    }
-
-    fn matches_event(&self, event: &HistoryEvent) -> bool {
-        matches!(event.event_type(), EventType::WorkflowPropertiesModified)
-    }
-}
-
-impl Cancellable for ModifyWorkflowPropertiesMachine {}
-
-impl TryFrom<HistEventData> for ModifyWorkflowPropertiesMachineEvents {
-    type Error = WFMachinesError;
-
-    fn try_from(e: HistEventData) -> Result<Self, Self::Error> {
-        let e = e.event;
-        match e.event_type() {
-            EventType::WorkflowPropertiesModified => {
-                Ok(ModifyWorkflowPropertiesMachineEvents::CommandRecorded)
-            }
-            _ => Err(Self::Error::Nondeterminism(format!(
-                "ModifyWorkflowPropertiesMachine does not handle {e}"
-            ))),
-        }
-    }
-}
-
-impl TryFrom<CommandType> for ModifyWorkflowPropertiesMachineEvents {
-    type Error = WFMachinesError;
-
-    fn try_from(c: CommandType) -> Result<Self, Self::Error> {
-        match c {
-            CommandType::ModifyWorkflowProperties => {
-                Ok(ModifyWorkflowPropertiesMachineEvents::CommandScheduled)
-            }
-            _ => Err(Self::Error::Nondeterminism(format!(
-                "ModifyWorkflowPropertiesMachine does not handle command type {c:?}"
-            ))),
-        }
-    }
-}
-
-impl From<CommandIssued> for Done {
-    fn from(_: CommandIssued) -> Self {
-        Self {}
-    }
-}
-
-impl From<Created> for CommandIssued {
-    fn from(_: Created) -> Self {
-        Self {}
-    }
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-    use crate::{replay::TestHistoryBuilder, worker::workflow::ManagedWFFunc};
-    use temporal_sdk::{WfContext, WorkflowFunction};
-    use temporal_sdk_core_protos::temporal::api::{
-        command::v1::command::Attributes, common::v1::Payload,
-    };
-
-    #[tokio::test]
-    async fn workflow_modify_props() {
-        let mut t = TestHistoryBuilder::default();
-        t.add_by_type(EventType::WorkflowExecutionStarted);
-        t.add_full_wf_task();
-        t.add_workflow_execution_completed();
-
-        let (k1, k2) = ("foo", "bar");
-
-        let wff = WorkflowFunction::new(move |ctx: WfContext| async move {
-            ctx.upsert_memo([
-                (
-                    String::from(k1),
-                    Payload {
-                        data: vec![0x01],
-                        ..Default::default()
-                    },
-                ),
-                (
-                    String::from(k2),
-                    Payload {
-                        data: vec![0x02],
-                        ..Default::default()
-                    },
-                ),
-            ]);
-            Ok(().into())
-        });
-        let mut wfm = ManagedWFFunc::new(t, wff, vec![]);
-
-        wfm.get_next_activation().await.unwrap();
-        let commands = wfm.get_server_commands().commands;
-        assert!(!commands.is_empty());
-        let cmd = commands[0].clone();
-        assert_eq!(
-            cmd.command_type,
-            CommandType::ModifyWorkflowProperties as i32
-        );
-        assert_matches!(
-        cmd.attributes.unwrap(),
-        Attributes::ModifyWorkflowPropertiesCommandAttributes(msg) => {
-            let fields = &msg.upserted_memo.unwrap().fields;
-            let payload1 = fields.get(k1).unwrap();
-            let payload2 = fields.get(k2).unwrap();
-            assert_eq!(payload1.data[0], 0x01);
-            assert_eq!(payload2.data[0], 0x02);
-            assert_eq!(fields.len(), 2);
-        });
-        wfm.shutdown().await.unwrap();
-    }
-}