temporalio 0.0.0 → 0.0.1

data/bridge/sdk-core/core/src/core_tests/replay_flag.rs

@@ -0,0 +1,65 @@
+use crate::{test_help::canned_histories, worker::ManagedWFFunc};
+use rstest::{fixture, rstest};
+use std::time::Duration;
+use temporal_sdk::{WfContext, WorkflowFunction};
+use temporal_sdk_core_protos::temporal::api::enums::v1::CommandType;
+
+fn timers_wf(num_timers: u32) -> WorkflowFunction {
+    WorkflowFunction::new(move |command_sink: WfContext| async move {
+        for _ in 1..=num_timers {
+            command_sink.timer(Duration::from_secs(1)).await;
+        }
+        Ok(().into())
+    })
+}
+
+#[fixture(num_timers = 1)]
+fn fire_happy_hist(num_timers: u32) -> ManagedWFFunc {
+    let func = timers_wf(num_timers);
+    // Add 1 b/c history takes # wf tasks, not timers
+    let t = canned_histories::long_sequential_timers(num_timers as usize);
+    ManagedWFFunc::new(t, func, vec![])
+}
+
+#[rstest]
+#[case::one_timer(fire_happy_hist(1), 1)]
+#[case::five_timers(fire_happy_hist(5), 5)]
+#[tokio::test]
+async fn replay_flag_is_correct(#[case] mut wfm: ManagedWFFunc, #[case] num_timers: usize) {
+    // Verify replay flag is correct by constructing a workflow manager that already has a complete
+    // history fed into it. It should always be replaying, because history is complete.
+
+    for _ in 1..=num_timers {
+        let act = wfm.get_next_activation().await.unwrap();
+        assert!(act.is_replaying);
+        let commands = wfm.get_server_commands().commands;
+        assert_eq!(commands.len(), 1);
+        assert_eq!(commands[0].command_type, CommandType::StartTimer as i32);
+    }
+
+    let act = wfm.get_next_activation().await.unwrap();
+    assert!(act.is_replaying);
+    let commands = wfm.get_server_commands().commands;
+    assert_eq!(commands.len(), 1);
+    assert_eq!(
+        commands[0].command_type,
+        CommandType::CompleteWorkflowExecution as i32
+    );
+    wfm.shutdown().await.unwrap();
+}
+
+#[tokio::test(flavor = "multi_thread")]
+async fn replay_flag_is_correct_partial_history() {
+    let func = timers_wf(1);
+    // Add 1 b/c history takes # wf tasks, not timers
+    let t = canned_histories::long_sequential_timers(2);
+    let mut wfm =
+        ManagedWFFunc::new_from_update(t.get_history_info(1).unwrap().into(), func, vec![]);
+
+    let act = wfm.get_next_activation().await.unwrap();
+    assert!(!act.is_replaying);
+    let commands = wfm.get_server_commands().commands;
+    assert_eq!(commands.len(), 1);
+    assert_eq!(commands[0].command_type, CommandType::StartTimer as i32);
+    wfm.shutdown().await.unwrap();
+}

data/bridge/sdk-core/core/src/core_tests/workers.rs

