Update callback support -- rebased to master + squashed

Squashed commits:
- Add links to request
- Add back link on UpdateWorkflowExecutionResponse
- Add update trigger
- Add WorkflowUpdateOptionsUpdate to WorkflowExecutionOptionsUpdatedEventAttributes
- Add request ID
- Add new link type
- Respond to PR comments

Author: Quinn-With-Two-Ns

openapi/openapiv2.json

@@ -9765,6 +9765,15 @@
       "type": "object",
       "description": "Trigger for when the activity is closed."
     },
+    "CallbackInfoUpdateWorkflowExecutionCompleted": {
+      "type": "object",
+      "properties": {
+        "updateId": {
+          "type": "string"
+        }
+      },
+      "description": "Trigger for when a workflow update is completed."
+    },
     "CallbackInfoWorkflowClosed": {
       "type": "object",
       "description": "Trigger for when the workflow is closed."
@@ -9911,6 +9920,24 @@
       },
       "description": "A link to a standalone Nexus operation."
     },
+    "LinkWorkflow": {
+      "type": "object",
+      "properties": {
+        "namespace": {
+          "type": "string"
+        },
+        "workflowId": {
+          "type": "string"
+        },
+        "runId": {
+          "type": "string"
+        },
+        "reason": {
+          "$ref": "#/definitions/v1LinkReason"
+        }
+      },
+      "description": "A link to a workflow execution. This is a more general version of WorkflowEvent that doesn't specify a \nparticular event within the workflow, useful when you want to link to a workflow but there is no particular event to link to,\nsuch as a Query or a Rejected Update."
+    },
     "LinkWorkflowEvent": {
       "type": "object",
       "properties": {
@@ -10248,6 +10275,27 @@
       },
       "description": "RequestIdReference is a indirect reference to a history event through the request ID."
     },
+    "WorkflowExecutionOptionsUpdatedEventAttributesWorkflowUpdateOptionsUpdate": {
+      "type": "object",
+      "properties": {
+        "updateId": {
+          "type": "string",
+          "description": "The ID of the workflow update this update options update corresponds to."
+        },
+        "attachedRequestId": {
+          "type": "string",
+          "title": "Request ID attached to the running workflow update 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 update."
+        }
+      }
+    },
     "WorkflowRuleActionActionActivityPause": {
       "type": "object"
     },
@@ -11897,6 +11945,26 @@
                   "description": "The arguments to pass to the named Update handler."
                 }
               }
+            },
+            "requestId": {
+              "type": "string",
+              "description": "The request ID of the request."
+            },
+            "completionCallbacks": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "$ref": "#/definitions/v1Callback"
+              },
+              "description": "Callbacks to be called by the server when this update reaches a terminal state."
+            },
+            "links": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "$ref": "#/definitions/apiCommonV1Link"
+              },
+              "description": "Links to be associated with this update."
             }
           },
           "description": "The request information that will be delivered all the way down to the\nWorkflow Execution."
@@ -12092,6 +12160,9 @@
       "properties": {
         "workflowClosed": {
           "$ref": "#/definitions/CallbackInfoWorkflowClosed"
+        },
+        "updateWorkflowExecutionCompleted": {
+          "$ref": "#/definitions/CallbackInfoUpdateWorkflowExecutionCompleted"
         }
       }
     },
@@ -15032,10 +15103,23 @@
         },
         "nexusOperation": {
           "$ref": "#/definitions/LinkNexusOperation"
+        },
+        "workflow": {
+          "$ref": "#/definitions/LinkWorkflow"
         }
       },
       "description": "Link can be associated with history events. It might contain information about an external entity\nrelated to the history event. For example, workflow A makes a Nexus call that starts workflow B:\nin this case, a history event in workflow A could contain a Link to the workflow started event in\nworkflow B, and vice-versa."
     },
+    "v1LinkReason": {
+      "type": "string",
+      "enum": [
+        "LINK_REASON_UNSPECIFIED",
+        "LINK_REASON_QUERY",
+        "LINK_REASON_UPDATE_REJECTED"
+      ],
+      "default": "LINK_REASON_UNSPECIFIED",
+      "description": "LinkReason is the reason for linking to a workflow execution."
+    },
     "v1ListActivityExecutionsResponse": {
       "type": "object",
       "properties": {
@@ -15494,6 +15578,10 @@
         "workerCommands": {
           "type": "boolean",
           "description": "True if the namespace supports worker commands (server-to-worker communication via control queues)."
+        },
+        "workflowUpdateCallbacks": {
+          "type": "boolean",
+          "title": "True if the namespace supports attaching callbacks on workflow updates"
         }
       },
       "description": "Namespace capability details. Should contain what features are enabled in a namespace."
@@ -16941,6 +17029,26 @@
         },
         "input": {
           "$ref": "#/definitions/v1Input"
+        },
+        "requestId": {
+          "type": "string",
+          "description": "The request ID of the request."
+        },
+        "completionCallbacks": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/v1Callback"
+          },
+          "description": "Callbacks to be called by the server when this update reaches a terminal state."
+        },
+        "links": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/v1Link"
+          },
+          "description": "Links to be associated with this update."
         }
       },
       "description": "The client request that triggers a Workflow Update."
