Merge branch 'master' of github.com:temporalio/api into spk/signal-with-start

Author: spkane31

nexus-rpc/temporal-proto-models-nexusrpc.yaml

@@ -0,0 +1,32 @@
+# yaml-language-server: $schema=https://raw.githubusercontent.com/nexus-rpc/nexus-rpc-gen/main/schemas/nexus-rpc-gen.json
+#
+# Nexus service definition for server-to-worker communication.
+# See request_response.proto for message definitions.
+#
+# Task queue format: /temporal-sys/worker-commands/{namespace}/{worker_grouping_key}
+
+nexusrpc: 1.0.0
+
+services:
+  temporal.api.nexusservices.workerservice.v1.WorkerService:
+    description: >
+      Internal Nexus service for server-to-worker communication.
+      Used by the Temporal server to send commands to workers.
+    operations:
+      ExecuteCommands:
+        description: Executes worker commands sent by the server.
+        input:
+          $goRef: "go.temporal.io/api/nexusservices/workerservice/v1.ExecuteCommandsRequest"
+          $javaRef: "io.temporal.api.nexusservices.workerservice.v1.ExecuteCommandsRequest"
+          $pythonRef: "temporalio.api.nexusservices.workerservice.v1.ExecuteCommandsRequest"
+          $typescriptRef: "@temporalio/api/nexusservices/workerservice/v1.ExecuteCommandsRequest"
+          $dotnetRef: "Temporalio.Api.Nexusservices.Workerservice.V1.ExecuteCommandsRequest"
+          $rubyRef: "Temporalio::Api::Nexusservices::Workerservice::V1::ExecuteCommandsRequest"
+        output:
+          $goRef: "go.temporal.io/api/nexusservices/workerservice/v1.ExecuteCommandsResponse"
+          $javaRef: "io.temporal.api.nexusservices.workerservice.v1.ExecuteCommandsResponse"
+          $pythonRef: "temporalio.api.nexusservices.workerservice.v1.ExecuteCommandsResponse"
+          $typescriptRef: "@temporalio/api/nexusservices/workerservice/v1.ExecuteCommandsResponse"
+          $dotnetRef: "Temporalio.Api.Nexusservices.Workerservice.V1.ExecuteCommandsResponse"
+          $rubyRef: "Temporalio::Api::Nexusservices::Workerservice::V1::ExecuteCommandsResponse"
+

openapi/openapiv2.json

@@ -15,6 +15,7 @@ import "google/protobuf/timestamp.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/deployment/v1/message.proto";
 import "temporal/api/enums/v1/activity.proto";
+import "temporal/api/callback/v1/message.proto";
 import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
@@ -161,6 +162,9 @@ message ActivityExecutionInfo {
 
     // Set if activity cancelation was requested.
     string canceled_reason = 32;
+
+    // Links to related entities, such as the entity that started this activity.
+    repeated temporal.api.common.v1.Link links = 33;
 }
 
 // Limited activity information returned in the list response.
@@ -195,3 +199,20 @@ message ActivityExecutionListInfo {
     // This field is only populated if the activity is closed.
     google.protobuf.Duration execution_duration = 11;
 }
+
+// CallbackInfo contains the state of an attached activity callback.
+message CallbackInfo {
+    // Trigger for when the activity is closed.
+    message ActivityClosed {}
+
+    message Trigger {
+        oneof variant {
+            ActivityClosed activity_closed = 1;
+        }
+    }
+
+    // Trigger for this callback.
+    Trigger trigger = 1;
+    // Common callback info.
+    temporal.api.callback.v1.CallbackInfo info = 2;
+}

openapi/openapiv3.yaml

@@ -0,0 +1,37 @@
+syntax = "proto3";
+
+package temporal.api.callback.v1;
+
+option go_package = "go.temporal.io/api/callback/v1;callback";
+option java_package = "io.temporal.api.callback.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Callback::V1";
+option csharp_namespace = "Temporalio.Api.Callback.V1";
+
+import "google/protobuf/timestamp.proto";
+
+import "temporal/api/common/v1/message.proto";
+import "temporal/api/enums/v1/common.proto";
+import "temporal/api/failure/v1/message.proto";
+
+// Common callback information. Specific CallbackInfo messages should embed this and may include additional fields.
+message CallbackInfo {
+    // Information on how this callback should be invoked (e.g. its URL and type).
+    temporal.api.common.v1.Callback callback = 1;
+    // The time when the callback was registered.
+    google.protobuf.Timestamp registration_time = 2;
+    // The current state of the callback.
+    temporal.api.enums.v1.CallbackState state = 3;
+    // The number of attempts made to deliver the callback.
+    // This number represents a minimum bound since the attempt is incremented after the callback request completes.
+    int32 attempt = 4;
+    // The time when the last attempt completed.
+    google.protobuf.Timestamp last_attempt_complete_time = 5;
+    // The last attempt's failure, if any.
+    temporal.api.failure.v1.Failure last_attempt_failure = 6;
+    // The time when the next attempt is scheduled.
+    google.protobuf.Timestamp next_attempt_schedule_time = 7;
+    // If the state is BLOCKED, blocked reason provides additional information.
+    string blocked_reason = 8;
+}

