Skip to content

Self-improving AI Employees for everyone

feat(schema): Wave 6 - 7 more Pydantic displayOptions rules + contract invariants

trohitga82a81cdfdf0
diff --git a/server/models/nodes.py b/server/models/nodes.py
index f292c66b..587d2ccf 100644
--- a/server/models/nodes.py
+++ b/server/models/nodes.py
@@ -304,10 +304,22 @@ class ProcessManagerParams(BaseNodeParams):
tool_name: str = Field(default="process_manager", alias="toolName")
tool_description: str = Field(default="", alias="toolDescription")
operation: Literal["start", "stop", "restart", "send_input", "list", "get_output"] = "start"
- name: str = ""
- command: str = ""
- cwd: Optional[str] = None
- input: Optional[str] = None
+ name: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["start", "stop", "restart", "send_input", "get_output"]}}},
+ )
+ command: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["start"]}}},
+ )
+ cwd: Optional[str] = Field(
+ default=None,
+ json_schema_extra={"displayOptions": {"show": {"operation": ["start"]}}},
+ )
+ input: Optional[str] = Field(
+ default=None,
+ json_schema_extra={"displayOptions": {"show": {"operation": ["send_input"]}}},
+ )
# =============================================================================
@@ -348,7 +360,21 @@ class WebhookTriggerParams(BaseNodeParams):
type: Literal["webhookTrigger"]
path: str = ""
method_filter: str = Field(default="all", alias="methodFilter")
- require_auth: bool = Field(default=False, alias="requireAuth")
+ response_mode: Literal["immediate", "response_node"] = Field(default="immediate", alias="responseMode")
+ authentication: Literal["none", "header"] = "none"
+ header_name: str = Field(
+ default="X-API-Key",
+ alias="headerName",
+ json_schema_extra={"displayOptions": {"show": {"authentication": ["header"]}}},
+ )
+ header_value: str = Field(
+ default="",
+ alias="headerValue",
+ json_schema_extra={
+ "displayOptions": {"show": {"authentication": ["header"]}},
+ "password": True,
+ },
+ )
class WebhookResponseParams(BaseNodeParams):
@@ -364,8 +390,15 @@ class ConsoleParams(BaseNodeParams):
type: Literal["console"]
label: str = ""
log_mode: Literal["full", "field", "expression"] = Field(default="full", alias="logMode")
- field_path: str = Field(default="", alias="fieldPath")
- expression: str = ""
+ field_path: str = Field(
+ default="",
+ alias="fieldPath",
+ json_schema_extra={"displayOptions": {"show": {"log_mode": ["field"]}}},
+ )
+ expression: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"log_mode": ["expression"]}}},
+ )
format: Literal["json", "text", "table"] = "json"
@@ -680,9 +713,18 @@ class EmailReadParams(BaseNodeParams):
type: Literal["emailRead"]
provider: str = ""
operation: Literal["list", "search", "read", "folders", "move", "delete", "flag"] = "list"
- folder: str = "INBOX"
- query: str = ""
- message_id: str = Field(default="", alias="messageId")
+ folder: str = Field(
+ default="INBOX",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["list", "search"]}}},
+ )
+ query: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["search"]}}},
+ )
+ message_id: str = Field(
+ default="", alias="messageId",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["read", "move", "delete", "flag"]}}},
+ )
class EmailReceiveParams(BaseNodeParams):
@@ -819,8 +861,14 @@ class VectorStoreParams(BaseNodeParams):
operation: Literal["store", "query", "delete"] = "store"
backend: Literal["chromadb", "qdrant", "pinecone"] = "chromadb"
collection_name: str = Field(default="default", alias="collectionName")
- query: str = ""
- top_k: int = Field(default=5, alias="topK", ge=1, le=100)
+ query: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["query"]}}},
+ )
+ top_k: int = Field(
+ default=5, alias="topK", ge=1, le=100,
+ json_schema_extra={"displayOptions": {"show": {"operation": ["query"]}}},
+ )
class FileDownloaderParams(BaseNodeParams):
@@ -844,10 +892,22 @@ class FileModifyParams(BaseNodeParams):
type: Literal["fileModify"]
operation: Literal["write", "edit"] = "write"
file_path: str = Field(default="", alias="filePath")
- content: str = ""
- old_string: str = Field(default="", alias="oldString")
- new_string: str = Field(default="", alias="newString")
- replace_all: bool = Field(default=False, alias="replaceAll")
+ content: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["write"]}}},
+ )
+ old_string: str = Field(
+ default="", alias="oldString",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["edit"]}}},
+ )
+ new_string: str = Field(
+ default="", alias="newString",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["edit"]}}},
+ )
+ replace_all: bool = Field(
+ default=False, alias="replaceAll",
+ json_schema_extra={"displayOptions": {"show": {"operation": ["edit"]}}},
+ )
class FsSearchParams(BaseNodeParams):
@@ -871,7 +931,10 @@ class ProxyRequestParams(BaseNodeParams):
method: Literal["GET", "POST", "PUT", "DELETE", "PATCH"] = "GET"
url: str = ""
headers: str = "{}"
- body: str = ""
+ body: str = Field(
+ default="",
+ json_schema_extra={"displayOptions": {"show": {"method": ["POST", "PUT", "PATCH"]}}},
+ )
timeout: int = Field(default=30, ge=1, le=300)
proxy_provider: str = Field(default="auto", alias="proxyProvider")
proxy_country: str = Field(default="", alias="proxyCountry")
diff --git a/server/tests/test_node_spec.py b/server/tests/test_node_spec.py
index 9cfdc5cb..73375031 100644
--- a/server/tests/test_node_spec.py
+++ b/server/tests/test_node_spec.py
@@ -553,6 +553,44 @@ class TestDisplayOptionsEnrichment:
api_key = spec["inputs"]["properties"]["apiKey"]
assert api_key["password"] is True
+ def test_webhook_trigger_header_auth_gated(self):
+ spec = get_node_spec("webhookTrigger")
+ for field in ["headerName", "headerValue"]:
+ prop = spec["inputs"]["properties"][field]
+ assert prop["displayOptions"]["show"]["authentication"] == ["header"]
+ assert spec["inputs"]["properties"]["headerValue"]["password"] is True
+
+ def test_console_field_mode_gating(self):
+ spec = get_node_spec("console")
+ assert spec["inputs"]["properties"]["fieldPath"]["displayOptions"]["show"]["log_mode"] == ["field"]
+ assert spec["inputs"]["properties"]["expression"]["displayOptions"]["show"]["log_mode"] == ["expression"]
+
+ def test_process_manager_operation_gating(self):
+ spec = get_node_spec("processManager")
+ assert spec["inputs"]["properties"]["command"]["displayOptions"]["show"]["operation"] == ["start"]
+ assert spec["inputs"]["properties"]["input"]["displayOptions"]["show"]["operation"] == ["send_input"]
+
+ def test_proxy_request_body_gating(self):
+ spec = get_node_spec("proxyRequest")
+ body = spec["inputs"]["properties"]["body"]
+ assert body["displayOptions"]["show"]["method"] == ["POST", "PUT", "PATCH"]
+
+ def test_vector_store_query_fields_gated(self):
+ spec = get_node_spec("vectorStore")
+ for field in ["query", "topK"]:
+ assert spec["inputs"]["properties"][field]["displayOptions"]["show"]["operation"] == ["query"]
+
+ def test_email_read_operation_gating(self):
+ spec = get_node_spec("emailRead")
+ assert "search" in spec["inputs"]["properties"]["query"]["displayOptions"]["show"]["operation"]
+ assert "read" in spec["inputs"]["properties"]["messageId"]["displayOptions"]["show"]["operation"]
+
+ def test_file_modify_edit_gated(self):
+ spec = get_node_spec("fileModify")
+ for field in ["oldString", "newString", "replaceAll"]:
+ assert spec["inputs"]["properties"][field]["displayOptions"]["show"]["operation"] == ["edit"]
+ assert spec["inputs"]["properties"]["content"]["displayOptions"]["show"]["operation"] == ["write"]
+
class TestUIHintsInNodeSpec:
"""Wave 6 Phase 5.b: NODE_METADATA carries panel-level uiHints
@@ -602,3 +640,111 @@ class TestUIHintsInNodeSpec:
hints = spec.get("uiHints", {})
assert hints.get("hideInputSection") is True
assert hints.get("hideOutputSection") is True
+
+
+class TestNodeSpecContractInvariants:
+ """Wave 6 Phase 3e safety net: runs over every registered NodeSpec
+ and asserts the wire contract stays intact. Catches Pydantic drift
+ / metadata typos before they reach the frontend adapter. Extend
+ these guards when the adapter gets new required fields."""
+
+ def _all_spec_types(self):
+ from services.node_spec import list_node_types_with_spec
+ return list_node_types_with_spec()
+
+ def test_every_spec_has_required_wire_fields(self):
+ """Every spec must have: type, displayName, group, version.
+ Missing any of these would break the adapter's defaults()."""
+ from services.node_spec import get_node_spec
+ for t in self._all_spec_types():
+ spec = get_node_spec(t)
+ assert spec is not None, f"No spec for {t}"
+ for field in ("type", "displayName", "group", "version"):
+ assert field in spec, f"{t}: missing required field {field!r}"
+ assert isinstance(spec["group"], list), f"{t}: group must be list"
+ assert isinstance(spec["version"], int), f"{t}: version must be int"
+
+ def test_input_schemas_have_json_schema_shape(self):
+ """Every emitted input schema must be a valid JSON Schema 7
+ object with properties dict. The adapter crashes if properties
+ is missing."""
+ from services.node_input_schemas import get_node_input_schema, NODE_INPUT_MODELS
+ for t in NODE_INPUT_MODELS:
+ schema = get_node_input_schema(t)
+ assert schema is not None, f"Input schema None for {t}"
+ assert isinstance(schema.get("properties"), dict), f"{t}: no properties dict"
+ # Discriminator stripped from surface
+ assert "type" not in schema["properties"], f"{t}: type discriminator leaked"
+
+ def test_display_options_on_every_rule_is_well_formed(self):
+ """Every displayOptions.show / .hide rule must be a dict whose
+ values are lists (the INodeProperties.displayOptions shape the
+ frontend evaluator expects)."""
+ from services.node_input_schemas import get_node_input_schema, NODE_INPUT_MODELS
+ for t in NODE_INPUT_MODELS:
+ schema = get_node_input_schema(t)
+ for prop_name, prop in schema.get("properties", {}).items():
+ rules = prop.get("displayOptions", {})
+ for key in ("show", "hide"):
+ rule = rules.get(key)
+ if rule is None:
+ continue
+ assert isinstance(rule, dict), f"{t}.{prop_name}.displayOptions.{key} not dict"
+ for ref_field, allowed in rule.items():
+ assert isinstance(allowed, list), (
+ f"{t}.{prop_name}.displayOptions.{key}[{ref_field!r}] must be list"
+ )
+
+ def test_load_options_methods_are_registered(self):
+ """Every Pydantic Field(loadOptionsMethod=X) must point at a
+ method registered in LOAD_OPTIONS_REGISTRY. Catches typos and
+ forgotten loader registrations."""
+ from services.node_input_schemas import get_node_input_schema, NODE_INPUT_MODELS
+ from services.node_option_loaders import LOAD_OPTIONS_REGISTRY
+ for t in NODE_INPUT_MODELS:
+ schema = get_node_input_schema(t)
+ for prop_name, prop in schema.get("properties", {}).items():
+ method = prop.get("loadOptionsMethod")
+ if method is None:
+ continue
+ assert method in LOAD_OPTIONS_REGISTRY, (
+ f"{t}.{prop_name} references unknown loadOptionsMethod {method!r}"
+ )
+
+ def test_every_enum_option_is_serialisable(self):
+ """Frontend options are {name, value} where value is scalar.
+ Catches Pydantic Literal unions that accidentally include
+ non-serialisable types."""
+ from services.node_input_schemas import get_node_input_schema, NODE_INPUT_MODELS
+ import json
+ for t in NODE_INPUT_MODELS:
+ schema = get_node_input_schema(t)
+ for prop_name, prop in schema.get("properties", {}).items():
+ enum_vals = prop.get("enum", [])
+ for val in enum_vals:
+ try:
+ json.dumps(val)
+ except (TypeError, ValueError) as e:
+ raise AssertionError(
+ f"{t}.{prop_name} enum value {val!r} not JSON-serialisable: {e}"
+ )
+
+ def test_ui_hints_only_carry_known_flags(self):
+ """NODE_METADATA uiHints should only carry flags the frontend
+ INodeUIHints knows about. New flag names without a frontend
+ consumer are dead weight."""
+ from models.node_metadata import NODE_METADATA
+ known = {
+ "hideInputSection", "hideOutputSection", "hideRunButton",
+ "hasCodeEditor", "isMasterSkillEditor", "isMemoryPanel",
+ "isToolPanel", "isMonitorPanel", "showLocationPanel",
+ "isAndroidToolkit", "isChatTrigger", "isConsoleSink",
+ "hasSkills",
+ }
+ for node_type, meta in NODE_METADATA.items():
+ hints = meta.get("uiHints") or {}
+ unknown = set(hints.keys()) - known
+ assert not unknown, (
+ f"{node_type}: NODE_METADATA['uiHints'] has unknown flags {unknown}. "
+ "Add to INodeUIHints + to the `known` set here."
+ )