Add PropagatedNexusSerializationContext

Author: Quinn-With-Two-Ns

openapi/openapiv2.json

@@ -12335,6 +12335,10 @@
         "startDelay": {
           "type": "string",
           "description": "Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this activity."
         }
       }
     },
@@ -12584,6 +12588,10 @@
         "timeSkippingConfig": {
           "$ref": "#/definitions/v1TimeSkippingConfig",
           "description": "Time-skipping configuration. If not set, time skipping is disabled."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this workflow."
         }
       }
     },
@@ -13104,6 +13112,10 @@
                 "$ref": "#/definitions/apiCommonV1Link"
               },
               "description": "Links to be associated with this update."
+            },
+            "propagatedNexusSerializationContext": {
+              "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+              "description": "Serialization context propagated from the Nexus caller that started this update."
             }
           },
           "description": "The request information that will be delivered all the way down to the\nWorkflow Execution."
@@ -13518,6 +13530,10 @@
           "type": "string",
           "format": "date-time",
           "description": "The time at which the first activity task is made available for dispatch, computed as\n`schedule_time + start_delay`. Same as `schedule_time` if `start_delay` is not set."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this activity."
         }
       },
       "description": "Information about a standalone activity."
@@ -18066,6 +18082,10 @@
         "pollerGroupsInfo": {
           "$ref": "#/definitions/v1PollerGroupsInfo",
           "description": "The weighted, versioned list of poller groups IDs that client should use for future polls to\nthis task queue. Client should ignore this if it has already applied a snapshot with a\nversion greater than or equal to `poller_groups_info.version`. Client is expected to:\n  1. Maintain minimum number of pollers no less than the number of groups.\n  2. Try to assign the next poll to a group without any pending polls,\n  3. If every group has some pending polls, assign the next poll to a group randomly\n    according to the weights."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this workflow."
         }
       }
     },
@@ -18181,6 +18201,22 @@
       },
       "description": "Priority contains metadata that controls relative ordering of task processing\nwhen tasks are backed up in a queue. Initially, Priority will be used in\nmatching (workflow and activity) task queues. Later it may be used in history\ntask queues and in rate limiting decisions.\n\nPriority is attached to workflows and activities. By default, activities\ninherit Priority from the workflow that created them, but may override fields\nwhen an activity is started or modified.\n\nDespite being named \"Priority\", this message also contains fields that\ncontrol \"fairness\" mechanisms.\n\nFor all fields, the field not present or equal to zero/empty string means to\ninherit the value from the calling workflow, or if there is no calling\nworkflow, then use the default value.\n\nFor all fields other than fairness_key, the zero value isn't meaningful so\nthere's no confusion between inherit/default and a meaningful value. For\nfairness_key, the empty string will be interpreted as \"inherit\". This means\nthat if a workflow has a non-empty fairness key, you can't override the\nfairness key of its activity to the empty string.\n\nThe overall semantics of Priority are:\n1. First, consider \"priority\": higher priority (lower number) goes first.\n2. Then, consider fairness: try to dispatch tasks for different fairness keys\n   in proportion to their weight.\n\nApplications may use any subset of mechanisms that are useful to them and\nleave the other fields to use default values.\n\nNot all queues in the system may support the \"full\" semantics of all priority\nfields. (Currently only support in matching task queues is planned.)"
     },
+    "v1PropagatedNexusSerializationContext": {
+      "type": "object",
+      "properties": {
+        "endpoint": {
+          "type": "string"
+        },
+        "service": {
+          "type": "string"
+        },
+        "operation": {
+          "type": "string",
+          "description": "If more context is needed, this message can be extended with additional fields."
+        }
+      },
+      "description": "PropagatedNexusSerializationContext represents the context of the Nexus caller that started this entity.\nIf multiple Nexus callers attempt to attach to the same entity the server will verify that\neach field matches, if any field does not match then the request will be rejected."
+    },
     "v1QueryRejectCondition": {
       "type": "string",
       "enum": [
@@ -18421,6 +18457,10 @@
             "$ref": "#/definitions/v1Link"
           },
           "description": "Links to be associated with this update."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this update."
         }
       },
       "description": "The client request that triggers a Workflow Update."
@@ -21086,6 +21126,10 @@
         "pauseInfo": {
           "$ref": "#/definitions/v1WorkflowExecutionPauseInfo",
           "description": "Information about the workflow execution pause operation."
+        },
+        "propagatedNexusSerializationContext": {
+          "$ref": "#/definitions/v1PropagatedNexusSerializationContext",
+          "description": "Serialization context propagated from the Nexus caller that started this workflow."
         }
       },
       "description": "Holds all the extra information about workflow execution that is not part of Visibility."

openapi/openapiv3.yaml

@@ -9861,6 +9861,10 @@ components:
             The time at which the first activity task is made available for dispatch, computed as
              `schedule_time + start_delay`. Same as `schedule_time` if `start_delay` is not set.
           format: date-time
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this activity.
       description: Information about a standalone activity.
     ActivityExecutionListInfo:
       type: object
@@ -14516,6 +14520,10 @@ components:
                2. Try to assign the next poll to a group without any pending polls,
                3. If every group has some pending polls, assign the next poll to a group randomly
                  according to the weights.
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this workflow.
     PollerGroupInfo:
       type: object
       properties:
@@ -14727,6 +14735,20 @@ components:
 
          Not all queues in the system may support the "full" semantics of all priority
          fields. (Currently only support in matching task queues is planned.)
