Refactor TraceData to encapsulate internal traces' representation

telemetry/telemetry/value/trace.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.
 
 import datetime
-import json
 import logging
 import os
 import random
 import shutil
-import subprocess
 import sys
 import tempfile
 
 from py_utils import cloud_storage  # pylint: disable=import-error
 
 from telemetry.internal.util import file_handle
 from telemetry.timeline import trace_data as trace_data_module
 from telemetry import value as value_module
 
-_TRACE2HTML_PATH = os.path.join(os.path.dirname(__file__), '..', '..', '..',
-                                'tracing', 'bin', 'trace2html')
-
 
 class TraceValue(value_module.Value):
   def __init__(self, page, trace_data, important=False, description=None):
     """A value that contains a TraceData object and knows how to
     output it.
 
     Adding TraceValues and outputting as JSON will produce a directory full of
     HTML files called trace_files. Outputting as chart JSON will also produce
     an index, files.html, linking to each of these files.
     """
     super(TraceValue, self).__init__(
         page, name='trace', units='', important=important,
         description=description, tir_label=None, grouping_keys=None)
     self._temp_file = self._GetTempFileHandle(trace_data)
     self._cloud_url = None
     self._serialized_file_handle = None
 
   @property
   def value(self):
     if self._cloud_url:
       return self._cloud_url
     elif self._serialized_file_handle:
       return self._serialized_file_handle.GetAbsPath()
 
   def _GetTraceParts(self, trace_data):
     return [(trace_data.GetTracesFor(p), p)
             for p in trace_data_module.ALL_TRACE_PARTS
             if trace_data.HasTracesFor(p)]
 
-  @staticmethod
-  def _DumpTraceToFile(trace, path):
-    with open(path, 'w') as fp:
-      if isinstance(trace, basestring):
-        fp.write(trace)
-      elif isinstance(trace, dict) or isinstance(trace, list):
-        json.dump(trace, fp)
-      else:
-        raise TypeError('Trace is of unknown type.')
-
   def _GetTempFileHandle(self, trace_data):
-    temp_dir = tempfile.mkdtemp()
-    trace_files = []
-    counter = 0
-    try:
-      trace_size_data = {}
-      for traces_list, part in self._GetTraceParts(trace_data):
-        for trace in traces_list:
-          if isinstance(trace, trace_data_module.TraceFileHandle):
-            file_path = trace.file_path
-          else:
-            file_path = os.path.join(temp_dir, '%s.trace' % counter)
-            self._DumpTraceToFile(trace, file_path)
-          trace_size_data.setdefault(part, 0)
-          trace_size_data[part] += os.path.getsize(file_path)
-          trace_files.append(file_path)
-          counter += 1
-      logging.info('Trace sizes in bytes: %s', trace_size_data)
-      tf = tempfile.NamedTemporaryFile(delete=False, suffix='.html')
-      tf.close()
-      if trace_files:
-        title = ''
-        if self.page:
-          title = self.page.display_name
-        cmd = (['python', _TRACE2HTML_PATH] + trace_files +
-               ['--output', tf.name] + ['--title', title])
-        subprocess.check_output(cmd)
-      else:
-        logging.warning('No traces to convert to html.')
-      return file_handle.FromTempFile(tf)
-    finally:
-      shutil.rmtree(temp_dir)
+    tf = tempfile.NamedTemporaryFile(delete=False, suffix='.html')
+    tf.close()
+    title = ''
+    if self.page:
+      title = self.page.display_name
+    trace_data.Serialize(tf.name, trace_title=title)
+    return file_handle.FromFilePath(tf.name)
 
   def __repr__(self):
     if self.page:
       page_name = self.page.display_name
     else:
       page_name = 'None'
     return 'TraceValue(%s, %s)' % (page_name, self.name)
 
   def CleanUp(self):
     """Cleans up tempfile after it is no longer needed.
@@ skipping 85 matching lines @@
           fh.extension))
       self._cloud_url = cloud_storage.Insert(
           bucket, remote_path, fh.GetAbsPath())
       sys.stderr.write(
           'View generated trace files online at %s for page %s\n' %
           (self._cloud_url, self.page.url if self.page else 'unknown'))
       return self._cloud_url
     except cloud_storage.PermissionError as e:
       logging.error('Cannot upload trace files to cloud storage due to '
                     ' permission error: %s' % e.message)