@@ -18690,6 +18798,10 @@
         "stage": {
           "$ref": "#/definitions/v1UpdateWorkflowExecutionLifecycleStage",
           "description": "The most advanced lifecycle stage that the Update is known to have\nreached, where lifecycle stages are ordered\nUPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED <\nUPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED <\nUPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED <\nUPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED.\nUNSPECIFIED will be returned if and only if the server's maximum wait\ntime was reached before the Update reached the stage specified in the\nrequest WaitPolicy, and before the context deadline expired; clients may\nmay then retry the call as needed."
+        },
+        "link": {
+          "$ref": "#/definitions/v1Link",
+          "description": "Link to the update event. May be null if the update has not yet been accepted."
         }
       }
     },
@@ -19712,6 +19824,14 @@
         "timeSkippingConfig": {
           "$ref": "#/definitions/v1TimeSkippingConfig",
           "description": "If set, the time-skipping configuration was changed. Contains the full updated configuration."
+        },
+        "workflowUpdateOptions": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "$ref": "#/definitions/WorkflowExecutionOptionsUpdatedEventAttributesWorkflowUpdateOptionsUpdate"
+          },
+          "description": "Updates to workflow updates options."
         }
       }
     },

openapi/openapiv3.yaml

@@ -11663,6 +11663,8 @@ components:
           $ref: '#/components/schemas/Link_Activity'
         nexusOperation:
           $ref: '#/components/schemas/Link_NexusOperation'
+        workflow:
+          $ref: '#/components/schemas/Link_Workflow'
       description: |-
         Link can be associated with history events. It might contain information about an external entity
          related to the history event. For example, workflow A makes a Nexus call that starts workflow B:
@@ -11697,6 +11699,23 @@ components:
         runId:
           type: string
       description: A link to a standalone Nexus operation.
+    Link_Workflow:
+      type: object
+      properties:
+        namespace:
+          type: string
+        workflowId:
+          type: string
+        runId:
+          type: string
+        reason:
+          enum:
+            - LINK_REASON_UNSPECIFIED
+            - LINK_REASON_QUERY
+            - LINK_REASON_UPDATE_REJECTED
+          type: string
+          format: enum
+      description: "A link to a workflow execution. This is a more general version of WorkflowEvent that doesn't specify a \n particular event within the workflow, useful when you want to link to a workflow but there is no particular event to link to,\n such as a Query or a Rejected Update."
     Link_WorkflowEvent:
       type: object
       properties:
@@ -12098,6 +12117,9 @@ components:
         workerCommands:
           type: boolean
           description: True if the namespace supports worker commands (server-to-worker communication via control queues).
+        workflowUpdateCallbacks:
+          type: boolean
+          description: True if the namespace supports attaching callbacks on workflow updates
       description: Namespace capability details. Should contain what features are enabled in a namespace.
     NamespaceInfo_Limits:
       type: object
@@ -13692,6 +13714,19 @@ components:
           $ref: '#/components/schemas/Meta'
         input:
           $ref: '#/components/schemas/Input'
+        requestId:
+          type: string
+          description: The request ID of the request.
+        completionCallbacks:
+          type: array
+          items:
+            $ref: '#/components/schemas/Callback'
+          description: Callbacks to be called by the server when this update reaches a terminal state.
+        links:
+          type: array
+          items:
+            $ref: '#/components/schemas/Link'
+          description: Links to be associated with this update.
       description: The client request that triggers a Workflow Update.
     RequestCancelActivityExecutionRequest:
       type: object
@@ -16928,6 +16963,10 @@ components:
              request WaitPolicy, and before the context deadline expired; clients may
              may then retry the call as needed.
           format: enum
+        link:
+          allOf:
+            - $ref: '#/components/schemas/Link'
+          description: Link to the update event. May be null if the update has not yet been accepted.
     UpsertWorkflowSearchAttributesEventAttributes:
       type: object
       properties:
@@ -18272,6 +18311,27 @@ components:
           allOf:
             - $ref: '#/components/schemas/TimeSkippingConfig'
           description: If set, the time-skipping configuration was changed. Contains the full updated configuration.
