Standalone activity prototype -- ID reuse/conflict policies (#650)

Use execution-specific ID reuse & conflict policies instead of
introducing shared policies for all CHASM executions.

Author: dandavison

openapi/openapiv2.json

@@ -10138,12 +10138,12 @@
           "description": "Serialized arguments to the activity. These are passed as arguments to the activity function."
         },
         "idReusePolicy": {
-          "$ref": "#/definitions/v1IdReusePolicy",
-          "description": "Defines whether to allow re-using the activity id from a previously *closed* activity.\nThe default policy is ID_REUSE_POLICY_ALLOW_DUPLICATE."
+          "$ref": "#/definitions/v1ActivityIdReusePolicy",
+          "description": "Defines whether to allow re-using the activity id from a previously *closed* activity.\nThe default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE."
         },
         "idConflictPolicy": {
-          "$ref": "#/definitions/v1IdConflictPolicy",
-          "description": "Defines how to resolve an activity id conflict with a *running* activity.\nThe default policy is ID_CONFLICT_POLICY_FAIL."
+          "$ref": "#/definitions/v1ActivityIdConflictPolicy",
+          "description": "Defines how to resolve an activity id conflict with a *running* activity.\nThe default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL."
         },
         "memo": {
           "$ref": "#/definitions/v1Memo",
@@ -10183,7 +10183,7 @@
         },
         "onConflictOptions": {
           "$ref": "#/definitions/apiactivityv1OnConflictOptions",
-          "description": "Defines actions to be done to the existing running activity when ID_CONFLICT_POLICY_USE_EXISTING is used. If not\nset or empty, it won't do anything to the existing running activity."
+          "description": "Defines actions to be done to the existing running activity when ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING is used. If not\nset or empty, it won't do anything to the existing running activity."
         },
         "priority": {
           "$ref": "#/definitions/v1Priority",
@@ -10818,7 +10818,7 @@
           "description": "Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event."
         }
       },
-      "description": "When StartActivityExecution uses the ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running\nactivity, OnConflictOptions defines actions to be taken on the existing running activity, updating its state."
+      "description": "When StartActivityExecution uses the ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running\nactivity, OnConflictOptions defines actions to be taken on the existing running activity, updating its state."
     },
     "apicommonv1Link": {
       "type": "object",
@@ -11219,6 +11219,28 @@
         }
       }
     },
+    "v1ActivityIdConflictPolicy": {
+      "type": "string",
+      "enum": [
+        "ACTIVITY_ID_CONFLICT_POLICY_UNSPECIFIED",
+        "ACTIVITY_ID_CONFLICT_POLICY_FAIL",
+        "ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING",
+        "ACTIVITY_ID_CONFLICT_POLICY_TERMINATE_EXISTING"
+      ],
+      "default": "ACTIVITY_ID_CONFLICT_POLICY_UNSPECIFIED",
+      "description": "Defines what to do when trying to start an activity with the same ID as a *running* activity.\nNote that it is *never* valid to have two running instances of the same activity ID.\n\nSee `ActivityIdReusePolicy` for handling activity ID duplication with a *closed* activity.\n\n - ACTIVITY_ID_CONFLICT_POLICY_FAIL: Don't start a new activity; instead return `ActivityExecutionAlreadyStarted` error.\n - ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING: Don't start a new activity; instead return a handle for the running activity.\n - ACTIVITY_ID_CONFLICT_POLICY_TERMINATE_EXISTING: Terminate the running activity before starting a new one."
+    },
+    "v1ActivityIdReusePolicy": {
+      "type": "string",
+      "enum": [
+        "ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED",
+        "ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE",
+        "ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY",
+        "ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE"
+      ],
+      "default": "ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED",
+      "description": "Defines whether to allow re-using an activity ID from a previously *closed* activity.\nIf the request is denied, the server returns an `ActivityExecutionAlreadyStarted` error.\n\nSee `ActivityIdConflictPolicy` for handling ID duplication with a *running* activity.\n\n - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE: Always allow starting an activity using the same activity ID.\n - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: Allow starting an activity using the same ID only when the last activity's final state is one\nof {failed, canceled, terminated, timed out}.\n - ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE: Do not permit re-use of the ID for this activity. Future start requests could potentially change the policy,\nallowing re-use of the ID."
+    },
     "v1ActivityListInfo": {
       "type": "object",
       "properties": {
@@ -13850,28 +13872,6 @@
       ],
       "default": "HISTORY_EVENT_FILTER_TYPE_UNSPECIFIED"
     },
