@temporalio/core-bridge 0.23.0 → 1.0.0

package/sdk-core/protos/local/temporal/sdk/core/activity_result/activity_result.proto

@@ -4,8 +4,8 @@ package coresdk.activity_result;
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
-import "temporal/sdk/core/common/common.proto";
 
 /**
  * Used to report activity completions to core
@@ -32,7 +32,7 @@ message ActivityResolution {
 
 /** Used to report successful completion either when executing or resolving */
 message Success {
-    common.Payload result = 1;
+    temporal.api.common.v1.Payload result = 1;
 }
 
 /** Used to report activity failure either when executing or resolving */

package/sdk-core/protos/local/temporal/sdk/core/activity_task/activity_task.proto

@@ -7,6 +7,7 @@ package coresdk.activity_task;
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "temporal/api/common/v1/message.proto";
 import "temporal/sdk/core/common/common.proto";
 
 message ActivityTask {
@@ -27,16 +28,16 @@ message Start {
     // The workflow's type name or function identifier
     string workflow_type = 2;
     // The workflow execution which requested this activity
-    common.WorkflowExecution workflow_execution = 3;
+    temporal.api.common.v1.WorkflowExecution workflow_execution = 3;
     // The activity's ID
     string activity_id = 4;
     // The activity's type name or function identifier
     string activity_type = 5;
-    map<string, common.Payload> header_fields = 6;
+    map<string, temporal.api.common.v1.Payload> header_fields = 6;
     // Arguments to the activity
-    repeated common.Payload input = 7;
+    repeated temporal.api.common.v1.Payload input = 7;
     // The last details that were recorded by a heartbeat when this task was generated
-    repeated common.Payload heartbeat_details = 8;
+    repeated temporal.api.common.v1.Payload heartbeat_details = 8;
     // When the task was *first* scheduled
     google.protobuf.Timestamp scheduled_time = 9;
     // When this current attempt at the task was scheduled
@@ -54,7 +55,7 @@ message Start {
     // This is an actual retry policy the service uses. It can be different from the one provided
     // (or not) during activity scheduling as the service can override the provided one in case its
     // values are not specified or exceed configured system limits.
-    common.RetryPolicy retry_policy = 16;
+    temporal.api.common.v1.RetryPolicy retry_policy = 16;
 
     // Set to true if this is a local activity. Note that heartbeating does not apply to local
     // activities.

package/sdk-core/protos/local/temporal/sdk/core/bridge/bridge.proto

@@ -56,7 +56,6 @@ message CreateClientRequest {
   string client_name = 3;
   string client_version = 4;
   string identity = 6;
-  string worker_binary_id = 7;
   TlsConfig tls_config = 8;
   RetryConfig retry_config = 9;
 

package/sdk-core/protos/local/temporal/sdk/core/child_workflow/child_workflow.proto

@@ -2,6 +2,7 @@ syntax = "proto3";
 
 package coresdk.child_workflow;
 
+import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/sdk/core/common/common.proto";
 
@@ -20,7 +21,7 @@ message ChildWorkflowResult {
  * Used in ChildWorkflowResult to report successful completion.
  */
 message Success {
-    common.Payload result = 1;
+    temporal.api.common.v1.Payload result = 1;
 }
 
 /**

package/sdk-core/protos/local/temporal/sdk/core/common/common.proto

@@ -4,26 +4,6 @@ package coresdk.common;
 
 import "google/protobuf/duration.proto";
 
-// Many of the messages in here are exact or near duplicates of the protobufs defined by the
-// Temporal API. We dupe them here to introduce better ergonomics wherever possible, and to
-// decouple ourselves from upstream changes. Additionally, we have no need for wire compatibility
-// between core and lang sdks, since the lang SDK chooses which version of core it wants to use.
-
-// Used as arguments to activities, signals, queries, etc.
-message Payload {
-    map<string,bytes> metadata = 1;
-    bytes data = 2;
-}
-
-// Identifying information about a particular workflow execution. Namespace is expected to be
-// assumed or included in whatever message is wrapping this one.
-message WorkflowExecution {
-    // Can never be empty
-    string workflow_id = 1;
-    // May be empty if the most recent run of the workflow with the given ID is being targeted
-    string run_id = 2;
-}
-
 // Identifying information about a particular workflow execution, including namespace
 message NamespacedWorkflowExecution {
     // Namespace the workflow run is located in
@@ -33,47 +13,3 @@ message NamespacedWorkflowExecution {
     // May be empty if the most recent run of the workflow with the given ID is being targeted
     string run_id = 3;
 }
-
-
-// Defines how an activity or workflow should be retried in the event of failure, timeout, etc.
-// Defaults may differ depending on what this is being used for. See containing messages.
-message RetryPolicy {
-    // Interval of the first retry. If backoff_coefficient is 1.0 then it is used for all
-    // retries. If this is not specified, there will be *no retrying*. Lang SDKs should require
-    // this to be set.
-    google.protobuf.Duration initial_interval = 1;
-    // Coefficient used to calculate the next retry interval. The next retry interval is previous
-    // interval multiplied by the coefficient. Must be 1 or larger.
-    double backoff_coefficient = 2;
-    // Maximum interval between retries. Exponential backoff leads to interval increase. This value
-    // caps that interval.
-    google.protobuf.Duration maximum_interval = 3;
-    // Maximum number of attempts. When exceeded, retrying will stop. 1 disables retries. 0 means
-    // unlimited retries (until the activity or workflow's total timeout is reached).
-    int32 maximum_attempts = 4;
-    // If a stringified error type matches something in this list, retries will cease.
-    repeated string non_retryable_error_types = 5;
-}
-
-enum WorkflowIdReusePolicy {
-    WORKFLOW_ID_REUSE_POLICY_UNSPECIFIED = 0;
-    // Allow start a workflow execution using the same workflow Id, when workflow not running.
-    WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE = 1;
-    // Allow start a workflow execution using the same workflow Id, when workflow not running, and the last execution close state is in
-    // [terminated, cancelled, timed out, failed].
-    WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY = 2;
-    // Do not allow start a workflow execution using the same workflow Id at all.
-    WORKFLOW_ID_REUSE_POLICY_REJECT_DUPLICATE = 3;
-}
-
-/** Possible causes of failure to cancel an external workflow */
-enum CancelExternalWorkflowExecutionFailedCause {
-    CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED = 0;
-    CANCEL_EXTERNAL_WORKFLOW_EXECUTION_FAILED_CAUSE_EXTERNAL_WORKFLOW_EXECUTION_NOT_FOUND = 1;
-}
-
-/** Possible causes of failure to signal an external workflow */
-enum SignalExternalWorkflowExecutionFailedCause {
-    SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED = 0;
-    SIGNAL_EXTERNAL_WORKFLOW_EXECUTION_FAILED_CAUSE_EXTERNAL_WORKFLOW_EXECUTION_NOT_FOUND = 1;
-}

package/sdk-core/protos/local/temporal/sdk/core/core_interface.proto

@@ -8,6 +8,7 @@ package coresdk;
 import "google/protobuf/duration.proto";
 import "google/protobuf/empty.proto";
 import "google/protobuf/timestamp.proto";
+import "temporal/api/common/v1/message.proto";
 import "temporal/sdk/core/activity_result/activity_result.proto";
 import "temporal/sdk/core/activity_task/activity_task.proto";
 import "temporal/sdk/core/common/common.proto";
@@ -19,7 +20,7 @@ import "temporal/sdk/core/workflow_completion/workflow_completion.proto";
 // A request as given to `record_activity_heartbeat`
 message ActivityHeartbeat {
     bytes task_token = 1;
-    repeated common.Payload details = 2;
+    repeated temporal.api.common.v1.Payload details = 2;
 }
 
 // A request as given to `complete_activity_task`

package/sdk-core/protos/local/temporal/sdk/core/workflow_activation/workflow_activation.proto

@@ -25,8 +25,11 @@ message WorkflowActivation {
     google.protobuf.Timestamp timestamp = 2;
     /// Whether or not the activation is replaying past events
     bool is_replaying = 3;
+    /// Current history length as determined by the event id of the most recently processed event.
+    /// This ensures that the number is always deterministic
+    uint32 history_length = 4;
     /// The things to do upon activating the workflow
-    repeated WorkflowActivationJob jobs = 4;
+    repeated WorkflowActivationJob jobs = 5;
 }
 
 message WorkflowActivationJob {
@@ -73,12 +76,12 @@ message StartWorkflow {
     // The workflow id used on the temporal server
     string workflow_id = 2;
     // Inputs to the workflow code
-    repeated common.Payload arguments = 3;
+    repeated temporal.api.common.v1.Payload arguments = 3;
     // The seed must be used to initialize the random generator used by SDK.
     // RandomSeedUpdatedAttributes are used to deliver seed updates.
     uint64 randomness_seed = 4;
     // Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors.
-    map<string, common.Payload> headers = 5;
+    map<string, temporal.api.common.v1.Payload> headers = 5;
     // Identity of the client who requested this execution
     string identity = 6;
     // If this workflow is a child, information about the parent
@@ -183,25 +186,25 @@ message QueryWorkflow {
     string query_id = 1;
     /// The query's function/method/etc name
     string query_type = 2;
-    repeated common.Payload arguments = 3;
+    repeated temporal.api.common.v1.Payload arguments = 3;
     /// Headers attached to the query
-    map<string, common.Payload> headers = 5;
+    map<string, temporal.api.common.v1.Payload> headers = 5;
 }
 
 /// Cancel a running workflow
 message CancelWorkflow {
     /// Information from the cancellation request
-    repeated common.Payload details = 1;
+    repeated temporal.api.common.v1.Payload details = 1;
 }
 
 // Send a signal to a workflow
 message SignalWorkflow {
     string signal_name = 1;
-    repeated common.Payload input = 2;
+    repeated temporal.api.common.v1.Payload input = 2;
     // Identity of the sender of the signal
     string identity = 3;
     // Headers attached to the signal
-    map<string, common.Payload> headers = 5;
+    map<string, temporal.api.common.v1.Payload> headers = 5;
 }
 
 // Inform lang what the result of a call to `patched` or similar API should be -- this is always

package/sdk-core/protos/local/temporal/sdk/core/workflow_commands/workflow_commands.proto

@@ -9,6 +9,8 @@ package coresdk.workflow_commands;
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
+import "temporal/api/common/v1/message.proto";
+import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/sdk/core/child_workflow/child_workflow.proto";
 import "temporal/sdk/core/common/common.proto";
@@ -32,7 +34,7 @@ message WorkflowCommand {
         CancelSignalWorkflow cancel_signal_workflow = 15;
         ScheduleLocalActivity schedule_local_activity = 16;
         RequestCancelLocalActivity request_cancel_local_activity = 17;
-        UpsertWorkflowSearchAttributes upsert_workflow_search_attributes_command_attributes = 18;
+        UpsertWorkflowSearchAttributes upsert_workflow_search_attributes = 18;
     }
 }
 
@@ -55,9 +57,9 @@ message ScheduleActivity {
     string namespace = 4;
     // The name of the task queue to place this activity request in
     string task_queue = 5;
-    map<string, common.Payload> headers = 6;
+    map<string, temporal.api.common.v1.Payload> headers = 6;
     /// Arguments/input to the activity. Called "input" upstream.
-    repeated common.Payload arguments = 7;
+    repeated temporal.api.common.v1.Payload arguments = 7;
     /// Indicates how long the caller is willing to wait for an activity completion. Limits how long
     /// retries will be attempted. Either this or start_to_close_timeout_seconds must be specified.
     /// When not specified defaults to the workflow execution timeout.
@@ -74,9 +76,13 @@ message ScheduleActivity {
     /// Activities are provided by a default retry policy controlled through the service dynamic
     /// configuration. Retries are happening up to schedule_to_close_timeout. To disable retries set
     /// retry_policy.maximum_attempts to 1.
-    common.RetryPolicy retry_policy = 12;
+    temporal.api.common.v1.RetryPolicy retry_policy = 12;
     /// Defines how the workflow will wait (or not) for cancellation of the activity to be confirmed
     ActivityCancellationType cancellation_type = 13;
+    /// If set, the worker will not tell the service that it can immediately start executing this
+    /// activity. When unset/default, workers will always attempt to do so if activity execution
+    /// slots are available.
+    bool do_not_eagerly_execute = 14;
 }
 
 message ScheduleLocalActivity {
@@ -91,9 +97,9 @@ message ScheduleLocalActivity {
     /// If this local activity is a retry (as per the attempt field) this needs to be the original
     /// scheduling time (as provided in `DoBackoff`)
     google.protobuf.Timestamp original_schedule_time = 5;
-    map<string, common.Payload> headers = 6;
+    map<string, temporal.api.common.v1.Payload> headers = 6;
     /// Arguments/input to the activity.
-    repeated common.Payload arguments = 7;
+    repeated temporal.api.common.v1.Payload arguments = 7;
     /// Indicates how long the caller is willing to wait for local activity completion. Limits how
     /// long retries will be attempted. When not specified defaults to the workflow execution
     /// timeout (which may be unset).
@@ -111,7 +117,7 @@ message ScheduleLocalActivity {
     google.protobuf.Duration start_to_close_timeout = 10;
     /// Specify a retry policy for the local activity. By default local activities will be retried
     /// indefinitely.
-    common.RetryPolicy retry_policy = 11;
+    temporal.api.common.v1.RetryPolicy retry_policy = 11;
     /// If the activity is retrying and backoff would exceed this value, lang will be told to
     /// schedule a timer and retry the activity after. Otherwise, backoff will happen internally in
     /// core. Defaults to 1 minute.
@@ -154,12 +160,12 @@ message QueryResult {
 }
 
 message QuerySuccess {
-    common.Payload response = 1;
+    temporal.api.common.v1.Payload response = 1;
 }
 
 /// Issued when the workflow completes successfully
 message CompleteWorkflowExecution {
-    common.Payload result = 1;
+    temporal.api.common.v1.Payload result = 1;
 }
 
 /// Issued when the workflow errors out
@@ -177,17 +183,17 @@ message ContinueAsNewWorkflowExecution {
     string task_queue = 2;
     /// Inputs to the workflow code. Should be specified. Will not re-use old arguments, as that
     /// typically wouldn't make any sense.
-    repeated common.Payload arguments = 3;
+    repeated temporal.api.common.v1.Payload arguments = 3;
     /// Timeout for a single run of the new workflow.
     google.protobuf.Duration workflow_run_timeout = 4;
     /// Timeout of a single workflow task.
     google.protobuf.Duration workflow_task_timeout = 5;
     /// Memo fields
-    map<string, common.Payload> memo = 6;
+    map<string, temporal.api.common.v1.Payload> memo = 6;
     /// Header fields
-    map<string, common.Payload> headers = 7;
+    map<string, temporal.api.common.v1.Payload> headers = 7;
     /// Search attributes
-    map<string, common.Payload> search_attributes = 8;
+    map<string, temporal.api.common.v1.Payload> search_attributes = 8;
 }
 
 /// Indicate a workflow has completed as cancelled. Generally sent as a response to an activation
@@ -213,7 +219,7 @@ message StartChildWorkflowExecution {
     string workflow_id = 3;
     string workflow_type = 4;
     string task_queue = 5;
-    repeated common.Payload input = 6;
+    repeated temporal.api.common.v1.Payload input = 6;
     /// Total workflow execution timeout including retries and continue as new.
     google.protobuf.Duration workflow_execution_timeout = 7;
     /// Timeout of a single workflow run.
@@ -224,15 +230,15 @@ message StartChildWorkflowExecution {
     child_workflow.ParentClosePolicy parent_close_policy = 10;
     // string control = 11; (unused from StartChildWorkflowExecutionCommandAttributes)
     // Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
-    common.WorkflowIdReusePolicy workflow_id_reuse_policy = 12;
-    common.RetryPolicy retry_policy = 13;
+    temporal.api.enums.v1.WorkflowIdReusePolicy workflow_id_reuse_policy = 12;
+    temporal.api.common.v1.RetryPolicy retry_policy = 13;
     string cron_schedule = 14;
     /// Header fields
-    map<string, common.Payload> headers = 15;
+    map<string, temporal.api.common.v1.Payload> headers = 15;
     /// Memo fields
-    map<string, common.Payload> memo = 16;
+    map<string, temporal.api.common.v1.Payload> memo = 16;
     /// Search attributes
-    map<string, common.Payload> search_attributes = 17;
+    map<string, temporal.api.common.v1.Payload> search_attributes = 17;
     /// Defines behaviour of the underlying workflow when child workflow cancellation has been requested.
     child_workflow.ChildWorkflowCancellationType cancellation_type = 18;
 }
@@ -270,9 +276,9 @@ message SignalExternalWorkflowExecution {
     /// Name of the signal handler
     string signal_name = 4;
     /// Arguments for the handler
-    repeated common.Payload args = 5;
+    repeated temporal.api.common.v1.Payload args = 5;
     /// Headers to attach to the signal
-    map<string, common.Payload> headers = 6;
+    map<string, temporal.api.common.v1.Payload> headers = 6;
 }
 
 /// Can be used to cancel not-already-sent `SignalExternalWorkflowExecution` commands
@@ -282,8 +288,7 @@ message CancelSignalWorkflow {
 }
 
 message UpsertWorkflowSearchAttributes {
-    /// Lang's incremental sequence number as passed to `UpsertWorkflowSearchAttributes`
-    uint32 seq = 1;
-    /// SearchAttributes fields - equivalent to indexed_fields on api. Key = search index, Value = value?
-    map<string, common.Payload> search_attributes = 2;
+    /// SearchAttributes fields - equivalent to indexed_fields on api. Key = search index, Value =
+    /// value?
+    map<string, temporal.api.common.v1.Payload> search_attributes = 1;
 }

package/sdk-core/sdk/src/activity_context.rs

@@ -1,3 +1,5 @@
+use crate::app_data::AppData;
+
 use prost_types::{Duration, Timestamp};
 use std::{
     collections::HashMap,
@@ -6,11 +8,8 @@ use std::{
 };
 use temporal_sdk_core_api::Worker;
 use temporal_sdk_core_protos::{
-    coresdk::{
-        activity_task,
-        common::{Payload, RetryPolicy, WorkflowExecution},
-        ActivityHeartbeat,
-    },
+    coresdk::{activity_task, ActivityHeartbeat},
+    temporal::api::common::v1::{Payload, RetryPolicy, WorkflowExecution},
     utilities::TryIntoOrNone,
 };
 use tokio_util::sync::CancellationToken;
@@ -19,6 +18,7 @@ use tokio_util::sync::CancellationToken;
 #[derive(Clone)]
 pub struct ActContext {
     worker: Arc<dyn Worker>,
+    app_data: Arc<AppData>,
     cancellation_token: CancellationToken,
     input: Vec<Payload>,
     heartbeat_details: Vec<Payload>,
@@ -55,6 +55,7 @@ impl ActContext {
     /// (which may be a default [Payload]).
     pub(crate) fn new(
         worker: Arc<dyn Worker>,
+        app_data: Arc<AppData>,
         cancellation_token: CancellationToken,
         task_queue: String,
         task_token: Vec<u8>,
@@ -90,6 +91,7 @@ impl ActContext {
         (
             ActContext {
                 worker,
+                app_data,
                 cancellation_token,
                 input,
                 heartbeat_details,
@@ -157,6 +159,11 @@ impl ActContext {
     pub fn headers(&self) -> &HashMap<String, Payload> {
         &self.header_fields
     }
+
+    /// Get custom Application Data
+    pub fn app_data<T: Send + Sync + 'static>(&self) -> Option<&T> {
+        self.app_data.get::<T>()
+    }
 }
 
 /// Deadline calculation.  This is a port of

package/sdk-core/sdk/src/app_data.rs

@@ -0,0 +1,37 @@
+use std::{
+    any::{Any, TypeId},
+    collections::HashMap,
+    fmt,
+};
+
+/// A Wrapper Type for workflow and activity app data
+#[derive(Default)]
+pub struct AppData {
+    map: HashMap<TypeId, Box<dyn Any + Send + Sync>>,
+}
+
+impl AppData {
+    /// Insert an item, overwritting duplicates
+    pub fn insert<T: Send + Sync + 'static>(&mut self, val: T) -> Option<T> {
+        self.map
+            .insert(TypeId::of::<T>(), Box::new(val))
+            .and_then(downcast_owned)
+    }
+
+    /// Get a reference to a type in the map
+    pub fn get<T: 'static>(&self) -> Option<&T> {
+        self.map
+            .get(&TypeId::of::<T>())
+            .and_then(|boxed| boxed.downcast_ref())
+    }
+}
+
+impl fmt::Debug for AppData {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.debug_struct("AppData").finish()
+    }
+}
+
+fn downcast_owned<T: Send + Sync + 'static>(boxed: Box<dyn Any + Send + Sync>) -> Option<T> {
+    boxed.downcast().ok().map(|boxed| *boxed)
+}