Skip to content

Automate browser based workflows with AI

fix(SKY-9627): batch credential validation to reduce DB acquires (#5855)

Celal Zamanoğlu312ed6b3fd91
diff --git a/skyvern/forge/sdk/db/repositories/credentials.py b/skyvern/forge/sdk/db/repositories/credentials.py
index 8bf474854..a4e3c9906 100644
--- a/skyvern/forge/sdk/db/repositories/credentials.py
+++ b/skyvern/forge/sdk/db/repositories/credentials.py
@@ -64,6 +64,21 @@ class CredentialRepository(BaseRepository):
return Credential.model_validate(credential)
return None
+ @db_operation("get_credentials_by_ids")
+ async def get_credentials_by_ids(self, credential_ids: list[str], organization_id: str) -> list[Credential]:
+ if not credential_ids:
+ return []
+ async with self.Session() as session:
+ credentials = (
+ await session.scalars(
+ select(CredentialModel)
+ .filter(CredentialModel.credential_id.in_(credential_ids))
+ .filter_by(organization_id=organization_id)
+ .filter(CredentialModel.deleted_at.is_(None))
+ )
+ ).all()
+ return [Credential.model_validate(credential) for credential in credentials]
+
@db_operation("get_credentials")
async def get_credentials(
self,
diff --git a/skyvern/forge/sdk/workflow/service.py b/skyvern/forge/sdk/workflow/service.py
index 4c8d6c81a..402510249 100644
--- a/skyvern/forge/sdk/workflow/service.py
+++ b/skyvern/forge/sdk/workflow/service.py
@@ -685,12 +685,17 @@ class WorkflowService:
value[i] = await self._refresh_output_urls(item, organization_id, workflow_run_id)
return value
- async def _validate_credential_id(self, credential_id: str, organization: Organization) -> None:
- credential = await app.DATABASE.credentials.get_credential(
- credential_id, organization_id=organization.organization_id
+ async def _validate_credential_ids(self, credential_ids: list[str], organization: Organization) -> None:
+ if not credential_ids:
+ return
+ unique_ids = list(dict.fromkeys(credential_ids))
+ existing = await app.DATABASE.credentials.get_credentials_by_ids(
+ unique_ids, organization_id=organization.organization_id
)
- if credential is None:
- raise InvalidCredentialId(credential_id)
+ found = {credential.credential_id for credential in existing}
+ missing = [credential_id for credential_id in unique_ids if credential_id not in found]
+ if missing:
+ raise InvalidCredentialId(", ".join(missing))
async def validate_schedule_parameters(
self,
@@ -717,6 +722,7 @@ class WorkflowService:
)
missing_parameters: list[str] = []
+ credential_ids_to_validate: list[str] = []
for workflow_parameter in schedule_parameters:
if workflow_parameter.key in request_data:
request_value = request_data[workflow_parameter.key]
@@ -730,14 +736,14 @@ class WorkflowService:
if workflow_parameter.workflow_parameter_type == WorkflowParameterType.CREDENTIAL_ID:
if not isinstance(request_value, str):
raise InvalidCredentialId(f"Credential ID must be a string, got {type(request_value).__name__}")
- await self._validate_credential_id(request_value, organization)
+ credential_ids_to_validate.append(request_value)
elif workflow_parameter.default_value is not None:
if workflow_parameter.workflow_parameter_type == WorkflowParameterType.CREDENTIAL_ID:
if not isinstance(workflow_parameter.default_value, str):
raise InvalidCredentialId(
f"Credential ID must be a string, got {type(workflow_parameter.default_value).__name__}"
)
- await self._validate_credential_id(workflow_parameter.default_value, organization)
+ credential_ids_to_validate.append(workflow_parameter.default_value)
else:
missing_parameters.append(workflow_parameter.key)
@@ -749,6 +755,8 @@ class WorkflowService:
)
)
+ await self._validate_credential_ids(credential_ids_to_validate, organization)
+
async def setup_workflow_run(
self,
request_id: str | None,
@@ -911,7 +919,6 @@ class WorkflowService:
if workflow_parameter.workflow_parameter_type == WorkflowParameterType.CREDENTIAL_ID:
if not isinstance(request_body_value, str):
raise InvalidCredentialId(f"<non-string value of type {type(request_body_value).__name__}>")
- await self._validate_credential_id(request_body_value, organization)
workflow_parameter_values.append((workflow_parameter, request_body_value))
elif workflow_parameter.default_value is not None:
if workflow_parameter.workflow_parameter_type == WorkflowParameterType.CREDENTIAL_ID:
@@ -919,7 +926,6 @@ class WorkflowService:
raise InvalidCredentialId(
f"<non-string value of type {type(workflow_parameter.default_value).__name__}>"
)
- await self._validate_credential_id(workflow_parameter.default_value, organization)
workflow_parameter_values.append((workflow_parameter, workflow_parameter.default_value))
else:
missing_parameters.append(workflow_parameter.key)
@@ -932,6 +938,15 @@ class WorkflowService:
workflow_run_id=workflow_run.workflow_run_id,
)
+ await self._validate_credential_ids(
+ [
+ value
+ for (workflow_parameter, value) in workflow_parameter_values
+ if workflow_parameter.workflow_parameter_type == WorkflowParameterType.CREDENTIAL_ID
+ ],
+ organization,
+ )
+
if workflow_parameter_values:
try:
await self.create_workflow_run_parameters(
diff --git a/tests/unit/test_workflow_run_parameter_batching.py b/tests/unit/test_workflow_run_parameter_batching.py
index 25e062180..c40ed7509 100644
--- a/tests/unit/test_workflow_run_parameter_batching.py
+++ b/tests/unit/test_workflow_run_parameter_batching.py
@@ -181,6 +181,160 @@ async def test_setup_workflow_run_raises_on_non_string_credential_id() -> None:
service.create_workflow_run_parameters.assert_not_awaited()
+async def test_setup_workflow_run_batches_credential_validation() -> None:
+ """N credential parameters should issue a single get_credentials_by_ids call, not N get_credential calls."""
+ cred_params = [
+ _make_workflow_parameter(
+ f"cred_param_{i}",
+ workflow_parameter_type=WorkflowParameterType.CREDENTIAL_ID,
+ default_value=f"cred_id_{i}",
+ )
+ for i in range(3)
+ ]
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=cred_params)
+
+ request = WorkflowRequestBody(data={})
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.DATABASE.credentials.get_credentials_by_ids = AsyncMock(
+ return_value=[SimpleNamespace(credential_id=f"cred_id_{i}") for i in range(3)]
+ )
+ mock_app.DATABASE.credentials.get_credential = AsyncMock()
+
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ mock_app.DATABASE.credentials.get_credentials_by_ids.assert_awaited_once()
+ args, kwargs = mock_app.DATABASE.credentials.get_credentials_by_ids.call_args
+ passed_ids = args[0] if args else kwargs["credential_ids"]
+ assert sorted(passed_ids) == ["cred_id_0", "cred_id_1", "cred_id_2"]
+ mock_app.DATABASE.credentials.get_credential.assert_not_awaited()
+
+
+async def test_setup_workflow_run_skips_credential_lookup_when_no_credentials() -> None:
+ """Workflows without credential params should not call get_credentials_by_ids at all."""
+ string_param = _make_workflow_parameter("name", default_value="value")
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=[string_param])
+
+ request = WorkflowRequestBody(data={})
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.DATABASE.credentials.get_credentials_by_ids = AsyncMock(return_value=[])
+
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ mock_app.DATABASE.credentials.get_credentials_by_ids.assert_not_awaited()
+
+
+async def test_setup_workflow_run_raises_invalid_credential_when_missing() -> None:
+ """A single missing credential should raise InvalidCredentialId."""
+ cred_param = _make_workflow_parameter(
+ "credential",
+ workflow_parameter_type=WorkflowParameterType.CREDENTIAL_ID,
+ default_value="cred_missing",
+ )
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=[cred_param])
+
+ request = WorkflowRequestBody(data={})
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.DATABASE.credentials.get_credentials_by_ids = AsyncMock(return_value=[])
+
+ with pytest.raises(InvalidCredentialId) as exc_info:
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ assert "cred_missing" in str(exc_info.value)
+
+
+async def test_setup_workflow_run_surfaces_all_missing_credentials() -> None:
+ """When multiple credentials are missing, the error should mention every missing id."""
+ cred_params = [
+ _make_workflow_parameter(
+ f"cred_param_{i}",
+ workflow_parameter_type=WorkflowParameterType.CREDENTIAL_ID,
+ default_value=f"cred_id_{i}",
+ )
+ for i in range(3)
+ ]
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=cred_params)
+
+ request = WorkflowRequestBody(data={})
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ # Only cred_id_0 exists; cred_id_1 and cred_id_2 are missing.
+ mock_app.DATABASE.credentials.get_credentials_by_ids = AsyncMock(
+ return_value=[SimpleNamespace(credential_id="cred_id_0")]
+ )
+
+ with pytest.raises(InvalidCredentialId) as exc_info:
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ error_msg = str(exc_info.value)
+ assert "cred_id_1" in error_msg
+ assert "cred_id_2" in error_msg
+ assert "cred_id_0" not in error_msg
+
+
+async def test_setup_workflow_run_dedupes_repeated_credential_ids() -> None:
+ """Repeated credential ids across params should be deduped before the IN-query."""
+ cred_params = [
+ _make_workflow_parameter(
+ f"cred_param_{i}",
+ workflow_parameter_type=WorkflowParameterType.CREDENTIAL_ID,
+ default_value="cred_shared",
+ )
+ for i in range(3)
+ ]
+ service, organization, _ = _make_service_with_mocks(workflow_parameters=cred_params)
+
+ request = WorkflowRequestBody(data={})
+
+ with patch("skyvern.forge.sdk.workflow.service.app") as mock_app:
+ mock_app.EXPERIMENTATION_PROVIDER.is_feature_enabled_cached = AsyncMock(return_value=False)
+ mock_app.DATABASE.credentials.get_credentials_by_ids = AsyncMock(
+ return_value=[SimpleNamespace(credential_id="cred_shared")]
+ )
+
+ await service.setup_workflow_run(
+ request_id="req_test",
+ workflow_request=request,
+ workflow_permanent_id="wpid_test",
+ organization=organization,
+ )
+
+ args, kwargs = mock_app.DATABASE.credentials.get_credentials_by_ids.call_args
+ passed_ids = args[0] if args else kwargs["credential_ids"]
+ assert passed_ids == ["cred_shared"]
+
+
@pytest.mark.asyncio
async def test_setup_workflow_run_preserves_parent_loop_state_when_replacing_context() -> None:
service, organization, _ = _make_service_with_mocks(workflow_parameters=[])