Merge pull request #6907 from telamonian/fix-lab-build-prod

Fix lab build prod
jupyterlab · Aug 1, 2019 · bdf6136 · bdf6136
2 parents 97bc2ca + f7f3fb8
commit bdf6136
Show file tree

Hide file tree

Showing 9 changed files with 110 additions and 47 deletions.
diff --git a/dev_mode/package.json b/dev_mode/package.json
@@ -4,8 +4,11 @@
   "private": true,
   "scripts": {
     "build": "webpack",
+    "build:dev": "jlpm run build",
+    "build:dev:minimize": "jlpm run build:dev",
     "build:prod": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --config webpack.prod.config.js",
-    "build:prod:stats": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --profile --config webpack.prod.config.js --json > stats.json",
+    "build:prod:minimize": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --config webpack.prod.minimize.config.js",
+    "build:prod:stats": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --profile --config webpack.prod.minimize.config.js --json > stats.json",
     "build:stats": "webpack --profile --json > stats.json",
     "clean": "rimraf build",
     "prepublishOnly": "npm run build",

diff --git a/dev_mode/webpack.prod.config.js b/dev_mode/webpack.prod.config.js
@@ -1,28 +1,11 @@
-const TerserPlugin = require('terser-webpack-plugin');
 var merge = require('webpack-merge');
 var config = require('./webpack.config');
 
 config[0] = merge(config[0], {
   mode: 'production',
   devtool: 'source-map',
   optimization: {
-    minimizer: [
-      new TerserPlugin({
-        parallel: true,
-        sourceMap: true,
-        terserOptions: {
-          compress: false,
-          ecma: 6,
-          mangle: true,
-          output: {
-            beautify: false,
-            comments: false
-          },
-          safari10: true
-        },
-        cache: process.platform !== 'win32'
-      })
-    ]
+    minimize: false
   }
 });
 

diff --git a/dev_mode/webpack.prod.minimize.config.js b/dev_mode/webpack.prod.minimize.config.js
@@ -0,0 +1,29 @@
+const TerserPlugin = require('terser-webpack-plugin');
+var merge = require('webpack-merge');
+var config = require('./webpack.config');
+
+config[0] = merge(config[0], {
+  mode: 'production',
+  devtool: 'source-map',
+  optimization: {
+    minimizer: [
+      new TerserPlugin({
+        parallel: true,
+        sourceMap: true,
+        terserOptions: {
+          compress: false,
+          ecma: 6,
+          mangle: true,
+          output: {
+            beautify: false,
+            comments: false
+          },
+          safari10: true
+        },
+        cache: process.platform !== 'win32'
+      })
+    ]
+  }
+});
+
+module.exports = config;
diff --git a/jupyterlab/commands.py b/jupyterlab/commands.py
@@ -534,10 +534,19 @@ def install_extension(self, extension, existing=None):
         return True
 
     def build(self, name=None, version=None, static_url=None,
-              command='build:prod', clean_staging=False):
+              command='build:prod:minimize', clean_staging=False):
         """Build the application.
         """
-        self.logger.info('Building jupyterlab assets')
+        # resolve the build type
+        parts = command.split(':')
+        if len(parts) < 2:
+            parts.append('dev')
+        elif parts[1] == 'none':
+            parts[1] = ('dev' if self.info['linked_packages'] or self.info['local_extensions'] else
+                        'prod')
+        command = ':'.join(parts)
+
+        self.logger.info(f'Building jupyterlab assets ({command})')
 
         # Set up the build directory.
         app_dir = self.app_dir
@@ -990,6 +999,7 @@ def _populate_staging(self, name=None, version=None, static_url=None,
 
         for fname in ['index.js', 'webpack.config.js',
                       'webpack.prod.config.js',
+                      'webpack.prod.minimize.config.js',
                       '.yarnrc', 'yarn.js']:
             target = pjoin(staging, fname)
             shutil.copy(pjoin(HERE, 'staging', fname), target)

diff --git a/jupyterlab/labapp.py b/jupyterlab/labapp.py
@@ -30,6 +30,7 @@
 build_aliases['name'] = 'LabBuildApp.name'
 build_aliases['version'] = 'LabBuildApp.version'
 build_aliases['dev-build'] = 'LabBuildApp.dev_build'
+build_aliases['minimize'] = 'LabBuildApp.minimize'
 build_aliases['debug-log-path'] = 'DebugLogFileMixin.debug_log_path'
 
 build_flags = dict(flags)
@@ -61,14 +62,24 @@ class LabBuildApp(JupyterApp, DebugLogFileMixin):
     version = Unicode('', config=True,
         help="The version of the built application")
 
-    dev_build = Bool(True, config=True,
-        help="Whether to build in dev mode (defaults to dev mode)")
+    dev_build = Bool(None, allow_none=True, config=True,
+        help="Whether to build in dev mode. Defaults to True (dev mode) if there are any locally linked extensions, else defaults to False (prod mode).")
+
+    minimize = Bool(True, config=True,
+        help="Whether to use a minifier during the Webpack build (defaults to True). Only affects production builds.")
 
     pre_clean = Bool(False, config=True,
         help="Whether to clean before building (defaults to False)")
 
     def start(self):
-        command = 'build:prod' if not self.dev_build else 'build'
+        parts = ['build']
+        parts.append('none' if self.dev_build is None else
+                     'dev' if self.dev_build else
+                     'prod')
+        if self.minimize:
+            parts.append('minimize')
+        command = ':'.join(parts)
+
         app_dir = self.app_dir or get_app_dir()
         self.log.info('JupyterLab %s', version)
         with self.debug_logging():
@@ -77,7 +88,7 @@ def start(self):
                 clean(self.app_dir)
             self.log.info('Building in %s', app_dir)
             build(app_dir=app_dir, name=self.name, version=self.version,
-                command=command, logger=self.log)
+                  command=command, logger=self.log)
 
 
 clean_aliases = dict(base_aliases)

