feat: add default user agent for grpc (#1726)

Pulkit0110 · web-flow · commit 7b319469d2e4 · 2026-01-29T08:41:32.000+05:30
Adding a default gcloud-python/{__version__} for grpc client just like
the json client
diff --git a/google/cloud/storage/_experimental/asyncio/async_grpc_client.py b/google/cloud/storage/_experimental/asyncio/async_grpc_client.py
@@ -18,25 +18,22 @@
 from google.cloud._storage_v2.services.storage.transports.base import (
     DEFAULT_CLIENT_INFO,
 )
+from google.cloud.storage import __version__
 
 
 class AsyncGrpcClient:
     """An asynchronous client for interacting with Google Cloud Storage using the gRPC API.
-
     :type credentials: :class:`~google.auth.credentials.Credentials`
     :param credentials: (Optional) The OAuth2 Credentials to use for this
                         client. If not passed, falls back to the default
                         inferred from the environment.
-
     :type client_info: :class:`~google.api_core.client_info.ClientInfo`
     :param client_info:
         The client info used to send a user-agent string along with API
         requests. If ``None``, then default info will be used.
-
     :type client_options: :class:`~google.api_core.client_options.ClientOptions`
     :param client_options: (Optional) Client options used to set user options
         on the client.
-
     :type attempt_direct_path: bool
     :param attempt_direct_path:
         (Optional) Whether to attempt to use DirectPath for gRPC connections.
@@ -51,6 +48,18 @@ def __init__(
         *,
         attempt_direct_path=True,
     ):
+        if client_info is None:
+            client_info = DEFAULT_CLIENT_INFO
+        else:
+            client_info = client_info
+        client_info.client_library_version = __version__
+        # TODO: When metrics all use gccl, this should be removed #9552
+        if client_info.user_agent is None:  # pragma: no branch
+            client_info.user_agent = ""
+        agent_version = f"gcloud-python/{__version__}"
+        if agent_version not in client_info.user_agent:
+            client_info.user_agent += f" {agent_version} "
+
         self._grpc_client = self._create_async_grpc_client(
             credentials=credentials,
             client_info=client_info,
@@ -69,8 +78,6 @@ def _create_async_grpc_client(
             "grpc_asyncio"
         )
 
-        if client_info is None:
-            client_info = DEFAULT_CLIENT_INFO
         primary_user_agent = client_info.to_user_agent()
 
         channel = transport_cls.create_channel(
diff --git a/tests/unit/asyncio/test_async_grpc_client.py b/tests/unit/asyncio/test_async_grpc_client.py
@@ -16,10 +16,8 @@
 from google.auth import credentials as auth_credentials
 from google.auth.credentials import AnonymousCredentials
 from google.api_core import client_info as client_info_lib
+from google.cloud.storage import __version__
 from google.cloud.storage._experimental.asyncio import async_grpc_client
-from google.cloud.storage._experimental.asyncio.async_grpc_client import (
-    DEFAULT_CLIENT_INFO,
-)
 
 
 def _make_credentials(spec=None):
@@ -36,16 +34,20 @@ def test_constructor_default_options(self, mock_async_storage_client):
         mock_async_storage_client.get_transport_class.return_value = mock_transport_cls
         mock_creds = _make_credentials()
 
-        primary_user_agent = DEFAULT_CLIENT_INFO.to_user_agent()
-        expected_options = (("grpc.primary_user_agent", primary_user_agent),)
-
         # Act
         async_grpc_client.AsyncGrpcClient(credentials=mock_creds)
 
         # Assert
         mock_async_storage_client.get_transport_class.assert_called_once_with(
             "grpc_asyncio"
         )
+        kwargs = mock_async_storage_client.call_args.kwargs
+        client_info = kwargs["client_info"]
+        agent_version = f"gcloud-python/{__version__}"
+        assert agent_version in client_info.user_agent
+        primary_user_agent = client_info.to_user_agent()
+        expected_options = (("grpc.primary_user_agent", primary_user_agent),)
+
         mock_transport_cls.create_channel.assert_called_once_with(
             attempt_direct_path=True,
             credentials=mock_creds,
@@ -54,11 +56,8 @@ def test_constructor_default_options(self, mock_async_storage_client):
         mock_channel = mock_transport_cls.create_channel.return_value
         mock_transport_cls.assert_called_once_with(channel=mock_channel)
         mock_transport = mock_transport_cls.return_value
-        mock_async_storage_client.assert_called_once_with(
-            transport=mock_transport,
-            client_options=None,
-            client_info=DEFAULT_CLIENT_INFO,
-        )
+        assert kwargs["transport"] is mock_transport
+        assert kwargs["client_options"] is None
 
     @mock.patch("google.cloud._storage_v2.StorageAsyncClient")
     def test_constructor_with_client_info(self, mock_async_storage_client):
@@ -73,6 +72,8 @@ def test_constructor_with_client_info(self, mock_async_storage_client):
             credentials=mock_creds, client_info=client_info
         )
 
+        agent_version = f"gcloud-python/{__version__}"
+        assert agent_version in client_info.user_agent
         primary_user_agent = client_info.to_user_agent()
         expected_options = (("grpc.primary_user_agent", primary_user_agent),)
 
@@ -92,7 +93,11 @@ def test_constructor_disables_directpath(self, mock_async_storage_client):
             credentials=mock_creds, attempt_direct_path=False
         )
 
-        primary_user_agent = DEFAULT_CLIENT_INFO.to_user_agent()
+        kwargs = mock_async_storage_client.call_args.kwargs
+        client_info = kwargs["client_info"]
+        agent_version = f"gcloud-python/{__version__}"
+        assert agent_version in client_info.user_agent
+        primary_user_agent = client_info.to_user_agent()
         expected_options = (("grpc.primary_user_agent", primary_user_agent),)
 
         mock_transport_cls.create_channel.assert_called_once_with(
@@ -109,43 +114,43 @@ def test_grpc_client_property(self, mock_grpc_gapic_client):
         mock_transport_cls = mock.MagicMock()
         mock_grpc_gapic_client.get_transport_class.return_value = mock_transport_cls
         channel_sentinel = mock.sentinel.channel
-
         mock_transport_cls.create_channel.return_value = channel_sentinel
-        mock_transport_cls.return_value = mock.sentinel.transport
+        mock_transport_instance = mock.sentinel.transport
+        mock_transport_cls.return_value = mock_transport_instance
 
         mock_creds = _make_credentials()
-        mock_client_info = mock.MagicMock(spec=client_info_lib.ClientInfo)
-        mock_client_info.to_user_agent.return_value = "test-user-agent"
+        # Use a real ClientInfo instance instead of a mock to properly test user agent logic
+        client_info = client_info_lib.ClientInfo(user_agent="test-user-agent")
         mock_client_options = mock.sentinel.client_options
         mock_attempt_direct_path = mock.sentinel.attempt_direct_path
 
         # Act
         client = async_grpc_client.AsyncGrpcClient(
             credentials=mock_creds,
-            client_info=mock_client_info,
+            client_info=client_info,
             client_options=mock_client_options,
             attempt_direct_path=mock_attempt_direct_path,
         )
+        retrieved_client = client.grpc_client  # This is what is being tested
 
-        mock_grpc_gapic_client.get_transport_class.return_value = mock_transport_cls
+        # Assert - verify that gcloud-python agent version was added
+        agent_version = f"gcloud-python/{__version__}"
+        assert agent_version in client_info.user_agent
+        # Also verify original user_agent is still there
+        assert "test-user-agent" in client_info.user_agent
 
-        mock_transport_cls.create_channel.return_value = channel_sentinel
-        mock_transport_instance = mock.sentinel.transport
-        mock_transport_cls.return_value = mock_transport_instance
-
-        retrieved_client = client.grpc_client
+        primary_user_agent = client_info.to_user_agent()
+        expected_options = (("grpc.primary_user_agent", primary_user_agent),)
 
-        # Assert
-        expected_options = (("grpc.primary_user_agent", "test-user-agent"),)
         mock_transport_cls.create_channel.assert_called_once_with(
             attempt_direct_path=mock_attempt_direct_path,
             credentials=mock_creds,
             options=expected_options,
         )
-        mock_transport_cls.assere_with(channel=channel_sentinel)
+        mock_transport_cls.assert_called_once_with(channel=channel_sentinel)
         mock_grpc_gapic_client.assert_called_once_with(
             transport=mock_transport_instance,
-            client_info=mock_client_info,
+            client_info=client_info,
             client_options=mock_client_options,
         )
         assert retrieved_client is mock_grpc_gapic_client.return_value
@@ -168,12 +173,39 @@ def test_grpc_client_with_anon_creds(self, mock_grpc_gapic_client):
         # Assert
         assert retrieved_client is mock_grpc_gapic_client.return_value
 
-        primary_user_agent = DEFAULT_CLIENT_INFO.to_user_agent()
+        kwargs = mock_grpc_gapic_client.call_args.kwargs
+        client_info = kwargs["client_info"]
+        agent_version = f"gcloud-python/{__version__}"
+        assert agent_version in client_info.user_agent
+        primary_user_agent = client_info.to_user_agent()
         expected_options = (("grpc.primary_user_agent", primary_user_agent),)
 
         mock_transport_cls.create_channel.assert_called_once_with(
             attempt_direct_path=True,
             credentials=anonymous_creds,
             options=expected_options,
         )
-        mock_transport_cls.assert_called_once_with(channel=channel_sentinel)
+
+    @mock.patch("google.cloud._storage_v2.StorageAsyncClient")
+    def test_user_agent_with_custom_client_info(self, mock_async_storage_client):
+        """Test that gcloud-python user agent is appended to existing user agent.
+
+        Regression test similar to test__http.py::TestConnection::test_duplicate_user_agent
+        """
+        mock_transport_cls = mock.MagicMock()
+        mock_async_storage_client.get_transport_class.return_value = mock_transport_cls
+        mock_creds = _make_credentials()
+
+        # Create a client_info with an existing user_agent
+        client_info = client_info_lib.ClientInfo(user_agent="custom-app/1.0")
+
+        # Act
+        async_grpc_client.AsyncGrpcClient(
+            credentials=mock_creds,
+            client_info=client_info,
+        )
+
+        # Assert - verify that gcloud-python version was appended
+        agent_version = f"gcloud-python/{__version__}"
+        expected_user_agent = f"custom-app/1.0 {agent_version} "
+        assert client_info.user_agent == expected_user_agent
