Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
feat(SKY-9737): paginate GET /browser_profiles (#5977)
Celal Zamanoğlu96beb495cda6
diff --git a/skyvern/forge/sdk/db/repositories/browser_sessions.py b/skyvern/forge/sdk/db/repositories/browser_sessions.pyindex cbb17c59f..faaeb1d94 100644--- a/skyvern/forge/sdk/db/repositories/browser_sessions.py+++ b/skyvern/forge/sdk/db/repositories/browser_sessions.py@@ -76,12 +76,18 @@ class BrowserSessionsRepository(BaseRepository):self,organization_id: str,include_deleted: bool = False,+ page: int = 1,+ page_size: int = 10,) -> list[BrowserProfile]:+ if page < 1:+ raise ValueError(f"Page must be greater than 0, got {page}")+ db_page = page - 1async with self.Session() as session:query = select(BrowserProfileModel).filter_by(organization_id=organization_id)if not include_deleted:query = query.filter(BrowserProfileModel.deleted_at.is_(None))- browser_profiles = await session.scalars(query.order_by(asc(BrowserProfileModel.created_at)))+ query = query.order_by(asc(BrowserProfileModel.created_at)).limit(page_size).offset(db_page * page_size)+ browser_profiles = await session.scalars(query)return [BrowserProfile.model_validate(profile) for profile in browser_profiles.all()]@db_operation("delete_browser_profile")diff --git a/skyvern/forge/sdk/routes/browser_profiles.py b/skyvern/forge/sdk/routes/browser_profiles.pyindex 2c7939a58..c06fbc6ab 100644--- a/skyvern/forge/sdk/routes/browser_profiles.py+++ b/skyvern/forge/sdk/routes/browser_profiles.py@@ -135,6 +135,8 @@ async def create_browser_profile(include_in_schema=False,)async def list_browser_profiles(+ page: int = Query(1, ge=1),+ page_size: int = Query(10, ge=1),include_deleted: bool = Query(default=False, description="Include deleted browser profiles"),current_org: Organization = Depends(org_auth_service.get_current_org),) -> list[BrowserProfile]:@@ -144,11 +146,15 @@ async def list_browser_profiles("Listing browser profiles",organization_id=organization_id,include_deleted=include_deleted,+ page=page,+ page_size=page_size,)profiles = await app.DATABASE.browser_sessions.list_browser_profiles(organization_id=organization_id,include_deleted=include_deleted,+ page=page,+ page_size=page_size,)LOG.info(diff --git a/tests/unit/forge/sdk/test_list_browser_profiles_route.py b/tests/unit/forge/sdk/test_list_browser_profiles_route.pynew file mode 100644index 000000000..45765eb9a--- /dev/null+++ b/tests/unit/forge/sdk/test_list_browser_profiles_route.py@@ -0,0 +1,121 @@+"""Tests for GET /browser_profiles pagination."""++from __future__ import annotations++from datetime import datetime, timezone+from types import SimpleNamespace+from unittest.mock import AsyncMock++import pytest+from fastapi import FastAPI, Request+from fastapi.responses import JSONResponse+from fastapi.testclient import TestClient++from skyvern.exceptions import SkyvernHTTPException+from skyvern.forge import app as forge_app+from skyvern.forge.sdk.routes import routers as routers_module+from skyvern.forge.sdk.schemas.browser_profiles import BrowserProfile+from skyvern.forge.sdk.services import org_auth_service++ORG_ID = "org_oss"+++def _profile(profile_id: str, name: str = "P") -> BrowserProfile:+ now = datetime.now(timezone.utc)+ return BrowserProfile(+ browser_profile_id=profile_id,+ organization_id=ORG_ID,+ name=name,+ description=None,+ source_browser_type=None,+ created_at=now,+ modified_at=now,+ deleted_at=None,+ )+++def _build_client(monkeypatch: pytest.MonkeyPatch) -> tuple[TestClient, AsyncMock]:+ async def _fake_org() -> SimpleNamespace:+ return SimpleNamespace(organization_id=ORG_ID)++ list_browser_profiles = AsyncMock()+ monkeypatch.setattr(+ forge_app.DATABASE.browser_sessions,+ "list_browser_profiles",+ list_browser_profiles,+ )++ fastapi_app = FastAPI()+ fastapi_app.dependency_overrides[org_auth_service.get_current_org] = _fake_org+ fastapi_app.include_router(routers_module.base_router, prefix="/v1")++ @fastapi_app.exception_handler(SkyvernHTTPException)+ async def _handle_skyvern_http_exception(request: Request, exc: SkyvernHTTPException) -> JSONResponse:+ return JSONResponse(status_code=exc.status_code, content={"detail": exc.message})++ return TestClient(fastapi_app), list_browser_profiles+++def test_list_browser_profiles_default_pagination(monkeypatch: pytest.MonkeyPatch) -> None:+ client, list_browser_profiles = _build_client(monkeypatch)+ list_browser_profiles.return_value = [_profile("bp_1"), _profile("bp_2")]++ response = client.get("/v1/browser_profiles")++ assert response.status_code == 200+ body = response.json()+ assert [p["browser_profile_id"] for p in body] == ["bp_1", "bp_2"]+ list_browser_profiles.assert_awaited_once_with(+ organization_id=ORG_ID,+ include_deleted=False,+ page=1,+ page_size=10,+ )+++def test_list_browser_profiles_explicit_pagination(monkeypatch: pytest.MonkeyPatch) -> None:+ client, list_browser_profiles = _build_client(monkeypatch)+ list_browser_profiles.return_value = [_profile("bp_11")]++ response = client.get("/v1/browser_profiles?page=2&page_size=10")++ assert response.status_code == 200+ list_browser_profiles.assert_awaited_once_with(+ organization_id=ORG_ID,+ include_deleted=False,+ page=2,+ page_size=10,+ )+++def test_list_browser_profiles_rejects_page_zero(monkeypatch: pytest.MonkeyPatch) -> None:+ client, list_browser_profiles = _build_client(monkeypatch)++ response = client.get("/v1/browser_profiles?page=0")++ assert response.status_code == 422+ list_browser_profiles.assert_not_awaited()+++def test_list_browser_profiles_rejects_page_size_zero(monkeypatch: pytest.MonkeyPatch) -> None:+ client, list_browser_profiles = _build_client(monkeypatch)++ response = client.get("/v1/browser_profiles?page_size=0")++ assert response.status_code == 422+ list_browser_profiles.assert_not_awaited()+++def test_list_browser_profiles_alias_trailing_slash(monkeypatch: pytest.MonkeyPatch) -> None:+ client, list_browser_profiles = _build_client(monkeypatch)+ list_browser_profiles.return_value = []++ response = client.get("/v1/browser_profiles/?page=3&page_size=5")++ assert response.status_code == 200+ list_browser_profiles.assert_awaited_once_with(+ organization_id=ORG_ID,+ include_deleted=False,+ page=3,+ page_size=5,+ )