Skip to content

Automate browser based workflows with AI

Downgrade setup_workflow_run client-4xx failures from error+traceback to warning (SKY-13284) (#7954)

Aaron Perez5dc96d234ad2
diff --git a/skyvern/forge/sdk/forge_log.py b/skyvern/forge/sdk/forge_log.py
index f8a2c8ac2..610e002a1 100644
--- a/skyvern/forge/sdk/forge_log.py
+++ b/skyvern/forge/sdk/forge_log.py
@@ -372,6 +372,22 @@ def add_error_processor(logger: logging.Logger, method_name: str, event_dict: Ev
return event_dict
+def exception_log_fields(exc: BaseException) -> dict[str, str]:
+ """The error_type/error_category/exception_hash fields add_error_processor derives from exc_info.
+
+ For callsites that want these dashboard fields on a log line that deliberately omits the
+ traceback (e.g. a warning downgraded from an exception log).
+ """
+ exc_type = type(exc)
+ fields = {
+ "error_type": f"{exc_type.__module__}.{exc_type.__name__}",
+ "error_category": _categorize_exception(exc_type, exc_type.__name__),
+ }
+ if exc.__traceback__ is not None:
+ fields["exception_hash"] = _generate_exception_hash(exc_type, exc.__traceback__)
+ return fields
+
+
def _generate_exception_hash(exc_type: type, tb: TracebackType) -> str:
"""
Generate a stable hash for an exception based on:
diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.py
index e311818ed..a1e2bf87f 100644
--- a/skyvern/forge/sdk/workflow/service.py
+++ b/skyvern/forge/sdk/workflow/service.py
@@ -76,6 +76,7 @@ from skyvern.forge.sdk.db.id import generate_output_parameter_id, generate_workf
from skyvern.forge.sdk.enterprise_features import collect_enterprise_gated_run_features
from skyvern.forge.sdk.experimentation.enrich_tree import resolve_enrich_tree_for_context
from skyvern.forge.sdk.experimentation.transient_ui_capture import resolve_transient_ui_capture_arm
+from skyvern.forge.sdk.forge_log import exception_log_fields
from skyvern.forge.sdk.models import Step, StepStatus
from skyvern.forge.sdk.schemas.browser_profiles import BrowserProfile
from skyvern.forge.sdk.schemas.credentials import Credential
@@ -2017,10 +2018,21 @@ class WorkflowService:
trigger_type=resolved_trigger_type,
)
except Exception as e:
- LOG.exception(
- f"Error while setting up workflow run {workflow_run.workflow_run_id}",
- workflow_run_id=workflow_run.workflow_run_id,
- )
+ # Client 4xx (e.g. missing param, invalid credential id) is expected user input and
+ # already surfaced via the failed run + failure_reason below, so it needs no operator
+ # action. Log it at warning without a traceback (keeping the error_type/exception_hash
+ # dashboard fields), and reserve error+traceback for genuine setup defects.
+ if isinstance(e, SkyvernHTTPException) and e.status_code < 500:
+ LOG.warning(
+ f"Error while setting up workflow run {workflow_run.workflow_run_id}",
+ workflow_run_id=workflow_run.workflow_run_id,
+ **exception_log_fields(e),
+ )
+ else:
+ LOG.exception(
+ f"Error while setting up workflow run {workflow_run.workflow_run_id}",
+ workflow_run_id=workflow_run.workflow_run_id,
+ )
# Discard any failed transaction state on the shared outer session before
# mark_workflow_run_as_failed reuses it.
diff --git a/tests/unit/test_forge_log_foreign_tracebacks.py b/tests/unit/test_forge_log_foreign_tracebacks.py
index 9c68cfc01..14931665e 100644
--- a/tests/unit/test_forge_log_foreign_tracebacks.py
+++ b/tests/unit/test_forge_log_foreign_tracebacks.py
@@ -60,6 +60,31 @@ def test_foreign_stdlib_exception_renders_single_structured_line(json_stream: io
assert record["exception_hash"]
+def test_exception_log_fields_matches_processor_output_for_raised_exception() -> None:
+ """exception_log_fields lets a warning carry the same dashboard fields add_error_processor
+ derives from exc_info, so downgraded lines stay groupable without rendering a traceback."""
+ from skyvern.forge.sdk.forge_log import exception_log_fields
+
+ try:
+ _raise_through_wrapper()
+ except ValueError as exc:
+ fields = exception_log_fields(exc)
+
+ assert fields["error_type"] == "builtins.ValueError"
+ assert fields["error_category"] == "ERROR"
+ assert fields["exception_hash"]
+
+
+def test_exception_log_fields_omits_hash_when_never_raised() -> None:
+ from skyvern.forge.sdk.forge_log import exception_log_fields
+
+ fields = exception_log_fields(ValueError("never raised"))
+
+ assert fields["error_type"] == "builtins.ValueError"
+ assert fields["error_category"] == "ERROR"
+ assert "exception_hash" not in fields
+
+
@pytest.fixture
def registered_credential() -> Iterator[str]:
secret_scrub._SESSION_SCRUB_VALUES.clear()
diff --git a/tests/unit/test_workflow_run_parameter_batching.py b/tests/unit/test_workflow_run_parameter_batching.py
index 00f0a26a8..ba820e1e6 100644
--- a/tests/unit/test_workflow_run_parameter_batching.py
+++ b/tests/unit/test_workflow_run_parameter_batching.py
@@ -356,6 +356,72 @@ async def test_setup_workflow_run_raises_on_missing_required_parameters() -> Non
service.mark_workflow_run_as_failed.assert_awaited_once()
+def _setup_log_calls(mock_log: object, level: str) -> list:
+ return [c for c in getattr(mock_log, level).call_args_list if "Error while setting up workflow run" in c.args[0]]
+
+
+async def test_setup_workflow_run_logs_client_4xx_as_warning_without_traceback() -> None:
+ """A client 4xx (missing param) is expected input, so the setup-failure log drops to warning
+ without a traceback while keeping the error_type field for dashboards."""
+ required_param = _make_workflow_parameter("api_key") # no default_value
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=[required_param])
+
+ request = WorkflowRequestBody(data={})
+
+ with (
+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,
+ patch("skyvern.forge.sdk.workflow.service.LOG") as mock_log,
+ ):
+ mock_app.DATABASE.workflows.get_browser_action_policy = AsyncMock(return_value=None)
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.AGENT_FUNCTION.should_use_flex_llm_routing = AsyncMock(return_value=False)
+
+ with pytest.raises(MissingValueForParameter):
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ assert not _setup_log_calls(mock_log, "exception")
+ warning_calls = _setup_log_calls(mock_log, "warning")
+ assert len(warning_calls) == 1
+ warning_kwargs = warning_calls[0].kwargs
+ assert warning_kwargs["error_type"] == "skyvern.exceptions.MissingValueForParameter"
+ assert "exc_info" not in warning_kwargs
+
+
+async def test_setup_workflow_run_logs_unexpected_defect_as_error_with_traceback() -> None:
+ """A non-client (5xx-class) failure is a real defect, so it keeps error+traceback via LOG.exception."""
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=[])
+ service._resolve_and_stamp_run_seed = AsyncMock(side_effect=RuntimeError("unexpected setup bug")) # type: ignore[method-assign]
+
+ request = WorkflowRequestBody(data={})
+
+ with (
+ patch("skyvern.forge.sdk.workflow.service.app") as mock_app,
+ patch("skyvern.forge.sdk.workflow.service.LOG") as mock_log,
+ ):
+ mock_app.DATABASE.workflows.get_browser_action_policy = AsyncMock(return_value=None)
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.AGENT_FUNCTION.should_use_flex_llm_routing = AsyncMock(return_value=False)
+
+ with pytest.raises(RuntimeError):
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ assert len(_setup_log_calls(mock_log, "exception")) == 1
+ assert not _setup_log_calls(mock_log, "warning")
+ service.mark_workflow_run_as_failed.assert_awaited_once()
+
+
@pytest.mark.asyncio
async def test_setup_workflow_run_persistence_error_identifies_specific_failing_parameter() -> None:
"""When batch fails with multiple params, fallback to one-by-one should pinpoint the failing key."""