earthscope-sdk 1.0.0b0__tar.gz → 1.0.0b1__tar.gz

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: earthscope-sdk
-Version: 1.0.0b0
+Version: 1.0.0b1
 Summary: An SDK for EarthScope API
 Author-email: EarthScope <data-help@earthscope.org>
 License:                                  Apache License
@@ -214,7 +214,8 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
-Requires-Dist: pydantic-settings[toml]>=2.7.0
+Requires-Dist: pydantic-settings[toml]>=2.8.0
+Requires-Dist: stamina>=24.3.0
 Provides-Extra: dev
 Requires-Dist: bumpver; extra == "dev"
 Requires-Dist: build; extra == "dev"
@@ -224,6 +225,7 @@ Requires-Dist: pip-tools; extra == "dev"
 Requires-Dist: pytest-httpx; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
 
 # EarthScope SDK
 

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "earthscope-sdk"
-version = "1.0.0b0"
+version = "1.0.0b1"
 description = "An SDK for EarthScope API"
 readme = "README.md"
 authors = [{ name = "EarthScope", email = "data-help@earthscope.org" }]
@@ -17,7 +17,11 @@ classifiers = [
 ]
 
 #Suggestion not to pin dependencies since the package should work in many different python environments
-dependencies = ["httpx>=0.27.0", "pydantic-settings[toml]>=2.7.0"]
+dependencies = [
+    "httpx>=0.27.0",
+    "pydantic-settings[toml]>=2.8.0",
+    "stamina>=24.3.0",
+]
 requires-python = ">=3.9"
 
 [project.optional-dependencies]
