Add client_info support to client / connection. (#7874)

Author: tseaver

google/cloud/logging/_http.py

@@ -25,16 +25,22 @@
 from google.cloud.logging.metric import Metric
 
 
-_CLIENT_INFO = _http.CLIENT_INFO_TEMPLATE.format(__version__)
-
-
 class Connection(_http.JSONConnection):
     """A connection to Google Stackdriver Logging via the JSON REST API.
 
     :type client: :class:`~google.cloud.logging.client.Client`
     :param client: The client that owns the current connection.
+
+    :type client_info: :class:`~google.api_core.client_info.ClientInfo`
+    :param client_info: (Optional) instance used to generate user agent.
     """
 
+    def __init__(self, client, client_info=None):
+        super(Connection, self).__init__(client, client_info)
+
+        self._client_info.gapic_version = __version__
+        self._client_info.client_library_version = __version__
+
     API_BASE_URL = "https://logging.googleapis.com"
     """The base of the API call URL."""
 
@@ -44,8 +50,6 @@ class Connection(_http.JSONConnection):
     API_URL_TEMPLATE = "{api_base_url}/{api_version}{path}"
     """A template for the URL of a particular API call."""
 
-    _EXTRA_HEADERS = {_http.CLIENT_INFO_HEADER: _CLIENT_INFO}
-
 
 class _LoggingAPI(object):
     """Helper mapping logging-related APIs.

google/cloud/logging/client.py

@@ -86,6 +86,13 @@ class Client(ClientWithProject):
                       environment variable
                       This parameter should be considered private, and could
                       change in the future.
+
+    :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. Generally,
+        you only need to set this if you're developing your own library
+        or partner tool.
     """
 
     _logging_api = None
@@ -100,11 +107,18 @@ class Client(ClientWithProject):
     )
     """The scopes required for authenticating as a Logging consumer."""
 
-    def __init__(self, project=None, credentials=None, _http=None, _use_grpc=None):
+    def __init__(
+        self,
+        project=None,
+        credentials=None,
+        _http=None,
+        _use_grpc=None,
+        client_info=None,
+    ):
         super(Client, self).__init__(
             project=project, credentials=credentials, _http=_http
         )
-        self._connection = Connection(self)
+        self._connection = Connection(self, client_info=client_info)
         if _use_grpc is None:
             self._use_grpc = _USE_GRPC
         else:

tests/unit/test__http.py

@@ -44,9 +44,7 @@ def test_default_url(self):
 
     def test_extra_headers(self):
         import requests
-
         from google.cloud import _http as base_http
-        from google.cloud.logging import _http as MUT
 
         http = mock.create_autospec(requests.Session, instance=True)
         response = requests.Response()
@@ -63,8 +61,8 @@ def test_extra_headers(self):
 
         expected_headers = {
             "Accept-Encoding": "gzip",
-            base_http.CLIENT_INFO_HEADER: MUT._CLIENT_INFO,
-            "User-Agent": conn.USER_AGENT,
+            base_http.CLIENT_INFO_HEADER: conn.user_agent,
+            "User-Agent": conn.user_agent,
         }
         expected_uri = conn.build_api_url("/rainbow")
         http.request.assert_called_once_with(

tests/unit/test_client.py

@@ -43,10 +43,28 @@ def _get_target_class():
     def _make_one(self, *args, **kw):
         return self._get_target_class()(*args, **kw)
 
-    def test_ctor(self):
+    def test_ctor_defaults(self):
+        from google.cloud._http import ClientInfo
+        from google.cloud.logging._http import Connection
+
         creds = _make_credentials()
         client = self._make_one(project=self.PROJECT, credentials=creds)
         self.assertEqual(client.project, self.PROJECT)
+        self.assertIsInstance(client._connection, Connection)
+        self.assertIsInstance(client._connection._client_info, ClientInfo)
+
+    def test_ctor_explicit(self):
+        from google.cloud._http import ClientInfo
+        from google.cloud.logging._http import Connection
+
+        creds = _make_credentials()
+        client_info = ClientInfo()
+        client = self._make_one(
+            project=self.PROJECT, credentials=creds, client_info=client_info
+        )
+        self.assertEqual(client.project, self.PROJECT)
+        self.assertIsInstance(client._connection, Connection)
+        self.assertIs(client._connection._client_info, client_info)
 
     def test_logging_api_wo_gapic(self):
         from google.cloud.logging._http import _LoggingAPI