@@ -0,0 +1,259 @@
+use crate::{
+    prost_dur,
+    test_help::{
+        build_fake_worker, build_mock_pollers, canned_histories, mock_manual_poller, mock_worker,
+        MockPollCfg, MockWorkerInputs, MocksHolder, ResponseType,
+    },
+    worker::client::mocks::mock_workflow_client,
+    PollActivityError, PollWfError,
+};
+use futures::FutureExt;
+use std::{cell::RefCell, time::Duration};
+use temporal_sdk_core_api::Worker;
+use temporal_sdk_core_protos::{
+    coresdk::{
+        workflow_activation::workflow_activation_job,
+        workflow_commands::{workflow_command, CompleteWorkflowExecution, StartTimer},
+        workflow_completion::WorkflowActivationCompletion,
+    },
+    temporal::api::workflowservice::v1::RespondWorkflowTaskCompletedResponse,
+};
+use temporal_sdk_core_test_utils::start_timer_cmd;
+use tokio::sync::{watch, Barrier};
+
+#[tokio::test]
+async fn after_shutdown_of_worker_get_shutdown_err() {
+    let t = canned_histories::single_timer("1");
+    let worker = build_fake_worker("fake_wf_id", t, &[1]);
+    let res = worker.poll_workflow_activation().await.unwrap();
+    assert_eq!(res.jobs.len(), 1);
+    let run_id = res.run_id;
+
+    tokio::join!(worker.shutdown(), async {
+        // Need to complete task for shutdown to finish
+        worker
+            .complete_workflow_activation(WorkflowActivationCompletion::from_cmd(
+                run_id.clone(),
+                workflow_command::Variant::StartTimer(StartTimer {
+                    seq: 1,
+                    start_to_fire_timeout: Some(prost_dur!(from_secs(1))),
+                }),
+            ))
+            .await
+            .unwrap();
+
+        // Shutdown proceeds if the only outstanding activations are evictions
+        assert_matches!(
+            worker.poll_workflow_activation().await.unwrap_err(),
+            PollWfError::ShutDown
+        );
+    });
+}
+
+#[tokio::test]
+async fn shutdown_worker_can_complete_pending_activation() {
+    let t = canned_histories::single_timer("1");
+    let worker = build_fake_worker("fake_wf_id", t, &[2]);
+    let res = worker.poll_workflow_activation().await.unwrap();
+    assert_eq!(res.jobs.len(), 1);
+    // Complete the timer, will queue PA
+    worker
+        .complete_workflow_activation(WorkflowActivationCompletion::from_cmds(
+            res.run_id,
+            vec![start_timer_cmd(1, Duration::from_secs(1))],
+        ))
+        .await
+        .unwrap();
+
+    tokio::join!(worker.shutdown(), async {
+        let res = worker.poll_workflow_activation().await.unwrap();
+        // The timer fires
+        assert_eq!(res.jobs.len(), 1);
+        worker
+            .complete_workflow_activation(WorkflowActivationCompletion::from_cmds(
+                res.run_id,
+                vec![CompleteWorkflowExecution::default().into()],
+            ))
+            .await
+            .unwrap();
+        // Shutdown proceeds if the only outstanding activations are evictions
+        assert_matches!(
+            worker.poll_workflow_activation().await.unwrap_err(),
+            PollWfError::ShutDown
+        );
+    });
+}
+
+#[tokio::test]
+async fn worker_shutdown_during_poll_doesnt_deadlock() {
+    let (tx, rx) = watch::channel(false);
+    let mut mock_poller = mock_manual_poller();
+    let rx = rx.clone();
+    mock_poller.expect_poll().returning(move || {
+        let mut rx = rx.clone();
+        async move {
+            // Don't resolve polls until worker shuts down
+            rx.changed().await.unwrap();
+            // We don't want to return a real response here because it would get buffered and
+            // then we'd have real work to do to be able to finish shutdown.
+            Some(Ok(Default::default()))
+        }
+        .boxed()
+    });
+    let mw = MockWorkerInputs::new_from_poller(Box::new(mock_poller));
+    let mut mock_client = mock_workflow_client();
+    mock_client
+        .expect_complete_workflow_task()
+        .returning(|_| Ok(RespondWorkflowTaskCompletedResponse::default()));
+    let worker = mock_worker(MocksHolder::from_mock_worker(mock_client, mw));
+    let pollfut = worker.poll_workflow_activation();
+    let shutdownfut = async {
+        worker.shutdown().await;
+        // Either the send works and unblocks the poll or the poll future is dropped before actually
+        // polling -- either way things worked OK
+        let _ = tx.send(true);
+    };
+    let (pollres, _) = tokio::join!(pollfut, shutdownfut);
+    assert_matches!(pollres.unwrap_err(), PollWfError::ShutDown);
+    worker.finalize_shutdown().await;
+}
+
+#[tokio::test]
+async fn can_shutdown_local_act_only_worker_when_act_polling() {
+    let t = canned_histories::single_timer("1");
+    let mock = mock_workflow_client();
+    let mh = MockPollCfg::from_resp_batches("fakeid", t, [1], mock);
+    let mut mock = build_mock_pollers(mh);
+    mock.worker_cfg(|w| {
+        w.no_remote_activities = true;
+        w.max_cached_workflows = 1;
+    });
+    let worker = mock_worker(mock);
+    let barrier = Barrier::new(2);
+
+    tokio::join!(
+        async {
+            barrier.wait().await;
+            worker.shutdown().await;
+        },
+        async {
+            let res = worker.poll_workflow_activation().await.unwrap();
+            // Complete so there's no outstanding WFT and shutdown can finish
+            worker
+                .complete_workflow_activation(WorkflowActivationCompletion::empty(res.run_id))
+                .await
+                .unwrap();
+            barrier.wait().await;
+            assert_matches!(
+                worker.poll_activity_task().await.unwrap_err(),
+                PollActivityError::ShutDown
+            );
+        }
+    );
+    worker.finalize_shutdown().await;
+}
+
+#[tokio::test]
+async fn complete_with_task_not_found_during_shutdown() {
+    let t = canned_histories::single_timer("1");
+    let mut mock = mock_workflow_client();
+    mock.expect_complete_workflow_task()
+        .times(1)
+        .returning(|_| Err(tonic::Status::not_found("Workflow task not found.")));
+    let mh = MockPollCfg::from_resp_batches("fakeid", t, [1], mock);
+    let core = mock_worker(build_mock_pollers(mh));
+
+    let res = core.poll_workflow_activation().await.unwrap();
+    assert_eq!(res.jobs.len(), 1);
+
+    let complete_order = RefCell::new(vec![]);
+    // Initiate shutdown before completing the activation
+    let shutdown_fut = async {
+        core.shutdown().await;
+        complete_order.borrow_mut().push(3);
+    };
+    let poll_fut = async {
+        // This will return shutdown once the completion goes through
+        assert_matches!(
+            core.poll_workflow_activation().await.unwrap_err(),
+            PollWfError::ShutDown
+        );
+        complete_order.borrow_mut().push(2);
+    };
+    let complete_fut = async {
+        core.complete_workflow_activation(WorkflowActivationCompletion::from_cmds(
+            res.run_id,
+            vec![start_timer_cmd(1, Duration::from_secs(1))],
+        ))
+        .await
+        .unwrap();
+        complete_order.borrow_mut().push(1);
+    };
+    tokio::join!(shutdown_fut, poll_fut, complete_fut);
+    // Shutdown will currently complete first before the actual eviction reply since the
+    // workflow task is marked complete as soon as we get not found back from the server.
+    assert_eq!(&complete_order.into_inner(), &[1, 3, 2])
+}
+
+#[tokio::test]
+async fn complete_eviction_after_shutdown_doesnt_panic() {
+    let t = canned_histories::single_timer("1");
+    let mut mh = build_mock_pollers(MockPollCfg::from_resp_batches(
+        "fakeid",
+        t,
+        [1],
+        mock_workflow_client(),
+    ));
+    mh.make_wft_stream_interminable();
+    let core = mock_worker(mh);
+
+    let res = core.poll_workflow_activation().await.unwrap();
+    assert_eq!(res.jobs.len(), 1);
+    core.complete_workflow_activation(WorkflowActivationCompletion::from_cmds(
+        res.run_id,
+        vec![start_timer_cmd(1, Duration::from_secs(1))],
+    ))
+    .await
+    .unwrap();
+    let res = core.poll_workflow_activation().await.unwrap();
+    assert_matches!(
+        res.jobs[0].variant,
+        Some(workflow_activation_job::Variant::RemoveFromCache(_))
+    );
+    core.shutdown().await;
+    core.complete_workflow_activation(WorkflowActivationCompletion::empty(res.run_id))
+        .await
+        .unwrap();
+}
+
+#[tokio::test]
+async fn worker_does_not_panic_on_retry_exhaustion_of_nonfatal_net_err() {
+    let t = canned_histories::single_timer("1");
+    let mut mock = mock_workflow_client();
+    // Return a failure that counts as retryable, and hence we want to be swallowed
+    mock.expect_complete_workflow_task()
+        .times(1)
+        .returning(|_| Err(tonic::Status::internal("Some retryable error")));
+    let mut mh =
+        MockPollCfg::from_resp_batches("fakeid", t, [1.into(), ResponseType::AllHistory], mock);
+    mh.enforce_correct_number_of_polls = false;
+    let mut mock = build_mock_pollers(mh);
+    mock.worker_cfg(|w| w.max_cached_workflows = 1);
+    let core = mock_worker(mock);
+
+    let res = core.poll_workflow_activation().await.unwrap();
+    assert_eq!(res.jobs.len(), 1);
+    // This should not return a fatal error
+    core.complete_workflow_activation(WorkflowActivationCompletion::from_cmds(
+        res.run_id,
+        vec![start_timer_cmd(1, Duration::from_secs(1))],
+    ))
+    .await
+    .unwrap();
+    // We should see an eviction
+    let res = core.poll_workflow_activation().await.unwrap();
+    assert_matches!(
+        res.jobs[0].variant,
+        Some(workflow_activation_job::Variant::RemoveFromCache(_))
+    );
+}