@@ -36,7 +40,7 @@ dev = [
 Homepage = "https://gitlab.com/earthscope/public/earthscope-sdk"
 
 [tool.bumpver]
-current_version = "1.0.0b0"
+current_version = "1.0.0b1"
 version_pattern = "MAJOR.MINOR.PATCH[PYTAGNUM]"
 commit_message = "chore: bump version {old_version} -> {new_version}"
 commit = true

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.0.0b0"
+__version__ = "1.0.0b1"
 
 from earthscope_sdk.client import AsyncEarthScopeClient, EarthScopeClient
 

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk/auth/auth_flow.py

@@ -157,12 +157,14 @@ class AuthFlow(httpx.Auth):
             NoRefreshTokenError: no refresh token is present
             InvalidRefreshTokenError: the token refresh failed
         """
+        from httpx import HTTPStatusError, ReadTimeout
+
         refresh_token = self.refresh_token
         scope = scope or self._settings.scope
 
-        r = await self._ctx.httpx_client.post(
+        request = self._ctx.httpx_client.build_request(
+            "POST",
             f"{self._settings.domain}oauth/token",
-            auth=None,  # override client default
             headers={"content-type": "application/x-www-form-urlencoded"},
             data={
                 "grant_type": "refresh_token",
@@ -171,9 +173,22 @@ class AuthFlow(httpx.Auth):
                 "scopes": scope,
             },
         )
-        if r.status_code != 200:
-            logger.error(f"error during token refresh: {r.content}")
+
+        try:
+            async for attempt in self._settings.retry.retry_context(ReadTimeout):
+                with attempt:
+                    r = await self._ctx.httpx_client.send(request, auth=None)
+                    r.raise_for_status()
+        except HTTPStatusError as e:
+            logger.error(
+                f"error during token refresh ({attempt.num} attempts): {e.response.content}"
+            )
             raise InvalidRefreshTokenError("refresh token exchange failed")
+        except Exception as e:
+            logger.error(
+                f"error during token refresh ({attempt.num} attempts)", exc_info=e
+            )
+            raise InvalidRefreshTokenError("refresh token exchange failed") from e
 
         # add previous refresh token to new tokens if omitted from resp
         # (i.e. we have a non-rotating refresh token)

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk/client/user/_base.py

@@ -18,7 +18,7 @@ class UserBaseService(SdkService):
             url=f"{self.resources.api_url}beta/user/credentials/aws/{role}",
         )
 
-        resp = await self._send(req)
+        resp = await self._send_with_retries(req)
 
         return AwsTemporaryCredentials.model_validate_json(resp.content)
 
@@ -34,6 +34,6 @@ class UserBaseService(SdkService):
             url=f"{self.resources.api_url}beta/user/profile",
         )
 
-        resp = await self._send(req)
+        resp = await self._send_with_retries(req)
 
         return UserProfile.model_validate_json(resp.content)

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk/common/service.py

@@ -52,3 +52,8 @@ class SdkService:
         resp.raise_for_status()
 
         return resp
+
+    async def _send_with_retries(self, request: "Request"):
+        async for attempt in self.ctx.settings.http.retry.retry_context():
+            with attempt:
+                return await self._send(request=request)

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk/config/models.py

@@ -1,11 +1,13 @@
 import base64
 import binascii
 import datetime as dt
+import functools
 from contextlib import suppress
 from enum import Enum
 from functools import cached_property
-from typing import Annotated, Any, Optional, Union
+from typing import Annotated, Any, Optional, Type, Union
 
+from annotated_types import Ge, Gt
 from pydantic import (
     AliasChoices,
     BaseModel,
@@ -86,7 +88,7 @@ class Tokens(BaseModel):
             return None
 
         with suppress(IndexError, binascii.Error, ValidationError):
-            payload_b64 = self.access_token.get_secret_value().split(".")[1]
+            payload_b64 = self.access_token.get_secret_value().split(".", 2)[1]
             payload = base64.b64decode(payload_b64 + "==")  # extra padding
             return AccessTokenBody.model_validate_json(payload)
 
@@ -121,6 +123,76 @@ class Tokens(BaseModel):
         raise ValueError("At least one of access token and refresh token is required.")
 
 
+class RetrySettings(BaseModel):
+    """
+    Retry configuration for the [Stamina library](https://stamina.hynek.me/en/stable/index.html)
+    """
+
+    # same defaults as AWS SDK "standard" mode:
+    # https://boto3.amazonaws.com/v1/documentation/api/latest/guide/retries.html#standard-retry-mode
+
+    attempts: Annotated[int, Ge(0)] = 3
+    timeout: Timedelta = dt.timedelta(seconds=20)
+
+    wait_initial: Timedelta = dt.timedelta(milliseconds=100)
+    wait_max: Timedelta = dt.timedelta(seconds=5)
+    wait_jitter: Timedelta = dt.timedelta(seconds=1)
+    wait_exp_base: Annotated[float, Gt(0)] = 2
+
+    async def retry_context(self, *retry_exc: Type[Exception]):
+        """
+        Obtain a [Stamina](https://stamina.hynek.me/en/stable/index.html) retry iterator.
+        """
+        from stamina import retry_context
+
+        retry_on = functools.partial(self.is_retriable, retry_exc=retry_exc)
+
+        ctx = retry_context(
+            on=retry_on,
+            attempts=self.attempts,
+            timeout=self.timeout,
+            wait_initial=self.wait_initial,
+            wait_jitter=self.wait_jitter,
+            wait_max=self.wait_max,
+            wait_exp_base=self.wait_exp_base,
+        )
+        async for attempt in ctx:
+            yield attempt
+
+    def is_retriable(
+        self,
+        exc: Exception,
+        *args,
+        retry_exc: tuple[Type[Exception]] = (),
+        **kwargs,
+    ) -> bool:
+        """
+        Check if the given exception can be retried
+        """
+        if retry_exc and isinstance(exc, retry_exc):
+            return True
+
+        return False
+
+
+class HttpRetrySettings(RetrySettings):
+    status_codes: set[int] = {429, 500, 502, 503, 504}
+
+    def is_retriable(
+        self,
+        exc: Exception,
+        *args,
+        **kwargs,
+    ) -> bool:
+        from httpx import HTTPStatusError
+
+        if isinstance(exc, HTTPStatusError):
+            if exc.response.status_code in self.status_codes:
+                return True
+
+        return super().is_retriable(exc, *args, **kwargs)
+
+
 class AuthFlowSettings(Tokens):
     """
     Auth flow configuration
@@ -135,6 +207,14 @@ class AuthFlowSettings(Tokens):
     scope: str = "offline_access"
     client_secret: Optional[SecretStr] = None
 
+    # Auth exchange retries
+    retry: HttpRetrySettings = HttpRetrySettings(
+        attempts=5,
+        timeout=dt.timedelta(seconds=30),
+        wait_initial=dt.timedelta(seconds=1),
+        wait_jitter=dt.timedelta(seconds=3),
+    )
+
     @cached_property
     def auth_flow_type(self) -> AuthFlowType:
         if self.client_secret is not None:
@@ -157,6 +237,9 @@ class HttpSettings(BaseModel):
     timeout_connect: Timedelta = dt.timedelta(seconds=5)
     timeout_read: Timedelta = dt.timedelta(seconds=5)
 
+    # automatically retry requests
+    retry: HttpRetrySettings = HttpRetrySettings()
+
     # Other
     user_agent: str = f"earthscope-sdk py/{__version__}"
 

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: earthscope-sdk
-Version: 1.0.0b0
+Version: 1.0.0b1
 Summary: An SDK for EarthScope API
 Author-email: EarthScope <data-help@earthscope.org>
 License:                                  Apache License
@@ -214,7 +214,8 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
-Requires-Dist: pydantic-settings[toml]>=2.7.0
+Requires-Dist: pydantic-settings[toml]>=2.8.0
+Requires-Dist: stamina>=24.3.0
 Provides-Extra: dev
 Requires-Dist: bumpver; extra == "dev"
 Requires-Dist: build; extra == "dev"
@@ -224,6 +225,7 @@ Requires-Dist: pip-tools; extra == "dev"
 Requires-Dist: pytest-httpx; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
+Dynamic: license-file
 
 # EarthScope SDK
 

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/src/earthscope_sdk.egg-info/requires.txt

@@ -1,5 +1,6 @@
 httpx>=0.27.0
-pydantic-settings[toml]>=2.7.0
+pydantic-settings[toml]>=2.8.0
+stamina>=24.3.0
 
 [dev]
 bumpver

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/tests/test_auth.py

@@ -2,6 +2,7 @@ import time
 import webbrowser
 
 import pytest
+from pytest_httpx import HTTPXMock
 
 from earthscope_sdk.auth.client_credentials_flow import ClientCredentialsFlow
 from earthscope_sdk.auth.device_code_flow import DeviceCodeFlow
@@ -17,6 +18,8 @@ from .util import (
     is_pipeline,
     missing_m2m_creds,
     missing_refresh_token,
+    register_mock_token_response,
+    retries_enabled,
 )
 
 
@@ -135,6 +138,33 @@ class TestAuthDeviceCodeFlow:
         flow.refresh_if_necessary()
         assert flow.access_token == at
 
+    @pytest.mark.asyncio
+    async def test_refresh_retry(
+        self,
+        httpx_mock: HTTPXMock,
+    ):
+        httpx_mock.add_response(429)
+        httpx_mock.add_response(500)
+        httpx_mock.add_response(502)
+        httpx_mock.add_response(504)
+        mock_token_body = register_mock_token_response(httpx_mock)
+
+        settings = SdkSettings(
+            oauth2=AuthFlowSettings(
+                audience=AUDIENCE,
+                domain=DOMAIN,
+                refresh_token="mock-refresh-token",
+            )
+        )
+        flow = DeviceCodeFlow(SdkContext(settings))
+
+        with retries_enabled(5):
+            await flow.async_refresh()
+
+        assert len(httpx_mock.get_requests()) == 5
+        assert flow.refresh_token == "mock-refresh-token"
+        assert flow.access_token_body == mock_token_body
+
 
 class TestAuthClientCredentialsFlow:
     def test_no_device_code_with_m2m_creds(self):

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/tests/test_client.py

@@ -8,6 +8,7 @@ from earthscope_sdk.client import AsyncEarthScopeClient, EarthScopeClient
 from earthscope_sdk.client.user.models import AwsTemporaryCredentials, UserProfile
 from earthscope_sdk.common.context import SdkContext
 from earthscope_sdk.config.settings import SdkSettings
+from tests.util import retries_enabled
 
 
 class TestSyncClient:
@@ -128,3 +129,34 @@ class TestAsyncClient:
 
             c_resp = await client.user.get_aws_credentials(force=True)
             assert c_resp == c2, "got new credentials when forced"
+
+    @pytest.mark.asyncio
+    async def test_retries(
+        self,
+        mock_settings: SdkSettings,
+        httpx_mock: HTTPXMock,
+    ):
+        # reuse context
+        ctx = SdkContext(settings=mock_settings)
+
+        httpx_mock.add_response(429)
+        httpx_mock.add_response(429)
+
+        u = UserProfile(
+            first_name="Jane",
+            last_name="Doe",
+            country_code="US",
+            region_code="CO",
+            institution="EarthScope Consortium",
+            work_sector="non-profit",
+            user_id="user-id-123",
+            primary_email="jane.doe@earthscope.org",
+            created_at="2024-01-01T00:00:00Z",
+            updated_at="2024-03-01T00:00:00Z",
+        )
+        httpx_mock.add_response(json=u.model_dump(mode="json"))
+
+        with retries_enabled(3):
+            async with AsyncEarthScopeClient(ctx=ctx) as client:
+                u_resp = await client.user.get_profile()
+                assert u == u_resp

{earthscope_sdk-1.0.0b0 → earthscope_sdk-1.0.0b1}/tests/test_settings.py

@@ -8,7 +8,12 @@ from pytest import MonkeyPatch
 from earthscope_sdk import __version__
 from earthscope_sdk.config._compat import _get_legacy_auth_state_path
 from earthscope_sdk.config.error import ProfileDoesNotExistError
-from earthscope_sdk.config.models import AuthFlowSettings, HttpSettings, Tokens
+from earthscope_sdk.config.models import (
+    AuthFlowSettings,
+    HttpRetrySettings,
+    HttpSettings,
+    Tokens,
+)
 from earthscope_sdk.config.settings import SdkSettings, _get_config_toml_path
 
 
@@ -41,9 +46,21 @@ class TestSdkSettings:
         assert s.http.max_keepalive_connections is None
         assert s.http.keepalive_expiry.total_seconds() == 5.0
         assert s.http.timeout_read.total_seconds() == 5.0
+        assert s.http.retry.attempts == 3
+        assert s.http.retry.timeout.total_seconds() == 20.0
+        assert s.http.retry.wait_initial.total_seconds() == 0.1
+        assert s.http.retry.wait_max.total_seconds() == 5.0
+        assert s.http.retry.wait_jitter.total_seconds() == 1.0
+        assert s.http.retry.wait_exp_base == 2
         assert s.oauth2.client_secret is None
         assert s.oauth2.access_token is None
         assert s.oauth2.refresh_token is None
+        assert s.oauth2.retry.attempts == 5
+        assert s.oauth2.retry.timeout.total_seconds() == 30.0
+        assert s.oauth2.retry.wait_initial.total_seconds() == 1.0
+        assert s.oauth2.retry.wait_max.total_seconds() == 5.0
+        assert s.oauth2.retry.wait_jitter.total_seconds() == 3.0
+        assert s.oauth2.retry.wait_exp_base == 2
 
     def test_profile_does_not_exist_init(self):
         with pytest.raises(ProfileDoesNotExistError):
@@ -228,24 +245,45 @@ class TestSdkSettingsProfiles:
                 http.max_keepalive_connections = 11
                 http.timeout_read = 11.1
                 http.keepalive_expiry = 11.1
+                   
+                http.retry.attempts = 11
+                http.retry.timeout = 11.1
+                http.retry.wait_jitter = 11.1
+                http.retry.wait_initial = 11.1
 
                 [profile.pytest]
                 http.max_connections = 22
                 http.max_keepalive_connections = 22
                 http.keepalive_expiry = 22.2
+                http.retry.timeout = 22.2
+                http.retry.wait_jitter = 22.2
+                http.retry.wait_initial = 22.2
             """)
         )
 
         monkeypatch.setenv("ES_HTTP__MAX_CONNECTIONS", "33")
         monkeypatch.setenv("ES_HTTP__KEEPALIVE_EXPIRY", "33.3")
+        monkeypatch.setenv("ES_HTTP__RETRY__WAIT_JITTER", "33.3")
+        monkeypatch.setenv("ES_HTTP__RETRY__WAIT_INITIAL", "33.3")
 
-        s = SdkSettings(profile_name="pytest", http=HttpSettings(keepalive_expiry=44.4))
+        s = SdkSettings(
+            profile_name="pytest",
+            http=HttpSettings(
+                keepalive_expiry=44.4,
+                retry=HttpRetrySettings(wait_initial=44.4),
+            ),
+        )
 
         assert s.http.keepalive_expiry.total_seconds() == 44.4
         assert s.http.max_connections == 33
         assert s.http.max_keepalive_connections == 22
         assert s.http.timeout_read.total_seconds() == 11.1
 
+        assert s.http.retry.attempts == 11
+        assert s.http.retry.timeout.total_seconds() == 22.2
+        assert s.http.retry.wait_jitter.total_seconds() == 33.3
+        assert s.http.retry.wait_initial.total_seconds() == 44.4
+
 
 class TestTokens:
     def test_defaults(self):