Issue 5535 - Replace our module system with webpack

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
+import shutil
 from StringIO import StringIO
 import struct
+import subprocess
 import sys
-import collections
+import tempfile
 
 from packager import (readMetadata, getDefaultFileName, getBuildVersion,
                       getTemplate, Files)
 
 defaultLocale = 'en_US'
 
 
 def getIgnoredFiles(params):
     return {'store.description'}
 
@@ skipping 108 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 convertJS(params, files):
-    output_files = collections.OrderedDict()
-    args = {}
+def create_bundles(params, files):
+    base_extension_path = params['baseDir']
+    info_templates = {
+        'chrome': 'chromeInfo.js.tmpl',
+        'edge': 'edgeInfo.js.tmpl',
+        'gecko-webext': 'geckoInfo.js.tmpl'
+    }
+    info_module = None
 
-    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
+    # Once we use relative paths when requiring modules we can remove these,
+    # but in the mean time Webpack needs to know where to look.
+    resolve_paths = ' '.join(['./lib',
+                              './adblockpluscore/lib',
+                              './adblockplusui/lib'])
+    try:
+        temp_dir = tempfile.mkdtemp()
+        template = getTemplate(info_templates[params['type']])
+        with tempfile.NamedTemporaryFile(delete=False) as info_file:

[tlucas, 2017/09/22 10:27:07]

You are creating two separate temporary instances - resulting in having to take
care of getting rid of two things i two different ways.

What do think about about just using the temporary folder, along with a
subfolder 'files' and a file 'info_module' (which you write the rendered
template to)?

That way you would only have to call

    finally:
        shutil.rmtree(temp_dir)

in order to get rid of everything temporary.

[kzar, 2017/09/22 14:01:51]

Good idea, we might as well have everything deleted at the same time.
Done.

+            info_file.write(
+                template.render(
+                    basename=params['metadata'].get('general', 'basename'),
+                    version=params['metadata'].get('general', 'version')
+                ).encode('utf-8')
+            )
+            info_module = info_file.name
 
-    template = getTemplate('modules.js.tmpl')
+        for item in params['metadata'].items('bundles'):
+            name, value = item
+            base_item_path = os.path.dirname(item.source)
 
-    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 = []
-
-        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,
-            basename=params['metadata'].get('general', 'basename'),
-            modules=modules,
-            type=params['type'],
-            version=params['metadata'].get('general', 'version')
-        ).encode('utf-8')
+            bundle_file = os.path.relpath(os.path.join(base_item_path, name),
+                                          base_extension_path)
+            entry_files = [
+                os.path.join(
+                    '.',
+                    os.path.relpath(os.path.join(base_item_path, module_path),
+                                    base_extension_path)
+                )
+                for module_path in value.split()
+            ]
+            subprocess.check_call(
+                ['npm', 'run-script', 'webpack'],
+                cwd=os.path.dirname(__file__),
+                env={
+                    'EXTENSION_PATH': base_extension_path,
+                    'ENTRY_POINTS': ' '.join(entry_files),
+                    'OUTPUT_PATH': temp_dir,
+                    'BUNDLE_NAME': bundle_file,
+                    'RESOLVE_PATHS': resolve_paths,
+                    'INFO_PATH': info_module,
+                    'PATH': os.environ['PATH']
+                }
+            )
+            for file_name in [bundle_file, bundle_file + '.map']:
+                with open(os.path.join(temp_dir, file_name), 'r') as f:
+                    files[file_name] = f.read()
+    finally:
+        if info_module:
+            os.remove(info_module)
+        shutil.rmtree(temp_dir)
 
 
 def toJson(data):
     return json.dumps(
         data, ensure_ascii=False, sort_keys=True,
         indent=2, separators=(',', ': ')
     ).encode('utf-8') + '\n'
 
 
 def import_string_webext(data, key, source):
@@ skipping 188 matching lines @@
         'metadata': metadata,
     }
 
     mapped = metadata.items('mapping') if metadata.has_section('mapping') else []
     files = Files(getPackageFiles(params), getIgnoredFiles(params),
                   process=lambda path, data: processFile(path, data, params))
 
     files.readMappedFiles(mapped)
     files.read(baseDir, skip=[opt for opt, _ in mapped])
 
-    if metadata.has_section('convert_js'):
-        convertJS(params, files)
+    if metadata.has_section('bundles'):
+        create_bundles(params, files)
 
     if metadata.has_section('preprocess'):
         files.preprocess(
             [f for f, _ in metadata.items('preprocess')],
             {'needsExt': True}
         )
 
     if metadata.has_section('import_locales'):
         import_locales(params, files)
 
@@ skipping 12 matching lines @@
                 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)