rebaseline_server: serve JSON from static file, rather than generating it live

gm/rebaseline_server/server.py

Index: gm/rebaseline_server/server.py
diff --git a/gm/rebaseline_server/server.py b/gm/rebaseline_server/server.py
index 396f42d8e430066fe7edda59d27ea5ab25c33add..1ca5757b1a72c5259424584732e5ac56dfa50364 100755
--- a/gm/rebaseline_server/server.py
+++ b/gm/rebaseline_server/server.py
@@ -28,16 +28,20 @@ import urlparse
 
 # Imports from within Skia
 #
-# We need to add the 'tools' directory, so that we can import svn.py within
-# that directory.
-# Make sure that the 'tools' dir is in the PYTHONPATH, but add it at the *end*
+# We need to add the 'tools' directory for svn.py, and the 'gm' directory for
+# gm_json.py .
+# Make sure that these dirs are in the PYTHONPATH, but add them at the *end*
 # so any dirs that are already in the PYTHONPATH will be preferred.
 PARENT_DIRECTORY = os.path.dirname(os.path.realpath(__file__))
-TRUNK_DIRECTORY = os.path.dirname(os.path.dirname(PARENT_DIRECTORY))
+GM_DIRECTORY = os.path.dirname(PARENT_DIRECTORY)
+TRUNK_DIRECTORY = os.path.dirname(GM_DIRECTORY)
 TOOLS_DIRECTORY = os.path.join(TRUNK_DIRECTORY, 'tools')
 if TOOLS_DIRECTORY not in sys.path:
   sys.path.append(TOOLS_DIRECTORY)
 import svn
+if GM_DIRECTORY not in sys.path:
+  sys.path.append(GM_DIRECTORY)
+import gm_json
 
 # Imports from local dir
 #
@@ -71,6 +75,11 @@ DEFAULT_ACTUALS_REPO_REVISION = 'HEAD'
 DEFAULT_ACTUALS_REPO_URL = 'http://skia-autogen.googlecode.com/svn/gm-actual'
 DEFAULT_PORT = 8888
 
+# Directory within which the server will serve out static files.
+STATIC_CONTENTS_DIR = os.path.realpath(os.path.join(PARENT_DIRECTORY, 'static'))
+GENERATED_IMAGES_DIR = os.path.join(STATIC_CONTENTS_DIR, 'generated-images')
+GENERATED_JSON_DIR = os.path.join(STATIC_CONTENTS_DIR, 'generated-json')

[epoger, 2014/03/19 21:13:51]

FOR NOW we still need the server running so the client can download diff images
anyway, so this is a convenient place to serve the JSON files from.

+
 # How often (in seconds) clients should reload while waiting for initial
 # results to load.
 RELOAD_INTERVAL_UNTIL_READY = 10
@@ -232,7 +241,20 @@ class Server(object):
             results_mod.DEFAULT_EXPECTATIONS_DIR)
         _run_command(['gclient', 'sync'], TRUNK_DIRECTORY)
 
-      self._results = results_mod.Results(actuals_root=self._actuals_dir)
+      new_results = results_mod.Results(
+          actuals_root=self._actuals_dir,
+          generated_images_root=GENERATED_IMAGES_DIR,
+          diff_base_url=os.path.relpath(

[epoger, 2014/03/19 21:13:51]

Because this uses a relative diff_base_url, this CL depends on
https://codereview.chromium.org/205273002/ ('rebaseline_server: image URLs are
relative to JSON file's location')

+              GENERATED_IMAGES_DIR, GENERATED_JSON_DIR))
+      if not os.path.isdir(GENERATED_JSON_DIR):
+        os.makedirs(GENERATED_JSON_DIR)
+      for summary_type in [results_mod.KEY__HEADER__RESULTS_ALL,
+                           results_mod.KEY__HEADER__RESULTS_FAILURES]:
+        gm_json.WriteToFile(
+            new_results.get_packaged_results_of_type(results_type=summary_type),
+            os.path.join(GENERATED_JSON_DIR, '%s.json' % summary_type))
+
+      self._results = new_results

