More cleanup

Author: bergundy

openapi/openapiv2.json

@@ -9764,13 +9764,17 @@
           "type": "string",
           "description": "Activity run ID, targets the latest run if run_id is empty."
         },
-        "reason": {
-          "type": "string",
-          "description": "Reason for requesting the termination, recorded in in the activity's result failure outcome."
-        },
         "identity": {
           "type": "string",
           "description": "The identity of the worker/client."
+        },
+        "requestId": {
+          "type": "string",
+          "description": "Used to de-dupe cancellation requests."
+        },
+        "reason": {
+          "type": "string",
+          "description": "Reason for requesting the termination, recorded in in the activity's result failure outcome."
         }
       }
     },
@@ -10350,6 +10354,29 @@
           "$ref": "#/definitions/v1PendingActivityState",
           "description": "More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING."
         },
+        "taskQueue": {
+          "$ref": "#/definitions/v1TaskQueue"
+        },
+        "scheduleToCloseTimeout": {
+          "type": "string",
+          "description": "Indicates how long the caller is willing to wait for an activity completion. Limits how long\nretries will be attempted.\n"
+        },
+        "scheduleToStartTimeout": {
+          "type": "string",
+          "description": "Limits time an activity task can stay in a task queue before a worker picks it up. This\ntimeout is always non retryable, as all a retry would achieve is to put it back into the same\nqueue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not\nspecified.\n"
+        },
+        "startToCloseTimeout": {
+          "type": "string",
+          "description": "Maximum time an activity is allowed to execute after being picked up by a worker. This\ntimeout is always retryable.\n"
+        },
+        "heartbeatTimeout": {
+          "type": "string",
+          "description": "Maximum permitted time between successful worker heartbeats."
+        },
+        "retryPolicy": {
+          "$ref": "#/definitions/v1RetryPolicy",
+          "description": "The retry policy for the activity. Will never exceed `schedule_to_close_timeout`."
+        },
         "heartbeatDetails": {
           "$ref": "#/definitions/v1Payloads",
           "description": "Details provided in the last recorded activity heartbeat."
@@ -10383,6 +10410,11 @@
           "format": "date-time",
           "description": "Scheduled time + schedule to close timeout."
         },
