fix: client_info default values (#681)

Author: daniel-sanche

google/cloud/logging_v2/_gapic.py

@@ -35,6 +35,9 @@
 from google.cloud.logging_v2.sink import Sink
 from google.cloud.logging_v2.metric import Metric
 
+from google.api_core import client_info
+from google.api_core import gapic_v1
+
 
 class _LoggingAPI(object):
     """Helper mapping logging-related APIs."""
@@ -562,6 +565,22 @@ def _log_entry_mapping_to_pb(mapping):
     return LogEntryPB(entry_pb)
 
 
+def _client_info_to_gapic(input_info):
+    """
+    Helper function to convert api_core.client_info to
+    api_core.gapic_v1.client_info subclass
+    """
+    return gapic_v1.client_info.ClientInfo(
+        python_version=input_info.python_version,
+        grpc_version=input_info.grpc_version,
+        api_core_version=input_info.api_core_version,
+        gapic_version=input_info.gapic_version,
+        client_library_version=input_info.client_library_version,
+        user_agent=input_info.user_agent,
+        rest_version=input_info.rest_version,
+    )
+
+
 def make_logging_api(client):
     """Create an instance of the Logging API adapter.
 
@@ -572,9 +591,14 @@ def make_logging_api(client):
     Returns:
         _LoggingAPI: A metrics API instance with the proper credentials.
     """
+    info = client._client_info
+    if type(info) == client_info.ClientInfo:
+        # convert into gapic-compatible subclass
+        info = _client_info_to_gapic(info)
+
     generated = LoggingServiceV2Client(
         credentials=client._credentials,
-        client_info=client._client_info,
+        client_info=info,
         client_options=client._client_options,
     )
     return _LoggingAPI(generated, client)
@@ -590,9 +614,14 @@ def make_metrics_api(client):
     Returns:
         _MetricsAPI: A metrics API instance with the proper credentials.
     """
+    info = client._client_info
+    if type(info) == client_info.ClientInfo:
+        # convert into gapic-compatible subclass
+        info = _client_info_to_gapic(info)
+
     generated = MetricsServiceV2Client(
         credentials=client._credentials,
-        client_info=client._client_info,
+        client_info=info,
         client_options=client._client_options,
     )
     return _MetricsAPI(generated, client)
@@ -608,9 +637,14 @@ def make_sinks_api(client):
     Returns:
         _SinksAPI: A metrics API instance with the proper credentials.
     """
+    info = client._client_info
+    if type(info) == client_info.ClientInfo:
+        # convert into gapic-compatible subclass
+        info = _client_info_to_gapic(info)
+
     generated = ConfigServiceV2Client(
         credentials=client._credentials,
-        client_info=client._client_info,
+        client_info=info,
         client_options=client._client_options,
     )
     return _SinksAPI(generated, client)

google/cloud/logging_v2/client.py

@@ -137,6 +137,10 @@ def __init__(
                 kw_args["api_endpoint"] = api_endpoint
 
         self._connection = Connection(self, **kw_args)
+        if client_info is None:
+            # if client info not passed in, use the discovered
+            # client info from _connection object
+            client_info = self._connection._client_info
 
         self._client_info = client_info
         self._client_options = client_options

tests/unit/gapic/logging_v2/test_config_service_v2.py

@@ -99,6 +99,22 @@ def test__get_default_mtls_endpoint():
     )
 
 
+def test_config_default_client_info_headers():
+    import re
+    import pkg_resources
+
+    # test that DEFAULT_CLIENT_INFO contains the expected gapic headers
+    gapic_header_regex = re.compile(
+        r"gapic\/[0-9]+\.[\w.-]+ gax\/[0-9]+\.[\w.-]+ gl-python\/[0-9]+\.[\w.-]+ grpc\/[0-9]+\.[\w.-]+"
+    )
+    detected_info = (
+        google.cloud.logging_v2.services.config_service_v2.transports.base.DEFAULT_CLIENT_INFO
+    )
+    assert detected_info is not None
+    detected_agent = " ".join(sorted(detected_info.to_user_agent().split(" ")))
+    assert gapic_header_regex.match(detected_agent)
+
+
 @pytest.mark.parametrize(
     "client_class,transport_name",
     [

tests/unit/gapic/logging_v2/test_logging_service_v2.py

@@ -71,6 +71,22 @@ def modify_default_endpoint(client):
     )
 
 
+def test_logging_default_client_info_headers():
+    import re
+    import pkg_resources
+
+    # test that DEFAULT_CLIENT_INFO contains the expected gapic headers
+    gapic_header_regex = re.compile(
+        r"gapic\/[0-9]+\.[\w.-]+ gax\/[0-9]+\.[\w.-]+ gl-python\/[0-9]+\.[\w.-]+ grpc\/[0-9]+\.[\w.-]+"
+    )
+    detected_info = (
+        google.cloud.logging_v2.services.logging_service_v2.transports.base.DEFAULT_CLIENT_INFO
+    )
+    assert detected_info is not None
+    detected_agent = " ".join(sorted(detected_info.to_user_agent().split(" ")))
+    assert gapic_header_regex.match(detected_agent)
+
+
 def test__get_default_mtls_endpoint():
     api_endpoint = "example.googleapis.com"
     api_mtls_endpoint = "example.mtls.googleapis.com"

tests/unit/gapic/logging_v2/test_metrics_service_v2.py

@@ -99,6 +99,22 @@ def test__get_default_mtls_endpoint():
     )
 
 
+def test_metrics_default_client_info_headers():
+    import re
+    import pkg_resources
+
+    # test that DEFAULT_CLIENT_INFO contains the expected gapic headers
+    gapic_header_regex = re.compile(
+        r"gapic\/[0-9]+\.[\w.-]+ gax\/[0-9]+\.[\w.-]+ gl-python\/[0-9]+\.[\w.-]+ grpc\/[0-9]+\.[\w.-]+"
+    )
+    detected_info = (
+        google.cloud.logging_v2.services.metrics_service_v2.transports.base.DEFAULT_CLIENT_INFO
+    )
+    assert detected_info is not None
+    detected_agent = " ".join(sorted(detected_info.to_user_agent().split(" ")))
+    assert gapic_header_regex.match(detected_agent)
+
+
 @pytest.mark.parametrize(
     "client_class,transport_name",
     [

tests/unit/test_client.py

@@ -16,11 +16,16 @@
 from datetime import datetime
 from datetime import timedelta
 from datetime import timezone
+import re
 
 import unittest
 
 import mock
 
+VENEER_HEADER_REGEX = re.compile(
+    r"gapic\/[0-9]+\.[\w.-]+ gax\/[0-9]+\.[\w.-]+ gccl\/[0-9]+\.[\w.-]+ gl-python\/[0-9]+\.[\w.-]+ grpc\/[0-9]+\.[\w.-]+"
+)
+
 
 def _make_credentials():
     import google.auth.credentials
@@ -148,6 +153,59 @@ def make_api(client_obj):
         again = client.logging_api
         self.assertIs(again, api)
 
+    def test_veneer_grpc_headers(self):
+        # test that client APIs have client_info populated with the expected veneer headers
+        # required for proper instrumentation
+        creds = _make_credentials()
+        # ensure client info is set on client object
+        client = self._make_one(project=self.PROJECT, credentials=creds, _use_grpc=True)
+        self.assertIsNotNone(client._client_info)
+        user_agent_sorted = " ".join(
+            sorted(client._client_info.to_user_agent().split(" "))
+        )
+        self.assertTrue(VENEER_HEADER_REGEX.match(user_agent_sorted))
+        # ensure client info is propagated to gapic wrapped methods
+        patch = mock.patch("google.api_core.gapic_v1.method.wrap_method")
+        with patch as gapic_mock:
+            client.logging_api  # initialize logging api
+            client.metrics_api  # initialize metrics api
+            client.sinks_api  # initialize sinks api
+            wrapped_call_list = gapic_mock.call_args_list
+            num_api_calls = 37  # expected number of distinct APIs in all gapic services (logging,metrics,sinks)
+            self.assertGreaterEqual(
+                len(wrapped_call_list),
+                num_api_calls,
+                "unexpected number of APIs wrapped",
+            )
+            for call in wrapped_call_list:
+                client_info = call.kwargs["client_info"]
+                self.assertIsNotNone(client_info)
+                wrapped_user_agent_sorted = " ".join(
+                    sorted(client_info.to_user_agent().split(" "))
+                )
+                self.assertTrue(VENEER_HEADER_REGEX.match(wrapped_user_agent_sorted))
+
+    def test_veneer_http_headers(self):
+        # test that http APIs have client_info populated with the expected veneer headers
+        # required for proper instrumentation
+        creds = _make_credentials()
+        # ensure client info is set on client object
+        client = self._make_one(
+            project=self.PROJECT, credentials=creds, _use_grpc=False
+        )
+        self.assertIsNotNone(client._client_info)
+        user_agent_sorted = " ".join(
+            sorted(client._client_info.to_user_agent().split(" "))
+        )
+        self.assertTrue(VENEER_HEADER_REGEX.match(user_agent_sorted))
+        # ensure client info is propagated to _connection object
+        connection_user_agent = client._connection._client_info.to_user_agent()
+        self.assertIsNotNone(connection_user_agent)
+        connection_user_agent_sorted = " ".join(
+            sorted(connection_user_agent.split(" "))
+        )
+        self.assertTrue(VENEER_HEADER_REGEX.match(connection_user_agent_sorted))
+
     def test_no_gapic_ctor(self):
         from google.cloud.logging_v2._http import _LoggingAPI