+    PropagatedNexusSerializationContext:
+      type: object
+      properties:
+        endpoint:
+          type: string
+        service:
+          type: string
+        operation:
+          type: string
+          description: If more context is needed, this message can be extended with additional fields.
+      description: |-
+        PropagatedNexusSerializationContext represents the context of the Nexus caller that started this entity.
+         If multiple Nexus callers attempt to attach to the same entity the server will verify that
+         each field matches, if any field does not match then the request will be rejected.
     QueryRejected:
       type: object
       properties:
@@ -14989,6 +15011,10 @@ components:
           items:
             $ref: '#/components/schemas/Link'
           description: Links to be associated with this update.
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this update.
       description: The client request that triggers a Workflow Update.
     RequestCancelActivityExecutionRequest:
       type: object
@@ -16754,6 +16780,10 @@ components:
           pattern: ^-?(?:0|[1-9][0-9]{0,11})(?:\.[0-9]{1,9})?s$
           type: string
           description: Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this activity.
     StartActivityExecutionResponse:
       type: object
       properties:
@@ -17212,6 +17242,10 @@ components:
           allOf:
             - $ref: '#/components/schemas/TimeSkippingConfig'
           description: Time-skipping configuration. If not set, time skipping is disabled.
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this workflow.
     StartWorkflowExecutionResponse:
       type: object
       properties:
@@ -19635,6 +19669,10 @@ components:
           allOf:
             - $ref: '#/components/schemas/WorkflowExecutionPauseInfo'
           description: Information about the workflow execution pause operation.
+        propagatedNexusSerializationContext:
+          allOf:
+            - $ref: '#/components/schemas/PropagatedNexusSerializationContext'
+          description: Serialization context propagated from the Nexus caller that started this workflow.
       description: Holds all the extra information about workflow execution that is not part of Visibility.
     WorkflowExecutionFailedEventAttributes:
       type: object

temporal/api/activity/v1/message.proto

@@ -191,6 +191,9 @@ message ActivityExecutionInfo {
     // The time at which the first activity task is made available for dispatch, computed as
     // `schedule_time + start_delay`. Same as `schedule_time` if `start_delay` is not set.
     google.protobuf.Timestamp execution_time = 38;
+
+    // Serialization context propagated from the Nexus caller that started this activity.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 39;
 }
 
 // Limited activity information returned in the list response.

temporal/api/common/v1/message.proto

@@ -60,6 +60,16 @@ message Header {
     map<string, Payload> fields = 1;
 }
 
+// PropagatedNexusSerializationContext represents the context of the Nexus caller that started this entity.
+// If multiple Nexus callers attempt to attach to the same entity the server will verify that
+// each field matches, if any field does not match then the request will be rejected.
+message PropagatedNexusSerializationContext {
+    string endpoint = 1;
+    string service = 2;
+    // If more context is needed, this message can be extended with additional fields.
+    string operation = 3;
+}
+
 // Identifies a specific workflow within a namespace. Practically speaking, because run_id is a
 // uuid, a workflow execution is globally unique. Note that many commands allow specifying an empty
 // run id as a way of saying "target the latest run of the workflow".

temporal/api/update/v1/message.proto

@@ -68,6 +68,8 @@ message Request {
     repeated temporal.api.common.v1.Callback completion_callbacks = 4;
      // Links to be associated with this update.
     repeated temporal.api.common.v1.Link links = 5;
+    // Serialization context propagated from the Nexus caller that started this update.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 6;
 }
 
 // An Update protocol message indicating that a Workflow Update has been rejected.

temporal/api/workflow/v1/message.proto

@@ -134,6 +134,9 @@ message WorkflowExecutionExtendedInfo {
 
     // Information about the workflow execution pause operation.
     WorkflowExecutionPauseInfo pause_info = 8;
+
+    // Serialization context propagated from the Nexus caller that started this workflow.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 9;
 }
 
 // Holds all the information about worker versioning for a particular workflow execution.

temporal/api/workflowservice/v1/request_response.proto

@@ -217,6 +217,8 @@ message StartWorkflowExecutionRequest {
 
     // Time-skipping configuration. If not set, time skipping is disabled.
     temporal.api.common.v1.TimeSkippingConfig time_skipping_config = 29;
+    // Serialization context propagated from the Nexus caller that started this workflow.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 30;
 }
 
 message StartWorkflowExecutionResponse {
@@ -382,6 +384,8 @@ message PollWorkflowTaskQueueResponse {
     //   3. If every group has some pending polls, assign the next poll to a group randomly
     //     according to the weights.
     temporal.api.taskqueue.v1.PollerGroupsInfo poller_groups_info = 19;
+    // Serialization context propagated from the Nexus caller that started this workflow.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 20;
 }
 
 message RespondWorkflowTaskCompletedRequest {
@@ -610,6 +614,8 @@ message PollActivityTaskQueueResponse {
     //   3. If every group has some pending polls, assign the next poll to a group randomly
     //     according to the weights.
     temporal.api.taskqueue.v1.PollerGroupsInfo poller_groups_info = 22;
+    // Serialization context propagated from the Nexus caller that started this activity.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 23;
 }
 
 message RecordActivityTaskHeartbeatRequest {
@@ -3246,6 +3252,8 @@ message StartActivityExecutionRequest {
     temporal.api.common.v1.OnConflictOptions on_conflict_options = 21;
     // Time to wait before making the first activity task available for dispatch. This delay is not applied to retry attempts.
     google.protobuf.Duration start_delay = 22;
+    // Serialization context propagated from the Nexus caller that started this activity.
+    temporal.api.common.v1.PropagatedNexusSerializationContext propagated_nexus_serialization_context = 23;
 }
 
 message StartActivityExecutionResponse {