Add OnConflictOptions to StartWorkflowExecutionRequest (#510)

_**READ BEFORE MERGING:** All PRs require approval by both Server AND
SDK teams before merging! This is why the number of required approvals
is "2" and not "1"--two reviewers from the same team is NOT sufficient.
If your PR is not approved by someone in BOTH teams, it may be summarily
reverted._

<!-- Describe what has changed in this PR -->
**What changed?**
Add `OnConflictOptions` to `StartWorkflowExecutionRequest`

<!-- Tell your future self why have you made these changes -->
**Why?**
When the workflow id conflict policy is `USE_EXISTING`,
`OnConflictOptions` add the ability to change the existing running
workflow.

<!-- Are there any breaking changes on binary or code level? -->
**Breaking changes**


<!-- If this breaks the Server, please provide the Server PR to merge
right after this PR was merged. -->
**Server PR**
temporalio/temporal#7080

Author: rodrigozhou

openapi/openapiv2.json

@@ -6533,6 +6533,10 @@
         "versioningOverride": {
           "$ref": "#/definitions/v1VersioningOverride",
           "description": "If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.\nTo unset the override after the workflow is running, use UpdateWorkflowExecutionOptions."
+        },
+        "onConflictOptions": {
+          "$ref": "#/definitions/v1OnConflictOptions",
+          "description": "Defines actions to be done to the existing running workflow when the conflict policy\nWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a\nempty object (ie., all options with default value), it won't do anything to the existing\nrunning workflow. If set, it will add a history event to the running workflow."
         }
       }
     },
@@ -9986,6 +9990,24 @@
       },
       "description": "Nexus operation timed out."
     },
+    "v1OnConflictOptions": {
+      "type": "object",
+      "properties": {
+        "attachRequestId": {
+          "type": "boolean",
+          "description": "Attaches the request ID to the running workflow."
+        },
+        "attachCompletionCallbacks": {
+          "type": "boolean",
+          "description": "Attaches the completion callbacks to the running workflow."
+        },
+        "attachLinks": {
+          "type": "boolean",
+          "description": "Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event."
+        }
+      },
+      "description": "When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and\nthere is already an existing running workflow, OnConflictOptions defines actions to be taken on\nthe existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent\nhistory event in the running workflow with the changes requested in this object."
+    },
     "v1Outcome": {
       "type": "object",
       "properties": {
@@ -12019,6 +12041,10 @@
         "versioningOverride": {
           "$ref": "#/definitions/v1VersioningOverride",
           "description": "If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.\nTo unset the override after the workflow is running, use UpdateWorkflowExecutionOptions."
+        },
+        "onConflictOptions": {
+          "$ref": "#/definitions/v1OnConflictOptions",
+          "description": "Defines actions to be done to the existing running workflow when the conflict policy\nWORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a\nempty object (ie., all options with default value), it won't do anything to the existing\nrunning workflow. If set, it will add a history event to the running workflow."
         }
       }
     },
@@ -13093,6 +13119,18 @@
         "unsetVersioningOverride": {
           "type": "boolean",
           "description": "Versioning override removed in this event."
+        },
+        "attachedRequestId": {
+          "type": "string",
+          "description": "Request ID attachedto the running workflow execution so that subsequent requests with same\nrequest ID will be deduped."
+        },
+        "attachedCompletionCallbacks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/v1Callback"
+          },
+          "description": "Completion callbacks attached to the running workflow execution."
         }
       }
     },

openapi/openapiv3.yaml

@@ -7474,6 +7474,23 @@ components:
           type: string
           description: The request ID allocated at schedule time.
       description: Nexus operation timed out.
+    OnConflictOptions:
+      type: object
+      properties:
+        attachRequestId:
+          type: boolean
+          description: Attaches the request ID to the running workflow.
+        attachCompletionCallbacks:
+          type: boolean
+          description: Attaches the completion callbacks to the running workflow.
+        attachLinks:
+          type: boolean
+          description: Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
+      description: |-
+        When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and
+         there is already an existing running workflow, OnConflictOptions defines actions to be taken on
+         the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
+         history event in the running workflow with the changes requested in this object.
     Outcome:
       type: object
       properties:
@@ -9411,6 +9428,14 @@ components:
           description: |-
             If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
              To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
+        onConflictOptions:
+          allOf:
+            - $ref: '#/components/schemas/OnConflictOptions'
+          description: |-
+            Defines actions to be done to the existing running workflow when the conflict policy
+             WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
+             empty object (ie., all options with default value), it won't do anything to the existing
+             running workflow. If set, it will add a history event to the running workflow.
     StartWorkflowExecutionResponse:
       type: object
       properties:
@@ -10591,6 +10616,16 @@ components:
         unsetVersioningOverride:
           type: boolean
           description: Versioning override removed in this event.
+        attachedRequestId:
+          type: string
+          description: |-
+            Request ID attachedto the running workflow execution so that subsequent requests with same
+             request ID will be deduped.
+        attachedCompletionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
+          description: Completion callbacks attached to the running workflow execution.
     WorkflowExecutionSignaledEventAttributes:
       type: object
       properties:

temporal/api/history/v1/message.proto

@@ -746,6 +746,11 @@ message WorkflowExecutionOptionsUpdatedEventAttributes {
     temporal.api.workflow.v1.VersioningOverride versioning_override = 1;
     // Versioning override removed in this event.
     bool unset_versioning_override = 2;
+    // Request ID attachedto the running workflow execution so that subsequent requests with same
+    // request ID will be deduped.
+    string attached_request_id = 3;
+    // Completion callbacks attached to the running workflow execution.
+    repeated temporal.api.common.v1.Callback attached_completion_callbacks = 4;
 }
 
 // Not used anywhere. Use case is replaced by WorkflowExecutionOptionsUpdatedEventAttributes

temporal/api/workflow/v1/message.proto

@@ -440,3 +440,16 @@ message VersioningOverride {
     // Identifies the worker deployment to pin the workflow to.
     temporal.api.deployment.v1.Deployment deployment = 2;
 }
+
+// When StartWorkflowExecution uses the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING and
+// there is already an existing running workflow, OnConflictOptions defines actions to be taken on
+// the existing running workflow. In this case, it will create a WorkflowExecutionOptionsUpdatedEvent
+// history event in the running workflow with the changes requested in this object.
+message OnConflictOptions {
+    // Attaches the request ID to the running workflow.
+    bool attach_request_id = 1;
+    // Attaches the completion callbacks to the running workflow.
+    bool attach_completion_callbacks = 2;
+    // Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event.
+    bool attach_links = 3;
+}

temporal/api/workflowservice/v1/request_response.proto

@@ -206,6 +206,11 @@ message StartWorkflowExecutionRequest {
     // If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion.
     // To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.
     temporal.api.workflow.v1.VersioningOverride versioning_override = 25;
+    // Defines actions to be done to the existing running workflow when the conflict policy
+    // WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a
+    // empty object (ie., all options with default value), it won't do anything to the existing
+    // running workflow. If set, it will add a history event to the running workflow.
+    temporal.api.workflow.v1.OnConflictOptions on_conflict_options = 26;
 }
 
 message StartWorkflowExecutionResponse {