+        "closeTime": {
+          "type": "string",
+          "format": "date-time",
+          "description": "Time when the activity transitioned to a closed state."
+        },
         "lastFailure": {
           "$ref": "#/definitions/apifailurev1Failure",
           "description": "Failure details from the last failed attempt."

openapi/openapiv3.yaml

@@ -7256,6 +7256,45 @@ components:
           type: string
           description: More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
           format: enum
+        taskQueue:
+          $ref: '#/components/schemas/TaskQueue'
+        scheduleToCloseTimeout:
+          pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
+          type: string
+          description: |-
+            Indicates how long the caller is willing to wait for an activity completion. Limits how long
+             retries will be attempted.
+
+             (-- api-linter: core::0140::prepositions=disabled
+                 aip.dev/not-precedent: "to" is used to indicate interval. --)
+        scheduleToStartTimeout:
+          pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
+          type: string
+          description: |-
+            Limits time an activity task can stay in a task queue before a worker picks it up. This
+             timeout is always non retryable, as all a retry would achieve is to put it back into the same
+             queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
+             specified.
+
+             (-- api-linter: core::0140::prepositions=disabled
+                 aip.dev/not-precedent: "to" is used to indicate interval. --)
+        startToCloseTimeout:
+          pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
+          type: string
+          description: |-
+            Maximum time an activity is allowed to execute after being picked up by a worker. This
+             timeout is always retryable.
+
+             (-- api-linter: core::0140::prepositions=disabled
+                 aip.dev/not-precedent: "to" is used to indicate interval. --)
+        heartbeatTimeout:
+          pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
+          type: string
+          description: Maximum permitted time between successful worker heartbeats.
+        retryPolicy:
+          allOf:
+            - $ref: '#/components/schemas/RetryPolicy'
+          description: The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
         heartbeatDetails:
           allOf:
             - $ref: '#/components/schemas/Payloads'
@@ -7286,6 +7325,10 @@ components:
           type: string
           description: Scheduled time + schedule to close timeout.
           format: date-time
+        closeTime:
+          type: string
+          description: Time when the activity transitioned to a closed state.
+          format: date-time
         lastFailure:
           allOf:
             - $ref: '#/components/schemas/Failure'
@@ -13748,12 +13791,15 @@ components:
         runId:
           type: string
           description: Activity run ID, targets the latest run if run_id is empty.
-        reason:
-          type: string
-          description: Reason for requesting the termination, recorded in in the activity's result failure outcome.
         identity:
           type: string
           description: The identity of the worker/client.
+        requestId:
+          type: string
+          description: Used to de-dupe cancellation requests.
+        reason:
+          type: string
+          description: Reason for requesting the termination, recorded in in the activity's result failure outcome.
     TerminateActivityExecutionResponse:
       type: object
       properties: {}

temporal/api/activity/v1/message.proto

@@ -66,60 +66,93 @@ message ActivityExecutionInfo {
     temporal.api.enums.v1.ActivityExecutionStatus status = 4;
     // More detailed breakdown of ACTIVITY_EXECUTION_STATUS_RUNNING.
     temporal.api.enums.v1.PendingActivityState run_state = 5;
+
+    temporal.api.taskqueue.v1.TaskQueue task_queue = 6;
+
+    // Indicates how long the caller is willing to wait for an activity completion. Limits how long
+    // retries will be attempted.
+    //
+    // (-- api-linter: core::0140::prepositions=disabled
+    //     aip.dev/not-precedent: "to" is used to indicate interval. --)
+    google.protobuf.Duration schedule_to_close_timeout = 7;
+    // Limits time an activity task can stay in a task queue before a worker picks it up. This
+    // timeout is always non retryable, as all a retry would achieve is to put it back into the same
+    // queue. Defaults to `schedule_to_close_timeout` or workflow execution timeout if not
+    // specified.
+    //
+    // (-- api-linter: core::0140::prepositions=disabled
+    //     aip.dev/not-precedent: "to" is used to indicate interval. --)
+    google.protobuf.Duration schedule_to_start_timeout = 8;
+    // Maximum time an activity is allowed to execute after being picked up by a worker. This
+    // timeout is always retryable.
+    //
+    // (-- api-linter: core::0140::prepositions=disabled
+    //     aip.dev/not-precedent: "to" is used to indicate interval. --)
+    google.protobuf.Duration start_to_close_timeout = 9;
+
+    // Maximum permitted time between successful worker heartbeats.
+    google.protobuf.Duration heartbeat_timeout = 10;
+
+    // The retry policy for the activity. Will never exceed `schedule_to_close_timeout`.
+    temporal.api.common.v1.RetryPolicy retry_policy = 11;
+
     // Details provided in the last recorded activity heartbeat.
-    temporal.api.common.v1.Payloads heartbeat_details = 6;
+    temporal.api.common.v1.Payloads heartbeat_details = 12;
     // Time the last heartbeat was recorded.
-    google.protobuf.Timestamp last_heartbeat_time = 7;
+    google.protobuf.Timestamp last_heartbeat_time = 13;
     // Time the last attempt was started.
-    google.protobuf.Timestamp last_started_time = 8;
+    google.protobuf.Timestamp last_started_time = 14;
     // The attempt this activity is currently on.
     // Incremented each time a new attempt is started.
     // TODO(dandavison): Confirm if this is on scheduled or started.
-    int32 attempt = 9;
-    int32 maximum_attempts = 10;
+    int32 attempt = 15;
+    int32 maximum_attempts = 16;
     // Time the activity was originally scheduled via a StartActivityExecution request.
-    google.protobuf.Timestamp scheduled_time = 11;
+    google.protobuf.Timestamp scheduled_time = 17;
     // Scheduled time + schedule to close timeout.
-    google.protobuf.Timestamp expiration_time = 12;
+    google.protobuf.Timestamp expiration_time = 18;
+    // Time when the activity transitioned to a closed state.
+    google.protobuf.Timestamp close_time = 19;
+
     // Failure details from the last failed attempt.
-    temporal.api.failure.v1.Failure last_failure = 13;
-    string last_worker_identity = 14;
+    temporal.api.failure.v1.Failure last_failure = 20;
+    string last_worker_identity = 21;
 
     // Time from the last attempt failure to the next activity retry.
     // If the activity is currently running, this represents the next retry interval in case the attempt fails.
     // If activity is currently backing off between attempt, this represents the current retry interval.
     // If there is no next retry allowed, this field will be null.
     // This interval is typically calculated from the specified retry policy, but may be modified if an activity fails
     // with a retryable application failure specifying a retry delay.
-    google.protobuf.Duration current_retry_interval = 15;
+    google.protobuf.Duration current_retry_interval = 22;
 
     // The time when the last activity attempt completed. If activity has not been completed yet, it will be null.
-    google.protobuf.Timestamp last_attempt_complete_time = 16;
+    google.protobuf.Timestamp last_attempt_complete_time = 23;
 
     // The time when the next activity attempt will be scheduled.
     // If activity is currently scheduled or started, this field will be null.
-    google.protobuf.Timestamp next_attempt_schedule_time = 17;
+    google.protobuf.Timestamp next_attempt_schedule_time = 24;
 
     // The Worker Deployment Version this activity was dispatched to most recently.
     // If nil, the activity has not yet been dispatched or was last dispatched to an unversioned worker.
-    temporal.api.deployment.v1.WorkerDeploymentVersion last_deployment_version = 18;
+    temporal.api.deployment.v1.WorkerDeploymentVersion last_deployment_version = 25;
 
     // Priority metadata.
-    temporal.api.common.v1.Priority priority = 19;
+    temporal.api.common.v1.Priority priority = 26;
 
     // Current activity options. May be different from the one used to start the activity.
-    temporal.api.activity.v1.ActivityOptions activity_options = 20;
+    temporal.api.activity.v1.ActivityOptions activity_options = 27;
 
     // Incremented each time the activity's state is mutated in persistence.
-    int64 state_transition_count = 21;
+    int64 state_transition_count = 28;
 
-    temporal.api.common.v1.SearchAttributes search_attributes = 22;
-    temporal.api.common.v1.Header header = 23;
+    temporal.api.common.v1.SearchAttributes search_attributes = 29;
+    temporal.api.common.v1.Header header = 30;
     // Metadata for use by user interfaces to display the fixed as-of-start summary and details of the activity.
-    temporal.api.sdk.v1.UserMetadata user_metadata = 24;
+    temporal.api.sdk.v1.UserMetadata user_metadata = 31;
 
     // Set if activity cancelation was requested.
-    string canceled_reason = 25;
+    string canceled_reason = 32;
 }
 
 // Limited activity information returned in the list response.

temporal/api/workflowservice/v1/request_response.proto

@@ -2844,10 +2844,12 @@ message TerminateActivityExecutionRequest {
     string activity_id = 2;
     // Activity run ID, targets the latest run if run_id is empty.
     string run_id = 3;
-    // Reason for requesting the termination, recorded in in the activity's result failure outcome.
-    string reason = 4;
     // The identity of the worker/client.
-    string identity = 5;
+    string identity = 4;
+    // Used to de-dupe cancellation requests.
+    string request_id = 5;
+    // Reason for requesting the termination, recorded in in the activity's result failure outcome.
+    string reason = 6;
 }
 
 message TerminateActivityExecutionResponse {