Issue 5060 - Move require into modules template, make info a module

packagerChrome.py

 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 import errno
 import io
 import json
 import os
 import re
 from StringIO import StringIO
@@ skipping 120 matching lines @@
     # Normalize JSON structure
     licenseComment = re.compile(r'/\*.*?\*/', re.S)
     data = json.loads(re.sub(licenseComment, '', manifest, 1))
     if '_dummy' in data:
         del data['_dummy']
     manifest = json.dumps(data, sort_keys=True, indent=2)
 
     return manifest.encode('utf-8')
 
 
-def createInfoModule(params):
-    if params['type'] == 'gecko-webext':
-        template = getTemplate('geckoInfo.js.tmpl')
-    else:
-        template = getTemplate('chromeInfo.js.tmpl')
-    return template.render(params).encode('utf-8')
-
-
 def convertJS(params, files):
     output_files = collections.OrderedDict()
     args = {}
 
+    info_module = None

[Sebastian Noack, 2017/03/31 10:42:01]

How about merging chromeInfo.js.tmpl, geckoInfo.js.tmpl and modules.js.tmpl into
one template:
  
  require.modules["info"] = function(module, exports)
  {
    {%- if type == "gecko-webext" %}
       ...
    {%- elif type == "edge" %}
       ...
    {%- else %}
       ...
    {%- endif %}
    
    exports.addonName = {{ metadata.get('general', 'basename')|json }};
    exports.addonVersion = {{ version|json }};
    exports.application = application;
    exports.applicationVersion = applicationVersion;
    exports.platform = platform;
    exports.platformVersion = platformVersion;
    return exports;  
  };
  {%- for module_name, script in modules -%}
  require.modules[{{ module_name|json }}] = function(module, exports)
  {
  {{ script }}
  return module.exports;
  };

  {% endfor -%}

That way, we...

1. simplify the logic here in the packager.
2. remove some duplication from the info module's code.
3. unify how different targets are handled (currently
   the logic for Edge is merged into the one for Chrome,
   while FF/WebExt have an independent implementation).

[kzar, 2017/03/31 14:03:01]

Well I tried that and figured that repeating the module wrapping boilreplate for
the info module kind of sucked. But then on the other hand perhaps you're right
and it's worth it to reduce complexity from the packager.

As for splitting out the Edge user-agent parsing code from Chrome's, no thanks.
I am not familiar with that code at all, it's hardly trivial and the Edge logic
overlaps with the Chrome logic quite a bit.

Done... kinda.

[Sebastian Noack, 2017/03/31 14:50:45]

We definitely should clean up that mess and target every platform that has
separate builds the same way. But I guess, we don't necessarily have to do it
with the changes here.

+    info_template = {
+        'chrome': 'chromeInfo.js.tmpl',
+        'gecko-webext': 'geckoInfo.js.tmpl'
+    }.get(params['type'])
+    if info_template:
+        info_module = getTemplate(info_template).render(
+            basename=params['metadata'].get('general', 'basename'),
+            version=params['metadata'].get('general', 'version')
+        ).decode('utf-8')
+
     for item in params['metadata'].items('convert_js'):
         name, value = item
         filename, arg = re.search(r'^(.*?)(?:\[(.*)\])?$', name).groups()
         if arg is None:
             output_files[filename] = (value.split(), item.source)
         else:
             args.setdefault(filename, {})[arg] = value
 
     template = getTemplate('modules.js.tmpl')
 
     for filename, (input_files, origin) in output_files.iteritems():
         if '/' in filename and not files.isIncluded(filename):
             continue
 
         current_args = args.get(filename, {})
         current_args['autoload'] = [module for module in
                                     current_args.get('autoload', '').split(',')
                                     if module != '']
 
         base_dir = os.path.dirname(origin)
         modules = []
 
+        if 'module' in current_args and info_module:
+            modules.append(('info', info_module))
+
         for input_filename in input_files:
             module_name = os.path.splitext(os.path.basename(input_filename))[0]
             prefix = os.path.basename(os.path.dirname(input_filename))
             if prefix != 'lib':
                 module_name = '{}_{}'.format(prefix, module_name)
             with open(os.path.join(base_dir, input_filename), 'r') as file:
                 modules.append((module_name, file.read().decode('utf-8')))
             files.pop(input_filename, None)
 
         files[filename] = template.render(
             args=current_args,
-            modules=modules
+            modules=modules,
+            basename=params['metadata'].get('general', 'basename'),
+            version=params['metadata'].get('general', 'version')
         ).encode('utf-8')
 
 
 def toJson(data):
     return json.dumps(
         data, ensure_ascii=False, sort_keys=True,
         indent=2, separators=(',', ': ')
     ).encode('utf-8') + '\n'
 
 
@@ skipping 192 matching lines @@
     files['manifest.json'] = createManifest(params, files)
     if type == 'chrome':
         fixTranslationsForCWS(files)
 
     if devenv:
         import buildtools
         import random
         files.read(os.path.join(buildtools.__path__[0], 'chromeDevenvPoller__.js'), relpath='devenvPoller__.js')
         files['devenvVersion__'] = str(random.random())
 
-    if (metadata.has_option('general', 'backgroundScripts') and
-        'lib/info.js' in metadata.get('general', 'backgroundScripts').split() and
-        'lib/info.js' not in files):
-        files['lib/info.js'] = createInfoModule(params)
-
     if metadata.has_option('general', 'testScripts'):
         files['qunit/index.html'] = createScriptPage(params, 'testIndex.html.tmpl',
                                                      ('general', 'testScripts'))
 
     zipdata = files.zipToString()
     signature = None
     pubkey = None
     if keyFile != None:
         signature = signBinary(zipdata, keyFile)
         pubkey = getPublicKey(keyFile)
     writePackage(outFile, pubkey, signature, zipdata)