feat(io_storages): tag S3 user-agent for attribution

Signed-off-by: Gonzalo Peña-Castellanos <goanpeca@gmail.com>

Author: goanpeca

label_studio/io_storages/s3/tests/test_user_agent.py

@@ -0,0 +1,33 @@
+"""Tests for the S3 client user agent.
+
+Verifies get_client_and_resource attaches a label-studio user agent to both the
+client and resource while preserving signature_version and a custom endpoint_url
+(the path used for AWS S3 and S3-compatible storage such as Backblaze B2).
+"""
+
+import unittest
+
+from io_storages.s3.utils import _get_user_agent_extra, get_client_and_resource
+
+
+class TestS3ClientUserAgent(unittest.TestCase):
+    def test_user_agent_extra_format(self):
+        ua = _get_user_agent_extra()
+        assert ua.startswith('label-studio/')
+
+    def test_client_and_resource_carry_user_agent(self):
+        client, resource = get_client_and_resource()
+        expected = _get_user_agent_extra()
+        assert expected in (client.meta.config.user_agent_extra or '')
+        assert expected in (resource.meta.client.meta.config.user_agent_extra or '')
+
+    def test_signature_version_preserved(self):
+        client, _ = get_client_and_resource()
+        assert client.meta.config.signature_version == 's3v4'
+
+    def test_custom_endpoint_preserved(self):
+        endpoint = 'https://s3.us-west-004.backblazeb2.com'
+        client, resource = get_client_and_resource(s3_endpoint=endpoint)
+        assert client.meta.endpoint_url == endpoint
+        assert resource.meta.client.meta.endpoint_url == endpoint
+        assert _get_user_agent_extra() in (client.meta.config.user_agent_extra or '')

label_studio/io_storages/s3/utils.py

@@ -2,6 +2,7 @@
 
 import base64
 import fnmatch
+import importlib.metadata
 import logging
 import mimetypes
 import re
@@ -16,6 +17,14 @@
 logger = logging.getLogger(__name__)
 
 
+def _get_user_agent_extra():
+    try:
+        version = importlib.metadata.version('label-studio')
+    except importlib.metadata.PackageNotFoundError:
+        version = 'dev'
+    return f'label-studio/{version}'
+
+
 def get_client_and_resource(
     aws_access_key_id=None, aws_secret_access_key=None, aws_session_token=None, region_name=None, s3_endpoint=None
 ):
@@ -37,8 +46,9 @@ def get_client_and_resource(
     s3_endpoint = s3_endpoint or get_env('S3_ENDPOINT')
     if s3_endpoint:
         settings['endpoint_url'] = s3_endpoint
-    client = session.client('s3', config=boto3.session.Config(signature_version='s3v4'), **settings)
-    resource = session.resource('s3', config=boto3.session.Config(signature_version='s3v4'), **settings)
+    config = boto3.session.Config(signature_version='s3v4', user_agent_extra=_get_user_agent_extra())
+    client = session.client('s3', config=config, **settings)
+    resource = session.resource('s3', config=config, **settings)
     return client, resource