@temporalio/core-bridge 1.6.0 → 1.7.1

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

@@ -1,14 +1,13 @@
 syntax = "proto3";
 
 package coresdk.child_workflow;
+option ruby_package = "Temporalio::Bridge::Api::ChildWorkflow";
 
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/sdk/core/common/common.proto";
 
-/**
- * Used by core to resolve child workflow executions.
- */
+// Used by core to resolve child workflow executions.
 message ChildWorkflowResult {
     oneof status {
         Success completed = 1;
@@ -17,61 +16,51 @@ message ChildWorkflowResult {
     }
 }
 
-/**
- * Used in ChildWorkflowResult to report successful completion.
- */
+// Used in ChildWorkflowResult to report successful completion.
 message Success {
     temporal.api.common.v1.Payload result = 1;
 }
 
-/**
- * Used in ChildWorkflowResult to report non successful outcomes such as
- * application failures, timeouts, terminations, and cancellations.
- */
+// Used in ChildWorkflowResult to report non successful outcomes such as
+// application failures, timeouts, terminations, and cancellations.
 message Failure {
     temporal.api.failure.v1.Failure failure = 1;
 }
 
-/**
- * Used in ChildWorkflowResult to report cancellation.
- * Failure should be ChildWorkflowFailure with a CanceledFailure cause.
- */
+// Used in ChildWorkflowResult to report cancellation.
+// Failure should be ChildWorkflowFailure with a CanceledFailure cause.
 message Cancellation {
     temporal.api.failure.v1.Failure failure = 1;
 }
 
-/**
- * Used by the service to determine the fate of a child workflow
- * in case its parent is closed.
- */
+// Used by the service to determine the fate of a child workflow
+// in case its parent is closed.
 enum ParentClosePolicy {
-    /** Let's the server set the default. */
+    // Let's the server set the default.
     PARENT_CLOSE_POLICY_UNSPECIFIED = 0;
-    /** Terminate means terminating the child workflow. */
+    // Terminate means terminating the child workflow.
     PARENT_CLOSE_POLICY_TERMINATE = 1;
-    /** Abandon means not doing anything on the child workflow. */
+    // Abandon means not doing anything on the child workflow.
     PARENT_CLOSE_POLICY_ABANDON = 2;
-    /** Cancel means requesting cancellation on the child workflow. */
+    // Cancel means requesting cancellation on the child workflow.
     PARENT_CLOSE_POLICY_REQUEST_CANCEL = 3;
 }
 
-/** Possible causes of failure to start a child workflow */
+// Possible causes of failure to start a child workflow
 enum StartChildWorkflowExecutionFailedCause {
     START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_UNSPECIFIED = 0;
     START_CHILD_WORKFLOW_EXECUTION_FAILED_CAUSE_WORKFLOW_ALREADY_EXISTS = 1;
 }
 
-/**
- * Controls at which point to report back to lang when a child workflow is cancelled
- */
+// Controls at which point to report back to lang when a child workflow is cancelled
 enum ChildWorkflowCancellationType {
-    /** Do not request cancellation of the child workflow if already scheduled */
+    // Do not request cancellation of the child workflow if already scheduled
     ABANDON = 0;
-    /** Initiate a cancellation request and immediately report cancellation to the parent. */
+    // Initiate a cancellation request and immediately report cancellation to the parent.
     TRY_CANCEL = 1;
-    /** Wait for child cancellation completion. */
+    // Wait for child cancellation completion.
     WAIT_CANCELLATION_COMPLETED = 2;
-    /** Request cancellation of the child and wait for confirmation that the request was received. */
+    // Request cancellation of the child and wait for confirmation that the request was received.
     WAIT_CANCELLATION_REQUESTED = 3;
 }
 

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

@@ -1,6 +1,7 @@
 syntax = "proto3";
 
 package coresdk.common;
+option ruby_package = "Temporalio::Bridge::Api::Common";
 
 import "google/protobuf/duration.proto";
 

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

@@ -1,6 +1,7 @@
 syntax = "proto3";
 
 package coresdk;
+option ruby_package = "Temporalio::Bridge::Api::CoreInterface";
 
 // Note: Intellij will think the Google imports don't work because of the slightly odd nature of
 // the include paths. You can make it work by going to the "Protobuf Support" settings section

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

@@ -1,6 +1,7 @@
 syntax = "proto3";
 
 package coresdk.external_data;
+option ruby_package = "Temporalio::Bridge::Api::ExternalData";
 
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
@@ -27,4 +28,11 @@ message LocalActivityMarkerData {
   // The time the LA was originally scheduled (wall clock time). This is used to track
   // schedule-to-close timeouts when timer-based backoffs are used
   google.protobuf.Timestamp original_schedule_time = 7;
+}
+
+message PatchedMarkerData {
+  // The patch id
+  string id = 1;
+  // Whether or not the patch is marked deprecated.
+  bool deprecated = 2;
 }

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

@@ -5,6 +5,7 @@ syntax = "proto3";
  * lang SDK applies these activation jobs to drive workflows.
  */
 package coresdk.workflow_activation;
+option ruby_package = "Temporalio::Bridge::Api::WorkflowActivation";
 
 import "google/protobuf/timestamp.proto";
 import "google/protobuf/duration.proto";
@@ -15,56 +16,60 @@ import "temporal/sdk/core/activity_result/activity_result.proto";
 import "temporal/sdk/core/child_workflow/child_workflow.proto";
 import "temporal/sdk/core/common/common.proto";
 
-/// An instruction to the lang sdk to run some workflow code, whether for the first time or from
-/// a cached state.
+// An instruction to the lang sdk to run some workflow code, whether for the first time or from
+// a cached state.
 message WorkflowActivation {
-    /// The id of the currently active run of the workflow. Also used as a cache key. There may
-    /// only ever be one active workflow task (and hence activation) of a run at one time.
+    // The id of the currently active run of the workflow. Also used as a cache key. There may
+    // only ever be one active workflow task (and hence activation) of a run at one time.
     string run_id = 1;
-    /// The current time as understood by the workflow, which is set by workflow task started events
+    // The current time as understood by the workflow, which is set by workflow task started events
     google.protobuf.Timestamp timestamp = 2;
-    /// Whether or not the activation is replaying past events
+    // 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
+    // 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
+    // The things to do upon activating the workflow
     repeated WorkflowActivationJob jobs = 5;
+    // Internal flags which are available for use by lang. If `is_replaying` is false, all
+    // internal flags may be used. This is not a delta - all previously used flags always
+    // appear since this representation is cheap.
+    repeated uint32 available_internal_flags = 6;
 }
 
 message WorkflowActivationJob {
     oneof variant {
-        /// Begin a workflow for the first time
+        // Begin a workflow for the first time
         StartWorkflow start_workflow = 1;
-        /// A timer has fired, allowing whatever was waiting on it (if anything) to proceed
+        // A timer has fired, allowing whatever was waiting on it (if anything) to proceed
         FireTimer fire_timer = 2;
-        /// Workflow was reset. The randomness seed must be updated.
+        // Workflow was reset. The randomness seed must be updated.
         UpdateRandomSeed update_random_seed = 4;
-        /// A request to query the workflow was received.
+        // A request to query the workflow was received.
         QueryWorkflow query_workflow = 5;
-        /// A request to cancel the workflow was received.
+        // A request to cancel the workflow was received.
         CancelWorkflow cancel_workflow = 6;
-        /// A request to signal the workflow was received.
+        // A request to signal the workflow was received.
         SignalWorkflow signal_workflow = 7;
-        /// An activity was resolved, result could be completed, failed or cancelled
+        // An activity was resolved, result could be completed, failed or cancelled
         ResolveActivity resolve_activity = 8;
-        /// A patch marker has been detected and lang is being told that change exists. This
-        /// job is strange in that it is sent pre-emptively to lang without any corresponding
-        /// command being sent first.
+        // A patch marker has been detected and lang is being told that change exists. This
+        // job is strange in that it is sent pre-emptively to lang without any corresponding
+        // command being sent first.
         NotifyHasPatch notify_has_patch = 9;
-        /// A child workflow execution has started or failed to start
+        // A child workflow execution has started or failed to start
         ResolveChildWorkflowExecutionStart resolve_child_workflow_execution_start = 10;
-        /// A child workflow was resolved, result could be completed or failed
+        // A child workflow was resolved, result could be completed or failed
         ResolveChildWorkflowExecution resolve_child_workflow_execution = 11;
-        /// An attempt to signal an external workflow resolved
+        // An attempt to signal an external workflow resolved
         ResolveSignalExternalWorkflow resolve_signal_external_workflow = 12;
-        /// An attempt to cancel an external workflow resolved
+        // An attempt to cancel an external workflow resolved
         ResolveRequestCancelExternalWorkflow resolve_request_cancel_external_workflow = 13;
-        /// Remove the workflow identified by the [WorkflowActivation] containing this job from the cache
-        /// after performing the activation.
-        ///
-        /// If other job variant are present in the list, this variant will be the last job in the
-        /// job list. The string value is a reason for eviction.
+        // Remove the workflow identified by the [WorkflowActivation] containing this job from the cache
+        // after performing the activation.
+        //
+        // If other job variant are present in the list, this variant will be the last job in the
+        // job list. The string value is a reason for eviction.
         RemoveFromCache remove_from_cache = 50;
     }
 }
@@ -123,23 +128,23 @@ message StartWorkflow {
     google.protobuf.Timestamp start_time = 23;
 }
 
-/// Notify a workflow that a timer has fired
+// Notify a workflow that a timer has fired
 message FireTimer {
-    /// Sequence number as provided by lang in the corresponding StartTimer command
+    // Sequence number as provided by lang in the corresponding StartTimer command
     uint32 seq = 1;
 }
 
-/// Notify a workflow that an activity has been resolved
+// Notify a workflow that an activity has been resolved
 message ResolveActivity {
-    /// Sequence number as provided by lang in the corresponding ScheduleActivity command
+    // Sequence number as provided by lang in the corresponding ScheduleActivity command
     uint32 seq = 1;
     activity_result.ActivityResolution result = 2;
 }
 
-/// Notify a workflow that a start child workflow execution request has succeeded, failed or was
-/// cancelled.
+// Notify a workflow that a start child workflow execution request has succeeded, failed or was
+// cancelled.
 message ResolveChildWorkflowExecutionStart {
-    /// Sequence number as provided by lang in the corresponding StartChildWorkflowExecution command
+    // Sequence number as provided by lang in the corresponding StartChildWorkflowExecution command
     uint32 seq = 1;
     oneof status {
         ResolveChildWorkflowExecutionStartSuccess succeeded = 2;
@@ -148,54 +153,54 @@ message ResolveChildWorkflowExecutionStart {
     }
 }
 
-/// Simply pass the run_id to lang
+// Simply pass the run_id to lang
 message ResolveChildWorkflowExecutionStartSuccess {
     string run_id = 1;
 }
 
-/// Provide lang the cause of failure
+// Provide lang the cause of failure
 message ResolveChildWorkflowExecutionStartFailure {
-    /// Lang should have this information but it's more convenient to pass it back
-    /// for error construction on the lang side.
+    // Lang should have this information but it's more convenient to pass it back
+    // for error construction on the lang side.
     string workflow_id = 1;
     string workflow_type = 2;
     child_workflow.StartChildWorkflowExecutionFailedCause cause = 3;
 }
 
-/// `failure` should be ChildWorkflowFailure with cause set to CancelledFailure.
-/// The failure is constructed in core for lang's convenience.
+// `failure` should be ChildWorkflowFailure with cause set to CancelledFailure.
+// The failure is constructed in core for lang's convenience.
 message ResolveChildWorkflowExecutionStartCancelled {
   temporal.api.failure.v1.Failure failure = 1;
 }
 
-/// Notify a workflow that a child workflow execution has been resolved
+// Notify a workflow that a child workflow execution has been resolved
 message ResolveChildWorkflowExecution {
-    /// Sequence number as provided by lang in the corresponding StartChildWorkflowExecution command
+    // Sequence number as provided by lang in the corresponding StartChildWorkflowExecution command
     uint32 seq = 1;
     child_workflow.ChildWorkflowResult result = 2;
 }
 
-/// Update the workflow's random seed
+// Update the workflow's random seed
 message UpdateRandomSeed {
     uint64 randomness_seed = 1;
 }
 
-/// Query a workflow
+// Query a workflow
 message QueryWorkflow {
-    /// For PollWFTResp `query` field, this will be set to the special value `legacy`. For the
-    /// `queries` field, the server provides a unique identifier. If it is a `legacy` query,
-    /// lang cannot issue any commands in response other than to answer the query.
+    // For PollWFTResp `query` field, this will be set to the special value `legacy`. For the
+    // `queries` field, the server provides a unique identifier. If it is a `legacy` query,
+    // lang cannot issue any commands in response other than to answer the query.
     string query_id = 1;
-    /// The query's function/method/etc name
+    // The query's function/method/etc name
     string query_type = 2;
     repeated temporal.api.common.v1.Payload arguments = 3;
-    /// Headers attached to the query
+    // Headers attached to the query
     map<string, temporal.api.common.v1.Payload> headers = 5;
 }
 
-/// Cancel a running workflow
+// Cancel a running workflow
 message CancelWorkflow {
-    /// Information from the cancellation request
+    // Information from the cancellation request
     repeated temporal.api.common.v1.Payload details = 1;
 }
 
@@ -216,20 +221,20 @@ message NotifyHasPatch {
 }
 
 message ResolveSignalExternalWorkflow {
-    /// Sequence number as provided by lang in the corresponding SignalExternalWorkflowExecution
-    /// command
+    // Sequence number as provided by lang in the corresponding SignalExternalWorkflowExecution
+    // command
     uint32 seq = 1;
-    /// If populated, this signal either failed to be sent or was cancelled depending on failure
-    /// type / info.
+    // If populated, this signal either failed to be sent or was cancelled depending on failure
+    // type / info.
     temporal.api.failure.v1.Failure failure = 2;
 }
 
 message ResolveRequestCancelExternalWorkflow {
-    /// Sequence number as provided by lang in the corresponding
-    /// RequestCancelExternalWorkflowExecution command
+    // Sequence number as provided by lang in the corresponding
+    // RequestCancelExternalWorkflowExecution command
     uint32 seq = 1;
-    /// If populated, this signal either failed to be sent or was cancelled depending on failure
-    /// type / info.
+    // If populated, this signal either failed to be sent or was cancelled depending on failure
+    // type / info.
     temporal.api.failure.v1.Failure failure = 2;
 }