@fluidgrids/workflows 2026.1028.2 → 2026.1030.1

package/schema/history-file.schema.json

@@ -37,7 +37,7 @@
     },
     "replay": {
       "type": "boolean",
-      "description": "False for histories that use Phase C features (updates); they are parsed and projected but not replayed."
+      "description": "False for histories that are parsed and projected but not replayed (written by hand for a feature the recording runtime did not have)."
     },
     "info": {
       "$ref": "#/$defs/info"
@@ -205,6 +205,7 @@
             "workflowKey",
             "workflowId"
           ],
+          "description": "The open run of a workflow id, following its continue-as-new chain; firstRunId pins the chain (R2).",
           "properties": {
             "workflowKey": {
               "type": "string",
@@ -215,12 +216,82 @@
               "type": "string",
               "minLength": 1,
               "maxLength": 256
+            },
+            "firstRunId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
             }
           },
           "additionalProperties": false
         }
       ]
     },
+    "runRetryPolicy": {
+      "type": "object",
+      "required": [
+        "initialDelayMs"
+      ],
+      "description": "Run-level retry (11 §2.17), in milliseconds. maxAttempts counts every attempt; absent means unlimited, bounded by the execution timeout.",
+      "properties": {
+        "maxAttempts": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "initialDelayMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "backoffMultiplier": {
+          "type": "number",
+          "minimum": 1
+        },
+        "maxDelayMs": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "enum": [
+              "TIMEOUT",
+              "TRANSIENT",
+              "DEPENDENCY",
+              "AUTHORIZATION",
+              "VALIDATION",
+              "PERMANENT",
+              "UNKNOWN"
+            ]
+          }
+        },
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "timeouts": {
+      "type": "object",
+      "description": "The three workflow timeouts (11 §2.20), in milliseconds.",
+      "properties": {
+        "executionTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "runTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "workflowTaskTimeout": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
     "childOptions": {
       "type": "object",
       "required": [
@@ -282,14 +353,119 @@
         "startDelay": {
           "type": "integer",
           "minimum": 0
+        },
+        "retry": {
+          "$ref": "#/$defs/runRetryPolicy"
+        },
+        "versioningBehavior": {
+          "enum": [
+            "PINNED",
+            "AUTO_UPGRADE"
+          ]
+        },
+        "idReusePolicy": {
+          "enum": [
+            "ALLOW_DUPLICATE",
+            "ALLOW_DUPLICATE_FAILED_ONLY",
+            "REJECT_DUPLICATE"
+          ]
+        },
+        "idConflictPolicy": {
+          "enum": [
+            "FAIL",
+            "USE_EXISTING",
+            "TERMINATE_EXISTING"
+          ]
+        },
+        "fairnessKey": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+        },
+        "fairnessWeight": {
+          "type": "number",
+          "minimum": 0.1,
+          "maximum": 10,
+          "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
         }
       }
     },
+    "legacyCanRetryPolicy": {
+      "type": "object",
+      "required": [
+        "retryDelay"
+      ],
+      "description": "The R1 activity-shaped CONTINUE_AS_NEW retry: whatever explicitRetryPolicy wrote from a Partial<RetryPolicy>, so numbers carry no integer or minimum constraint. It never had a meaning, and the service ignores it.",
+      "properties": {
+        "maxRetries": {
+          "type": "number"
+        },
+        "retryDelay": {
+          "type": "number"
+        },
+        "backoffMultiplier": {
+          "type": "number"
+        },
+        "maxDelay": {
+          "type": "number"
+        },
+        "retryOnErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "nonRetryableErrorTypes": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "canOptions": {
+      "type": "object",
+      "description": "Options of a CONTINUE_AS_NEW command (C-SCHEMA, frozen in R2). retry is the R2 run-retry policy of the new run, or the R1 activity shape (retryDelay, maxRetries, maxDelay) that R1 bundles wrote and R2 bundles still write for that shape: it never had a meaning, and the service ignores it instead of reading it as a run-retry policy.",
+      "properties": {
+        "taskQueue": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "retry": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/runRetryPolicy"
+            },
+            {
+              "$ref": "#/$defs/legacyCanRetryPolicy"
+            }
+          ]
+        },
+        "workflowTaskTimeout": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "context": {
+          "type": "object"
+        },
+        "versioningBehavior": {
+          "enum": [
+            "PINNED",
+            "AUTO_UPGRADE"
+          ]
+        }
+      },
+      "additionalProperties": false
+    },
     "headers": {
       "type": "object",
       "additionalProperties": {
         "type": "string"
-      }
+      },
+      "description": "Interceptor headers (11 §2.10): string values; a user activity carries at most 16 KiB of JSON (checked by validateCommands)."
     },
     "payload_WORKFLOW_STARTED": {
       "type": "object",
@@ -391,6 +567,54 @@
           "type": "string",
           "minLength": 1,
           "maxLength": 256
+        },
+        "startDelayMs": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "R2: the start delay of a delayed run (11 §2.23); the first task waits for it."
+        },
+        "runAttempt": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "R2: the run-level retry attempt (11 §2.17), 1-based."
+        },
+        "businessId": {
+          "type": "string",
+          "description": "R2: the workflow id (11 §2.1), stored as WorkflowRun.businessId."
+        },
+        "workflowId": {
+          "type": "string",
+          "description": "R2: the same value as businessId."
+        },
+        "timeouts": {
+          "$ref": "#/$defs/timeouts"
+        },
+        "retry": {
+          "$ref": "#/$defs/runRetryPolicy"
+        },
+        "priority": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 5
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
+        },
+        "searchAttributes": {
+          "type": "object",
+          "description": "Phase C: the search attributes the start set (11 §2.8)."
+        },
+        "fairnessKey": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+        },
+        "fairnessWeight": {
+          "type": "number",
+          "minimum": 0.1,
+          "maximum": 10,
+          "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
         }
       }
     },
