Skip to content

Automate browser based workflows with AI

feat(SKY-12253): add run_type filter to runs list (BE param + FE facet) (#7307)

Aaron Pereza4c74f68d83b
diff --git a/skyvern-frontend/src/components/RunTypeFilterDropdown.tsx b/skyvern-frontend/src/components/RunTypeFilterDropdown.tsx
new file mode 100644
index 000000000..3956de668
--- /dev/null
+++ b/skyvern-frontend/src/components/RunTypeFilterDropdown.tsx
@@ -0,0 +1,91 @@
+import { ChevronDownIcon } from "@radix-ui/react-icons";
+import { Button } from "./ui/button";
+import {
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuTrigger,
+} from "./ui/dropdown-menu";
+import { Checkbox } from "./ui/checkbox";
+import { TaskRunType } from "@/api/types";
+
+// Customer-facing groups over the raw RunType enum; engine-specific CUA
+// values are never surfaced individually.
+export const RunTypeGroup = {
+ Task: "task",
+ Workflow: "workflow",
+ Agent: "agent",
+} as const;
+
+export type RunTypeGroup = (typeof RunTypeGroup)[keyof typeof RunTypeGroup];
+
+// eslint-disable-next-line react-refresh/only-export-components
+export const runTypeGroupToRunTypes: Record<
+ RunTypeGroup,
+ Array<TaskRunType>
+> = {
+ [RunTypeGroup.Task]: [TaskRunType.TaskV1, TaskRunType.TaskV2],
+ [RunTypeGroup.Workflow]: [TaskRunType.WorkflowRun],
+ [RunTypeGroup.Agent]: [
+ TaskRunType.OpenaiCua,
+ TaskRunType.AnthropicCua,
+ TaskRunType.UiTars,
+ TaskRunType.YutoriNavigator,
+ ],
+};
+
+const runTypeDropdownItems: Array<{ label: string; value: RunTypeGroup }> = [
+ {
+ label: "Task",
+ value: RunTypeGroup.Task,
+ },
+ {
+ label: "Workflow",
+ value: RunTypeGroup.Workflow,
+ },
+ {
+ label: "Agent (CUA)",
+ value: RunTypeGroup.Agent,
+ },
+];
+
+type Props = {
+ values: Array<RunTypeGroup>;
+ onChange: (values: Array<RunTypeGroup>) => void;
+};
+
+function RunTypeFilterDropdown({ values, onChange }: Props) {
+ return (
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button variant="outline">
+ Filter by Type <ChevronDownIcon className="ml-2" />
+ </Button>
+ </DropdownMenuTrigger>
+ <DropdownMenuContent align="end">
+ {runTypeDropdownItems.map((item) => {
+ return (
+ <div
+ key={item.value}
+ className="flex items-center gap-2 p-2 text-sm"
+ >
+ <Checkbox
+ id={`run-type-${item.value}`}
+ checked={values.includes(item.value)}
+ onCheckedChange={(checked) => {
+ if (checked) {
+ onChange([...values, item.value]);
+ } else {
+ onChange(values.filter((value) => value !== item.value));
+ }
+ }}
+ />
+ <label htmlFor={`run-type-${item.value}`}>{item.label}</label>
+ </div>
+ );
+ })}
+ </DropdownMenuContent>
+ </DropdownMenu>
+ );
+}
+
+export { RunTypeFilterDropdown };
diff --git a/skyvern-frontend/src/hooks/useRunsQuery.ts b/skyvern-frontend/src/hooks/useRunsQuery.ts
index 9f14bbc9e..6c84ae0a6 100644
--- a/skyvern-frontend/src/hooks/useRunsQuery.ts
+++ b/skyvern-frontend/src/hooks/useRunsQuery.ts
@@ -1,7 +1,7 @@
import { getClient } from "@/api/AxiosClient";
import { useCredentialGetter } from "@/hooks/useCredentialGetter";
import { useQuery } from "@tanstack/react-query";
-import { Status, TaskRunListItem } from "@/api/types";
+import { Status, TaskRunListItem, TaskRunType } from "@/api/types";
import {
getActiveOrgQueryKeyScope,
getOrgScopedQueryKey,
@@ -18,6 +18,7 @@ type Props = {
page?: number;
pageSize?: number;
statusFilters?: Array<Status>;
+ runTypeFilters?: Array<TaskRunType>;
search?: string;
} & UseQueryOptions;
@@ -25,6 +26,7 @@ function useRunsQuery({
page = 1,
pageSize = 10,
statusFilters,
+ runTypeFilters,
search,
...queryOptions
}: Props) {
@@ -33,7 +35,7 @@ function useRunsQuery({
const activeOrgQueryKeyScope = getActiveOrgQueryKeyScope(activeOrgId);
return useQuery<Array<TaskRunListItem>>({
queryKey: getOrgScopedQueryKey(
- ["runs", { statusFilters }, page, pageSize, search],
+ ["runs", { statusFilters, runTypeFilters }, page, pageSize, search],
activeOrgQueryKeyScope,
),
queryFn: async ({ signal }) => {
@@ -46,6 +48,11 @@ function useRunsQuery({
params.append("status", status);
});
}
+ if (runTypeFilters) {
+ runTypeFilters.forEach((runType) => {
+ params.append("run_type", runType);
+ });
+ }
if (search) {
params.append("search_key", search);
}
diff --git a/skyvern-frontend/src/routes/history/RunHistory.test.tsx b/skyvern-frontend/src/routes/history/RunHistory.test.tsx
index 4b4a372ac..1b65e3d8a 100644
--- a/skyvern-frontend/src/routes/history/RunHistory.test.tsx
+++ b/skyvern-frontend/src/routes/history/RunHistory.test.tsx
@@ -43,8 +43,13 @@ vi.mock("posthog-js/react", () => ({
useFeatureFlagEnabled: () => false,
}));
+const runsQueryCalls: Array<Record<string, unknown>> = [];
+
vi.mock("@/hooks/useRunsQuery", () => ({
- useRunsQuery: () => runsQueryResult,
+ useRunsQuery: (props: Record<string, unknown>) => {
+ runsQueryCalls.push(props);
+ return runsQueryResult;
+ },
}));
vi.mock("@/hooks/useCredentialGetter", () => ({
@@ -59,6 +64,34 @@ vi.mock("@/components/StatusFilterDropdown", () => ({
StatusFilterDropdown: () => <div data-testid="status-filter" />,
}));
+vi.mock("@/components/RunTypeFilterDropdown", async (importOriginal) => {
+ const actual =
+ await importOriginal<typeof import("@/components/RunTypeFilterDropdown")>();
+ return {
+ ...actual,
+ RunTypeFilterDropdown: ({
+ values,
+ onChange,
+ }: {
+ values: Array<string>;
+ onChange: (values: Array<string>) => void;
+ }) => (
+ <button
+ data-testid="run-type-filter"
+ onClick={() =>
+ onChange(
+ values.includes("agent")
+ ? values.filter((value) => value !== "agent")
+ : [...values, "agent"],
+ )
+ }
+ >
+ toggle-agent
+ </button>
+ ),
+ };
+});
+
vi.mock("@/components/TriggerTypeBadge", () => ({
TriggerTypeBadge: ({ triggerType }: { triggerType: string }) => (
<span data-testid={`trigger-type-${triggerType}`}>{triggerType}</span>
@@ -124,6 +157,7 @@ function activateSearch() {
afterEach(() => {
runsData.splice(0, runsData.length, workflowRun);
+ runsQueryCalls.length = 0;
cleanup();
vi.clearAllMocks();
});
@@ -162,4 +196,28 @@ describe("RunHistory inputs during filtering", () => {
expect(screen.getByTestId("trigger-type-mcp")).toBeTruthy();
});
+
+ it("expands the selected run-type group into raw run types for the runs query", () => {
+ renderRunHistory();
+
+ expect(runsQueryCalls[runsQueryCalls.length - 1]?.runTypeFilters).toEqual(
+ [],
+ );
+
+ fireEvent.click(screen.getByTestId("run-type-filter"));
+
+ // The curated Agent group expands to the engine-specific CUA run types.
+ expect(runsQueryCalls[runsQueryCalls.length - 1]?.runTypeFilters).toEqual([
+ TaskRunType.OpenaiCua,
+ TaskRunType.AnthropicCua,
+ TaskRunType.UiTars,
+ TaskRunType.YutoriNavigator,
+ ]);
+
+ fireEvent.click(screen.getByTestId("run-type-filter"));
+
+ expect(runsQueryCalls[runsQueryCalls.length - 1]?.runTypeFilters).toEqual(
+ [],
+ );
+ });
});
diff --git a/skyvern-frontend/src/routes/history/RunHistory.tsx b/skyvern-frontend/src/routes/history/RunHistory.tsx
index 029fe1c23..fd9300325 100644
--- a/skyvern-frontend/src/routes/history/RunHistory.tsx
+++ b/skyvern-frontend/src/routes/history/RunHistory.tsx
@@ -22,6 +22,11 @@ import {
} from "@/api/types";
import { StatusBadge } from "@/components/StatusBadge";
import { StatusFilterDropdown } from "@/components/StatusFilterDropdown";
+import {
+ RunTypeFilterDropdown,
+ RunTypeGroup,
+ runTypeGroupToRunTypes,
+} from "@/components/RunTypeFilterDropdown";
import { TriggerTypeBadge } from "@/components/TriggerTypeBadge";
import {
Pagination,
@@ -95,6 +100,29 @@ function parseStatusParam(raw: string | null): Array<Status> {
return out;
}
+const runTypeGroupValues = new Set<string>(Object.values(RunTypeGroup));
+
+function parseRunTypeParam(raw: string | null): Array<RunTypeGroup> {
+ if (!raw) {
+ return [];
+ }
+ const seen = new Set<RunTypeGroup>();
+ const out: Array<RunTypeGroup> = [];
+ for (const token of raw.split(",")) {
+ const trimmed = token.trim();
+ if (!runTypeGroupValues.has(trimmed)) {
+ continue;
+ }
+ const group = trimmed as RunTypeGroup;
+ if (seen.has(group)) {
+ continue;
+ }
+ seen.add(group);
+ out.push(group);
+ }
+ return out;
+}
+
// Scheduled workflow runs carry a deterministic `wr_sched_<hash>` id prefix.
function inferTriggerType(run: TaskRunListItem): TriggerType | null {
if (run.trigger_type) {
@@ -147,6 +175,14 @@ function RunHistory() {
() => parseStatusParam(searchParams.get("status")),
[searchParams],
);
+ const runTypeGroups = useMemo(
+ () => parseRunTypeParam(searchParams.get("run_type")),
+ [searchParams],
+ );
+ const runTypeFilters = useMemo(
+ () => runTypeGroups.flatMap((group) => runTypeGroupToRunTypes[group]),
+ [runTypeGroups],
+ );
const [search, setSearch] = useState("");
const [debouncedSearch] = useDebounce(search, 500);
@@ -156,6 +192,7 @@ function RunHistory() {
page,
pageSize: itemsPerPage,
statusFilters,
+ runTypeFilters,
search: effectiveSearch,
});
const navigate = useNavigate();
@@ -165,6 +202,7 @@ function RunHistory() {
page: page + 1,
pageSize: itemsPerPage,
statusFilters,
+ runTypeFilters,
search: effectiveSearch,
enabled: rawRuns?.length === itemsPerPage,
});
@@ -378,6 +416,7 @@ function RunHistory() {
const hasActiveFilters =
statusFilters.length > 0 ||
+ runTypeGroups.length > 0 ||
!!debouncedSearch ||
!!workflowPermanentIdFilter;
const showOnboardingEmpty =
@@ -448,19 +487,34 @@ function RunHistory() {
disabled={!!workflowPermanentIdFilter}
className="w-48 lg:w-72"
/>
- <StatusFilterDropdown
- values={statusFilters}
- onChange={(filters) => {
- const params = new URLSearchParams(searchParams);
- if (filters.length === 0) {
- params.delete("status");
- } else {
- params.set("status", filters.join(","));
- }
- params.set("page", "1");
- setSearchParams(params, { replace: true });
- }}
- />
+ <div className="flex items-center gap-2">
+ <RunTypeFilterDropdown
+ values={runTypeGroups}
+ onChange={(groups) => {
+ const params = new URLSearchParams(searchParams);
+ if (groups.length === 0) {
+ params.delete("run_type");
+ } else {
+ params.set("run_type", groups.join(","));
+ }
+ params.set("page", "1");
+ setSearchParams(params, { replace: true });
+ }}
+ />
+ <StatusFilterDropdown
+ values={statusFilters}
+ onChange={(filters) => {
+ const params = new URLSearchParams(searchParams);
+ if (filters.length === 0) {
+ params.delete("status");
+ } else {
+ params.set("status", filters.join(","));
+ }
+ params.set("page", "1");
+ setSearchParams(params, { replace: true });
+ }}
+ />
+ </div>
</div>
<div className="overflow-hidden rounded-lg border border-border">
<Table className="sm:table-fixed">
diff --git a/skyvern/forge/sdk/db/repositories/workflow_runs.py b/skyvern/forge/sdk/db/repositories/workflow_runs.py
index 8f9fc09e5..f9771aed7 100644
--- a/skyvern/forge/sdk/db/repositories/workflow_runs.py
+++ b/skyvern/forge/sdk/db/repositories/workflow_runs.py
@@ -580,6 +580,7 @@ class WorkflowRunsRepository(BaseRepository):
page_size: int = 10,
status: list[str] | None = None,
search_key: str | None = None,
+ run_type: list[str] | None = None,
) -> list[dict[str, Any]]:
async with self.Session() as session:
effective_status = func.coalesce(WorkflowRunModel.status, TaskRunModel.status)
@@ -626,6 +627,9 @@ class WorkflowRunsRepository(BaseRepository):
if status:
query = query.filter(effective_status.in_(status))
+ if run_type:
+ query = query.filter(TaskRunModel.task_run_type.in_(run_type))
+
if search_key:
query = query.filter(
or_(
@@ -653,47 +657,49 @@ class WorkflowRunsRepository(BaseRepository):
rows = [dict(row) for row in result.mappings().all()]
if search_key:
- task_run_exists = (
- select(1)
- .select_from(TaskRunModel)
- .where(TaskRunModel.organization_id == WorkflowRunModel.organization_id)
- .where(TaskRunModel.run_id == WorkflowRunModel.workflow_run_id)
- .correlate_except(TaskRunModel)
- .exists()
- )
- fallback_query = (
- select(
- WorkflowRunModel.workflow_run_id.label("task_run_id"),
- WorkflowRunModel.workflow_run_id.label("run_id"),
- literal(RunType.workflow_run.value).label("task_run_type"),
- WorkflowRunModel.status.label("status"),
- WorkflowModel.title.label("title"),
- WorkflowRunModel.started_at.label("started_at"),
- WorkflowRunModel.finished_at.label("finished_at"),
- WorkflowRunModel.created_at.label("created_at"),
- WorkflowRunModel.workflow_permanent_id.label("workflow_permanent_id"),
- WorkflowRunModel.script_run.label("script_run"),
- WorkflowRunModel.trigger_type.label("trigger_type"),
- WorkflowModel.title.label("searchable_text"),
- self._workflow_deleted_expr(
- WorkflowRunModel.workflow_permanent_id,
- WorkflowRunModel.organization_id,
- ),
+ # The fallback only yields workflow_run rows, so skip it when the run_type filter excludes them.
+ if not run_type or RunType.workflow_run in run_type:
+ task_run_exists = (
+ select(1)
+ .select_from(TaskRunModel)
+ .where(TaskRunModel.organization_id == WorkflowRunModel.organization_id)
+ .where(TaskRunModel.run_id == WorkflowRunModel.workflow_run_id)
+ .correlate_except(TaskRunModel)
+ .exists()
)
- .select_from(WorkflowRunModel)
- .outerjoin(WorkflowModel, WorkflowModel.workflow_id == WorkflowRunModel.workflow_id)
- .filter(WorkflowRunModel.organization_id == organization_id)
- .filter(WorkflowRunModel.parent_workflow_run_id.is_(None))
- .filter(WorkflowRunModel.debug_session_id.is_(None))
- .filter(WorkflowRunModel.copilot_session_id.is_(None))
- .filter(~task_run_exists)
- )
- fallback_query = self._apply_workflow_run_search_key_filter(fallback_query, search_key)
- if status:
- fallback_query = fallback_query.filter(WorkflowRunModel.status.in_(status))
- fallback_query = fallback_query.order_by(WorkflowRunModel.created_at.desc()).limit(query_limit)
- fallback_result = await session.execute(fallback_query)
- rows.extend(dict(row) for row in fallback_result.mappings().all())
+ fallback_query = (
+ select(
+ WorkflowRunModel.workflow_run_id.label("task_run_id"),
+ WorkflowRunModel.workflow_run_id.label("run_id"),
+ literal(RunType.workflow_run.value).label("task_run_type"),
+ WorkflowRunModel.status.label("status"),
+ WorkflowModel.title.label("title"),
+ WorkflowRunModel.started_at.label("started_at"),
+ WorkflowRunModel.finished_at.label("finished_at"),
+ WorkflowRunModel.created_at.label("created_at"),
+ WorkflowRunModel.workflow_permanent_id.label("workflow_permanent_id"),
+ WorkflowRunModel.script_run.label("script_run"),
+ WorkflowRunModel.trigger_type.label("trigger_type"),
+ WorkflowModel.title.label("searchable_text"),
+ self._workflow_deleted_expr(
+ WorkflowRunModel.workflow_permanent_id,
+ WorkflowRunModel.organization_id,
+ ),
+ )
+ .select_from(WorkflowRunModel)
+ .outerjoin(WorkflowModel, WorkflowModel.workflow_id == WorkflowRunModel.workflow_id)
+ .filter(WorkflowRunModel.organization_id == organization_id)
+ .filter(WorkflowRunModel.parent_workflow_run_id.is_(None))
+ .filter(WorkflowRunModel.debug_session_id.is_(None))
+ .filter(WorkflowRunModel.copilot_session_id.is_(None))
+ .filter(~task_run_exists)
+ )
+ fallback_query = self._apply_workflow_run_search_key_filter(fallback_query, search_key)
+ if status:
+ fallback_query = fallback_query.filter(WorkflowRunModel.status.in_(status))
+ fallback_query = fallback_query.order_by(WorkflowRunModel.created_at.desc()).limit(query_limit)
+ fallback_result = await session.execute(fallback_query)
+ rows.extend(dict(row) for row in fallback_result.mappings().all())
rows.sort(key=lambda row: row["created_at"], reverse=True)
rows = rows[offset : offset + page_size]
diff --git a/skyvern/forge/sdk/routes/agent_protocol.py b/skyvern/forge/sdk/routes/agent_protocol.py
index af5f64f6c..7d7c355e7 100644
--- a/skyvern/forge/sdk/routes/agent_protocol.py
+++ b/skyvern/forge/sdk/routes/agent_protocol.py
@@ -3883,6 +3883,7 @@ async def get_runs_v2(
description="Case-insensitive substring search (min 3 chars for trigram index).",
examples=["login_url", "wr_abc123"],
),
+ run_type: Annotated[list[RunType] | None, Query()] = None,
) -> Response:
analytics.capture("skyvern-oss-agent-runs-v2-get")
if search_key and (page - 1) * page_size >= MAX_SEARCH_FETCH_LIMIT:
@@ -3897,6 +3898,7 @@ async def get_runs_v2(
page_size=page_size,
status=[s.value for s in status] if status else None,
search_key=search_key,
+ run_type=[r.value for r in run_type] if run_type else None,
)
items = [TaskRunListItem.model_validate(row) for row in rows]
return ORJSONResponse([item.model_dump(mode="json") for item in items])
diff --git a/tests/unit/forge/sdk/db/test_workflow_runs_repository.py b/tests/unit/forge/sdk/db/test_workflow_runs_repository.py
index 293d71606..8aaedcfc5 100644
--- a/tests/unit/forge/sdk/db/test_workflow_runs_repository.py
+++ b/tests/unit/forge/sdk/db/test_workflow_runs_repository.py
@@ -365,6 +365,48 @@ async def test_get_all_runs_v2_status_filter_uses_coalesced_effective_status() -
assert "task_runs.status is not null" not in where_clause
+async def test_get_all_runs_v2_run_type_filter_applies_task_run_type_predicate() -> None:
+ captured: dict[str, Any] = {}
+
+ async def _execute(query):
+ captured["query"] = query
+ return _EmptyExecuteResult()
+
+ session = MagicMock()
+ session.execute = AsyncMock(side_effect=_execute)
+
+ repo = WorkflowRunsRepository(session_factory=lambda: _SessionContext(session), debug_enabled=False)
+
+ await repo.get_all_runs_v2(organization_id="o_test", run_type=["task_v1", "task_v2"])
+
+ where_clause = _where_clause_sql(captured["query"])
+ assert "task_runs.task_run_type IN ('task_v1', 'task_v2')" in where_clause
+
+
+async def test_get_all_runs_v2_run_type_filter_gates_workflow_run_search_fallback() -> None:
+ """The search fallback query only ever yields workflow_run rows, so it must be
+ skipped when the run_type filter excludes workflow_run and kept when it doesn't."""
+ captured_queries: list[Any] = []
+
+ async def _execute(query):
+ captured_queries.append(query)
+ return _EmptyExecuteResult()
+
+ session = MagicMock()
+ session.execute = AsyncMock(side_effect=_execute)
+
+ repo = WorkflowRunsRepository(session_factory=lambda: _SessionContext(session), debug_enabled=False)
+
+ await repo.get_all_runs_v2(organization_id="o_test", search_key="wr_abc123", run_type=["task_v1"])
+ assert len(captured_queries) == 1
+
+ captured_queries.clear()
+ await repo.get_all_runs_v2(organization_id="o_test", search_key="wr_abc123", run_type=["task_v1", "workflow_run"])
+ assert len(captured_queries) == 2
+
+
@pytest.mark.asyncio
async def test_get_all_runs_v2_excludes_copilot_session_workflow_runs() -> None:
captured: dict[str, Any] = {}
diff --git a/tests/unit/test_runs_v2_route.py b/tests/unit/test_runs_v2_route.py
index 0627c948f..9b0b02323 100644
--- a/tests/unit/test_runs_v2_route.py
+++ b/tests/unit/test_runs_v2_route.py
@@ -12,6 +12,7 @@ from skyvern.forge.sdk.db.enums import WorkflowRunTriggerType
from skyvern.forge.sdk.routes import agent_protocol
from skyvern.forge.sdk.workflow.models.tags import CallerType, TagSource
from skyvern.forge.sdk.workflow.models.workflow import WorkflowRequestBody, WorkflowRunStatus
+from skyvern.schemas.run_enums import RunType
from skyvern.schemas.runs import MAX_SEARCH_FETCH_LIMIT
@@ -54,6 +55,7 @@ async def test_get_runs_v2_serializes_mapping_rows_from_database(monkeypatch: py
page=2,
page_size=5,
search_key="abc",
+ run_type=[RunType.workflow_run, RunType.task_v1],
)
mock_workflow_runs.get_all_runs_v2.assert_awaited_once_with(
@@ -62,6 +64,7 @@ async def test_get_runs_v2_serializes_mapping_rows_from_database(monkeypatch: py
page_size=5,
status=None,
search_key="abc",
+ run_type=["workflow_run", "task_v1"],
)
assert orjson.loads(response.body) == [
{