Updated the python agent to not override any pre existing labels in the breakpoint if there was a conflict with a label it wanted to add.

jasonborg · copybara-github · commit da3bb1401a18 · 2019-04-04T14:08:59.000-07:00
Expected agent behaviour with respect to pre existing breakpoint labels is that they are not removed or overriden by the agent.

PiperOrigin-RevId: 242004674
Change-Id: I218c615b715ae74ea958f1e8d509a7e07668378f
diff --git a/src/googleclouddebugger/capture_collector.py b/src/googleclouddebugger/capture_collector.py
@@ -642,7 +642,7 @@ def _CaptureEnvironmentLabels(self):
 
     if callable(breakpoint_labels_collector):
       for (key, value) in six.iteritems(breakpoint_labels_collector()):
-        self.breakpoint['labels'][key] = value
+        self._StoreLabel(key, value)
 
   def _CaptureRequestLogId(self):
     """Captures the request log id if possible.
@@ -654,15 +654,28 @@ def _CaptureRequestLogId(self):
       request_log_id = request_log_id_collector()
       if request_log_id:
         # We have a request_log_id, save it into the breakpoint labels
-        self.breakpoint['labels'][
-            labels.Breakpoint.REQUEST_LOG_ID] = request_log_id
+        self._StoreLabel(labels.Breakpoint.REQUEST_LOG_ID, request_log_id)
 
   def _CaptureUserId(self):
     """Captures the user id of the end user, if possible."""
     user_kind, user_id = user_id_collector()
     if user_kind and user_id:
       self.breakpoint['evaluatedUserId'] = {'kind': user_kind, 'id': user_id}
 
+  def _StoreLabel(self, name, value):
+    """Stores the specified label in the breakpoint's labels.
+
+    In the event of a duplicate label, favour the pre-existing labels. This
+    generally should not be an issue as the pre-existing client label names are
+    chosen with care and there should be no conflicts.
+
+    Args:
+      name: The name of the label to be stored.
+      value: The value of the label to be stored.
+    """
+    if name not in self.breakpoint['labels']:
+      self.breakpoint['labels'][name] = value
+
 
 class LogCollector(object):
   """Captures minimal application snapshot and logs it to application log.
