Skip to content

Automate browser based workflows with AI

fix(SKY-10655): derive credential-test trigger_type from x-user-agent (#6380)

Celal Zamanoğlufa2c89f10be6
diff --git a/skyvern/forge/sdk/routes/credentials.py b/skyvern/forge/sdk/routes/credentials.py
index 46f0c05ad..894989bb1 100644
--- a/skyvern/forge/sdk/routes/credentials.py
+++ b/skyvern/forge/sdk/routes/credentials.py
@@ -28,16 +28,17 @@ exact threat the vault architecture is designed to prevent.
import asyncio
import json
from datetime import datetime
+from typing import Annotated
import structlog
-from fastapi import BackgroundTasks, Body, Depends, HTTPException, Path, Query
+from fastapi import BackgroundTasks, Body, Depends, Header, HTTPException, Path, Query
from skyvern.config import settings
from skyvern.exceptions import HttpException as SkyvernHttpException
from skyvern.exceptions import SkyvernHTTPException
from skyvern.forge import app
from skyvern.forge.sdk.core.aiohttp_helper import aiohttp_request
-from skyvern.forge.sdk.db.enums import OrganizationAuthTokenType, WorkflowRunTriggerType
+from skyvern.forge.sdk.db.enums import OrganizationAuthTokenType
from skyvern.forge.sdk.db.models import CredentialFolderModel
from skyvern.forge.sdk.executor.factory import AsyncExecutorFactory
from skyvern.forge.sdk.routes.code_samples import (
@@ -57,6 +58,7 @@ from skyvern.forge.sdk.routes.code_samples import (
UPDATE_CREDENTIAL_CODE_SAMPLE_TS,
)
from skyvern.forge.sdk.routes.routers import base_router, legacy_base_router
+from skyvern.forge.sdk.routes.trigger_type import workflow_run_trigger_type_from_user_agent
from skyvern.forge.sdk.schemas.credentials import (
CancelTestResponse,
CreateCredentialRequest,
@@ -496,6 +498,7 @@ async def test_login(
description="The login credentials and URL to test",
),
current_org: Organization = Depends(org_auth_service.get_current_org),
+ x_user_agent: Annotated[str | None, Header()] = None,
) -> TestLoginResponse:
"""Test a login with inline credentials without requiring a saved credential."""
organization_id = current_org.organization_id
@@ -584,7 +587,7 @@ async def test_login(
workflow_permanent_id=workflow.workflow_permanent_id,
organization=current_org,
max_steps_override=None,
- trigger_type=WorkflowRunTriggerType.api,
+ trigger_type=workflow_run_trigger_type_from_user_agent(x_user_agent),
)
await AsyncExecutorFactory.get_executor().execute_workflow(
@@ -680,6 +683,7 @@ async def test_credential(
description="Test configuration including the login URL",
),
current_org: Organization = Depends(org_auth_service.get_current_org),
+ x_user_agent: Annotated[str | None, Header()] = None,
) -> TestCredentialResponse:
organization_id = current_org.organization_id
@@ -776,7 +780,7 @@ async def test_credential(
workflow_permanent_id=workflow.workflow_permanent_id,
organization=current_org,
max_steps_override=None,
- trigger_type=WorkflowRunTriggerType.api,
+ trigger_type=workflow_run_trigger_type_from_user_agent(x_user_agent),
)
await AsyncExecutorFactory.get_executor().execute_workflow(
diff --git a/tests/unit/test_credential_test_trigger_type.py b/tests/unit/test_credential_test_trigger_type.py
new file mode 100644
index 000000000..5c1d4b420
--- /dev/null
+++ b/tests/unit/test_credential_test_trigger_type.py
@@ -0,0 +1,200 @@
+import asyncio
+from types import SimpleNamespace
+from unittest.mock import AsyncMock
+
+import pytest
+from fastapi import BackgroundTasks, FastAPI
+from fastapi.testclient import TestClient
+
+from skyvern.forge.sdk.db.enums import WorkflowRunTriggerType
+from skyvern.forge.sdk.routes import credentials
+from skyvern.forge.sdk.schemas.credentials import CredentialType
+from skyvern.forge.sdk.schemas.credentials import TestCredentialRequest as CredentialTestRequest
+from skyvern.forge.sdk.schemas.credentials import TestLoginRequest as LoginTestRequest
+from skyvern.forge.sdk.services import org_auth_service
+
+USER_AGENT_CASES = [
+ ("skyvern-ui", WorkflowRunTriggerType.manual),
+ ("skyvern-mcp", WorkflowRunTriggerType.manual),
+ (None, WorkflowRunTriggerType.api),
+ ("python-sdk/1.0", WorkflowRunTriggerType.api),
+]
+
+
+def _workflow_service(setup_mock: AsyncMock) -> SimpleNamespace:
+ return SimpleNamespace(
+ create_workflow_from_request=AsyncMock(return_value=SimpleNamespace(workflow_permanent_id="wpid_test")),
+ setup_workflow_run=setup_mock,
+ )
+
+
+def _setup_mock() -> AsyncMock:
+ return AsyncMock(
+ return_value=SimpleNamespace(
+ workflow_run_id="wr_test",
+ workflow_id="wf_test",
+ workflow_permanent_id="wpid_test",
+ )
+ )
+
+
+def _patch_executor(monkeypatch: pytest.MonkeyPatch) -> None:
+ executor = SimpleNamespace(execute_workflow=AsyncMock())
+ monkeypatch.setattr(credentials.AsyncExecutorFactory, "get_executor", lambda: executor)
+
+
[email protected]("x_user_agent, expected", USER_AGENT_CASES)
+async def test_test_credential_trigger_type_from_user_agent(
+ monkeypatch: pytest.MonkeyPatch,
+ x_user_agent: str | None,
+ expected: WorkflowRunTriggerType,
+) -> None:
+ setup_mock = _setup_mock()
+ mock_credentials = SimpleNamespace(
+ get_credential=AsyncMock(
+ return_value=SimpleNamespace(
+ credential_type=CredentialType.PASSWORD,
+ browser_profile_id=None,
+ totp_identifier=None,
+ name="Test Credential",
+ )
+ )
+ )
+ monkeypatch.setattr(credentials.app, "DATABASE", SimpleNamespace(credentials=mock_credentials))
+ monkeypatch.setattr(credentials.app, "WORKFLOW_SERVICE", _workflow_service(setup_mock))
+ _patch_executor(monkeypatch)
+
+ response = await credentials.test_credential(
+ background_tasks=BackgroundTasks(),
+ credential_id="cred_test",
+ data=CredentialTestRequest(url="https://example.com/login", save_browser_profile=False),
+ current_org=SimpleNamespace(organization_id="org_test"),
+ x_user_agent=x_user_agent,
+ )
+
+ setup_mock.assert_awaited_once()
+ assert setup_mock.call_args.kwargs["trigger_type"] == expected
+ assert response.workflow_run_id == "wr_test"
+
+
[email protected]("x_user_agent, expected", USER_AGENT_CASES)
+async def test_test_login_trigger_type_from_user_agent(
+ monkeypatch: pytest.MonkeyPatch,
+ x_user_agent: str | None,
+ expected: WorkflowRunTriggerType,
+) -> None:
+ setup_mock = _setup_mock()
+ vault_service = SimpleNamespace(
+ create_credential=AsyncMock(
+ return_value=SimpleNamespace(vault_type=None, credential_id="cred_test", totp_identifier=None)
+ )
+ )
+ monkeypatch.setattr(credentials, "_get_credential_vault_service", AsyncMock(return_value=vault_service))
+ monkeypatch.setattr(credentials, "_create_browser_profile_after_workflow", AsyncMock())
+ monkeypatch.setattr(credentials.app, "WORKFLOW_SERVICE", _workflow_service(setup_mock))
+ _patch_executor(monkeypatch)
+
+ response = await credentials.test_login(
+ background_tasks=BackgroundTasks(),
+ data=LoginTestRequest(url="https://example.com/login", username="[email protected]", password="pw"),
+ current_org=SimpleNamespace(organization_id="org_test"),
+ x_user_agent=x_user_agent,
+ )
+
+ setup_mock.assert_awaited_once()
+ assert setup_mock.call_args.kwargs["trigger_type"] == expected
+ assert response.workflow_run_id == "wr_test"
+ # test_login fires _create_browser_profile_after_workflow via create_task; drain the
+ # stubbed task so the loop doesn't warn about a pending task at teardown.
+ await asyncio.sleep(0)
+
+
+def _auth_override() -> SimpleNamespace:
+ return SimpleNamespace(organization_id="org_test")
+
+
+# The tests above call the handlers directly, bypassing FastAPI's Header() injection; these
+# drive the real HTTP path so a regression in the x-user-agent -> x_user_agent wiring is caught.
+# Mixed header casing asserts the lookup stays case-insensitive.
+ "headers, expected",
+ [
+ ({"x-user-agent": "skyvern-ui"}, WorkflowRunTriggerType.manual),
+ ({"X-User-Agent": "skyvern-mcp"}, WorkflowRunTriggerType.manual),
+ ({}, WorkflowRunTriggerType.api),
+ ({"x-user-agent": "python-sdk/1.0"}, WorkflowRunTriggerType.api),
+ ],
+)
+def test_test_credential_endpoint_wires_user_agent_header(
+ monkeypatch: pytest.MonkeyPatch,
+ headers: dict[str, str],
+ expected: WorkflowRunTriggerType,
+) -> None:
+ setup_mock = _setup_mock()
+ mock_credentials = SimpleNamespace(
+ get_credential=AsyncMock(
+ return_value=SimpleNamespace(
+ credential_type=CredentialType.PASSWORD,
+ browser_profile_id=None,
+ totp_identifier=None,
+ name="Test Credential",
+ )
+ )
+ )
+ monkeypatch.setattr(credentials.app, "DATABASE", SimpleNamespace(credentials=mock_credentials))
+ monkeypatch.setattr(credentials.app, "WORKFLOW_SERVICE", _workflow_service(setup_mock))
+ _patch_executor(monkeypatch)
+
+ app = FastAPI()
+ app.add_api_route("/credentials/{credential_id}/test", credentials.test_credential, methods=["POST"])
+ app.dependency_overrides[org_auth_service.get_current_org] = _auth_override
+
+ resp = TestClient(app).post(
+ "/credentials/cred_test/test",
+ json={"url": "https://example.com/login", "save_browser_profile": False},
+ headers=headers,
+ )
+
+ assert resp.status_code == 200
+ setup_mock.assert_awaited_once()
+ assert setup_mock.call_args.kwargs["trigger_type"] == expected
+
+
+ "headers, expected",
+ [
+ ({"x-user-agent": "skyvern-ui"}, WorkflowRunTriggerType.manual),
+ ({}, WorkflowRunTriggerType.api),
+ ],
+)
+def test_test_login_endpoint_wires_user_agent_header(
+ monkeypatch: pytest.MonkeyPatch,
+ headers: dict[str, str],
+ expected: WorkflowRunTriggerType,
+) -> None:
+ setup_mock = _setup_mock()
+ vault_service = SimpleNamespace(
+ create_credential=AsyncMock(
+ return_value=SimpleNamespace(vault_type=None, credential_id="cred_test", totp_identifier=None)
+ )
+ )
+ monkeypatch.setattr(credentials, "_get_credential_vault_service", AsyncMock(return_value=vault_service))
+ monkeypatch.setattr(credentials, "_create_browser_profile_after_workflow", AsyncMock())
+ monkeypatch.setattr(credentials.app, "WORKFLOW_SERVICE", _workflow_service(setup_mock))
+ _patch_executor(monkeypatch)
+
+ app = FastAPI()
+ app.add_api_route("/credentials/test-login", credentials.test_login, methods=["POST"])
+ app.dependency_overrides[org_auth_service.get_current_org] = _auth_override
+
+ resp = TestClient(app).post(
+ "/credentials/test-login",
+ json={"url": "https://example.com/login", "username": "[email protected]", "password": "pw"},
+ headers=headers,
+ )
+
+ assert resp.status_code == 200
+ setup_mock.assert_awaited_once()
+ assert setup_mock.call_args.kwargs["trigger_type"] == expected