diff --git a/jupyterlab/labextensions.py b/jupyterlab/labextensions.py
@@ -53,8 +53,10 @@
 aliases = dict(base_aliases)
 aliases['app-dir'] = 'BaseExtensionApp.app_dir'
 aliases['dev-build'] = 'BaseExtensionApp.dev_build'
+aliases['minimize'] = 'BaseExtensionApp.minimize'
 aliases['debug-log-path'] = 'DebugLogFileMixin.debug_log_path'
 
+
 VERSION = get_app_version()
 
 
@@ -69,8 +71,11 @@ class BaseExtensionApp(JupyterApp, DebugLogFileMixin):
     should_build = Bool(True, config=True,
         help="Whether to build the app after the action")
 
-    dev_build = Bool(True, config=True,
-        help="Whether to build in dev mode (defaults to dev mode)")
+    dev_build = Bool(None, allow_none=True, config=True,
+        help="Whether to build in dev mode. Defaults to True (dev mode) if there are any locally linked extensions, else defaults to False (prod mode).")
+
+    minimize = Bool(True, config=True,
+        help="Whether to use a minifier during the Webpack build (defaults to True). Only affects production builds.")
 
     should_clean = Bool(False, config=True,
         help="Whether temporary files should be cleaned up after building jupyterlab")
@@ -81,7 +86,14 @@ def start(self):
         with self.debug_logging():
             ans = self.run_task()
             if ans and self.should_build:
-                command = 'build:prod' if not self.dev_build else 'build'
+                parts = ['build']
+                parts.append('none' if self.dev_build is None else
+                             'dev' if self.dev_build else
+                             'prod')
+                if self.minimize:
+                    parts.append('minimize')
+                command = ':'.join(parts)
+
                 build(app_dir=self.app_dir, clean_staging=self.should_clean,
                       logger=self.log, command=command)
 

diff --git a/jupyterlab/staging/package.json b/jupyterlab/staging/package.json
@@ -4,8 +4,11 @@
   "private": true,
   "scripts": {
     "build": "webpack",
+    "build:dev": "jlpm run build",
+    "build:dev:minimize": "jlpm run build:dev",
     "build:prod": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --config webpack.prod.config.js",
-    "build:prod:stats": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --profile --config webpack.prod.config.js --json > stats.json",
+    "build:prod:minimize": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --config webpack.prod.minimize.config.js",
+    "build:prod:stats": "cross-env NODE_OPTIONS=--max_old_space_size=4096 webpack --profile --config webpack.prod.minimize.config.js --json > stats.json",
     "build:stats": "webpack --profile --json > stats.json",
     "clean": "rimraf build",
     "prepublishOnly": "npm run build",

diff --git a/jupyterlab/staging/webpack.prod.config.js b/jupyterlab/staging/webpack.prod.config.js
@@ -1,28 +1,11 @@
-const TerserPlugin = require('terser-webpack-plugin');
 var merge = require('webpack-merge');
 var config = require('./webpack.config');
 
 config[0] = merge(config[0], {
   mode: 'production',
   devtool: 'source-map',
   optimization: {
-    minimizer: [
-      new TerserPlugin({
-        parallel: true,
-        sourceMap: true,
-        terserOptions: {
-          compress: false,
-          ecma: 6,
-          mangle: true,
-          output: {
-            beautify: false,
-            comments: false
-          },
-          safari10: true
-        },
-        cache: process.platform !== 'win32'
-      })
-    ]
+    minimize: false
   }
 });
 

diff --git a/jupyterlab/staging/webpack.prod.minimize.config.js b/jupyterlab/staging/webpack.prod.minimize.config.js
@@ -0,0 +1,29 @@
+const TerserPlugin = require('terser-webpack-plugin');
+var merge = require('webpack-merge');
+var config = require('./webpack.config');
+
+config[0] = merge(config[0], {
+  mode: 'production',
+  devtool: 'source-map',
+  optimization: {
+    minimizer: [
+      new TerserPlugin({
+        parallel: true,
+        sourceMap: true,
+        terserOptions: {
+          compress: false,
+          ecma: 6,
+          mangle: true,
+          output: {
+            beautify: false,
+            comments: false
+          },
+          safari10: true
+        },
+        cache: process.platform !== 'win32'
+      })
+    ]
+  }
+});
+
+module.exports = config;