Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Clean up browser launch failure messaging (#4844)
Suchintanbc369f530c9b
diff --git a/skyvern/exceptions.py b/skyvern/exceptions.pyindex e30302f79..a8d12f941 100644--- a/skyvern/exceptions.py+++ b/skyvern/exceptions.py@@ -1,3 +1,5 @@+import re+from fastapi import status@@ -19,6 +21,12 @@ class SkyvernHTTPException(SkyvernException):super().__init__(message)+def get_user_facing_exception_message(exception: Exception) -> str:+ if isinstance(exception, SkyvernException):+ return exception.message or str(exception)+ return f"Unexpected error: {exception}"++class DisabledBlockExecutionError(SkyvernHTTPException):def __init__(self, message: str | None = None):super().__init__(message, status_code=status.HTTP_400_BAD_REQUEST)@@ -277,10 +285,39 @@ class UnknownBrowserType(SkyvernException):class UnknownErrorWhileCreatingBrowserContext(SkyvernException):+ SUPPORT_GUIDANCE = "Please try re-running. If this continues, contact [email protected]."+def __init__(self, browser_type: str, exception: Exception) -> None:- super().__init__(- f"Unknown error while creating browser context for {browser_type}. Exception type: {type(exception)} Exception message: {str(exception)}"- )+ exception_type = type(exception).__name__+ detail = self._get_detail(exception)+ super().__init__(f"Failed to create browser context for {browser_type} ({exception_type}). {detail}")++ @staticmethod+ def _get_detail(exception: Exception) -> str:+ raw_message = str(exception).strip()+ # Patchright timeout errors include a verbose "Call log" section with launch args.+ trimmed_message = raw_message.split("Call log:")[0].strip()+ normalized_message = " ".join(trimmed_message.split())++ timeout_match = re.search(r"Timeout\s+(\d+)ms\s+exceeded", normalized_message, flags=re.IGNORECASE)+ if timeout_match and "launch_persistent_context" in normalized_message:+ timeout_seconds = int(timeout_match.group(1)) // 1000+ if timeout_seconds > 0:+ return (+ f"Browser launch timed out after {timeout_seconds} seconds. "+ f"This is usually transient. {UnknownErrorWhileCreatingBrowserContext.SUPPORT_GUIDANCE}"+ )+ return (+ "Browser launch timed out. "+ f"This is usually transient. {UnknownErrorWhileCreatingBrowserContext.SUPPORT_GUIDANCE}"+ )++ if normalized_message:+ if len(normalized_message) > 280:+ normalized_message = f"{normalized_message[:277]}..."+ return f"{normalized_message} {UnknownErrorWhileCreatingBrowserContext.SUPPORT_GUIDANCE}"++ return f"Unknown browser startup error. {UnknownErrorWhileCreatingBrowserContext.SUPPORT_GUIDANCE}"class OrganizationNotFound(SkyvernHTTPException):diff --git a/skyvern/forge/agent.py b/skyvern/forge/agent.pyindex 1a96430a1..a738c809a 100644--- a/skyvern/forge/agent.py+++ b/skyvern/forge/agent.py@@ -55,7 +55,6 @@ from skyvern.exceptions import (NoTOTPVerificationCodeFound,PDFEmbedBase64DecodeError,ScrapingFailed,- SkyvernException,StepTerminationError,StepUnableToExecuteError,TaskAlreadyCanceled,@@ -63,6 +62,7 @@ from skyvern.exceptions import (TaskNotFound,UnsupportedActionType,UnsupportedTaskType,+ get_user_facing_exception_message,)from skyvern.forge import appfrom skyvern.forge.async_operations import AgentPhase, AsyncOperationPool@@ -842,9 +842,7 @@ class ForgeAgent:except Exception as e:LOG.exception("Got an unexpected exception in step, marking task as failed")- failure_reason = f"Unexpected error: {str(e)}"- if isinstance(e, SkyvernException):- failure_reason = f"unexpected SkyvernException({e.__class__.__name__}): {str(e)}"+ failure_reason = get_user_facing_exception_message(e)is_task_marked_as_failed = await self.fail_task(task, step, failure_reason)if is_task_marked_as_failed:diff --git a/skyvern/forge/sdk/workflow/models/block.py b/skyvern/forge/sdk/workflow/models/block.pyindex 74c1e06ce..0ac29a49c 100644--- a/skyvern/forge/sdk/workflow/models/block.py+++ b/skyvern/forge/sdk/workflow/models/block.py@@ -46,9 +46,9 @@ from skyvern.exceptions import (MissingBrowserState,MissingBrowserStatePage,PDFParsingError,- SkyvernException,TaskNotFound,UnexpectedTaskStatus,+ get_user_facing_exception_message,)from skyvern.forge import appfrom skyvern.forge.prompts import prompt_engine@@ -559,9 +559,7 @@ class Block(BaseModel, abc.ABC):if not workflow_run_context.has_value(self.output_parameter.key):await self.record_output_parameter_value(workflow_run_context, workflow_run_id)- failure_reason = f"Unexpected error: {str(e)}"- if isinstance(e, SkyvernException):- failure_reason = f"unexpected SkyvernException({e.__class__.__name__}): {str(e)}"+ failure_reason = get_user_facing_exception_message(e)return await self.build_block_result(success=False,diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.pyindex 698c2504c..77be0a7fb 100644--- a/skyvern/forge/sdk/workflow/service.py+++ b/skyvern/forge/sdk/workflow/service.py@@ -45,6 +45,7 @@ from skyvern.exceptions import (WorkflowNotFoundForWorkflowRun,WorkflowRunNotFound,WorkflowRunParameterPersistenceError,+ get_user_facing_exception_message,)from skyvern.forge import appfrom skyvern.forge.prompts import prompt_engine@@ -651,9 +652,7 @@ class WorkflowService:workflow_run_id=workflow_run.workflow_run_id,)- failure_reason = f"Setup workflow failed due to an unexpected exception: {str(e)}"- if isinstance(e, SkyvernException):- failure_reason = f"Setup workflow failed due to an SkyvernException({e.__class__.__name__}): {str(e)}"+ failure_reason = f"Setup workflow failed. failure reason: {get_user_facing_exception_message(e)}"workflow_run = await self.mark_workflow_run_as_failed(workflow_run_id=workflow_run.workflow_run_id, failure_reason=failure_reason@@ -821,9 +820,7 @@ class WorkflowService:workflow_run_id=workflow_run_id,)- exception_message = f"Unexpected error: {str(e)}"- if isinstance(e, SkyvernException):- exception_message = f"unexpected SkyvernException({e.__class__.__name__}): {str(e)}"+ exception_message = get_user_facing_exception_message(e)failure_reason = f"Failed to initialize workflow run context. failure reason: {exception_message}"workflow_run = await self.mark_workflow_run_as_failed(@@ -1604,9 +1601,7 @@ class WorkflowService:block_label=block.label,)- exception_message = f"Unexpected error: {str(e)}"- if isinstance(e, SkyvernException):- exception_message = f"unexpected SkyvernException({e.__class__.__name__}): {str(e)}"+ exception_message = get_user_facing_exception_message(e)failure_reason = f"{block.block_type} block failed. failure reason: {exception_message}"workflow_run = await self.mark_workflow_run_as_failed(diff --git a/tests/unit/test_exception_messages.py b/tests/unit/test_exception_messages.pynew file mode 100644index 000000000..563013fd6--- /dev/null+++ b/tests/unit/test_exception_messages.py@@ -0,0 +1,35 @@+from skyvern.exceptions import (+ SkyvernException,+ UnknownErrorWhileCreatingBrowserContext,+ get_user_facing_exception_message,+)+++class FakePatchrightTimeoutError(Exception):+ pass+++def test_unknown_error_while_creating_browser_context_strips_call_log() -> None:+ inner_exception = FakePatchrightTimeoutError(+ "BrowserType.launch_persistent_context: Timeout 180000ms exceeded. "+ "Call log:\n- <launching> /opt/microsoft/msedge/msedge --proxy-server=http://network.joinmassive.com:65534"+ )++ error = UnknownErrorWhileCreatingBrowserContext("dynamic-browser", inner_exception)+ message = str(error)++ assert "Call log:" not in message+ assert "--proxy-server=" not in message+ assert "timed out after 180 seconds" in message+ assert "Please try re-running." in message+ assert "[email protected]" in message+++def test_get_user_facing_exception_message_for_skyvern_exception() -> None:+ message = get_user_facing_exception_message(SkyvernException("Human-friendly message"))+ assert message == "Human-friendly message"+++def test_get_user_facing_exception_message_for_generic_exception() -> None:+ message = get_user_facing_exception_message(ValueError("raw error"))+ assert message == "Unexpected error: raw error"