Skip to content

Say 'client_region' in S3 diagnostics for clarity #1494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jmaeagle99 merged 1 commit into from
May 1, 2026
+11 −11
Merged

Say 'client_region' in S3 diagnostics for clarity #1494

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion temporalio/contrib/aws/s3driver/aioboto3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ def describe(self) -> Mapping[str, str]:
messages to short-circuit the most common silent 403 misconfiguration.
"""
region = self._client.meta.region_name
return {"region": region} if region else {}
return {"client_region": region} if region else {}

async def object_exists(self, *, bucket: str, key: str) -> bool:
"""Check existence via aioboto3's ``head_object``."""
Expand Down
4 changes: 2 additions & 2 deletions tests/contrib/aws/s3driver/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from temporalio.contrib.aws.s3driver.aioboto3 import new_aioboto3_client

BUCKET = "test-bucket"
REGION = "us-east-1"
CLIENT_REGION = "us-east-1"


def _find_free_port() -> int:
Expand Down Expand Up @@ -50,7 +50,7 @@ async def aioboto3_client(moto_server_url: str) -> AsyncIterator[S3Client]:
session = aioboto3.Session()
async with session.client(
"s3",
region_name=REGION,
region_name=CLIENT_REGION,
endpoint_url=moto_server_url,
aws_access_key_id="testing",
aws_secret_access_key="testing",
Expand Down
10 changes: 5 additions & 5 deletions tests/contrib/aws/s3driver/test_s3driver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
StorageDriverStoreContext,
StorageDriverWorkflowInfo,
)
from tests.contrib.aws.s3driver.conftest import BUCKET, REGION
from tests.contrib.aws.s3driver.conftest import BUCKET, CLIENT_REGION

_CONVERTER = JSONPlainPayloadConverter()

Expand Down Expand Up @@ -620,7 +620,7 @@ async def test_store_nonexistent_bucket_raises(
await driver.store(make_store_context(), [payload])
assert (
str(exc_info.value)
== f"S3StorageDriver store failed [bucket={bucket}, key={expected_key}, region={REGION}]"
== f"S3StorageDriver store failed [bucket={bucket}, key={expected_key}, client_region={CLIENT_REGION}]"
)
assert isinstance(exc_info.value.__cause__, ClientError)
assert (
Expand All @@ -638,7 +638,7 @@ async def test_retrieve_nonexistent_key_raises(
await driver.retrieve(StorageDriverRetrieveContext(), [claim])
assert (
str(exc_info.value)
== f"S3StorageDriver retrieve failed [bucket={BUCKET}, key={key}, region={REGION}]"
== f"S3StorageDriver retrieve failed [bucket={BUCKET}, key={key}, client_region={CLIENT_REGION}]"
)
assert isinstance(exc_info.value.__cause__, ClientError)
assert (
Expand All @@ -657,7 +657,7 @@ async def test_retrieve_nonexistent_bucket_raises(
await driver.retrieve(StorageDriverRetrieveContext(), [claim])
assert (
str(exc_info.value)
== f"S3StorageDriver retrieve failed [bucket={bucket}, key={key}, region={REGION}]"
== f"S3StorageDriver retrieve failed [bucket={bucket}, key={key}, client_region={CLIENT_REGION}]"
)
assert isinstance(exc_info.value.__cause__, ClientError)
assert (
Expand Down Expand Up @@ -856,7 +856,7 @@ def _make_client(self, region: str | None) -> _Aioboto3StorageDriverClient:

def test_returns_region(self) -> None:
client = self._make_client(region="ap-southeast-1")
assert client.describe() == {"region": "ap-southeast-1"}
assert client.describe() == {"client_region": "ap-southeast-1"}

def test_omits_region_when_none(self) -> None:
client = self._make_client(region=None)
Expand Down
6 changes: 3 additions & 3 deletions tests/contrib/aws/s3driver/test_s3driver_worker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
from temporalio.converter import ExternalStorage, JSONPlainPayloadConverter
from temporalio.exceptions import ActivityError, ApplicationError
from temporalio.testing import WorkflowEnvironment
from tests.contrib.aws.s3driver.conftest import BUCKET, REGION
from tests.contrib.aws.s3driver.conftest import BUCKET, CLIENT_REGION
from tests.contrib.aws.s3driver.workflows import (
LARGE,
ChildWorkflow,
Expand Down Expand Up @@ -463,7 +463,7 @@ async def test_s3_store_failure_surfaces_in_workflow_history(
session = aioboto3.Session()
async with session.client(
"s3",
region_name=REGION,
region_name=CLIENT_REGION,
endpoint_url=moto_server_url,
aws_access_key_id="testing",
aws_secret_access_key="testing",
Expand Down Expand Up @@ -506,4 +506,4 @@ async def test_s3_store_failure_surfaces_in_workflow_history(
msg = app_error.message
assert f"S3StorageDriver store failed [bucket={bad_bucket}, key=" in msg
assert f"/wt/LargeOutputNoRetryWorkflow/wi/{workflow_id}/ri/" in msg
assert f"/d/sha256/{expected_hash}, region={REGION}]" in msg
assert f"/d/sha256/{expected_hash}, client_region={CLIENT_REGION}]" in msg
Loading