[Telemetry] Add interaction_record field to Value

tools/telemetry/telemetry/value/__init__.py

 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 """
 The Value hierarchy provides a way of representing the values measurements
 produce such that they can be merged across runs, grouped by page, and output
 to different targets.
 
 The core Value concept provides the basic functionality:
 - association with a page, may be none
@@ skipping 24 matching lines @@
 # value is being interpreted actually affects the conversion. This is insane,
 # but there you have it. There are three contexts in which Values are converted
 # for use by buildbot, represented by these output-intent values.
 PER_PAGE_RESULT_OUTPUT_CONTEXT = 'per-page-result-output-context'
 COMPUTED_PER_PAGE_SUMMARY_OUTPUT_CONTEXT = 'merged-pages-result-output-context'
 SUMMARY_RESULT_OUTPUT_CONTEXT = 'summary-result-output-context'
 
 class Value(object):
   """An abstract value produced by a telemetry page test.
   """
-  def __init__(self, page, name, units, important, description):
+  def __init__(self, page, name, units, important, description,
+               interaction_record):
     """A generic Value object.
 
     Args:
       page: A Page object, may be given as None to indicate that the value
           represents results for multiple pages.
       name: A value name string, may contain a dot. Values from the same test
           with the same prefix before the dot may be considered to belong to
           the same chart.
       units: A units string.
       important: Whether the value is "important". Causes the value to appear
           by default in downstream UIs.
       description: A string explaining in human-understandable terms what this
           value represents.
+      interaction_record: The string label of the TimelineInteractionRecord with
+          which this value is associated.
     """
     # TODO(eakuefner): Check user story here after migration (crbug.com/442036)
     if not isinstance(name, basestring):
       raise ValueError('name field of Value must be string.')
     if not isinstance(units, basestring):
       raise ValueError('units field of Value must be string.')
     if not isinstance(important, bool):
       raise ValueError('important field of Value must be bool.')
     if not ((description is None) or isinstance(description, basestring)):
       raise ValueError('description field of Value must absent or string.')
+    if not ((interaction_record is None) or
+            isinstance(interaction_record, basestring)):
+      raise ValueError('interaction_record field of Value must absent or '
+                       'string.')
 
     self.page = page
     self.name = name
     self.units = units
     self.important = important
     self.description = description
+    self.interaction_record = interaction_record
 
   def IsMergableWith(self, that):
     return (self.units == that.units and
             type(self) == type(that) and
-            self.important == that.important)
+            self.important == that.important and
+            self.interaction_record == that.interaction_record)
 
   @classmethod
   def MergeLikeValuesFromSamePage(cls, values):
     """Combines the provided list of values into a single compound value.
 
     When a page runs multiple times, it may produce multiple values. This
     function is given the same-named values across the multiple runs, and has
     the responsibility of producing a single result.
 
     It must return a single Value. If merging does not make sense, the
@@ skipping 99 matching lines @@
     d = {
       'name': self.name,
       'type': self.GetJSONTypeName(),
       'units': self.units,
       'important': self.important
     }
 
     if self.description:
       d['description'] = self.description
 
+    if self.interaction_record:
+      d['interaction_record'] = self.interaction_record
+
     if self.page:
       d['page_id'] = self.page.id
 
     return d
 
   def AsDictWithoutBaseClassEntries(self):
     full_dict = self.AsDict()
     base_dict_keys = set(self._AsDictImpl().keys())
 
     # Extracts only entries added by the subclass.
@@ skipping 66 matching lines @@
       d['description'] = None
 
     page_id = value_dict.get('page_id', None)
     if page_id:
       d['page'] = page_dict[int(page_id)]
     else:
       d['page'] = None
 
     d['important'] = False
 
+    interaction_record = value_dict.get('interaction_record', None)
+    if interaction_record:
+      d['interaction_record'] = interaction_record
+    else:
+      d['interaction_record'] = None
+
     return d
 
 def ValueNameFromTraceAndChartName(trace_name, chart_name=None):
   """Mangles a trace name plus optional chart name into a standard string.
 
   A value might just be a bareword name, e.g. numPixels. In that case, its
   chart may be None.
 
   But, a value might also be intended for display with other values, in which
   case the chart name indicates that grouping. So, you might have
@@ skipping 14 matching lines @@
   whereas telemetry represents values with a chart_name.trace_name convention,
   where chart_name is optional. This convention is also used by chart_json.
 
   This converts from the telemetry convention to the buildbot convention,
   returning a 2-tuple (measurement_name, trace_name).
   """
   if '.' in value_name:
     return value_name.split('.', 1)
   else:
     return value_name, value_name