data/bridge/sdk-core/core/src/core_tests/workflow_cancels.rs

@@ -0,0 +1,124 @@
+use crate::{
+    job_assert,
+    test_help::{
+        build_fake_worker, canned_histories, gen_assert_and_reply, poll_and_reply, ResponseType,
+        WorkflowCachingPolicy::NonSticky,
+    },
+};
+use rstest::rstest;
+use std::time::Duration;
+use temporal_sdk_core_protos::coresdk::{
+    workflow_activation::{workflow_activation_job, WorkflowActivationJob},
+    workflow_commands::{
+        CancelWorkflowExecution, CompleteWorkflowExecution, FailWorkflowExecution,
+    },
+};
+use temporal_sdk_core_test_utils::start_timer_cmd;
+
+enum CompletionType {
+    Complete,
+    Fail,
+    Cancel,
+}
+
+#[rstest]
+#[case::incremental_cancel(vec![1.into(), ResponseType::AllHistory], CompletionType::Cancel)]
+#[case::replay_cancel(vec![ResponseType::AllHistory], CompletionType::Cancel)]
+#[case::incremental_complete(vec![1.into(), ResponseType::AllHistory], CompletionType::Complete)]
+#[case::replay_complete(vec![ResponseType::AllHistory], CompletionType::Complete)]
+#[case::incremental_fail(vec![1.into(), ResponseType::AllHistory], CompletionType::Fail)]
+#[case::replay_fail(vec![ResponseType::AllHistory], CompletionType::Fail)]
+#[tokio::test]
+async fn timer_then_cancel_req(
+    #[case] hist_batches: Vec<ResponseType>,
+    #[case] completion_type: CompletionType,
+) {
+    let wfid = "fake_wf_id";
+    let timer_seq = 1;
+    let timer_id = timer_seq.to_string();
+    let t = match completion_type {
+        CompletionType::Complete => {
+            canned_histories::timer_wf_cancel_req_completed(timer_id.as_str())
+        }
+        CompletionType::Fail => canned_histories::timer_wf_cancel_req_failed(timer_id.as_str()),
+        CompletionType::Cancel => {
+            canned_histories::timer_wf_cancel_req_cancelled(timer_id.as_str())
+        }
+    };
+    let core = build_fake_worker(wfid, t, hist_batches);
+
+    let final_cmd = match completion_type {
+        CompletionType::Complete => CompleteWorkflowExecution::default().into(),
+        CompletionType::Fail => FailWorkflowExecution::default().into(),
+        CompletionType::Cancel => CancelWorkflowExecution::default().into(),
+    };
+
+    poll_and_reply(
+        &core,
+        NonSticky,
+        &[
+            gen_assert_and_reply(
+                &job_assert!(workflow_activation_job::Variant::StartWorkflow(_)),
+                vec![start_timer_cmd(timer_seq, Duration::from_secs(1))],
+            ),
+            gen_assert_and_reply(
+                &job_assert!(
+                    workflow_activation_job::Variant::FireTimer(_),
+                    workflow_activation_job::Variant::CancelWorkflow(_)
+                ),
+                vec![final_cmd],
+            ),
+        ],
+    )
+    .await;
+}
+
+#[tokio::test]
+async fn timer_then_cancel_req_then_timer_then_cancelled() {
+    let wfid = "fake_wf_id";
+    let t = canned_histories::timer_wf_cancel_req_do_another_timer_then_cancelled();
+    let core = build_fake_worker(wfid, t, [ResponseType::AllHistory]);
+
+    poll_and_reply(
+        &core,
+        NonSticky,
+        &[
+            gen_assert_and_reply(
+                &job_assert!(workflow_activation_job::Variant::StartWorkflow(_)),
+                vec![start_timer_cmd(1, Duration::from_secs(1))],
+            ),
+            gen_assert_and_reply(
+                &job_assert!(
+                    workflow_activation_job::Variant::FireTimer(_),
+                    workflow_activation_job::Variant::CancelWorkflow(_)
+                ),
+                vec![start_timer_cmd(2, Duration::from_secs(1))],
+            ),
+            gen_assert_and_reply(
+                &job_assert!(workflow_activation_job::Variant::FireTimer(_)),
+                vec![CancelWorkflowExecution::default().into()],
+            ),
+        ],
+    )
+    .await;
+}
+
+#[tokio::test]
+async fn immediate_cancel() {
+    let wfid = "fake_wf_id";
+    let t = canned_histories::immediate_wf_cancel();
+    let core = build_fake_worker(wfid, t, &[1]);
+
+    poll_and_reply(
+        &core,
+        NonSticky,
+        &[gen_assert_and_reply(
+            &job_assert!(
+                workflow_activation_job::Variant::StartWorkflow(_),
+                workflow_activation_job::Variant::CancelWorkflow(_)
+            ),
+            vec![CancelWorkflowExecution {}.into()],
+        )],
+    )
+    .await;
+}