Added type safe workflow defintion traits and functions

Author: h7kanna

core/Cargo.toml

@@ -95,6 +95,8 @@ bimap = "0.6.1"
 clap = { version = "4.0", features = ["derive"] }
 criterion = "0.4"
 rstest = "0.17"
+serde = "1.0"
+serde_json = "1.0"
 temporal-sdk-core-test-utils = { path = "../test-utils" }
 temporal-sdk = { path = "../sdk" }
 

sdk-core-protos/src/lib.rs

@@ -1259,6 +1259,13 @@ pub mod coresdk {
         }
     }
 
+    /// Trait to map the Failure to Rust Error for idiomatic error handling in Workflow code <br/>
+    /// NOTE: This is *NOT* the generic
+    /// [failure converter](https://docs.temporal.io/dataconversion#failure-converter)
+    pub trait FromFailureExt: std::error::Error {
+        fn from_failure(failure: Failure) -> Self;
+    }
+
     pub trait FromPayloadsExt {
         fn from_payloads(p: Option<Payloads>) -> Self;
     }

sdk/Cargo.toml

@@ -20,6 +20,7 @@ base64 = "0.21"
 crossbeam = "0.8"
 derive_more = "0.99"
 futures = "0.3"
+futures-core = "0.3"
 once_cell = "1.10"
 parking_lot = { version = "0.12", features = ["send_guard"] }
 prost-types = { version = "0.4", package = "prost-wkt-types" }

sdk/src/lib.rs

@@ -48,6 +48,8 @@ mod activity_context;
 mod app_data;
 pub mod interceptors;
 mod payload_converter;
+pub mod prelude;
+pub mod workflow;
 mod workflow_context;
 mod workflow_future;
 
@@ -730,7 +732,7 @@ impl WorkflowFunction {
 pub type WorkflowResult<T> = Result<WfExitValue<T>, anyhow::Error>;
 
 /// Workflow functions may return these values when exiting
-#[derive(Debug, derive_more::From)]
+#[derive(derive_more::From)]
 pub enum WfExitValue<T: Debug> {
     /// Continue the workflow as a new execution
     #[from(ignore)]

sdk/src/prelude.rs

@@ -0,0 +1,55 @@
+//! Prelude for easy importing of required types when defining workflow and activity definitions
+
+/// Registry prelude
+#[allow(unused_imports)]
+pub mod registry {
+    pub use crate::workflow::{
+        into_activity_0_args, into_activity_0_args_without_ctx, into_activity_1_args,
+        into_activity_1_args_exit_value, into_activity_1_args_with_errors, into_activity_2_args,
+        into_workflow_0_args, into_workflow_1_args, into_workflow_1_args_exit_value,
+        into_workflow_1_args_with_errors, into_workflow_2_args,
+    };
+}
+
+/// Activity prelude
+#[allow(unused_imports)]
+pub mod activity {
+    pub use crate::{ActContext, ActExitValue, ActivityCancelledError, NonRetryableActivityError};
+    pub use serde::{Deserialize, Serialize};
+    pub use temporal_sdk_core_protos::{
+        coresdk::FromFailureExt, temporal::api::failure::v1::Failure,
+    };
+}
+
+/// Workflow prelude
+#[allow(unused_imports)]
+pub mod workflow {
+    pub use crate::workflow::{
+        execute_activity_0_args, execute_activity_0_args_without_ctx, execute_activity_1_args,
+        execute_activity_1_args_exit_value, execute_activity_1_args_with_errors,
+        execute_activity_2_args, execute_child_workflow_0_args_exit_value,
+        execute_child_workflow_1_args, execute_child_workflow_2_args,
+        execute_child_workflow_2_args_exit_value,
+    };
+    pub use crate::workflow::{AsyncFn0, AsyncFn1, AsyncFn2, AsyncFn3};
+    pub use crate::{
+        ActivityOptions, ChildWorkflowOptions, LocalActivityOptions, Signal, SignalData,
+        SignalWorkflowOptions, WfContext, WfExitValue, WorkflowResult,
+    };
+    use futures::FutureExt;
+    pub use serde::{Deserialize, Serialize};
+    pub use std::{
+        fmt::{Debug, Display},
+        future::Future,
+        time::Duration,
+    };
+    pub use temporal_sdk_core_protos::{
+        coresdk::{
+            activity_result::{self, activity_resolution},
+            child_workflow::{child_workflow_result, Failure, Success},
+            workflow_commands::ActivityCancellationType,
+            AsJsonPayloadExt, FromFailureExt, FromJsonPayloadExt,
+        },
+        temporal::api::common::v1::Payload,
+    };
+}