Improve retrieval of customer ID in logging interceptor (googleads#262)

BenRKarl · web-flow · commit 704b906ef93f · 2020-04-17T12:34:05.000-04:00
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,6 @@
+* 5.0.4
+- Enable logging interceptor to retrieve customer ID from resource_name.
+
 * 5.0.3
 - Fix bug in generated init files preventing import *.
 
diff --git a/google/ads/google_ads/interceptors/logging_interceptor.py b/google/ads/google_ads/interceptors/logging_interceptor.py
@@ -117,7 +117,15 @@ def _get_customer_id(self, request):
         Args:
             request: An instance of a request proto message.
         """
-        return getattr(request, 'customer_id', None)
+        if hasattr(request, 'customer_id'):
+            return getattr(request, 'customer_id')
+        elif hasattr(request, 'resource_name'):
+            resource_name = getattr(request, 'resource_name')
+            segments = resource_name.split('/')
+            if segments[0] == 'customers':
+                return segments[1]
+        else:
+            return None
 
     def _parse_exception_to_str(self, exception):
         """Parses response exception object to str for logging.
diff --git a/tests/interceptors/logging_interceptor_test.py b/tests/interceptors/logging_interceptor_test.py
@@ -22,6 +22,7 @@
 
 from google.ads.google_ads import client as Client
 from google.ads.google_ads.interceptors import LoggingInterceptor
+from google.ads.google_ads.v3.proto.services import customer_service_pb2
 
 default_version = Client._DEFAULT_VERSION
 
@@ -530,3 +531,33 @@ def test_get_fault_message_transport_failure(self):
             interceptor = self._create_test_interceptor()
             result = interceptor._get_fault_message(mock_exception)
             self.assertEqual(result, self._MOCK_TRANSPORT_ERROR_MESSAGE)
+
+    def test_get_customer_id_not_present(self):
+        """Returns None if request has no customer_id or resource_name."""
+        mock_request = {}
+        interceptor = self._create_test_interceptor()
+        self.assertEqual(interceptor._get_customer_id(mock_request), None)
+
+    def test_get_customer_id(self):
+        """Retrieves a customer_id from a request object."""
+        mock_request = self._get_mock_request()
+        interceptor = self._create_test_interceptor()
+        self.assertEqual(interceptor._get_customer_id(mock_request),
+                         self._MOCK_CUSTOMER_ID)
+
+    def test_get_customer_id_from_resource_name(self):
+        """Retrieves a customer_id from a request object via resource_name."""
+        resource_name = f'customers/{self._MOCK_CUSTOMER_ID}'
+        mock_request = customer_service_pb2.GetCustomerRequest(
+            resource_name=resource_name)
+        interceptor = self._create_test_interceptor()
+        self.assertEqual(interceptor._get_customer_id(mock_request),
+                         self._MOCK_CUSTOMER_ID)
+
+    def test_get_customer_id_from_invalid_resource_name(self):
+        """Returns None for a resource_name not starting with 'customers'."""
+        resource_name = f'languageConstants/{self._MOCK_CUSTOMER_ID}'
+        mock_request = customer_service_pb2.GetCustomerRequest(
+            resource_name=resource_name)
+        interceptor = self._create_test_interceptor()
+        self.assertEqual(interceptor._get_customer_id(mock_request), None)

-Original file line number
+Diff line change
@@ @@ -1,3 +1,6 @@ @@
 +* 5.0.4
 +- Enable logging interceptor to retrieve customer ID from resource_name.
++
 * 5.0.3
 - Fix bug in generated init files preventing import *.