Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
fix(SKY-8799): preserve ISO datetime strings in workflow YAML loading (#5421)
Aaron Perez6bab0aeaee63
diff --git a/skyvern/forge/sdk/routes/agent_protocol.py b/skyvern/forge/sdk/routes/agent_protocol.pyindex a6a8f278d..0c8c3312a 100644--- a/skyvern/forge/sdk/routes/agent_protocol.py+++ b/skyvern/forge/sdk/routes/agent_protocol.py@@ -132,6 +132,7 @@ from skyvern.schemas.workflows import ()from skyvern.services import block_service, run_service, task_v1_service, task_v2_service, workflow_servicefrom skyvern.services.pdf_import_service import pdf_import_service+from skyvern.utils.yaml_loader import safe_load_no_datesfrom skyvern.webeye.actions.actions import ActionLOG = structlog.get_logger()@@ -547,7 +548,7 @@ async def create_workflow_legacy(analytics.capture("skyvern-oss-agent-workflow-create-legacy")raw_yaml = await request.body()try:- workflow_yaml = yaml.safe_load(raw_yaml)+ workflow_yaml = safe_load_no_dates(raw_yaml)except yaml.YAMLError:raise HTTPException(status_code=422, detail="Invalid YAML")@@ -607,7 +608,7 @@ async def create_workflow(analytics.capture("skyvern-oss-agent-workflow-create")try:if data.yaml_definition:- workflow_json_from_yaml = yaml.safe_load(data.yaml_definition)+ workflow_json_from_yaml = safe_load_no_dates(data.yaml_definition)# Auto-sanitize block labels and update references for importsworkflow_json_from_yaml = sanitize_workflow_yaml_with_references(workflow_json_from_yaml)workflow_definition = WorkflowCreateYAMLRequest.model_validate(workflow_json_from_yaml)@@ -953,7 +954,7 @@ async def update_workflow_legacy(# validate the workflowraw_yaml = await request.body()try:- workflow_yaml = yaml.safe_load(raw_yaml)+ workflow_yaml = safe_load_no_dates(raw_yaml)except yaml.YAMLError:raise HTTPException(status_code=422, detail="Invalid YAML")@@ -1022,7 +1023,7 @@ async def update_workflow(analytics.capture("skyvern-oss-agent-workflow-update")try:if data.yaml_definition:- workflow_json_from_yaml = yaml.safe_load(data.yaml_definition)+ workflow_json_from_yaml = safe_load_no_dates(data.yaml_definition)# Auto-sanitize block labels and update references for importsworkflow_json_from_yaml = sanitize_workflow_yaml_with_references(workflow_json_from_yaml)workflow_definition = WorkflowCreateYAMLRequest.model_validate(workflow_json_from_yaml)diff --git a/skyvern/forge/sdk/routes/workflow_copilot.py b/skyvern/forge/sdk/routes/workflow_copilot.pyindex 973439c91..356e7d230 100644--- a/skyvern/forge/sdk/routes/workflow_copilot.py+++ b/skyvern/forge/sdk/routes/workflow_copilot.py@@ -49,6 +49,7 @@ from skyvern.schemas.workflows import (WorkflowCreateYAMLRequest,WorkflowDefinitionYAML,)+from skyvern.utils.yaml_loader import safe_load_no_datesWORKFLOW_KNOWLEDGE_BASE_PATH = Path("skyvern/forge/prompts/skyvern/workflow_knowledge_base.txt")CHAT_HISTORY_CONTEXT_MESSAGES = 10@@ -572,7 +573,7 @@ def _process_workflow_yaml(organization_id: str,workflow_yaml: str,) -> Workflow:- parsed_yaml = yaml.safe_load(workflow_yaml)+ parsed_yaml = safe_load_no_dates(workflow_yaml)# Fixing trivial common LLM mistakesworkflow_definition = parsed_yaml.get("workflow_definition", None)@@ -850,7 +851,7 @@ async def workflow_copilot_convert_yaml_to_blocks(that the comparison panel expects."""try:- parsed_yaml = yaml.safe_load(request.workflow_definition_yaml)+ parsed_yaml = safe_load_no_dates(request.workflow_definition_yaml)workflow_definition_yaml = WorkflowDefinitionYAML.model_validate(parsed_yaml)_repair_next_block_label_chain(workflow_definition_yaml.blocks)diff --git a/skyvern/utils/yaml_loader.py b/skyvern/utils/yaml_loader.pynew file mode 100644index 000000000..f284138aa--- /dev/null+++ b/skyvern/utils/yaml_loader.py@@ -0,0 +1,32 @@+"""YAML loading helpers.++PyYAML's default ``SafeLoader`` resolves ISO 8601 strings into Python+``datetime`` / ``date`` objects via the ``tag:yaml.org,2002:timestamp``+implicit resolver. That breaks downstream JSON serialization when users+embed datetime-like strings inside free-form JSON parameter defaults+(e.g. ``"created_at": "2023-10-27T10:00:00Z"``).++``NoDatesSafeLoader`` is a ``SafeLoader`` subclass with the timestamp+resolver removed so such strings stay as plain ``str`` values.+"""++from typing import Any++import yaml+++class NoDatesSafeLoader(yaml.SafeLoader):+ """SafeLoader that does not auto-convert ISO 8601 strings to datetime."""+++# Remove the implicit timestamp resolver from this loader only, leaving+# the global yaml.SafeLoader untouched.+NoDatesSafeLoader.yaml_implicit_resolvers = {+ key: [(tag, regexp) for tag, regexp in resolvers if tag != "tag:yaml.org,2002:timestamp"]+ for key, resolvers in yaml.SafeLoader.yaml_implicit_resolvers.items()+}+++def safe_load_no_dates(stream: Any) -> Any:+ """``yaml.safe_load`` variant that keeps ISO 8601 strings as strings."""+ return yaml.load(stream, Loader=NoDatesSafeLoader)diff --git a/tests/unit/test_yaml_loader_no_dates.py b/tests/unit/test_yaml_loader_no_dates.pynew file mode 100644index 000000000..00636f7b2--- /dev/null+++ b/tests/unit/test_yaml_loader_no_dates.py@@ -0,0 +1,77 @@+"""Regression tests for SKY-8799.++PyYAML's default ``SafeLoader`` resolves ISO 8601 strings into Python+``datetime`` objects. When users embed such strings inside the+``default_value`` of a JSON workflow parameter, those values become+``datetime`` instances on the way in and then crash ``json.dumps`` on+the way back out, producing::++ TypeError: Object of type datetime is not JSON serializable++``skyvern.utils.yaml_loader.safe_load_no_dates`` removes the timestamp+implicit resolver so the values stay as plain strings.+"""++import json++import yaml++from skyvern.utils.yaml_loader import safe_load_no_dates++ISO_BLOB = """+parameters:+ - parameter_type: workflow+ key: payload+ workflow_parameter_type: json+ default_value:+ id: "12345"+ metadata:+ # Unquoted ISO 8601 strings are what trip the default SafeLoader.+ created_at: 2023-10-27T10:00:00Z+ updated_at: 2023-10-28T14:30:00Z+ tags: ["primary", "test-data"]+"""+++def test_default_safe_load_does_parse_datetimes() -> None:+ # Sanity check: documents the behavior we are working around.+ parsed = yaml.safe_load(ISO_BLOB)+ default_value = parsed["parameters"][0]["default_value"]+ # The default loader turns the unquoted-looking timestamps into datetimes,+ # which is exactly what breaks downstream JSON serialization.+ assert not isinstance(default_value["metadata"]["created_at"], str)+++def test_safe_load_no_dates_keeps_iso_strings_as_strings() -> None:+ parsed = safe_load_no_dates(ISO_BLOB)+ metadata = parsed["parameters"][0]["default_value"]["metadata"]++ assert metadata["created_at"] == "2023-10-27T10:00:00Z"+ assert metadata["updated_at"] == "2023-10-28T14:30:00Z"+ assert isinstance(metadata["created_at"], str)+ assert isinstance(metadata["updated_at"], str)+++def test_safe_load_no_dates_round_trips_through_json() -> None:+ parsed = safe_load_no_dates(ISO_BLOB)+ # The whole point: the parsed structure must be JSON-serializable+ # without a custom encoder.+ serialized = json.dumps(parsed)+ assert "2023-10-27T10:00:00Z" in serialized+++def test_safe_load_no_dates_preserves_other_implicit_types() -> None:+ parsed = safe_load_no_dates(+ """+ an_int: 42+ a_float: 3.14+ a_bool: true+ a_null: null+ a_list: [1, 2, 3]+ """+ )+ assert parsed["an_int"] == 42+ assert parsed["a_float"] == 3.14+ assert parsed["a_bool"] is True+ assert parsed["a_null"] is None+ assert parsed["a_list"] == [1, 2, 3]