@@ -441,6 +665,9 @@
           "type": "integer",
           "minimum": 1,
           "description": "The history length the attempt was leased with (run.taskStartedSeq), when it is not this event's own seq. Required on the WORKFLOW_TASK_STARTED of a transient attempt: input events with a higher seq that precede this event arrived during the attempt and belong to the next activation."
+        },
+        "version": {
+          "description": "R2: the workflow version whose bundle served the task (it differs from WORKFLOW_STARTED.version after an AUTO_UPGRADE or a versioning override)."
         }
       }
     },
@@ -525,85 +752,193 @@
       }
     },
     "payload_ACTIVITY_SCHEDULED": {
-      "type": "object",
-      "required": [
-        "activityId",
-        "kind",
-        "nodeType",
-        "operation",
-        "args",
-        "retry"
-      ],
-      "properties": {
-        "headers": {
-          "$ref": "#/$defs/headers"
-        },
-        "activityId": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
-        },
-        "kind": {
-          "const": "node"
-        },
-        "nodeType": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
-        },
-        "nodeVersion": {
-          "type": "string"
-        },
-        "operation": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
-        },
-        "args": {},
-        "connection": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 256
-        },
-        "retry": {
-          "$ref": "#/$defs/retryPolicy"
-        },
-        "startToCloseTimeout": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "scheduleToCloseTimeout": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "scheduleToStartTimeout": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "heartbeatTimeout": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "cancellationType": {
-          "enum": [
-            "WAIT_CANCELLATION_COMPLETED",
-            "TRY_CANCEL",
-            "ABANDON"
-          ]
-        },
-        "priority": {
-          "type": "integer",
-          "minimum": 1,
-          "maximum": 5
-        },
-        "summary": {
-          "type": "string",
-          "maxLength": 200
+      "description": "The SCHEDULE_ACTIVITY command as the service accepted it: kind node, or kind user (Phase C) with activityName, taskQueue, fairness, connections and headers.",
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "activityId",
+            "kind",
+            "nodeType",
+            "operation",
+            "args",
+            "retry"
+          ],
+          "properties": {
+            "activityId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "args": {},
+            "retry": {
+              "$ref": "#/$defs/retryPolicy"
+            },
+            "startToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToStartTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "heartbeatTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "cancellationType": {
+              "enum": [
+                "WAIT_CANCELLATION_COMPLETED",
+                "TRY_CANCEL",
+                "ABANDON"
+              ]
+            },
+            "priority": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 5
+            },
+            "summary": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "fairnessKey": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 255,
+              "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+            },
+            "fairnessWeight": {
+              "type": "number",
+              "minimum": 0.1,
+              "maximum": 10,
+              "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
+            },
+            "kind": {
+              "const": "node"
+            },
+            "nodeType": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "nodeVersion": {
+              "type": "string"
+            },
+            "operation": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "connection": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "runOn": {
+              "type": "string"
+            },
+            "headers": {
+              "$ref": "#/$defs/headers"
+            }
+          }
         },
-        "runOn": {
-          "type": "string"
+        {
+          "type": "object",
+          "required": [
+            "activityId",
+            "kind",
+            "activityName",
+            "taskQueue",
+            "args",
+            "retry"
+          ],
+          "properties": {
+            "activityId": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            },
+            "args": {},
+            "retry": {
+              "$ref": "#/$defs/retryPolicy"
+            },
+            "startToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToCloseTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "scheduleToStartTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "heartbeatTimeout": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "cancellationType": {
+              "enum": [
+                "WAIT_CANCELLATION_COMPLETED",
+                "TRY_CANCEL",
+                "ABANDON"
+              ]
+            },
+            "priority": {
+              "type": "integer",
+              "minimum": 1,
+              "maximum": 5
+            },
+            "summary": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "fairnessKey": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 255,
+              "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+            },
+            "fairnessWeight": {
+              "type": "number",
+              "minimum": 0.1,
+              "maximum": 10,
+              "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
+            },
+            "kind": {
+              "const": "user"
+            },
+            "activityName": {
+              "type": "string",
+              "pattern": "^[A-Za-z_][A-Za-z0-9_.-]{0,127}$"
+            },
+            "taskQueue": {
+              "type": "string",
+              "pattern": "^[a-z0-9][a-z0-9-]{0,62}$"
+            },
+            "connections": {
+              "type": "array",
+              "maxItems": 16,
+              "uniqueItems": true,
+              "items": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 256
+              },
+              "description": "Connection names the worker may resolve for each started attempt (H2: declared by the definition and on the worker token allow-list)."
+            },
+            "headers": {
+              "$ref": "#/$defs/headers"
+            }
+          }
         }