-    "v1IdConflictPolicy": {
-      "type": "string",
-      "enum": [
-        "ID_CONFLICT_POLICY_UNSPECIFIED",
-        "ID_CONFLICT_POLICY_FAIL",
-        "ID_CONFLICT_POLICY_USE_EXISTING",
-        "ID_CONFLICT_POLICY_TERMINATE_EXISTING"
-      ],
-      "default": "ID_CONFLICT_POLICY_UNSPECIFIED",
-      "description": "Defines what to do when trying to start an execution with the same ID as a *running* execution.\nNote that it is *never* valid to have two actively running instances of the same execution ID.\n\nSee `IdReusePolicy` for handling execution ID duplication with a *closed* execution.\n\n - ID_CONFLICT_POLICY_FAIL: Don't start a new execution; instead return `ExecutionAlreadyStarted` error.\n - ID_CONFLICT_POLICY_USE_EXISTING: Don't start a new execution; instead return a handle for the running execution.\n - ID_CONFLICT_POLICY_TERMINATE_EXISTING: Terminate the running execution before starting a new one."
-    },
-    "v1IdReusePolicy": {
-      "type": "string",
-      "enum": [
-        "ID_REUSE_POLICY_UNSPECIFIED",
-        "ID_REUSE_POLICY_ALLOW_DUPLICATE",
-        "ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY",
-        "ID_REUSE_POLICY_REJECT_DUPLICATE"
-      ],
-      "default": "ID_REUSE_POLICY_UNSPECIFIED",
-      "description": "Defines whether to allow re-using an ID from a previously *closed* execution.\nIf the request is denied, the server returns an `ExecutionAlreadyStarted` error.\n\nSee `IdConflictPolicy` for handling ID duplication with a *running* execution.\n\n - ID_REUSE_POLICY_ALLOW_DUPLICATE: Always allow starting an execution using the same entity ID.\n - ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY: Allow starting an execution using the same ID, only when the last execution's final state is one of [terminated,\ncancelled, timed out, failed].\n - ID_REUSE_POLICY_REJECT_DUPLICATE: Do not permit re-use of the ID for this execution. Future start requests could potentially change the policy,\nallowing re-use of the ID."
-    },
     "v1IndexedValueType": {
       "type": "string",
       "enum": [
@@ -16783,7 +16783,7 @@
       "properties": {
         "runId": {
           "type": "string",
-          "description": "The run ID of the activity that was started - or used (via ID_CONFLICT_POLICY_USE_EXISTING)."
+          "description": "The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING)."
         },
         "started": {
           "type": "boolean",

openapi/openapiv3.yaml

@@ -11234,7 +11234,7 @@ components:
           type: boolean
           description: Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
       description: |-
-        When StartActivityExecution uses the ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running
+        When StartActivityExecution uses the ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running
          activity, OnConflictOptions defines actions to be taken on the existing running activity, updating its state.
     Outcome:
       type: object
@@ -13793,25 +13793,25 @@ components:
           description: Serialized arguments to the activity. These are passed as arguments to the activity function.
         idReusePolicy:
           enum:
-            - ID_REUSE_POLICY_UNSPECIFIED
-            - ID_REUSE_POLICY_ALLOW_DUPLICATE
-            - ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY
-            - ID_REUSE_POLICY_REJECT_DUPLICATE
+            - ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED
+            - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE
+            - ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY
+            - ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE
           type: string
           description: |-
             Defines whether to allow re-using the activity id from a previously *closed* activity.
-             The default policy is ID_REUSE_POLICY_ALLOW_DUPLICATE.
+             The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
           format: enum
         idConflictPolicy:
           enum:
-            - ID_CONFLICT_POLICY_UNSPECIFIED
-            - ID_CONFLICT_POLICY_FAIL
-            - ID_CONFLICT_POLICY_USE_EXISTING
-            - ID_CONFLICT_POLICY_TERMINATE_EXISTING
+            - ACTIVITY_ID_CONFLICT_POLICY_UNSPECIFIED
+            - ACTIVITY_ID_CONFLICT_POLICY_FAIL
+            - ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING
+            - ACTIVITY_ID_CONFLICT_POLICY_TERMINATE_EXISTING
           type: string
           description: |-
             Defines how to resolve an activity id conflict with a *running* activity.
-             The default policy is ID_CONFLICT_POLICY_FAIL.
+             The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
           format: enum
         memo:
           allOf:
@@ -13854,7 +13854,7 @@ components:
           allOf:
             - $ref: '#/components/schemas/OnConflictOptions'
           description: |-
-            Defines actions to be done to the existing running activity when ID_CONFLICT_POLICY_USE_EXISTING is used. If not
+            Defines actions to be done to the existing running activity when ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING is used. If not
              set or empty, it won't do anything to the existing running activity.
         priority:
           allOf:
@@ -13865,7 +13865,7 @@ components:
       properties:
         runId:
           type: string
-          description: The run ID of the activity that was started - or used (via ID_CONFLICT_POLICY_USE_EXISTING).
+          description: The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).
         started:
           type: boolean
           description: If true, a new activity was started.

temporal/api/activity/v1/message.proto

@@ -20,7 +20,7 @@ import "temporal/api/failure/v1/message.proto";
 import "temporal/api/taskqueue/v1/message.proto";
 import "temporal/api/sdk/v1/user_metadata.proto";
 
-// When StartActivityExecution uses the ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running
+// When StartActivityExecution uses the ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING and there is already an existing running
 // activity, OnConflictOptions defines actions to be taken on the existing running activity, updating its state.
 message OnConflictOptions {
     // Attaches the request ID to the running workflow.

temporal/api/enums/v1/activity.proto

@@ -38,3 +38,33 @@ enum ActivityExecutionStatus {
     // TODO: Clarify if there are other conditions where the activity can end up in timed out status.
     ACTIVITY_EXECUTION_STATUS_TIMED_OUT = 6;
 }
+
+// Defines whether to allow re-using an activity ID from a previously *closed* activity.
+// If the request is denied, the server returns an `ActivityExecutionAlreadyStarted` error.
+//
+// See `ActivityIdConflictPolicy` for handling ID duplication with a *running* activity.
+enum ActivityIdReusePolicy {
+    ACTIVITY_ID_REUSE_POLICY_UNSPECIFIED = 0;
+    // Always allow starting an activity using the same activity ID.
+    ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE = 1;
+    // Allow starting an activity using the same ID only when the last activity's final state is one
+    // of {failed, canceled, terminated, timed out}.
+    ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE_FAILED_ONLY = 2;
+    // Do not permit re-use of the ID for this activity. Future start requests could potentially change the policy,
+    // allowing re-use of the ID.
+    ACTIVITY_ID_REUSE_POLICY_REJECT_DUPLICATE = 3;
+}
+
+// Defines what to do when trying to start an activity with the same ID as a *running* activity.
+// Note that it is *never* valid to have two running instances of the same activity ID.
+//
+// See `ActivityIdReusePolicy` for handling activity ID duplication with a *closed* activity.
+enum ActivityIdConflictPolicy {
+    ACTIVITY_ID_CONFLICT_POLICY_UNSPECIFIED = 0;
+    // Don't start a new activity; instead return `ActivityExecutionAlreadyStarted` error.
+    ACTIVITY_ID_CONFLICT_POLICY_FAIL = 1;
+    // Don't start a new activity; instead return a handle for the running activity.
+    ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING = 2;
+    // Terminate the running activity before starting a new one.
+    ACTIVITY_ID_CONFLICT_POLICY_TERMINATE_EXISTING = 3;
+}

temporal/api/enums/v1/id.proto

@@ -19,7 +19,7 @@ import "temporal/api/enums/v1/reset.proto";
 import "temporal/api/enums/v1/task_queue.proto";
 import "temporal/api/enums/v1/deployment.proto";
 import "temporal/api/enums/v1/update.proto";
-import "temporal/api/enums/v1/id.proto";
+import "temporal/api/enums/v1/activity.proto";
 import "temporal/api/activity/v1/message.proto";
 import "temporal/api/common/v1/message.proto";
 import "temporal/api/history/v1/message.proto";
@@ -2624,11 +2624,11 @@ message StartActivityExecutionRequest {
     temporal.api.common.v1.Payloads input = 7;
 
     // Defines whether to allow re-using the activity id from a previously *closed* activity.
-    // The default policy is ID_REUSE_POLICY_ALLOW_DUPLICATE.
-    temporal.api.enums.v1.IdReusePolicy id_reuse_policy = 8;
+    // The default policy is ACTIVITY_ID_REUSE_POLICY_ALLOW_DUPLICATE.
+    temporal.api.enums.v1.ActivityIdReusePolicy id_reuse_policy = 8;
     // Defines how to resolve an activity id conflict with a *running* activity.
-    // The default policy is ID_CONFLICT_POLICY_FAIL.
-    temporal.api.enums.v1.IdConflictPolicy id_conflict_policy = 9;
+    // The default policy is ACTIVITY_ID_CONFLICT_POLICY_FAIL.
+    temporal.api.enums.v1.ActivityIdConflictPolicy id_conflict_policy = 9;
 
     // Arbitrary structured data that can be attached to the activity execution and made available via the list and
     // describe APIs.
@@ -2649,15 +2649,15 @@ message StartActivityExecutionRequest {
     temporal.api.sdk.v1.UserMetadata user_metadata = 15;
     // Links to be associated with the activity.
     repeated temporal.api.common.v1.Link links = 16;
-    // Defines actions to be done to the existing running activity when ID_CONFLICT_POLICY_USE_EXISTING is used. If not
+    // Defines actions to be done to the existing running activity when ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING is used. If not
     // set or empty, it won't do anything to the existing running activity.
     temporal.api.activity.v1.OnConflictOptions on_conflict_options = 17;
     // Priority metadata
     temporal.api.common.v1.Priority priority = 18;
 }
 
 message StartActivityExecutionResponse {
-    // The run ID of the activity that was started - or used (via ID_CONFLICT_POLICY_USE_EXISTING).
+    // The run ID of the activity that was started - or used (via ACTIVITY_ID_CONFLICT_POLICY_USE_EXISTING).
     string run_id = 1;
     // If true, a new activity was started.
     bool started = 2;