Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
feat: add enriched script version detail endpoint (#5111)
pedrohsdbf2062b65b3f7
diff --git a/skyvern-frontend/src/routes/workflows/hooks/useScriptVersionDetailQuery.ts b/skyvern-frontend/src/routes/workflows/hooks/useScriptVersionDetailQuery.tsnew file mode 100644index 000000000..7b521e57b--- /dev/null+++ b/skyvern-frontend/src/routes/workflows/hooks/useScriptVersionDetailQuery.ts@@ -0,0 +1,26 @@+import { getClient } from "@/api/AxiosClient";+import { useCredentialGetter } from "@/hooks/useCredentialGetter";+import { useQuery } from "@tanstack/react-query";+import { ScriptVersionDetailResponse } from "../types/scriptTypes";++type Props = {+ scriptId?: string | null;+ version?: number | null;+};++function useScriptVersionDetailQuery({ scriptId, version }: Props) {+ const credentialGetter = useCredentialGetter();++ return useQuery<ScriptVersionDetailResponse>({+ queryKey: ["script-version-detail", scriptId, version],+ queryFn: async () => {+ const client = await getClient(credentialGetter, "sans-api-v1");+ return client+ .get(`/scripts/${scriptId}/versions/${version}/detail`)+ .then((response) => response.data);+ },+ enabled: !!scriptId && version != null,+ });+}++export { useScriptVersionDetailQuery };diff --git a/skyvern-frontend/src/routes/workflows/types/scriptTypes.ts b/skyvern-frontend/src/routes/workflows/types/scriptTypes.tsindex d8f3ef185..451e6f292 100644--- a/skyvern-frontend/src/routes/workflows/types/scriptTypes.ts+++ b/skyvern-frontend/src/routes/workflows/types/scriptTypes.ts@@ -24,6 +24,17 @@ export type ScriptVersionListResponse = {versions: ScriptVersionSummary[];};+export type ScriptVersionDetailResponse = {+ script_id: string;+ script_revision_id: string;+ version: number;+ created_at: string;+ run_id: string | null;+ blocks: { [blockName: string]: string };+ main_script: string | null;+ fallback_episode_count: number;+};+export type ScriptFallbackEpisode = {episode_id: string;organization_id: string;diff --git a/skyvern/forge/sdk/db/agent_db.py b/skyvern/forge/sdk/db/agent_db.pyindex 07101eb3f..78e20dd7b 100644--- a/skyvern/forge/sdk/db/agent_db.py+++ b/skyvern/forge/sdk/db/agent_db.py@@ -6816,12 +6816,24 @@ class AgentDB(BaseAlchemyDB):async def get_fallback_episodes_count(self,organization_id: str,- workflow_permanent_id: str,+ workflow_permanent_id: str | None = None,workflow_run_id: str | None = None,block_label: str | None = None,reviewed: bool | None = None,fallback_type: str | None = None,+ script_revision_id: str | None = None,) -> int:+ """Count fallback episodes matching the given filters.++ At least one scoping filter (workflow_permanent_id, workflow_run_id,+ or script_revision_id) should be provided. Without any, this returns+ the total count for the entire organization which is rarely intended.+ """+ if workflow_permanent_id is None and workflow_run_id is None and script_revision_id is None:+ LOG.warning(+ "get_fallback_episodes_count called without any scoping filter",+ organization_id=organization_id,+ )try:async with self.Session() as session:query = (@@ -6829,9 +6841,10 @@ class AgentDB(BaseAlchemyDB):.select_from(ScriptFallbackEpisodeModel).filter(ScriptFallbackEpisodeModel.organization_id == organization_id,- ScriptFallbackEpisodeModel.workflow_permanent_id == workflow_permanent_id,))+ if workflow_permanent_id is not None:+ query = query.filter(ScriptFallbackEpisodeModel.workflow_permanent_id == workflow_permanent_id)if workflow_run_id is not None:query = query.filter(ScriptFallbackEpisodeModel.workflow_run_id == workflow_run_id)if block_label is not None:@@ -6840,6 +6853,8 @@ class AgentDB(BaseAlchemyDB):query = query.filter(ScriptFallbackEpisodeModel.reviewed == reviewed)if fallback_type is not None:query = query.filter(ScriptFallbackEpisodeModel.fallback_type == fallback_type)+ if script_revision_id is not None:+ query = query.filter(ScriptFallbackEpisodeModel.script_revision_id == script_revision_id)result = await session.scalar(query)return result or 0diff --git a/skyvern/forge/sdk/routes/scripts.py b/skyvern/forge/sdk/routes/scripts.pyindex 0cbb2c1be..372b69465 100644--- a/skyvern/forge/sdk/routes/scripts.py+++ b/skyvern/forge/sdk/routes/scripts.py@@ -26,6 +26,7 @@ from skyvern.schemas.scripts import (ScriptFallbackEpisode,ScriptStatus,ScriptVersionCompareResponse,+ ScriptVersionDetailResponse,ScriptVersionListResponse,ScriptVersionSummary,WorkflowScriptsListResponse,@@ -318,6 +319,7 @@ async def get_script_version_code(if not script:raise HTTPException(status_code=404, detail="Script version not found")+ # script_id doubles as workflow_permanent_id for script-based lookupsreturn await get_script_blocks_response(script_revision_id=script.script_revision_id,organization_id=current_org.organization_id,@@ -390,6 +392,60 @@ async def compare_script_versions()+@base_router.get(+ "/scripts/{script_id}/versions/{version}/detail",+ include_in_schema=False,+ response_model=ScriptVersionDetailResponse,+)+@base_router.get(+ "/scripts/{script_id}/versions/{version}/detail/",+ include_in_schema=False,+ response_model=ScriptVersionDetailResponse,+)+async def get_script_version_detail(+ script_id: str = Path(..., description="The script ID"),+ version: int = Path(..., description="The version number"),+ current_org: Organization = Depends(org_auth_service.get_current_org),+) -> ScriptVersionDetailResponse:+ """Get full detail for a specific script version, including code blocks and metadata."""+ organization_id = current_org.organization_id++ script = await app.DATABASE.get_script(+ script_id=script_id,+ organization_id=organization_id,+ version=version,+ )+ if not script:+ raise HTTPException(status_code=404, detail="Script version not found")++ # script_id doubles as workflow_permanent_id for script-based lookups+ blocks_response, fallback_episode_count = await asyncio.gather(+ get_script_blocks_response(+ script_revision_id=script.script_revision_id,+ organization_id=organization_id,+ workflow_permanent_id=script_id,+ include_main_script=True,+ script_id=script.script_id,+ version=script.version,+ ),+ app.DATABASE.get_fallback_episodes_count(+ organization_id=organization_id,+ script_revision_id=script.script_revision_id,+ ),+ )++ return ScriptVersionDetailResponse(+ script_id=script.script_id,+ script_revision_id=script.script_revision_id,+ version=script.version,+ created_at=script.created_at,+ run_id=script.run_id,+ blocks=blocks_response.blocks,+ main_script=blocks_response.main_script,+ fallback_episode_count=fallback_episode_count,+ )++@base_router.get("/scripts",response_model=list[Script],diff --git a/skyvern/schemas/scripts.py b/skyvern/schemas/scripts.pyindex 34c740de9..5e65a1264 100644--- a/skyvern/schemas/scripts.py+++ b/skyvern/schemas/scripts.py@@ -141,6 +141,19 @@ class ScriptVersionListResponse(BaseModel):versions: list[ScriptVersionSummary]+class ScriptVersionDetailResponse(BaseModel):+ """Full detail for a single script version, including code and metadata."""++ script_id: str+ script_revision_id: str+ version: int+ created_at: datetime+ run_id: str | None = None+ blocks: dict[str, str]+ main_script: str | None = None+ fallback_episode_count: int = 0++class ScriptBlock(BaseModel):script_block_id: strorganization_id: str