webpack-bundle-analyzer 3.3.0 → 3.4.1

package/src/BundleAnalyzerPlugin.js

@@ -8,11 +8,10 @@ const viewer = require('./viewer');
 
 class BundleAnalyzerPlugin {
 
-  constructor(opts) {
+  constructor(opts = {}) {
     this.opts = {
       analyzerMode: 'server',
       analyzerHost: '127.0.0.1',
-      analyzerPort: 8888,
       reportFilename: 'report.html',
       defaultSizes: 'parsed',
       openAnalyzer: true,
@@ -23,7 +22,8 @@ class BundleAnalyzerPlugin {
       logLevel: 'info',
       // deprecated
       startAnalyzer: true,
-      ...opts
+      ...opts,
+      analyzerPort: 'analyzerPort' in opts ? (opts.analyzerPort === 'auto' ? 0 : opts.analyzerPort) : 8888
     };
 
     this.server = null;
@@ -35,12 +35,11 @@ class BundleAnalyzerPlugin {
 
     const done = (stats, callback) => {
       callback = callback || (() => {});
-      stats = stats.toJson(this.opts.statsOptions);
 
       const actions = [];
 
       if (this.opts.generateStatsFile) {
-        actions.push(() => this.generateStatsFile(stats));
+        actions.push(() => this.generateStatsFile(stats.toJson(this.opts.statsOptions)));
       }
 
       // Handling deprecated `startAnalyzer` flag
@@ -49,9 +48,9 @@ class BundleAnalyzerPlugin {
       }
 
       if (this.opts.analyzerMode === 'server') {
-        actions.push(() => this.startAnalyzerServer(stats));
+        actions.push(() => this.startAnalyzerServer(stats.toJson()));
       } else if (this.opts.analyzerMode === 'static') {
-        actions.push(() => this.generateStaticReport(stats));
+        actions.push(() => this.generateStaticReport(stats.toJson()));
       }
 
       if (actions.length) {
@@ -128,7 +127,16 @@ class BundleAnalyzerPlugin {
   }
 
   getBundleDirFromCompiler() {
-    return (this.compiler.outputFileSystem.constructor.name === 'MemoryFileSystem') ? null : this.compiler.outputPath;
+    switch (this.compiler.outputFileSystem.constructor.name) {
+      case 'MemoryFileSystem':
+        return null;
+      // Detect AsyncMFS used by Nuxt 2.5 that replaces webpack's MFS during development
+      // Related: #274
+      case 'AsyncMFS':
+        return null;
+      default:
+        return this.compiler.outputPath;
+    }
   }
 
 }

package/src/bin/analyzer.js

@@ -32,14 +32,15 @@ const program = commander
     'server'
   )
   .option(
-    '-h, --host <host>',
+    // Had to make `host` parameter optional in order to let `-h` flag output help message
+    // Fixes https://github.com/webpack-contrib/webpack-bundle-analyzer/issues/239
+    '-h, --host [host]',
     'Host that will be used in `server` mode to start HTTP server.',
     '127.0.0.1'
   )
   .option(
     '-p, --port <n>',
     'Port that will be used in `server` mode to start HTTP server.',
-    Number,
     8888
   )
   .option(
@@ -86,8 +87,12 @@ const logger = new Logger(logLevel);
 
 if (!bundleStatsFile) showHelp('Provide path to Webpack Stats file as first argument');
 if (mode !== 'server' && mode !== 'static') showHelp('Invalid mode. Should be either `server` or `static`.');
-if (mode === 'server' && !host) showHelp('Invalid host name');
-if (mode === 'server' && isNaN(port)) showHelp('Invalid port number');
+if (mode === 'server') {
+  if (!host) showHelp('Invalid host name');
+
+  port = port === 'auto' ? 0 : Number(port);
+  if (isNaN(port)) showHelp('Invalid port. Should be a number or `auto`');
+}
 if (!SIZES.has(defaultSizes)) showHelp(`Invalid default sizes option. Possible values are: ${[...SIZES].join(', ')}`);
 
 bundleStatsFile = resolve(bundleStatsFile);
@@ -125,7 +130,7 @@ if (mode === 'server') {
 }
 
 function showHelp(error) {
-  if (error) console.log(`\n  ${magenta(error)}`);
+  if (error) console.log(`\n  ${magenta(error)}\n`);
   program.outputHelp();
   process.exit(1);
 }

package/src/viewer.js

@@ -14,6 +14,7 @@ const Logger = require('./Logger');
 const analyzer = require('./analyzer');
 
 const projectRoot = path.resolve(__dirname, '..');
+const assetsRoot = path.join(projectRoot, 'public');
 
 module.exports = {
   startServer,
@@ -51,9 +52,11 @@ async function startServer(bundleStats, opts) {
   app.use('/', (req, res) => {
     res.render('viewer', {
       mode: 'server',
-      get chartData() { return JSON.stringify(chartData) },
-      defaultSizes: JSON.stringify(defaultSizes),
-      enableWebSocket: true
+      get chartData() { return chartData },
+      defaultSizes,
+      enableWebSocket: true,
+      // Helpers
+      escapeJson
     });
   });
 
@@ -130,10 +133,12 @@ async function generateReport(bundleStats, opts) {
       `${projectRoot}/views/viewer.ejs`,
       {
         mode: 'static',
-        chartData: JSON.stringify(chartData),
+        chartData,
+        defaultSizes,
+        enableWebSocket: false,
+        // Helpers
         assetContent: getAssetContent,
-        defaultSizes: JSON.stringify(defaultSizes),
-        enableWebSocket: false
+        escapeJson
       },
       (err, reportHtml) => {
         try {
@@ -165,7 +170,20 @@ async function generateReport(bundleStats, opts) {
 }
 
 function getAssetContent(filename) {
-  return fs.readFileSync(`${projectRoot}/public/${filename}`, 'utf8');
+  const assetPath = path.join(assetsRoot, filename);
+
+  if (!assetPath.startsWith(assetsRoot)) {
+    throw new Error(`"${filename}" is outside of the assets root`);
+  }
+
+  return fs.readFileSync(assetPath, 'utf8');
+}
+
+/**
+ * Escapes `<` characters in JSON to safely use it in `<script>` tag.
+ */
+function escapeJson(json) {
+  return JSON.stringify(json).replace(/</gu, '\\u003c');
 }
 
 function getChartData(analyzerOpts, ...args) {

package/views/script.ejs

@@ -4,5 +4,5 @@
     <%- assetContent(filename) %>
   </script>
 <% } else { %>
-  <script src="/<%= filename %>"></script>
+  <script src="<%= filename %>"></script>
 <% } %>

package/views/viewer.ejs

@@ -11,9 +11,9 @@
   <body>
     <div id="app"></div>
     <script>
-      window.chartData = <%- chartData %>;
-      window.defaultSizes = <%- defaultSizes %>;
-      window.enableWebSocket = <%- enableWebSocket %>;
+      window.chartData = <%- escapeJson(chartData) %>;
+      window.defaultSizes = <%- escapeJson(defaultSizes) %>;
+      window.enableWebSocket = <%- escapeJson(enableWebSocket) %>;
     </script>
   </body>
 </html>