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

packagerChrome.py

Index: packagerChrome.py
diff --git a/packagerChrome.py b/packagerChrome.py
index a6555c932a237643011f271336ad7bfe4315f844..bd103da5125b00d76bc740447fcfa8ca84d674f3 100644
--- a/packagerChrome.py
+++ b/packagerChrome.py
@@ -138,18 +138,21 @@ def createManifest(params, files):
     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()
@@ -172,6 +175,9 @@ def convertJS(params, files):
         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))
@@ -183,7 +189,9 @@ def convertJS(params, files):
 
         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')
 
 
@@ -396,11 +404,6 @@ def createBuild(baseDir, type='chrome', outFile=None, buildNum=None, releaseBuil
         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'))