[MD History] Vulcanize as part of GN build.

chrome/browser/resources/vulcanize_gn.py

 #!/usr/bin/env python
 # Copyright 2016 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 argparse
 import itertools
 import os
 import platform
 import re
@@ skipping 24 matching lines @@
 
 
 _JS_RESOURCES_PATH = os.path.join(_RESOURCES_PATH, 'js')
 
 
 _POLYMER_PATH = os.path.join(
     _SRC_PATH, 'third_party', 'polymer', 'v1_0', 'components-chromium')
 
 
 _VULCANIZE_BASE_ARGS = [
   '--exclude', 'crisper.js',

[dpapad, 2017/02/08 23:04:18]

Is this necessary? We run crisper after vulcanize, so there shouldn't be any
crisper.js references by the time vulcanize runs.

Besides that, it also refers to a hardcoded crisper.js name instead of using
js_out_file, so probably obsolete.

[calamity, 2017/02/09 03:07:35]

I've removed this and nothing bad seems to have happened.

 
   # These files are already combined and minified.
   '--exclude', 'chrome://resources/html/polymer.html',
   '--exclude', 'web-animations-next-lite.min.js',
 
   # These files are dynamically created by C++.
   '--exclude', 'load_time_data.js',
   '--exclude', 'strings.js',
   '--exclude', 'text_defaults.css',
   '--exclude', 'text_defaults_md.css',
@@ skipping 10 matching lines @@
     ('chrome://resources/html/', _HTML_RESOURCES_PATH),
     ('chrome://resources/js/', _JS_RESOURCES_PATH),
     ('chrome://resources/polymer/v1_0/', _POLYMER_PATH)
 ]
 
 
 _VULCANIZE_REDIRECT_ARGS = list(itertools.chain.from_iterable(map(
     lambda m: ['--redirect', '"%s|%s"' % (m[0], m[1])], _URL_MAPPINGS)))
 
 
-_REQUEST_LIST_FILE = 'request_list.txt'
-
-
 _PAK_UNPACK_FOLDER = 'flattened'
 
 
 def _run_node(cmd_parts, stdout=None):
   cmd = " ".join([node.GetBinaryPath()] + cmd_parts)
   process = subprocess.Popen(
       cmd, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
   stdout, stderr = process.communicate()
 
   if stderr:
     print >> sys.stderr, '%s failed: %s' % (cmd, stderr)
     raise
 
   return stdout
 
 
 def _undo_mapping(mappings, url):
   for (redirect_url, file_path) in mappings:
     if url.startswith(redirect_url):
       return url.replace(redirect_url, file_path + os.sep)
   return url
 
+def _request_list_path(out_path, html_out_file):
+  return os.path.join(out_path, html_out_file + '.requestlist')

[dpapad, 2017/02/08 23:04:19]

I am not super fond of using random file extensions for a text file. Can we
either name it
<html_out_file>_requestlist.txt OR
<html_out_file>_requestlist (no extension at all)?

Also, I guess html_out_file is unique, even if there are multiple vulcanize()
targets in the same BUILD.gn file, so this is OK. The alternative is to pass
${target_name} from the gni to the python script, which is guaranteed to always
be unique. In this case it would generate two files:

vulcanize_app_requestlist.txt and vulcanize_lazy_load_request_list.txt

[calamity, 2017/02/09 03:07:35]

I've changed it to <html_out_file>_requestlist.txt because I think it's easier
to associate with the actual file it relates to. And the .txt extension ensures
this will openly correctly on Windows in Notepad.

 
 # Get a list of all files that were bundled with Vulcanize and update the
 # depfile accordingly such that Ninja knows when to trigger re-vulcanization.
 def _update_dep_file(in_folder, args):
   in_path = os.path.join(_CWD, in_folder)
   out_path = os.path.join(_CWD, args.out_folder)
 
   # Prior call to vulcanize already generated the deps list, grab it from there.
-  request_list = open(os.path.join(
-      out_path, _REQUEST_LIST_FILE), 'r').read().splitlines()

[Dan Beam, 2017/02/08 05:41:55]

rebase

[calamity, 2017/02/09 03:07:35]

Done.

+  request_list = open(_request_list_path(out_path, args.html_out_file),
+                      'r').read().splitlines()
 
   # Undo the URL mappings applied by vulcanize to get file paths relative to
   # current working directory.
   url_mappings = _URL_MAPPINGS + [
       ('/', os.path.relpath(in_path, _CWD)),
       ('chrome://%s/' % args.host, os.path.relpath(in_path, _CWD)),
   ]
 
   dependencies = map(
       lambda url: _undo_mapping(url_mappings, url), request_list)
@@ skipping 12 matching lines @@
             filtered_dependencies))
 
 
 def _vulcanize(in_folder, args):
   in_path = os.path.normpath(os.path.join(_CWD, in_folder))
   out_path = os.path.join(_CWD, args.out_folder)
 
   html_out_path = os.path.join(out_path, args.html_out_file)
   js_out_path = os.path.join(out_path, args.js_out_file)
 