temporal/api/activity/v1/message.proto

@@ -240,9 +240,17 @@ message Link {
         string job_id = 1;
     }
 
+    // A link to an activity.
+    message Activity {
+        string namespace = 1;
+        string activity_id = 2;
+        string run_id = 3;
+    }
+
     oneof variant {
         WorkflowEvent workflow_event = 1;
         BatchJob batch_job = 2;
+        Activity activity = 3;
     }
 }
 

temporal/api/callback/v1/message.proto

@@ -15,7 +15,7 @@ import "temporal/api/enums/v1/task_queue.proto";
 import "google/protobuf/field_mask.proto";
 
 message ComputeConfigScalingGroup {
-    // Optional. The set of task queue types this scaling group serves. 
+    // Optional. The set of task queue types this scaling group serves.
     // If not provided, this scaling group serves all not otherwise defined
     // task types.
     repeated temporal.api.enums.v1.TaskQueueType task_queue_types = 1;
@@ -34,7 +34,7 @@ message ComputeConfigScalingGroup {
 // events.
 message ComputeConfig {
 
-    // Each scaling group describes a compute config for a specific subset of the worker 
+    // Each scaling group describes a compute config for a specific subset of the worker
     // deployment version: covering a specific set of task types and/or regions.
     // Having different configurations for different task types, allows independent
     // tuning of activity and workflow task processing (for example).
@@ -56,3 +56,13 @@ message ComputeConfigScalingGroupUpdate {
   //   "provider.nexus_endpoint", "scaler", "scaler.type", "scaler.details"
   google.protobuf.FieldMask update_mask = 2;
 }
+
+// A subset of information in ComputeConfig optimized for list views.
+message ComputeConfigSummary {
+    map<string, ComputeConfigScalingGroupSummary> scaling_groups = 1;
+}
+
+message ComputeConfigScalingGroupSummary {
+    repeated temporal.api.enums.v1.TaskQueueType task_queue_types = 1;
+    string provider_type = 2;
+}

temporal/api/common/v1/message.proto

@@ -11,13 +11,13 @@ option csharp_namespace = "Temporalio.Api.Deployment.V1";
 
 import "google/protobuf/timestamp.proto";
 
+import "temporal/api/enums/v1/workflow.proto";
 import "temporal/api/enums/v1/deployment.proto";
 import "temporal/api/enums/v1/task_queue.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/compute/v1/config.proto";
 
 // Worker Deployment options set in SDK that need to be sent to server in every poll.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 message WorkerDeploymentOptions {
     // Required when `worker_versioning_mode==VERSIONED`.
     string deployment_name = 1;
@@ -87,13 +87,12 @@ message DeploymentListInfo {
 }
 
 
-// A Worker Deployment Version (Version, for short) represents all workers of the same 
-// code and config within a Deployment. Workers of the same Version are expected to 
-// behave exactly the same so when executions move between them there are no 
+// A Worker Deployment Version (Version, for short) represents all workers of the same
+// code and config within a Deployment. Workers of the same Version are expected to
+// behave exactly the same so when executions move between them there are no
 // non-determinism issues.
-// Worker Deployment Versions are created in Temporal server automatically when 
+// Worker Deployment Versions are created in Temporal server automatically when
 // their first poller arrives to the server.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 message WorkerDeploymentVersionInfo {
     // Deprecated. Use `deployment_version`.
     string version = 1 [deprecated = true];
@@ -175,7 +174,6 @@ message WorkerDeploymentVersionInfo {
 
 // Information about workflow drainage to help the user determine when it is safe
 // to decommission a Version. Not present while version is current or ramping.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 message VersionDrainageInfo {
     // Set to DRAINING when the version first stops accepting new executions (is no longer current or ramping).
     // Set to DRAINED when no more open pinned workflows exist on this version.
@@ -186,14 +184,13 @@ message VersionDrainageInfo {
     google.protobuf.Timestamp last_checked_time = 3;
 }
 
-// A Worker Deployment (Deployment, for short) represents all workers serving 
-// a shared set of Task Queues. Typically, a Deployment represents one service or 
+// A Worker Deployment (Deployment, for short) represents all workers serving
+// a shared set of Task Queues. Typically, a Deployment represents one service or
 // application.
-// A Deployment contains multiple Deployment Versions, each representing a different 
+// A Deployment contains multiple Deployment Versions, each representing a different
 // version of workers. (see documentation of WorkerDeploymentVersionInfo)
 // Deployment records are created in Temporal server automatically when their
 // first poller arrives to the server.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 message WorkerDeploymentInfo {
     // Identifies a Worker Deployment. Must be unique within the namespace.
     string name = 1;
@@ -257,6 +254,7 @@ message WorkerDeploymentInfo {
         // Timestamp when this version last stopped being current or ramping.
         // Cleared if the version becomes current or ramping again.
         google.protobuf.Timestamp last_deactivation_time = 10;
+        temporal.api.compute.v1.ComputeConfigSummary compute_config = 13;
     }
 }
 
@@ -317,11 +315,23 @@ message RoutingConfig {
     int64 revision_number = 10;
 }
 
-// Used as part of WorkflowExecutionStartedEventAttributes to pass down the AutoUpgrade behavior and source deployment version 
+// Used as part of WorkflowExecutionStartedEventAttributes to pass down the AutoUpgrade behavior and source deployment version
 // to a workflow execution whose parent/previous workflow has an AutoUpgrade behavior.
+// Also used for Upgrade-on-CaN behaviors AutoUpgrade and UseRampingVersion.
 message InheritedAutoUpgradeInfo {
     // The source deployment version of the parent/previous workflow.
     temporal.api.deployment.v1.WorkerDeploymentVersion source_deployment_version = 1;
     // The revision number of the source deployment version of the parent/previous workflow.
     int64 source_deployment_revision_number = 2;
+    // Experimental.
+    // If this workflow is the result of a continue-as-new, this field is set to the initial_versioning_behavior
+    // specified in that command.
+    // Only used for the initial task of this run and the initial task of any retries of this run.
+    // Not passed to children or to future continue-as-new.
+    //
+    // Note: In the first release of Upgrade-on-CaN, when the only ContinueAsNewVersioningBehavior was AutoUpgrade,
+    // a non-empty InheritedAutoUpgradeInfo meant that the workflow should start as AutoUpgrade. So for compatibility
+    // with history events generated during that time, know that an UNSPECIFIED value here is equivalent to AutoUpgrade
+    // value if the InheritedAutoUpgradeInfo is non-empty.
+    temporal.api.enums.v1.ContinueAsNewVersioningBehavior continue_as_new_initial_versioning_behavior = 3;
 }

temporal/api/compute/v1/config.proto

@@ -30,7 +30,6 @@ enum DeploymentReachability {
 //     aip.dev/not-precedent: Call this status because it is . --)
 // Specify the drainage status for a Worker Deployment Version so users can decide whether they
 // can safely decommission the version.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 enum VersionDrainageStatus {
     // Drainage Status is not specified.
     VERSION_DRAINAGE_STATUS_UNSPECIFIED = 0;
@@ -49,7 +48,6 @@ enum VersionDrainageStatus {
 // - Whether or not Temporal Server considers this worker's version (Build ID) when dispatching
 //   tasks to it.
 // - Whether or not the workflows processed by this worker are versioned using the worker's version.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 enum WorkerVersioningMode {
     WORKER_VERSIONING_MODE_UNSPECIFIED = 0;
     // Workers with this mode are not distinguished from each other for task routing, even if they
@@ -76,7 +74,6 @@ enum WorkerVersioningMode {
 // (-- api-linter: core::0216::synonyms=disabled
 //     aip.dev/not-precedent: Call this status because it is . --)
 // Specify the status of a Worker Deployment Version.
-// Experimental. Worker Deployments are experimental and might significantly change in the future.
 enum WorkerDeploymentVersionStatus {
     WORKER_DEPLOYMENT_VERSION_STATUS_UNSPECIFIED = 0;
     // The Worker Deployment Version has been created inside the Worker Deployment but is not used by any

temporal/api/deployment/v1/message.proto

@@ -31,6 +31,11 @@ enum TaskQueueKind {
     //
     // Sticky queues are only for workflow tasks. There are no sticky task queues for activities.
     TASK_QUEUE_KIND_STICKY = 2;
+    // A worker-commands task queue is used for server-to-worker communication (e.g. activity
+    // cancellations). These queues are ephemeral and per-worker-process — they exist only for
+    // the lifetime of the worker process. Used with TASK_QUEUE_TYPE_NEXUS and polled via
+    // PollNexusTaskQueue.
+    TASK_QUEUE_KIND_WORKER_COMMANDS = 3;
 }
 
 enum TaskQueueType {