Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
SKY-11165 Defer AWS session creation for missing profiles (#6680)
Andrew Neilsond3a036f59fbd
diff --git a/skyvern/forge/sdk/api/aws.py b/skyvern/forge/sdk/api/aws.pyindex 0dc5c5793..92d6417dc 100644--- a/skyvern/forge/sdk/api/aws.py+++ b/skyvern/forge/sdk/api/aws.py@@ -1,6 +1,7 @@from __future__ import annotationsimport io+import osimport timefrom enum import StrEnumfrom mimetypes import add_type, guess_type@@ -9,7 +10,7 @@ from urllib.parse import urlparseimport aioboto3import structlog-from botocore.exceptions import ClientError+from botocore.exceptions import ClientError, ProfileNotFoundfrom skyvern.config import settings@@ -50,6 +51,10 @@ class AWSClientType(StrEnum):BATCH = "batch"+class AWSSessionConfigurationError(RuntimeError):+ pass++class AsyncAWSClient:def __init__(self,@@ -64,14 +69,35 @@ class AsyncAWSClient:self._aws_access_key_id = aws_access_key_idself._aws_secret_access_key = aws_secret_access_keyself._profile_name = profile_name- self._create_session()+ self._session: aioboto3.Session | None = None- def _create_session(self) -> None:- self.session = aioboto3.Session(- aws_access_key_id=self._aws_access_key_id,- aws_secret_access_key=self._aws_secret_access_key,- profile_name=self._profile_name,- )+ @property+ def session(self) -> aioboto3.Session:+ return self._get_session()++ @session.setter+ def session(self, session: aioboto3.Session) -> None:+ self._session = session++ def _create_session(self, client_type_hint: AWSClientType | None = None) -> None:+ try:+ self._session = aioboto3.Session(+ aws_access_key_id=self._aws_access_key_id,+ aws_secret_access_key=self._aws_secret_access_key,+ profile_name=self._profile_name,+ )+ except ProfileNotFound as e:+ profile_name = self._profile_name or os.environ.get("AWS_PROFILE") or "default"+ client_scope = f" while creating the {client_type_hint.value} client" if client_type_hint else ""+ raise AWSSessionConfigurationError(+ f"AWS profile {profile_name!r} could not be resolved{client_scope}. "+ "Unset AWS_PROFILE, create the profile, or pass explicit AWS credentials."+ ) from e++ def _get_session(self, client_type_hint: AWSClientType | None = None) -> aioboto3.Session:+ if self._session is None:+ self._create_session(client_type_hint)+ return self._sessiondef refresh_session(self) -> None:"""Recreate the session to pick up refreshed credentials (e.g., rotated web identity tokens)."""@@ -82,6 +108,11 @@ class AsyncAWSClient:"""Check if an exception is an AWS ExpiredTokenException."""return isinstance(error, ClientError) and error.response.get("Error", {}).get("Code") == "ExpiredTokenException"+ def _error_code(self, error: Exception) -> str:+ if isinstance(error, ClientError):+ return error.response.get("Error", {}).get("Code", error.__class__.__name__)+ return error.__class__.__name__+async def _s3_with_retry(self,op_name: str,@@ -116,21 +147,29 @@ class AsyncAWSClient:raisedef _ecs_client(self) -> ECSClient:- return self.session.client(AWSClientType.ECS, region_name=self.region_name, endpoint_url=self._endpoint_url)+ return self._get_session(AWSClientType.ECS).client(+ AWSClientType.ECS, region_name=self.region_name, endpoint_url=self._endpoint_url+ )def _secrets_manager_client(self) -> SecretsManagerClient:- return self.session.client(+ return self._get_session(AWSClientType.SECRETS_MANAGER).client(AWSClientType.SECRETS_MANAGER, region_name=self.region_name, endpoint_url=self._endpoint_url)def _s3_client(self) -> S3Client:- return self.session.client(AWSClientType.S3, region_name=self.region_name, endpoint_url=self._endpoint_url)+ return self._get_session(AWSClientType.S3).client(+ AWSClientType.S3, region_name=self.region_name, endpoint_url=self._endpoint_url+ )def _ec2_client(self) -> EC2Client:- return self.session.client(AWSClientType.EC2, region_name=self.region_name, endpoint_url=self._endpoint_url)+ return self._get_session(AWSClientType.EC2).client(+ AWSClientType.EC2, region_name=self.region_name, endpoint_url=self._endpoint_url+ )def _batch_client(self) -> BatchClient:- return self.session.client(AWSClientType.BATCH, region_name=self.region_name, endpoint_url=self._endpoint_url)+ return self._get_session(AWSClientType.BATCH).client(+ AWSClientType.BATCH, region_name=self.region_name, endpoint_url=self._endpoint_url+ )def _create_tag_string(self, tags: dict[str, str]) -> str:return "&".join([f"{k}={v}" for k, v in tags.items()])@@ -142,10 +181,7 @@ class AsyncAWSClient:response = await client.get_secret_value(SecretId=secret_name)return response["SecretString"]except Exception as e:- try:- error_code = e.response["Error"]["Code"] # type: ignore- except Exception:- error_code = "failed-to-get-error-code"+ error_code = self._error_code(e)LOG.exception("Failed to get secret.", secret_name=secret_name, error_code=error_code)return Nonediff --git a/tests/unit/test_aws_client_ttl.py b/tests/unit/test_aws_client_ttl.pyindex b8e38876e..80e8bede6 100644--- a/tests/unit/test_aws_client_ttl.py+++ b/tests/unit/test_aws_client_ttl.py@@ -2,7 +2,7 @@ import timefrom unittest.mock import AsyncMock, MagicMock, patchimport pytest-from botocore.exceptions import ClientError+from botocore.exceptions import ClientError, ProfileNotFoundfrom skyvern.forge.sdk.api import aws@@ -43,6 +43,68 @@ def test_refresh_session_creates_new_session():assert client.session is not old_session+def test_no_profile_session_creation_uses_default_credential_chain(monkeypatch: pytest.MonkeyPatch):+ monkeypatch.delenv("AWS_PROFILE", raising=False)+ session = MagicMock()++ with patch.object(aws.aioboto3, "Session", return_value=session) as mock_session:+ client = aws.AsyncAWSClient()+ mock_session.assert_not_called()++ assert client.session is session++ mock_session.assert_called_once_with(+ aws_access_key_id=None,+ aws_secret_access_key=None,+ profile_name=None,+ )+++def test_session_attribute_remains_settable_for_compatibility():+ session = MagicMock()+ client = aws.AsyncAWSClient()++ client.session = session++ assert client.session is session+++async def test_missing_profile_is_deferred_until_aws_operation():+ profile_name = "__skyvern_missing_profile__"++ with patch.object(aws.aioboto3, "Session", side_effect=ProfileNotFound(profile=profile_name)) as mock_session:+ client = aws.AsyncAWSClient(profile_name=profile_name)+ mock_session.assert_not_called()++ with patch.object(aws.LOG, "exception") as mock_log_exception:+ result = await client.get_secret("example-secret")++ assert result is None+ mock_session.assert_called_once_with(+ aws_access_key_id=None,+ aws_secret_access_key=None,+ profile_name=profile_name,+ )+ mock_log_exception.assert_called_once()+ assert mock_log_exception.call_args.kwargs["error_code"] == "AWSSessionConfigurationError"+++async def test_missing_profile_raise_path_surfaces_scoped_error():+ profile_name = "__skyvern_missing_profile__"++ with patch.object(aws.aioboto3, "Session", side_effect=ProfileNotFound(profile=profile_name)):+ client = aws.AsyncAWSClient(profile_name=profile_name)++ with pytest.raises(aws.AWSSessionConfigurationError, match=f"AWS profile '{profile_name}'.*s3 client"):+ await client.upload_file_from_path(+ uri="s3://test-bucket/test-key.png",+ file_path="/tmp/test.png",+ raise_exception=True,+ )++@pytest.mark.asyncioasync def test_upload_file_retries_on_expired_token():"""upload_file_from_path should refresh the session and retry once on ExpiredTokenException."""