+        workflowUpdateOptions:
+          type: array
+          items:
+            $ref: '#/components/schemas/WorkflowExecutionOptionsUpdatedEventAttributes_WorkflowUpdateOptionsUpdate'
+          description: Updates to workflow updates options.
+    WorkflowExecutionOptionsUpdatedEventAttributes_WorkflowUpdateOptionsUpdate:
+      type: object
+      properties:
+        updateId:
+          type: string
+          description: The ID of the workflow update this update options update corresponds to.
+        attachedRequestId:
+          type: string
+          description: |-
+            Request ID attached to the running workflow update 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 update.
     WorkflowExecutionPauseInfo:
       type: object
       properties:

temporal/api/common/v1/message.proto

@@ -15,6 +15,7 @@ import "google/protobuf/empty.proto";
 import "temporal/api/enums/v1/common.proto";
 import "temporal/api/enums/v1/event_type.proto";
 import "temporal/api/enums/v1/reset.proto";
+import "temporal/api/enums/v1/link.proto";
 
 message DataBlob {
     temporal.api.enums.v1.EncodingType encoding_type = 1;
@@ -254,11 +255,22 @@ message Link {
         string run_id = 3;
     }
 
+    // A link to a workflow execution. This is a more general version of WorkflowEvent that doesn't specify a 
+    // particular event within the workflow, useful when you want to link to a workflow but there is no particular event to link to,
+    // such as a Query or a Rejected Update.
+    message Workflow {
+        string namespace = 1;
+        string workflow_id = 2;
+        string run_id = 3;
+        temporal.api.enums.v1.LinkReason reason = 4;
+    }
+
     oneof variant {
         WorkflowEvent workflow_event = 1;
         BatchJob batch_job = 2;
         Activity activity = 3;
         NexusOperation nexus_operation = 4;
+        Workflow workflow = 5;
     }
 }
 

temporal/api/enums/v1/link.proto

@@ -0,0 +1,17 @@
+syntax = "proto3";
+
+package temporal.api.enums.v1;
+
+option go_package = "go.temporal.io/api/enums/v1;enums";
+option java_package = "io.temporal.api.enums.v1";
+option java_multiple_files = true;
+option java_outer_classname = "LinkProto";
+option ruby_package = "Temporalio::Api::Enums::V1";
+option csharp_namespace = "Temporalio.Api.Enums.V1";
+
+// LinkReason is the reason for linking to a workflow execution.
+enum LinkReason {
+    LINK_REASON_UNSPECIFIED = 0;
+    LINK_REASON_QUERY = 1;
+    LINK_REASON_UPDATE_REJECTED = 2;
+}

temporal/api/history/v1/message.proto

@@ -881,6 +881,15 @@ message ChildWorkflowExecutionTerminatedEventAttributes {
 }
 
 message WorkflowExecutionOptionsUpdatedEventAttributes {
+    message WorkflowUpdateOptionsUpdate {
+        // The ID of the workflow update this update options update corresponds to.
+        string update_id = 1;
+        // Request ID attached to the running workflow update so that subsequent requests with same
+        // request ID will be deduped
+        string attached_request_id = 2;
+        // Completion callbacks attached to the running workflow update.
+        repeated temporal.api.common.v1.Callback attached_completion_callbacks = 3;
+    }
     // Versioning override upserted in this event.
     // Ignored if nil or if unset_versioning_override is true.
     temporal.api.workflow.v1.VersioningOverride versioning_override = 1;
@@ -898,6 +907,8 @@ message WorkflowExecutionOptionsUpdatedEventAttributes {
     temporal.api.common.v1.Priority priority = 6;
     // If set, the time-skipping configuration was changed. Contains the full updated configuration.
     temporal.api.workflow.v1.TimeSkippingConfig time_skipping_config = 7;
+    // Updates to workflow updates options.
+    repeated WorkflowUpdateOptionsUpdate workflow_update_options = 8;
 }
 
 // Not used anywhere. Use case is replaced by WorkflowExecutionOptionsUpdatedEventAttributes

temporal/api/namespace/v1/message.proto

@@ -52,6 +52,8 @@ message NamespaceInfo {
         bool poller_autoscaling = 9;
         // True if the namespace supports worker commands (server-to-worker communication via control queues).
         bool worker_commands = 10;
+        // True if the namespace supports attaching callbacks on workflow updates
+        bool workflow_update_callbacks = 11;
     }
 
     // Namespace configured limits

temporal/api/update/v1/message.proto

@@ -62,6 +62,12 @@ message Input {
 message Request {
     Meta meta = 1;
     Input input = 2;
+    // The request ID of the request.
+    string request_id = 3;
+    // Callbacks to be called by the server when this update reaches a terminal state.
+    repeated temporal.api.common.v1.Callback completion_callbacks = 4;
+     // Links to be associated with this update.
+    repeated temporal.api.common.v1.Link links = 5;
 }
 
 // An Update protocol message indicating that a Workflow Update has been rejected.