@fluidgrids/workflows 2026.1029.1 → 2026.1030.1

package/schema/bridge-v2.schema.json

@@ -0,0 +1,1062 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://docs.fluidgrids.ai/schemas/bridge-v2.schema.json",
+  "title": "FluidGrids worker bridge, protocol 2",
+  "description": "Frames between a self-hosted worker and wspace-sandbox-svc over /runner-bridge (JSON text frames, Bearer fgr_ token of kind WORKER, ping every 20 s, 65 s idle timeout, 10 MiB frame cap). Close codes: 4001 Unauthorized, 4002 Revoked, 4003 Replaced, 4004 ProtocolError, 4008 IdleTimeout, 4009 ShuttingDown, 4010 QuotaExceeded, 4011 QueueNotAllowed, 4012 FeatureDisabled.",
+  "oneOf": [
+    {
+      "$ref": "#/$defs/workerFrame"
+    },
+    {
+      "$ref": "#/$defs/serviceFrame"
+    }
+  ],
+  "$defs": {
+    "workflowTaskRef": {
+      "type": "object",
+      "required": [
+        "kind",
+        "runId",
+        "taskId",
+        "attempt",
+        "expectedHistoryLength"
+      ],
+      "properties": {
+        "kind": {
+          "const": "workflow"
+        },
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "taskId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "attempt": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "expectedHistoryLength": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "queryTaskRef": {
+      "type": "object",
+      "required": [
+        "kind",
+        "runId",
+        "queryTaskId"
+      ],
+      "properties": {
+        "kind": {
+          "const": "query"
+        },
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "queryTaskId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        }
+      },
+      "additionalProperties": false
+    },
+    "activityTaskRef": {
+      "type": "object",
+      "required": [
+        "kind",
+        "runId",
+        "activityId",
+        "attempt"
+      ],
+      "properties": {
+        "kind": {
+          "const": "activity"
+        },
+        "runId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "activityId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "attempt": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskRef": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/workflowTaskRef"
+        },
+        {
+          "$ref": "#/$defs/queryTaskRef"
+        },
+        {
+          "$ref": "#/$defs/activityTaskRef"
+        }
+      ]
+    },
+    "historyPage": {
+      "type": "object",
+      "required": [
+        "events",
+        "from",
+        "nextAfter",
+        "hasMore"
+      ],
+      "properties": {
+        "events": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        },
+        "from": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "nextAfter": {
+          "oneOf": [
+            {
+              "type": "null"
+            },
+            {
+              "type": "integer",
+              "minimum": 1
+            }
+          ]
+        },
+        "hasMore": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
+    },
+    "queryRequests": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "queryId",
+          "name"
+        ],
+        "properties": {
+          "queryId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "name": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "args": {}
+        },
+        "additionalProperties": false
+      }
+    },
+    "queryResults": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "queryId"
+        ],
+        "properties": {
+          "queryId": {
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 256
+          },
+          "value": {},
+          "error": {
+            "type": "string"
+          },
+          "rejected": {
+            "type": "boolean"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "hello": {
+      "type": "object",
+      "required": [
+        "type",
+        "protocol",
+        "kind",
+        "sdk",
+        "identity",
+        "taskQueues",
+        "buildIds",
+        "workflows",
+        "activities",
+        "slots",
+        "host",
+        "encodings"
+      ],
+      "properties": {
+        "type": {
+          "const": "hello"
+        },
+        "protocol": {
+          "const": 2
+        },
+        "kind": {
+          "const": "worker"
+        },
+        "sdk": {
+          "type": "object",
+          "required": [
+            "language",
+            "version"
+          ],
+          "properties": {
+            "language": {
+              "enum": [
+                "typescript",
+                "python"
+              ]
+            },
+            "version": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 256
+            }
+          },
+          "additionalProperties": false
+        },
+        "identity": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "taskQueues": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "minItems": 1
+        },
+        "buildIds": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "workflows": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "activities": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        },
+        "slots": {
+          "type": "object",
+          "required": [
+            "workflow",
+            "activity",
+            "localActivity"
+          ],
+          "properties": {
+            "workflow": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "activity": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "localActivity": {
+              "type": "integer",
+              "minimum": 0
+            }
+          },
+          "additionalProperties": false
+        },
+        "host": {
+          "type": "object",
+          "properties": {
+            "os": {
+              "type": "string"
+            },
+            "arch": {
+              "type": "string"
+            },
+            "hostname": {
+              "type": "string"
+            },
+            "runtime": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        },
+        "encodings": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "ping": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "ping"
+        },
+        "t": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "pollers": {
+      "type": "object",
+      "required": [
+        "type",
+        "workflow",
+        "activity"
+      ],
+      "properties": {
+        "type": {
+          "const": "pollers"
+        },
+        "workflow": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "activity": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "taskResult": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "commands",
+            "logs",
+            "cachedUpTo"
+          ],
+          "properties": {
+            "type": {
+              "const": "taskResult"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/workflowTaskRef"
+            },
+            "commands": {
+              "type": "array",
+              "items": {
+                "type": "object"
+              }
+            },
+            "logs": {
+              "type": "array",
+              "items": {
+                "type": "object"
+              }
+            },
+            "cachedUpTo": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "queryResults": {
+              "$ref": "#/$defs/queryResults"
+            },
+            "unfinishedHandlers": {
+              "type": "array",
+              "items": {
+                "type": "object"
+              }
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "result"
+          ],
+          "properties": {
+            "type": {
+              "const": "taskResult"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/activityTaskRef"
+            },
+            "result": {}
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "queryResults"
+          ],
+          "properties": {
+            "type": {
+              "const": "taskResult"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/queryTaskRef"
+            },
+            "queryResults": {
+              "$ref": "#/$defs/queryResults"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "taskFailed": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "failure"
+          ],
+          "properties": {
+            "type": {
+              "const": "taskFailed"
+            },
+            "taskRef": {
+              "oneOf": [
+                {
+                  "$ref": "#/$defs/workflowTaskRef"
+                },
+                {
+                  "$ref": "#/$defs/queryTaskRef"
+                }
+              ]
+            },
+            "failure": {
+              "type": "object",
+              "required": [
+                "cause",
+                "message"
+              ],
+              "properties": {
+                "cause": {
+                  "enum": [
+                    "NON_DETERMINISM",
+                    "TASK_TIMEOUT",
+                    "ISOLATE_MEMORY",
+                    "PROTOCOL_MISMATCH",
+                    "BUNDLE_UNAVAILABLE",
+                    "BUNDLE_INTEGRITY",
+                    "WORKFLOW_CODE_ERROR",
+                    "HISTORY_LIMIT",
+                    "UNSUPPORTED_COMMAND",
+                    "INVALID_REQUEST",
+                    "INTERNAL"
+                  ]
+                },
+                "message": {
+                  "type": "string"
+                },
+                "stackTrace": {
+                  "type": "string"
+                },
+                "seq": {
+                  "type": "integer"
+                },
+                "errorType": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "failure"
+          ],
+          "properties": {
+            "type": {
+              "const": "taskFailed"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/activityTaskRef"
+            },
+            "failure": {
+              "type": "object",
+              "required": [
+                "errorType",
+                "message"
+              ],
+              "description": "An activity failure (run-event failure shape)."
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "heartbeat": {
+      "type": "object",
+      "required": [
+        "type",
+        "reqId",
+        "taskRef"
+      ],
+      "properties": {
+        "type": {
+          "const": "heartbeat"
+        },
+        "reqId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "taskRef": {
+          "$ref": "#/$defs/activityTaskRef"
+        },
+        "details": {}
+      },
+      "additionalProperties": false
+    },
+    "workerHeartbeat": {
+      "type": "object",
+      "required": [
+        "type",
+        "slots",
+        "pollers",
+        "tasksInFlight",
+        "cachedRuns"
+      ],
+      "properties": {
+        "type": {
+          "const": "workerHeartbeat"
+        },
+        "slots": {
+          "type": "object",
+          "required": [
+            "workflow",
+            "activity",
+            "localActivity"
+          ],
+          "properties": {
+            "workflow": {
+              "type": "object",
+              "required": [
+                "used",
+                "total"
+              ],
+              "properties": {
+                "used": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "total": {
+                  "type": "integer",
+                  "minimum": 0
+                }
+              },
+              "additionalProperties": false
+            },
+            "activity": {
+              "type": "object",
+              "required": [
+                "used",
+                "total"
+              ],
+              "properties": {
+                "used": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "total": {
+                  "type": "integer",
+                  "minimum": 0
+                }
+              },
+              "additionalProperties": false
+            },
+            "localActivity": {
+              "type": "object",
+              "required": [
+                "used",
+                "total"
+              ],
+              "properties": {
+                "used": {
+                  "type": "integer",
+                  "minimum": 0
+                },
+                "total": {
+                  "type": "integer",
+                  "minimum": 0
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "additionalProperties": false
+        },
+        "pollers": {
+          "type": "object",
+          "required": [
+            "workflow",
+            "activity"
+          ],
+          "properties": {
+            "workflow": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "activity": {
+              "type": "integer",
+              "minimum": 0
+            }
+          },
+          "additionalProperties": false
+        },
+        "tasksInFlight": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "cachedRuns": {
+          "type": "integer",
+          "minimum": 0
+        }
+      },
+      "additionalProperties": false
+    },
+    "req": {
+      "type": "object",
+      "required": [
+        "type",
+        "id",
+        "method",
+        "params"
+      ],
+      "properties": {
+        "type": {
+          "const": "req"
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "method": {
+          "enum": [
+            "history.page",
+            "activity.connection"
+          ]
+        },
+        "params": {
+          "type": "object"
+        }
+      },
+      "additionalProperties": false
+    },
+    "bye": {
+      "type": "object",
+      "required": [
+        "type",
+        "reason"
+      ],
+      "properties": {
+        "type": {
+          "const": "bye"
+        },
+        "reason": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "welcome": {
+      "type": "object",
+      "required": [
+        "type",
+        "protocol",
+        "sessionId",
+        "workerId",
+        "workspaceId",
+        "heartbeatSeconds",
+        "workerHeartbeatSeconds",
+        "maxFrameBytes"
+      ],
+      "properties": {
+        "type": {
+          "const": "welcome"
+        },
+        "protocol": {
+          "const": 2
+        },
+        "sessionId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "workerId": {
+          "type": "string",
+          "pattern": "^worker:.+$"
+        },
+        "workspaceId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "heartbeatSeconds": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "workerHeartbeatSeconds": {
+          "type": "integer",
+          "minimum": 1
+        },
+        "maxFrameBytes": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "task": {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "lease",
+            "request",
+            "history"
+          ],
+          "properties": {
+            "type": {
+              "const": "task"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/workflowTaskRef"
+            },
+            "lease": {
+              "type": "object"
+            },
+            "request": {
+              "type": "object",
+              "required": [
+                "workflowFn",
+                "info",
+                "nowMs"
+              ],
+              "properties": {
+                "workflowFn": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 256
+                },
+                "info": {
+                  "type": "object"
+                },
+                "nowMs": {
+                  "type": "number"
+                },
+                "updates": {
+                  "type": "array",
+                  "items": {
+                    "type": "object"
+                  }
+                },
+                "queries": {
+                  "$ref": "#/$defs/queryRequests"
+                }
+              },
+              "additionalProperties": false
+            },
+            "history": {
+              "$ref": "#/$defs/historyPage"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "request",
+            "history"
+          ],
+          "properties": {
+            "type": {
+              "const": "task"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/queryTaskRef"
+            },
+            "request": {
+              "type": "object",
+              "required": [
+                "workflowFn",
+                "info",
+                "queries"
+              ],
+              "properties": {
+                "workflowFn": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 256
+                },
+                "info": {
+                  "type": "object"
+                },
+                "queries": {
+                  "$ref": "#/$defs/queryRequests"
+                }
+              },
+              "additionalProperties": false
+            },
+            "history": {
+              "$ref": "#/$defs/historyPage"
+            }
+          },
+          "additionalProperties": false
+        },
+        {
+          "type": "object",
+          "required": [
+            "type",
+            "taskRef",
+            "lease"
+          ],
+          "properties": {
+            "type": {
+              "const": "task"
+            },
+            "taskRef": {
+              "$ref": "#/$defs/activityTaskRef"
+            },
+            "lease": {
+              "type": "object"
+            }
+          },
+          "additionalProperties": false
+        }
+      ]
+    },
+    "heartbeatAck": {
+      "type": "object",
+      "required": [
+        "type",
+        "reqId",
+        "cancelRequested",
+        "paused"
+      ],
+      "properties": {
+        "type": {
+          "const": "heartbeatAck"
+        },
+        "reqId": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "cancelRequested": {
+          "type": "boolean"
+        },
+        "paused": {
+          "type": "boolean"
+        },
+        "pauseReason": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "cancel": {
+      "type": "object",
+      "required": [
+        "type",
+        "taskRef",
+        "reason"
+      ],
+      "properties": {
+        "type": {
+          "const": "cancel"
+        },
+        "taskRef": {
+          "$ref": "#/$defs/taskRef"
+        },
+        "reason": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false
+    },
+    "res": {
+      "type": "object",
+      "required": [
+        "type",
+        "id",
+        "ok"
+      ],
+      "properties": {
+        "type": {
+          "const": "res"
+        },
+        "id": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 256
+        },
+        "ok": {
+          "type": "boolean"
+        },
+        "result": {},
+        "error": {
+          "type": "object",
+          "required": [
+            "code",
+            "message"
+          ],
+          "properties": {
+            "code": {
+              "type": "string"
+            },
+            "message": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false,
+      "if": {
+        "properties": {
+          "ok": {
+            "const": false
+          }
+        },
+        "required": [
+          "ok"
+        ]
+      },
+      "then": {
+        "required": [
+          "error"
+        ]
+      }
+    },
+    "pong": {
+      "type": "object",
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "const": "pong"
+        },
+        "t": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false
+    },
+    "workerFrame": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/hello"
+        },
+        {
+          "$ref": "#/$defs/ping"
+        },
+        {
+          "$ref": "#/$defs/pollers"
+        },
+        {
+          "$ref": "#/$defs/taskResult"
+        },
+        {
+          "$ref": "#/$defs/taskFailed"
+        },
+        {
+          "$ref": "#/$defs/heartbeat"
+        },
+        {
+          "$ref": "#/$defs/workerHeartbeat"
+        },
+        {
+          "$ref": "#/$defs/req"
+        },
+        {
+          "$ref": "#/$defs/bye"
+        }
+      ]
+    },
+    "serviceFrame": {
+      "oneOf": [
+        {
+          "$ref": "#/$defs/welcome"
+        },
+        {
+          "$ref": "#/$defs/task"
+        },
+        {
+          "$ref": "#/$defs/heartbeatAck"
+        },
+        {
+          "$ref": "#/$defs/cancel"
+        },
+        {
+          "$ref": "#/$defs/res"
+        },
+        {
+          "$ref": "#/$defs/pong"
+        }
+      ]
+    }
+  }
+}