[epoger, 2014/03/19 21:13:51]

Even though we no longer serve the JSON from the live Results object, we still
need to hold onto it in case the client sends us edits to apply to it.

 
   def _result_loader(self, reload_seconds=0):
     """ Call self.update_results(), either once or periodically.
@@ -296,7 +318,6 @@ class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
       normpath = posixpath.normpath(self.path)
       (dispatcher_name, remainder) = PATHSPLIT_RE.match(normpath).groups()
       dispatchers = {
-          'results': self.do_GET_results,
           'static': self.do_GET_static,
       }
       dispatcher = dispatchers[dispatcher_name]
@@ -305,41 +326,6 @@ class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
       self.send_error(404)
       raise
 
-  def do_GET_results(self, results_type):
-    """ Handle a GET request for GM results.
-
-    Args:
-      results_type: string indicating which set of results to return;
-            must be one of the results_mod.RESULTS_* constants
-    """
-    logging.debug('do_GET_results: sending results of type "%s"' % results_type)
-    # Since we must make multiple calls to the Results object, grab a
-    # reference to it in case it is updated to point at a new Results
-    # object within another thread.
-    #
-    # TODO(epoger): Rather than using a global variable for the handler
-    # to refer to the Server object, make Server a subclass of
-    # HTTPServer, and then it could be available to the handler via
-    # the handler's .server instance variable.
-    results_obj = _SERVER.results
-    if results_obj:
-      response_dict = results_obj.get_packaged_results_of_type(
-          results_type=results_type, reload_seconds=_SERVER.reload_seconds,
-          is_editable=_SERVER.is_editable, is_exported=_SERVER.is_exported)
-    else:
-      now = int(time.time())
-      response_dict = {
-          results_mod.KEY__HEADER: {
-              results_mod.KEY__HEADER__SCHEMA_VERSION: (
-                  results_mod.REBASELINE_SERVER_SCHEMA_VERSION_NUMBER),
-              results_mod.KEY__HEADER__IS_STILL_LOADING: True,
-              results_mod.KEY__HEADER__TIME_UPDATED: now,
-              results_mod.KEY__HEADER__TIME_NEXT_UPDATE_AVAILABLE: (
-                  now + RELOAD_INTERVAL_UNTIL_READY),
-          },
-      }
-    self.send_json_dict(response_dict)
-
   def do_GET_static(self, path):
     """ Handle a GET request for a file under the 'static' directory.
     Only allow serving of files within the 'static' directory that is a
@@ -352,14 +338,13 @@ class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
     path = urlparse.urlparse(path).path
 
     logging.debug('do_GET_static: sending file "%s"' % path)
-    static_dir = os.path.realpath(os.path.join(PARENT_DIRECTORY, 'static'))
-    full_path = os.path.realpath(os.path.join(static_dir, path))
-    if full_path.startswith(static_dir):
+    full_path = os.path.realpath(os.path.join(STATIC_CONTENTS_DIR, path))
+    if full_path.startswith(STATIC_CONTENTS_DIR):
       self.send_file(full_path)
     else:
       logging.error(
           'Attempted do_GET_static() of path [%s] outside of static dir [%s]'
-          % (full_path, static_dir))
+          % (full_path, STATIC_CONTENTS_DIR))
       self.send_error(404)
 
   def do_POST(self):
@@ -471,18 +456,6 @@ class HTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler):
     else:
       self.send_error(404)
 
-  def send_json_dict(self, json_dict):
-    """ Send the contents of this dictionary in JSON format, with a JSON
-        mimetype.
-
-    Args:
-      json_dict: dictionary to send
-    """
-    self.send_response(200)
-    self.send_header('Content-type', 'application/json')
-    self.end_headers()
-    json.dump(json_dict, self.wfile)
-
 
 def main():
   logging.basicConfig(format='%(asctime)s %(levelname)s %(message)s',