+  exclude_args = []
+  for f in args.exclude or []:
+    exclude_args.append('--exclude')
+    exclude_args.append(f)
+
   output = _run_node(
       [node_modules.PathToVulcanize()] +
-      _VULCANIZE_BASE_ARGS + _VULCANIZE_REDIRECT_ARGS +
-      ['--out-request-list', os.path.join(out_path, _REQUEST_LIST_FILE),
+      _VULCANIZE_BASE_ARGS + _VULCANIZE_REDIRECT_ARGS + exclude_args +
+      ['--out-request-list', _request_list_path(out_path, args.html_out_file),
        '--redirect', '"/|%s"' % in_path,
        '--redirect', '"chrome://%s/|%s"' % (args.host, in_path),
        # TODO(dpapad): Figure out why vulcanize treats the input path
        # differently on Windows VS Linux/Mac.
        os.path.join(
            in_path if platform.system() == 'Windows' else os.sep,
            args.html_in_file)])
 
   # Grit includes are not supported, use HTML imports instead.
   output = output.replace('<include src="', '<include src-disabled="')
@@ skipping 24 matching lines @@
 def _css_build(out_folder, files):
   out_path = os.path.join(_CWD, out_folder)
   paths = map(lambda f: os.path.join(out_path, f), files)
 
   _run_node([node_modules.PathToPolymerCssBuild()] + paths)
 
 
 def main():
   parser = argparse.ArgumentParser()
   parser.add_argument('--depfile')
+  parser.add_argument('--exclude', action='append')

[Dan Beam, 2017/02/08 05:41:55]

rebase

[calamity, 2017/02/09 03:07:35]

Done.

   parser.add_argument('--host')
   parser.add_argument('--html_in_file')
   parser.add_argument('--html_out_file')
   parser.add_argument('--input')
   parser.add_argument('--input_type')
   parser.add_argument('--insert_in_head')
   parser.add_argument('--js_out_file')
   parser.add_argument('--out_folder')
   args = parser.parse_args()
   args.input = os.path.normpath(args.input)
 
   vulcanize_input_folder = args.input
 
   # If a .pak file was specified, unpack that file first and pass the output to
   # vulcanize.
   if (args.input_type == 'PAK_FILE'):
     import unpack_pak
-    input_folder = os.path.join(_CWD, args.input)
     output_folder = os.path.join(args.out_folder, _PAK_UNPACK_FOLDER)
     unpack_pak.unpack(args.input, output_folder)
     vulcanize_input_folder = output_folder
 
   _vulcanize(vulcanize_input_folder, args)
   _css_build(args.out_folder, files=[args.html_out_file])
 
   _update_dep_file(vulcanize_input_folder, args)
 
 
 if __name__ == '__main__':
   main()