Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Clarify credential lookup errors (#5872)
Suchintaneb4a1c6943f1
diff --git a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsxindex 9e5f6345e..5bfddc972 100644--- a/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx+++ b/skyvern-frontend/src/routes/workflows/editor/panels/WorkflowParameterEditPanel.tsx@@ -609,7 +609,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">Bitwarden Collection ID</Label>- <HelpTooltip content="The Bitwarden collection ID. You can find this in the URL when viewing a collection in Bitwarden (e.g., https://vault.bitwarden.com/#/organizations/.../collections/[COLLECTION_ID])." />+ <HelpTooltip content="Find in the Bitwarden collection URL. Supports workflow parameters." /></div><Inputvalue={bitwardenCollectionId}@@ -621,7 +621,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">Bitwarden Item ID</Label>- <HelpTooltip content="The Bitwarden item ID. You can find this in the URL when viewing the item in Bitwarden (e.g., https://vault.bitwarden.com/#/vault?itemId=[ITEM_ID])." />+ <HelpTooltip content="Find in /#/vault?itemId=[ITEM_ID]. Supports workflow parameters." /></div><Inputvalue={bitwardenLoginCredentialItemId}@@ -641,7 +641,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">Bitwarden Collection ID</Label>- <HelpTooltip content="Required. The Bitwarden collection ID containing the identity item. You can find this in the URL when viewing a collection in Bitwarden." />+ <HelpTooltip content="Collection containing the identity, such as {{ parameter_name }}." /></div><Inputvalue={bitwardenCollectionId}@@ -651,7 +651,7 @@ function WorkflowParameterEditPanel({<div className="space-y-1"><div className="flex gap-2"><Label className="text-xs text-slate-300">Identity Key</Label>- <HelpTooltip content="The key used to identify which identity to use from Bitwarden (e.g., the identity name or a custom identifier)." />+ <HelpTooltip content="Identity name or identifier, such as {{ parameter_name }}." /></div><Inputvalue={identityKey}@@ -682,7 +682,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">Bitwarden Collection ID</Label>- <HelpTooltip content="Required. The Bitwarden collection ID containing the credit card. You can find this in the URL when viewing a collection in Bitwarden." />+ <HelpTooltip content="Collection containing the credit card. Supports workflow parameters." /></div><Inputvalue={bitwardenCollectionId}@@ -694,7 +694,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">Bitwarden Item ID</Label>- <HelpTooltip content="Required. The Bitwarden item ID of the credit card. You can find this in the URL when viewing the item in Bitwarden." />+ <HelpTooltip content="Credit card item ID. Supports workflow parameters." /></div><Inputvalue={sensitiveInformationItemId}@@ -714,7 +714,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">1Password Vault ID</Label>- <HelpTooltip content="You can find the Vault ID in the URL when viewing the vault in 1Password on the web (e.g., https://my.1password.com/vaults/[VAULT_ID])." />+ <HelpTooltip content="Find this in the 1Password vault URL. Supports workflow parameters." /></div><Inputvalue={opVaultId}@@ -726,7 +726,7 @@ function WorkflowParameterEditPanel({<Label className="text-xs text-slate-300">1Password Item ID</Label>- <HelpTooltip content="You can find the Item ID in the URL when viewing the item in 1Password on the web. Supports all item types: Logins, Passwords, Credit Cards, Secure Notes, and more." />+ <HelpTooltip content="Find this in the 1Password item URL. Supports workflow parameters." /></div><Inputvalue={opItemId}diff --git a/skyvern/exceptions.py b/skyvern/exceptions.pyindex 244fead42..0b8956556 100644--- a/skyvern/exceptions.py+++ b/skyvern/exceptions.py@@ -611,13 +611,16 @@ class OnePasswordBaseError(SkyvernException):class OnePasswordServiceUnavailableError(OnePasswordBaseError):- def __init__(self, status_code: int | None = None) -> None:+ def __init__(self, status_code: int | None = None, lookup_context: str | None = None) -> None:suffix = f" (HTTP {status_code})" if status_code else ""- super().__init__(+ message = (f"1Password is currently unavailable{suffix}. ""This is an upstream outage on 1Password's side, not a Skyvern issue. ""Please retry in a few minutes.")+ if lookup_context:+ message = f"{message} {lookup_context}"+ super().__init__(message)class OnePasswordRateLimitError(OnePasswordBaseError):diff --git a/skyvern/forge/sdk/workflow/context_manager.py b/skyvern/forge/sdk/workflow/context_manager.pyindex 3618db6cf..59ff89e0c 100644--- a/skyvern/forge/sdk/workflow/context_manager.py+++ b/skyvern/forge/sdk/workflow/context_manager.py@@ -693,6 +693,7 @@ class WorkflowRunContext:item_id = self._resolve_required_parameter_value(parameter.item_id, "OnePassword Item ID")vault_id = self._resolve_required_parameter_value(parameter.vault_id, "OnePassword Vault ID")+ lookup_context = self._format_resolved_lookup_context("1Password", vault_id=vault_id, item_id=item_id)try:client = await OnePasswordClient.authenticate(auth=token,@@ -701,21 +702,24 @@ class WorkflowRunContext:)item = await client.items.get(vault_id, item_id)except RateLimitExceededException as e:- raise OnePasswordRateLimitError(str(e)) from e+ raise OnePasswordRateLimitError(f"{str(e)} {lookup_context}") from eexcept DesktopSessionExpiredException as e:- raise OnePasswordSessionExpiredError(str(e)) from e+ raise OnePasswordSessionExpiredError(f"{str(e)} {lookup_context}") from eexcept Exception as e:raw = str(e)match = _ONEPASSWORD_5XX_PATTERN.search(raw)if match:status_digits = match.group(1) or match.group(2)- raise OnePasswordServiceUnavailableError(status_code=int(status_digits)) from e- raise OnePasswordGetItemError(raw) from e+ raise OnePasswordServiceUnavailableError(+ status_code=int(status_digits),+ lookup_context=lookup_context,+ ) from e+ raise OnePasswordGetItemError(f"{raw} {lookup_context}") from e# Check if item is Noneif item is None:- LOG.error(f"No item found for vault_id:{parameter.vault_id}, item_id:{parameter.item_id}")- raise ValueError(f"1Password item not found: vault_id:{parameter.vault_id}, item_id:{parameter.item_id}")+ LOG.error("No 1Password item found", vault_id=vault_id, item_id=item_id)+ raise ValueError(f"1Password item not found. {lookup_context}")self.parameters[parameter.key] = parameterself.values[parameter.key] = {@@ -910,6 +914,11 @@ class WorkflowRunContext:collection_id = self._resolve_parameter_value(parameter.bitwarden_collection_id)item_id = self._resolve_parameter_value(parameter.bitwarden_item_id)+ lookup_context = self._format_resolved_lookup_context(+ "Bitwarden",+ collection_id=collection_id,+ item_id=item_id,+ )async def fetch_secret_credentials(client_id: str | None,@@ -968,6 +977,7 @@ class WorkflowRunContext:self.values[parameter.key]["totp"] = totp_secret_idexcept BitwardenBaseError as e:+ self._append_lookup_context_to_exception(e, lookup_context)LOG.error(f"Failed to get secret from Bitwarden. Error: {e}")raise e@@ -1025,13 +1035,18 @@ class WorkflowRunContext:parameter: BitwardenSensitiveInformationParameter,organization: Organization,) -> None:- bitwarden_identity_key = parameter.bitwarden_identity_key- if self.has_parameter(parameter.bitwarden_identity_key) and self.has_value(parameter.bitwarden_identity_key):- bitwarden_identity_key = self.values[parameter.bitwarden_identity_key]-- collection_id = parameter.bitwarden_collection_id- if self.has_parameter(parameter.bitwarden_collection_id) and self.has_value(parameter.bitwarden_collection_id):- collection_id = self.values[parameter.bitwarden_collection_id]+ bitwarden_identity_key = self._resolve_required_parameter_value(+ parameter.bitwarden_identity_key,+ "Bitwarden Identity Key",+ )+ collection_id = self._resolve_required_parameter_value(+ parameter.bitwarden_collection_id,+ "Bitwarden Collection ID",+ )+ lookup_context = self._format_resolved_lookup_context(+ "Bitwarden",+ collection_id=collection_id,+ )async def fetch_sensitive_values(client_id: str | None,@@ -1078,6 +1093,7 @@ class WorkflowRunContext:self.values[parameter.key][key] = secret_idexcept BitwardenBaseError as e:+ self._append_lookup_context_to_exception(e, lookup_context)LOG.error(f"Failed to get sensitive information from Bitwarden. Error: {e}")raise e@@ -1086,15 +1102,19 @@ class WorkflowRunContext:parameter: BitwardenCreditCardDataParameter,organization: Organization,) -> None:- 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:- item_id = parameter.bitwarden_item_id-- if self.has_parameter(parameter.bitwarden_collection_id) and self.has_value(parameter.bitwarden_collection_id):- collection_id = self.values[parameter.bitwarden_collection_id]- else:- collection_id = parameter.bitwarden_collection_id+ item_id = self._resolve_required_parameter_value(+ parameter.bitwarden_item_id,+ "Bitwarden Item ID",+ )+ collection_id = self._resolve_required_parameter_value(+ parameter.bitwarden_collection_id,+ "Bitwarden Collection ID",+ )+ lookup_context = self._format_resolved_lookup_context(+ "Bitwarden",+ collection_id=collection_id,+ item_id=item_id,+ )async def fetch_credit_card_data(client_id: str | None,@@ -1121,7 +1141,7 @@ class WorkflowRunContext:)client_id, client_secret, master_password, email = credentialsif not credit_card_data:- raise ValueError("Credit card data not found in Bitwarden")+ raise ValueError(f"Credit card data not found in Bitwarden. {lookup_context}")self.secrets[BitwardenConstants.CLIENT_ID] = client_idself.secrets[BitwardenConstants.CLIENT_SECRET] = client_secret@@ -1157,6 +1177,7 @@ class WorkflowRunContext:self.parameters[parameter.key] = parameterexcept BitwardenBaseError as e:+ self._append_lookup_context_to_exception(e, lookup_context)LOG.error(f"Failed to get credit card data from Bitwarden. Error: {e}")raise e@@ -1372,6 +1393,21 @@ class WorkflowRunContext:return parameter_keyreturn None+ @staticmethod+ def _format_resolved_lookup_context(provider: str, **identifiers: str | None) -> str:+ resolved_identifiers = ", ".join(+ f"{key}={sanitize_credential_for_error(value) if value else '<not provided>'}"+ for key, value in identifiers.items()+ )+ return f"Resolved {provider} credential identifiers: {resolved_identifiers}."++ @staticmethod+ def _append_lookup_context_to_exception(error: SkyvernException, lookup_context: str) -> None:+ message = error.message if error.message is not None else str(error)+ if lookup_context not in message:+ error.message = f"{message} {lookup_context}"+ error.args = (error.message,)+def _resolve_required_parameter_value(self, parameter_value: str | None, name: str) -> str:result = self._resolve_parameter_value(parameter_value)if not result:diff --git a/tests/unit/test_workflow_onepassword_errors.py b/tests/unit/test_workflow_onepassword_errors.pyindex 86bab61f8..0f88e5ba5 100644--- a/tests/unit/test_workflow_onepassword_errors.py+++ b/tests/unit/test_workflow_onepassword_errors.py@@ -31,14 +31,14 @@ def _make_context() -> WorkflowRunContext:)-def _make_parameter() -> OnePasswordCredentialParameter:+def _make_parameter(vault_id: str = "vault123", item_id: str = "item123") -> OnePasswordCredentialParameter:now = datetime.now(timezone.utc)return OnePasswordCredentialParameter(key="op_cred",onepassword_credential_parameter_id="opcp_test",workflow_id="wf-id",- vault_id="vault123",- item_id="item123",+ vault_id=vault_id,+ item_id=item_id,created_at=now,modified_at=now,)@@ -148,6 +148,34 @@ async def test_onepassword_generic_error_falls_back_to_get_item_error(mocked_appassert "1Password" in exc_info.value.message+async def test_onepassword_error_includes_resolved_vault_and_item_ids(+ mocked_app_database,+ patched_settings_token,+):+ ctx = _make_context()+ ctx.values["vault_param"] = "resolved-vault-id"+ ctx.values["item_param"] = "resolved-item-id"++ with patch(+ "skyvern.forge.sdk.workflow.context_manager.OnePasswordClient.authenticate",+ new_callable=AsyncMock,+ side_effect=Exception("lookup failed"),+ ):+ with pytest.raises(OnePasswordGetItemError) as exc_info:+ await ctx.register_onepassword_credential_parameter_value(+ _make_parameter(vault_id="{{ vault_param }}", item_id="{{ item_param }}"),+ _make_organization(),+ )++ message = exc_info.value.message+ assert "vault_id=resolved-vault-id" in message+ assert "item_id=resolved-item-id" in message+ assert "{{ vault_param }}" not in message+ assert "{{ item_param }}" not in message+ assert "fake-token" not in message++@pytest.mark.asyncioasync def test_onepassword_incidental_5xx_digits_do_not_trigger_service_unavailable(mocked_app_database, patched_settings_tokendiff --git a/tests/unit/workflow/test_bitwarden_email_auth_fallback.py b/tests/unit/workflow/test_bitwarden_email_auth_fallback.pyindex 0320e3def..35fd61a81 100644--- a/tests/unit/workflow/test_bitwarden_email_auth_fallback.py+++ b/tests/unit/workflow/test_bitwarden_email_auth_fallback.py@@ -6,7 +6,11 @@ import pytestfrom skyvern.exceptions import BitwardenListItemsErrorfrom skyvern.forge.sdk.workflow import context_manager as cmfrom skyvern.forge.sdk.workflow.context_manager import WorkflowRunContext-from skyvern.forge.sdk.workflow.models.parameter import BitwardenLoginCredentialParameter+from skyvern.forge.sdk.workflow.models.parameter import (+ BitwardenCreditCardDataParameter,+ BitwardenLoginCredentialParameter,+ BitwardenSensitiveInformationParameter,+)@pytest.mark.asyncio@@ -125,3 +129,268 @@ async def test_org_email_bitwarden_auth_falls_back_to_global_credentials(stored = context.values["bitwarden_login"]assert stored["username"].endswith("_username")assert stored["password"].endswith("_password")+++async def test_bitwarden_login_error_includes_resolved_collection_and_item_ids(+ monkeypatch: pytest.MonkeyPatch,+) -> None:+ class FakeOrganizationsRepo:+ async def get_valid_org_auth_token(self, organization_id: str, token_type: str) -> object | None:+ assert organization_id == "org-1"+ assert token_type == "bitwarden_credential"+ return None++ class FakeDatabase:+ def __init__(self) -> None:+ self.organizations = FakeOrganizationsRepo()++ monkeypatch.setattr(cm, "app", SimpleNamespace(DATABASE=FakeDatabase()))+ monkeypatch.setattr(+ cm,+ "settings",+ SimpleNamespace(+ BITWARDEN_CLIENT_ID="global-client-id",+ BITWARDEN_CLIENT_SECRET="global-client-secret",+ BITWARDEN_MASTER_PASSWORD="global-master-password",+ BITWARDEN_EMAIL=None,+ ),+ )++ 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]:+ assert collection_id == "resolved-collection-id"+ assert item_id == "resolved-item-id"+ raise BitwardenListItemsError("lookup failed")++ 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"+ context.values["collection_param"] = "resolved-collection-id"+ context.values["item_param"] = "resolved-item-id"++ 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="{{ collection_param }}",+ bitwarden_item_id="{{ item_param }}",+ 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=["resolved-collection-id"],+ )++ with pytest.raises(BitwardenListItemsError) as exc_info:+ await context.register_bitwarden_login_credential_parameter_value(parameter, organization)++ message = exc_info.value.message+ assert "collection_id=resolved-collection-id" in message+ assert "item_id=resolved-item-id" in message+ assert "{{ collection_param }}" not in message+ assert "{{ item_param }}" not in message+ assert "global-client-secret" not in message+ assert "global-master-password" not in message+++async def test_bitwarden_sensitive_information_resolves_collection_and_identity_parameters(+ monkeypatch: pytest.MonkeyPatch,+) -> None:+ class FakeOrganizationsRepo:+ async def get_valid_org_auth_token(self, organization_id: str, token_type: str) -> object | None:+ assert organization_id == "org-1"+ assert token_type == "bitwarden_credential"+ return None++ class FakeDatabase:+ def __init__(self) -> None:+ self.organizations = FakeOrganizationsRepo()++ monkeypatch.setattr(cm, "app", SimpleNamespace(DATABASE=FakeDatabase()))+ monkeypatch.setattr(+ cm,+ "settings",+ SimpleNamespace(+ BITWARDEN_CLIENT_ID="global-client-id",+ BITWARDEN_CLIENT_SECRET="global-client-secret",+ BITWARDEN_MASTER_PASSWORD="global-master-password",+ BITWARDEN_EMAIL=None,+ ),+ )++ async def fake_get_sensitive_information_from_identity(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ bw_organization_id: str | None,+ bw_collection_ids: list[str] | None,+ collection_id: str,+ identity_key: str,+ identity_fields: list[str],+ remaining_retries: int = 2,+ timeout: int = 60,+ fail_reasons: list[str] | None = None,+ email: str | None = None,+ ) -> dict[str, str]:+ assert collection_id == "resolved-collection-id"+ assert identity_key == "resolved-identity-key"+ assert identity_fields == ["ssn"]+ raise BitwardenListItemsError("lookup failed")++ monkeypatch.setattr(+ cm.BitwardenService,+ "get_sensitive_information_from_identity",+ fake_get_sensitive_information_from_identity,+ )++ context = WorkflowRunContext(+ workflow_title="title",+ workflow_id="wf-1",+ workflow_permanent_id="wfp-1",+ workflow_run_id="wr-1",+ aws_client=SimpleNamespace(),+ )+ context.values["collection_param"] = "resolved-collection-id"+ context.values["identity_param"] = "resolved-identity-key"++ parameter = BitwardenSensitiveInformationParameter(+ key="bitwarden_identity",+ description="Bitwarden identity",+ bitwarden_sensitive_information_parameter_id="bsi_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",+ bitwarden_collection_id="{{ collection_param }}",+ bitwarden_identity_key="{{ identity_param }}",+ bitwarden_identity_fields=["ssn"],+ 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=["resolved-collection-id"],+ )++ with pytest.raises(BitwardenListItemsError) as exc_info:+ await context.register_bitwarden_sensitive_information_parameter_value(parameter, organization)++ message = exc_info.value.message+ assert "collection_id=resolved-collection-id" in message+ assert "{{ collection_param }}" not in message+ assert "{{ identity_param }}" not in message+ assert "global-client-secret" not in message+ assert "global-master-password" not in message+++async def test_bitwarden_credit_card_resolves_collection_and_item_parameters(+ monkeypatch: pytest.MonkeyPatch,+) -> None:+ class FakeOrganizationsRepo:+ async def get_valid_org_auth_token(self, organization_id: str, token_type: str) -> object | None:+ assert organization_id == "org-1"+ assert token_type == "bitwarden_credential"+ return None++ class FakeDatabase:+ def __init__(self) -> None:+ self.organizations = FakeOrganizationsRepo()++ monkeypatch.setattr(cm, "app", SimpleNamespace(DATABASE=FakeDatabase()))+ monkeypatch.setattr(+ cm,+ "settings",+ SimpleNamespace(+ BITWARDEN_CLIENT_ID="global-client-id",+ BITWARDEN_CLIENT_SECRET="global-client-secret",+ BITWARDEN_MASTER_PASSWORD="global-master-password",+ BITWARDEN_EMAIL=None,+ ),+ )++ async def fake_get_credit_card_data(+ client_id: str | None,+ client_secret: str | None,+ master_password: str,+ bw_organization_id: str | None,+ bw_collection_ids: list[str] | None,+ collection_id: str,+ item_id: str,+ remaining_retries: int = 2,+ fail_reasons: list[str] | None = None,+ email: str | None = None,+ ) -> dict[str, str]:+ assert collection_id == "resolved-collection-id"+ assert item_id == "resolved-item-id"+ raise BitwardenListItemsError("lookup failed")++ monkeypatch.setattr(cm.BitwardenService, "get_credit_card_data", fake_get_credit_card_data)++ context = WorkflowRunContext(+ workflow_title="title",+ workflow_id="wf-1",+ workflow_permanent_id="wfp-1",+ workflow_run_id="wr-1",+ aws_client=SimpleNamespace(),+ )+ context.values["collection_param"] = "resolved-collection-id"+ context.values["item_param"] = "resolved-item-id"++ parameter = BitwardenCreditCardDataParameter(+ key="bitwarden_card",+ description="Bitwarden credit card",+ bitwarden_credit_card_data_parameter_id="bcc_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",+ bitwarden_collection_id="{{ collection_param }}",+ bitwarden_item_id="{{ item_param }}",+ 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=["resolved-collection-id"],+ )++ with pytest.raises(BitwardenListItemsError) as exc_info:+ await context.register_bitwarden_credit_card_data_parameter_value(parameter, organization)++ message = exc_info.value.message+ assert "collection_id=resolved-collection-id" in message+ assert "item_id=resolved-item-id" in message+ assert "{{ collection_param }}" not in message+ assert "{{ item_param }}" not in message+ assert "global-client-secret" not in message+ assert "global-master-password" not in message