Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Add Bitwarden email-auth fallback to global credentials on timeout (#5231)
Suchintan9d2c2543c1bd
diff --git a/skyvern/forge/sdk/services/bitwarden.py b/skyvern/forge/sdk/services/bitwarden.pyindex 2349736a9..e978315b6 100644--- a/skyvern/forge/sdk/services/bitwarden.py+++ b/skyvern/forge/sdk/services/bitwarden.py@@ -159,6 +159,26 @@ class RunCommandResult(BaseModel):class BitwardenService:+ @staticmethod+ def _is_ignorable_login_stderr(stderr: str) -> bool:+ lines = [line.strip() for line in stderr.splitlines() if line.strip()]+ if not lines:+ return True++ ignorable_substrings = [+ "You are already logged in as",+ ]+ ignorable_regexes = [+ re.compile(r'^Could not find data file, ".+?/data\.json"; creating it instead\.$'),+ ]+ for line in lines:+ if any(s in line for s in ignorable_substrings):+ continue+ if any(r.match(line) for r in ignorable_regexes):+ continue+ return False+ return True+@staticmethodasync def _apply_jitter() -> None:"""Apply random jitter delay to spread out concurrent Bitwarden CLI requests."""@@ -602,7 +622,7 @@ class BitwardenService:if login_result.stdout and "You are logged in!" not in login_result.stdout:raise BitwardenLoginError(f"Failed to log in. stdout: {login_result.stdout} stderr: {login_result.stderr}")- if login_result.stderr and "You are already logged in as" not in login_result.stderr:+ if login_result.stderr and not BitwardenService._is_ignorable_login_stderr(login_result.stderr):raise BitwardenLoginError(f"Failed to log in. stdout: {login_result.stdout} stderr: {login_result.stderr}")LOG.info("Bitwarden login successful")diff --git a/skyvern/forge/sdk/workflow/context_manager.py b/skyvern/forge/sdk/workflow/context_manager.pyindex 592684a2b..df0d3f421 100644--- a/skyvern/forge/sdk/workflow/context_manager.py+++ b/skyvern/forge/sdk/workflow/context_manager.py@@ -1,5 +1,5 @@import copy-from typing import TYPE_CHECKING, Any, Self+from typing import TYPE_CHECKING, Any, Awaitable, Callable, Selfimport structlogfrom jinja2.sandbox import SandboxedEnvironment@@ -52,6 +52,7 @@ if TYPE_CHECKING:LOG = structlog.get_logger()BlockMetadata = dict[str, str | int | float | bool | dict | list | None]+BitwardenCredentials = tuple[str | None, str | None, str | None, str | None]jinja_sandbox_env = SandboxedEnvironment()@@ -605,39 +606,12 @@ class WorkflowRunContext:if item.notes:self._add_secret_parameter_value(parameter, "notes", item.notes)- async def _get_bitwarden_credentials(+ async def _get_global_bitwarden_credentials(self,- organization: Organization,parameter: BitwardenLoginCredentialParameter| BitwardenSensitiveInformationParameter| BitwardenCreditCardDataParameter,- ) -> tuple[str | None, str | None, str | None, str | None]:- """Get Bitwarden credentials, checking org-level token first, then falling back to env vars / AWS secrets.-- Returns: (client_id, client_secret, master_password, email)-- Priority order:- 1. Per-org Bitwarden credential (from organization_auth_tokens table) — always wins if present- 2. Global env vars (BITWARDEN_CLIENT_ID, etc.) or AWS secrets (from workflow parameter keys)-- When an org-level token is configured with email auth, client_id and client_secret will be None- and the email will be used for `bw login <email> --passwordenv BW_PASSWORD`. To fall back to- env vars / AWS secrets for a specific workflow, the org-level credential must be deleted.- """- # Check for per-org Bitwarden credential first- org_bw_token = await app.DATABASE.get_valid_org_auth_token(- organization_id=organization.organization_id,- token_type=OrganizationAuthTokenType.bitwarden_credential.value,- )- if org_bw_token:- return (- None, # client_id — not used in email auth- None, # client_secret — not used in email auth- org_bw_token.credential.master_password,- org_bw_token.credential.email,- )-- # Fall back to env vars / AWS secrets+ ) -> BitwardenCredentials:try:client_id = settings.BITWARDEN_CLIENT_ID or await self._aws_client.get_secret(parameter.bitwarden_client_id_aws_secret_key@@ -654,15 +628,51 @@ class WorkflowRunContext:return client_id, client_secret, master_password, None- async def register_bitwarden_login_credential_parameter_value(+ async def _get_bitwarden_credential_candidates(self,- parameter: BitwardenLoginCredentialParameter,organization: Organization,- ) -> None:- client_id, client_secret, master_password, email = await self._get_bitwarden_credentials(- organization, parameter+ parameter: BitwardenLoginCredentialParameter+ | BitwardenSensitiveInformationParameter+ | BitwardenCreditCardDataParameter,+ ) -> list[BitwardenCredentials]:+ org_bw_token = await app.DATABASE.get_valid_org_auth_token(+ organization_id=organization.organization_id,+ token_type=OrganizationAuthTokenType.bitwarden_credential.value,)+ if not org_bw_token:+ return [await self._get_global_bitwarden_credentials(parameter)]++ candidates: list[BitwardenCredentials] = [+ (+ None,+ None,+ org_bw_token.credential.master_password,+ org_bw_token.credential.email,+ )+ ]++ try:+ global_credentials = await self._get_global_bitwarden_credentials(parameter)+ except Exception:+ LOG.info(+ "Global Bitwarden fallback credentials are unavailable",+ organization_id=organization.organization_id,+ )+ global_credentials = None++ if global_credentials and global_credentials not in candidates:+ candidates.append(global_credentials)++ return candidates++ @staticmethod+ def _validate_bitwarden_credentials(+ client_id: str | None,+ client_secret: str | None,+ master_password: str | None,+ email: str | None,+ ) -> None:if not client_id and not email and not settings.BITWARDEN_EMAIL:raise ValueError("Bitwarden client ID not found")if not client_secret and not email and not settings.BITWARDEN_EMAIL:@@ -670,6 +680,57 @@ class WorkflowRunContext:if not master_password:raise ValueError("Bitwarden master password not found")+ @staticmethod+ def _should_retry_bitwarden_with_global_credentials(error: BitwardenBaseError) -> bool:+ error_message = str(error).lower()+ return (+ "timeouterror" in error_message+ or "timed out" in error_message+ or "new device verification" in error_message+ )++ async def _run_bitwarden_operation_with_fallback(+ self,+ organization: Organization,+ parameter: BitwardenLoginCredentialParameter+ | BitwardenSensitiveInformationParameter+ | BitwardenCreditCardDataParameter,+ operation: Callable[[str | None, str | None, str, str | None], Awaitable[Any]],+ ) -> tuple[Any, BitwardenCredentials]:+ candidates = await self._get_bitwarden_credential_candidates(organization, parameter)+ last_error: BitwardenBaseError | None = None++ for index, credentials in enumerate(candidates):+ client_id, client_secret, master_password, email = credentials+ self._validate_bitwarden_credentials(client_id, client_secret, master_password, email)+ assert master_password++ try:+ result = await operation(client_id, client_secret, master_password, email)+ return result, credentials+ except BitwardenBaseError as error:+ last_error = error+ has_fallback = index + 1 < len(candidates)+ if email and has_fallback and self._should_retry_bitwarden_with_global_credentials(error):+ LOG.warning(+ "Org-level Bitwarden email auth failed, retrying with global Bitwarden credentials",+ organization_id=organization.organization_id,+ workflow_id=parameter.workflow_id,+ parameter_key=parameter.key,+ error=str(error),+ )+ continue+ raise++ if last_error is not None:+ raise last_error+ raise ValueError("No Bitwarden credential candidates available")++ async def register_bitwarden_login_credential_parameter_value(+ self,+ parameter: BitwardenLoginCredentialParameter,+ organization: Organization,+ ) -> None:url = self._resolve_parameter_value(parameter.url_parameter_key)if not url and not parameter.bitwarden_item_id:LOG.error(f"URL parameter {parameter.url_parameter_key} not found or has no value")@@ -678,8 +739,13 @@ class WorkflowRunContext:collection_id = self._resolve_parameter_value(parameter.bitwarden_collection_id)item_id = self._resolve_parameter_value(parameter.bitwarden_item_id)- try:- secret_credentials = await BitwardenService.get_secret_value_from_url(+ async def fetch_secret_credentials(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ email: str | None,+ ) -> dict[str, str]:+ return await BitwardenService.get_secret_value_from_url(client_id,client_secret,master_password,@@ -690,6 +756,14 @@ class WorkflowRunContext:item_id=item_id,email=email,)++ try:+ secret_credentials, credentials = await self._run_bitwarden_operation_with_fallback(+ organization,+ parameter,+ fetch_secret_credentials,+ )+ client_id, client_secret, master_password, email = credentialsif secret_credentials:self.secrets[BitwardenConstants.BW_ORGANIZATION_ID] = organization.bw_organization_idself.secrets[BitwardenConstants.BW_COLLECTION_IDS] = organization.bw_collection_ids@@ -779,17 +853,6 @@ class WorkflowRunContext:parameter: BitwardenSensitiveInformationParameter,organization: Organization,) -> None:- client_id, client_secret, master_password, email = await self._get_bitwarden_credentials(- organization, parameter- )-- if not client_id and not email and not settings.BITWARDEN_EMAIL:- raise ValueError("Bitwarden client ID not found")- if not client_secret and not email and not settings.BITWARDEN_EMAIL:- raise ValueError("Bitwarden client secret not found")- if not master_password:- raise ValueError("Bitwarden master password not found")-bitwarden_identity_key = parameter.bitwarden_identity_keyif self.has_parameter(parameter.bitwarden_identity_key) and self.has_value(parameter.bitwarden_identity_key):bitwarden_identity_key = self.values[parameter.bitwarden_identity_key]@@ -798,8 +861,13 @@ class WorkflowRunContext:if self.has_parameter(parameter.bitwarden_collection_id) and self.has_value(parameter.bitwarden_collection_id):collection_id = self.values[parameter.bitwarden_collection_id]- try:- sensitive_values = await BitwardenService.get_sensitive_information_from_identity(+ async def fetch_sensitive_values(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ email: str | None,+ ) -> dict[str, str]:+ return await BitwardenService.get_sensitive_information_from_identity(client_id,client_secret,master_password,@@ -810,6 +878,14 @@ class WorkflowRunContext:parameter.bitwarden_identity_fields,email=email,)++ try:+ sensitive_values, credentials = await self._run_bitwarden_operation_with_fallback(+ organization,+ parameter,+ fetch_sensitive_values,+ )+ client_id, client_secret, master_password, email = credentialsif sensitive_values:self.secrets[BitwardenConstants.BW_ORGANIZATION_ID] = organization.bw_organization_idself.secrets[BitwardenConstants.BW_COLLECTION_IDS] = organization.bw_collection_ids@@ -838,17 +914,6 @@ class WorkflowRunContext:parameter: BitwardenCreditCardDataParameter,organization: Organization,) -> None:- client_id, client_secret, master_password, email = await self._get_bitwarden_credentials(- organization, parameter- )-- if not client_id and not email and not settings.BITWARDEN_EMAIL:- raise ValueError("Bitwarden client ID not found")- if not client_secret and not email and not settings.BITWARDEN_EMAIL:- raise ValueError("Bitwarden client secret not found")- if not master_password:- raise ValueError("Bitwarden master password not found")-if self.has_parameter(parameter.bitwarden_item_id) and self.has_value(parameter.bitwarden_item_id):item_id = self.values[parameter.bitwarden_item_id]else:@@ -859,8 +924,13 @@ class WorkflowRunContext:else:collection_id = parameter.bitwarden_collection_id- try:- credit_card_data = await BitwardenService.get_credit_card_data(+ async def fetch_credit_card_data(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ email: str | None,+ ) -> dict[str, str]:+ return await BitwardenService.get_credit_card_data(client_id,client_secret,master_password,@@ -870,6 +940,14 @@ class WorkflowRunContext:item_id,email=email,)++ try:+ credit_card_data, credentials = await self._run_bitwarden_operation_with_fallback(+ organization,+ parameter,+ fetch_credit_card_data,+ )+ client_id, client_secret, master_password, email = credentialsif not credit_card_data:raise ValueError("Credit card data not found in Bitwarden")diff --git a/tests/unit/test_bitwarden_login.py b/tests/unit/test_bitwarden_login.pynew file mode 100644index 000000000..b0f179371--- /dev/null+++ b/tests/unit/test_bitwarden_login.py@@ -0,0 +1,19 @@+import pytest++from skyvern.forge.sdk.services.bitwarden import BitwardenService, RunCommandResult+++async def test_login_ignores_data_file_creation_notice_on_stderr(+ monkeypatch: pytest.MonkeyPatch,+) -> None:+ async def fake_run_command(*args, **kwargs) -> RunCommandResult:+ return RunCommandResult(+ stdout="You are logged in!\n\nTo unlock your vault, use the `unlock` command.",+ stderr='Could not find data file, "/tmp/bitwarden/data.json"; creating it instead.\n',+ returncode=0,+ )++ monkeypatch.setattr(BitwardenService, "run_command", fake_run_command)++ await BitwardenService.login("client-id", "client-secret", master_password="master-password")diff --git a/tests/unit/workflow/test_bitwarden_email_auth_fallback.py b/tests/unit/workflow/test_bitwarden_email_auth_fallback.pynew file mode 100644index 000000000..120de1841--- /dev/null+++ b/tests/unit/workflow/test_bitwarden_email_auth_fallback.py@@ -0,0 +1,123 @@+from datetime import UTC, datetime+from types import SimpleNamespace++import pytest++from skyvern.exceptions import BitwardenListItemsError+from skyvern.forge.sdk.workflow import context_manager as cm+from skyvern.forge.sdk.workflow.context_manager import WorkflowRunContext+from skyvern.forge.sdk.workflow.models.parameter import BitwardenLoginCredentialParameter+++async def test_org_email_bitwarden_auth_falls_back_to_global_credentials(+ monkeypatch: pytest.MonkeyPatch,+) -> None:+ org_token = SimpleNamespace(+ credential=SimpleNamespace(+ email="[email protected]",+ master_password="org-master-password",+ )+ )++ class FakeDatabase:+ async def get_valid_org_auth_token(self, organization_id: str, token_type: str) -> object:+ assert organization_id == "org-1"+ assert token_type == "bitwarden_credential"+ return org_token++ fake_app = SimpleNamespace(DATABASE=FakeDatabase())+ monkeypatch.setattr(cm, "app", fake_app)++ fake_settings = SimpleNamespace(+ BITWARDEN_CLIENT_ID="global-client-id",+ BITWARDEN_CLIENT_SECRET="global-client-secret",+ BITWARDEN_MASTER_PASSWORD="global-master-password",+ BITWARDEN_EMAIL=None,+ )+ monkeypatch.setattr(cm, "settings", fake_settings)++ calls: list[dict[str, object]] = []++ async def fake_get_secret_value_from_url(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ bw_organization_id: str | None,+ bw_collection_ids: list[str] | None,+ url: str | None = None,+ collection_id: str | None = None,+ item_id: str | None = None,+ max_retries: int = 2,+ timeout: int = 60,+ email: str | None = None,+ ) -> dict[str, str]:+ calls.append(+ {+ "client_id": client_id,+ "client_secret": client_secret,+ "master_password": master_password,+ "email": email,+ "url": url,+ "collection_id": collection_id,+ "item_id": item_id,+ }+ )+ if len(calls) == 1:+ raise BitwardenListItemsError(+ "Bitwarden CLI failed after all retry attempts. Fail reasons: ['TimeoutError: ']"+ )+ return {+ "BW_USERNAME": "fallback-user",+ "BW_PASSWORD": "fallback-password",+ "BW_TOTP": "",+ }++ monkeypatch.setattr(cm.BitwardenService, "get_secret_value_from_url", fake_get_secret_value_from_url)++ context = WorkflowRunContext(+ workflow_title="title",+ workflow_id="wf-1",+ workflow_permanent_id="wfp-1",+ workflow_run_id="wr-1",+ aws_client=SimpleNamespace(),+ )+ context.values["target_url"] = "https://www.example.com/login"++ parameter = BitwardenLoginCredentialParameter(+ key="bitwarden_login",+ description="Bitwarden login",+ bitwarden_login_credential_parameter_id="blc_1",+ workflow_id="wf-1",+ bitwarden_client_id_aws_secret_key="unused-client-id-secret",+ bitwarden_client_secret_aws_secret_key="unused-client-secret",+ bitwarden_master_password_aws_secret_key="unused-master-password",+ url_parameter_key="target_url",+ bitwarden_collection_id=None,+ bitwarden_item_id=None,+ created_at=datetime.now(UTC),+ modified_at=datetime.now(UTC),+ )++ organization = SimpleNamespace(+ organization_id="org-1",+ bw_organization_id="bw-org-1",+ bw_collection_ids=["col-1"],+ )++ await context.register_bitwarden_login_credential_parameter_value(parameter, organization)++ assert len(calls) == 2+ assert calls[0]["email"] == "[email protected]"+ assert calls[0]["client_id"] is None+ assert calls[0]["client_secret"] is None+ assert calls[0]["master_password"] == "org-master-password"++ assert calls[1]["email"] is None+ assert calls[1]["client_id"] == "global-client-id"+ assert calls[1]["client_secret"] == "global-client-secret"+ assert calls[1]["master_password"] == "global-master-password"++ stored = context.values["bitwarden_login"]+ assert stored["username"].endswith("_username")+ assert stored["password"].endswith("_password")