-      }
+      ]
     },
     "payload_ACTIVITY_STARTED": {
       "type": "object",
@@ -865,6 +1200,9 @@
         "actor": {},
         "idempotencyKey": {
           "type": "string"
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
         }
       }
     },
@@ -885,7 +1223,10 @@
           "minLength": 1,
           "maxLength": 256
         },
-        "args": {}
+        "args": {},
+        "headers": {
+          "$ref": "#/$defs/headers"
+        }
       }
     },
     "payload_UPDATE_ACCEPTED": {
@@ -905,7 +1246,10 @@
           "minLength": 1,
           "maxLength": 256
         },
-        "args": {}
+        "args": {},
+        "headers": {
+          "$ref": "#/$defs/headers"
+        }
       }
     },
     "payload_UPDATE_COMPLETED": {
@@ -963,6 +1307,9 @@
             "GRAPH",
             "DURABLE_FN"
           ]
+        },
+        "headers": {
+          "$ref": "#/$defs/headers"
         }
       }
     },
@@ -1217,6 +1564,19 @@
         "attempts": {
           "type": "integer",
           "minimum": 1
+        },
+        "nodeType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "operation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "summary": {
+          "type": "string"
         }
       }
     },
@@ -1239,6 +1599,19 @@
         "attempts": {
           "type": "integer",
           "minimum": 1
+        },
+        "nodeType": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "operation": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "summary": {
+          "type": "string"
         }
       }
     },
@@ -1307,6 +1680,13 @@
         },
         "reason": {
           "type": "string"
+        },
+        "actor": {},
+        "reapplySignals": {
+          "type": "boolean"
+        },
+        "reapplyUpdates": {
+          "type": "boolean"
         }
       }
     },
@@ -1316,7 +1696,44 @@
         "override"
       ],
       "properties": {
-        "override": {}
+        "override": {
+          "description": "The per-run override (11 §2.27): { behavior: PINNED, version } pins the run, { behavior: AUTO_UPGRADE } upgrades it, null removes the override.",
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "object",
+              "required": [
+                "behavior",
+                "version"
+              ],
+              "properties": {
+                "behavior": {
+                  "const": "PINNED"
+                },
+                "version": {}
+              },
+              "additionalProperties": false
+            },
+            {
+              "type": "object",
+              "required": [
+                "behavior"
+              ],
+              "properties": {
+                "behavior": {
+                  "const": "AUTO_UPGRADE"
+                }
+              },
+              "additionalProperties": false
+            }
+          ]
+        },
+        "actor": {},
+        "reason": {
+          "type": "string"
+        }
       }
     },
     "payload_WORKFLOW_COMPLETED": {
@@ -1367,6 +1784,9 @@
             "WORKFLOW_RUN",
             "WORKFLOW_EXECUTION"
           ]
+        },
+        "failure": {
+          "$ref": "#/$defs/failure"
         }
       }
     },
@@ -1379,7 +1799,8 @@
       "properties": {
         "input": {},
         "options": {
-          "type": "object"
+          "type": "object",
+          "description": "The CONTINUE_AS_NEW options as the service recorded them. New commands are checked against canOptions; histories recorded before R2 may hold any object the R1 contract accepted."
         },
         "newRunId": {
           "type": "string"
@@ -2453,10 +2874,17 @@
         "businessId": {
           "type": "string"
         },
+        "workflowId": {
+          "type": "string"
+        },
         "attempt": {
           "type": "integer",
           "minimum": 1
         },
+        "runAttempt": {
+          "type": "integer",
+          "minimum": 1
+        },
         "taskQueue": {
           "type": "string"
         },
@@ -2537,6 +2965,33 @@
         },
         "context": {
           "type": "object"
+        },
+        "memo": {
+          "type": "object"
+        },
+        "versioningBehavior": {
+          "enum": [
+            "PINNED",
+            "AUTO_UPGRADE"
+          ]
+        },
+        "retry": {
+          "$ref": "#/$defs/runRetryPolicy"
+        },
+        "searchAttributes": {
+          "type": "object"
+        },
+        "fairnessKey": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 255,
+          "description": "Phase C: the fairness key of the task (11 §2.11); default the workspace id."
+        },
+        "fairnessWeight": {
+          "type": "number",
+          "minimum": 0.1,
+          "maximum": 10,
+          "description": "Phase C: the weight of the fairness key, 0.1 to 10 (default 1)."
         }
       }
     }