webpack-bundle-analyzer 4.4.2 → 4.5.0

package/src/BundleAnalyzerPlugin.js

@@ -1,154 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-const {bold} = require('chalk');
-
-const Logger = require('./Logger');
-const viewer = require('./viewer');
-const utils = require('./utils');
-const {writeStats} = require('./statsUtils');
-
-class BundleAnalyzerPlugin {
-  constructor(opts = {}) {
-    this.opts = {
-      analyzerMode: 'server',
-      analyzerHost: '127.0.0.1',
-      reportFilename: null,
-      reportTitle: utils.defaultTitle,
-      defaultSizes: 'parsed',
-      openAnalyzer: true,
-      generateStatsFile: false,
-      statsFilename: 'stats.json',
-      statsOptions: null,
-      excludeAssets: null,
-      logLevel: 'info',
-      // deprecated
-      startAnalyzer: true,
-      ...opts,
-      analyzerPort: 'analyzerPort' in opts ? (opts.analyzerPort === 'auto' ? 0 : opts.analyzerPort) : 8888
-    };
-
-    this.server = null;
-    this.logger = new Logger(this.opts.logLevel);
-  }
-
-  apply(compiler) {
-    this.compiler = compiler;
-
-    const done = (stats, callback) => {
-      callback = callback || (() => {});
-
-      const actions = [];
-
-      if (this.opts.generateStatsFile) {
-        actions.push(() => this.generateStatsFile(stats.toJson(this.opts.statsOptions)));
-      }
-
-      // Handling deprecated `startAnalyzer` flag
-      if (this.opts.analyzerMode === 'server' && !this.opts.startAnalyzer) {
-        this.opts.analyzerMode = 'disabled';
-      }
-
-      if (this.opts.analyzerMode === 'server') {
-        actions.push(() => this.startAnalyzerServer(stats.toJson()));
-      } else if (this.opts.analyzerMode === 'static') {
-        actions.push(() => this.generateStaticReport(stats.toJson()));
-      } else if (this.opts.analyzerMode === 'json') {
-        actions.push(() => this.generateJSONReport(stats.toJson()));
-      }
-
-      if (actions.length) {
-        // Making analyzer logs to be after all webpack logs in the console
-        setImmediate(async () => {
-          try {
-            await Promise.all(actions.map(action => action()));
-            callback();
-          } catch (e) {
-            callback(e);
-          }
-        });
-      } else {
-        callback();
-      }
-    };
-
-    if (compiler.hooks) {
-      compiler.hooks.done.tapAsync('webpack-bundle-analyzer', done);
-    } else {
-      compiler.plugin('done', done);
-    }
-  }
-
-  async generateStatsFile(stats) {
-    const statsFilepath = path.resolve(this.compiler.outputPath, this.opts.statsFilename);
-    await fs.promises.mkdir(path.dirname(statsFilepath), {recursive: true});
-
-    try {
-      await writeStats(stats, statsFilepath);
-
-      this.logger.info(
-        `${bold('Webpack Bundle Analyzer')} saved stats file to ${bold(statsFilepath)}`
-      );
-    } catch (error) {
-      this.logger.error(
-        `${bold('Webpack Bundle Analyzer')} error saving stats file to ${bold(statsFilepath)}: ${error}`
-      );
-    }
-  }
-
-  async startAnalyzerServer(stats) {
-    if (this.server) {
-      (await this.server).updateChartData(stats);
-    } else {
-      this.server = viewer.startServer(stats, {
-        openBrowser: this.opts.openAnalyzer,
-        host: this.opts.analyzerHost,
-        port: this.opts.analyzerPort,
-        reportTitle: this.opts.reportTitle,
-        bundleDir: this.getBundleDirFromCompiler(),
-        logger: this.logger,
-        defaultSizes: this.opts.defaultSizes,
-        excludeAssets: this.opts.excludeAssets
-      });
-    }
-  }
-
-  async generateJSONReport(stats) {
-    await viewer.generateJSONReport(stats, {
-      reportFilename: path.resolve(this.compiler.outputPath, this.opts.reportFilename || 'report.json'),
-      bundleDir: this.getBundleDirFromCompiler(),
-      logger: this.logger,
-      excludeAssets: this.opts.excludeAssets
-    });
-  }
-
-  async generateStaticReport(stats) {
-    await viewer.generateReport(stats, {
-      openBrowser: this.opts.openAnalyzer,
-      reportFilename: path.resolve(this.compiler.outputPath, this.opts.reportFilename || 'report.html'),
-      reportTitle: this.opts.reportTitle,
-      bundleDir: this.getBundleDirFromCompiler(),
-      logger: this.logger,
-      defaultSizes: this.opts.defaultSizes,
-      excludeAssets: this.opts.excludeAssets
-    });
-  }
-
-  getBundleDirFromCompiler() {
-    if (typeof this.compiler.outputFileSystem.constructor === 'undefined') {
-      return 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;
-    }
-  }
-
-}
-
-module.exports = BundleAnalyzerPlugin;

package/src/Logger.js

@@ -1,51 +0,0 @@
-const LEVELS = [
-  'debug',
-  'info',
-  'warn',
-  'error',
-  'silent'
-];
-
-const LEVEL_TO_CONSOLE_METHOD = new Map([
-  ['debug', 'log'],
-  ['info', 'log'],
-  ['warn', 'log']
-]);
-
-class Logger {
-
-  static levels = LEVELS;
-  static defaultLevel = 'info';
-
-  constructor(level = Logger.defaultLevel) {
-    this.activeLevels = new Set();
-    this.setLogLevel(level);
-  }
-
-  setLogLevel(level) {
-    const levelIndex = LEVELS.indexOf(level);
-
-    if (levelIndex === -1) throw new Error(`Invalid log level "${level}". Use one of these: ${LEVELS.join(', ')}`);
-
-    this.activeLevels.clear();
-
-    for (const [i, level] of LEVELS.entries()) {
-      if (i >= levelIndex) this.activeLevels.add(level);
-    }
-  }
-
-  _log(level, ...args) {
-    console[LEVEL_TO_CONSOLE_METHOD.get(level) || level](...args);
-  }
-
-};
-
-LEVELS.forEach(level => {
-  if (level === 'silent') return;
-
-  Logger.prototype[level] = function (...args) {
-    if (this.activeLevels.has(level)) this._log(level, ...args);
-  };
-});
-
-module.exports = Logger;

package/src/analyzer.js

@@ -1,213 +0,0 @@
-const fs = require('fs');
-const path = require('path');
-
-const _ = require('lodash');
-const gzipSize = require('gzip-size');
-
-const Logger = require('./Logger');
-const Folder = require('./tree/Folder').default;
-const {parseBundle} = require('./parseUtils');
-const {createAssetsFilter} = require('./utils');
-
-const FILENAME_QUERY_REGEXP = /\?.*$/u;
-const FILENAME_EXTENSIONS = /\.(js|mjs)$/iu;
-
-module.exports = {
-  getViewerData,
-  readStatsFromFile
-};
-
-function getViewerData(bundleStats, bundleDir, opts) {
-  const {
-    logger = new Logger(),
-    excludeAssets = null
-  } = opts || {};
-
-  const isAssetIncluded = createAssetsFilter(excludeAssets);
-
-  // Sometimes all the information is located in `children` array (e.g. problem in #10)
-  if (_.isEmpty(bundleStats.assets) && !_.isEmpty(bundleStats.children)) {
-    const {children} = bundleStats;
-    bundleStats = bundleStats.children[0];
-    // Sometimes if there are additional child chunks produced add them as child assets,
-    // leave the 1st one as that is considered the 'root' asset.
-    for (let i = 1; i < children.length; i++) {
-      children[i].assets.forEach((asset) => {
-        asset.isChild = true;
-        bundleStats.assets.push(asset);
-      });
-    }
-  } else if (!_.isEmpty(bundleStats.children)) {
-    // Sometimes if there are additional child chunks produced add them as child assets
-    bundleStats.children.forEach((child) => {
-      child.assets.forEach((asset) => {
-        asset.isChild = true;
-        bundleStats.assets.push(asset);
-      });
-    });
-  }
-
-  // Picking only `*.js or *.mjs` assets from bundle that has non-empty `chunks` array
-  bundleStats.assets = bundleStats.assets.filter(asset => {
-    // Filter out non 'asset' type asset if type is provided (Webpack 5 add a type to indicate asset types)
-    if (asset.type && asset.type !== 'asset') {
-      return false;
-    }
-
-    // Removing query part from filename (yes, somebody uses it for some reason and Webpack supports it)
-    // See #22
-    asset.name = asset.name.replace(FILENAME_QUERY_REGEXP, '');
-
-    return FILENAME_EXTENSIONS.test(asset.name) && !_.isEmpty(asset.chunks) && isAssetIncluded(asset.name);
-  });
-
-  // Trying to parse bundle assets and get real module sizes if `bundleDir` is provided
-  let bundlesSources = null;
-  let parsedModules = null;
-
-  if (bundleDir) {
-    bundlesSources = {};
-    parsedModules = {};
-
-    for (const statAsset of bundleStats.assets) {
-      const assetFile = path.join(bundleDir, statAsset.name);
-      let bundleInfo;
-
-      try {
-        bundleInfo = parseBundle(assetFile);
-      } catch (err) {
-        const msg = (err.code === 'ENOENT') ? 'no such file' : err.message;
-        logger.warn(`Error parsing bundle asset "${assetFile}": ${msg}`);
-        continue;
-      }
-
-      bundlesSources[statAsset.name] = _.pick(bundleInfo, 'src', 'runtimeSrc');
-      Object.assign(parsedModules, bundleInfo.modules);
-    }
-
-    if (_.isEmpty(bundlesSources)) {
-      bundlesSources = null;
-      parsedModules = null;
-      logger.warn('\nNo bundles were parsed. Analyzer will show only original module sizes from stats file.\n');
-    }
-  }
-
-  const assets = bundleStats.assets.reduce((result, statAsset) => {
-    // If asset is a childAsset, then calculate appropriate bundle modules by looking through stats.children
-    const assetBundles = statAsset.isChild ? getChildAssetBundles(bundleStats, statAsset.name) : bundleStats;
-    const modules = assetBundles ? getBundleModules(assetBundles) : [];
-    const asset = result[statAsset.name] = _.pick(statAsset, 'size');
-    const assetSources = bundlesSources && _.has(bundlesSources, statAsset.name) ?
-      bundlesSources[statAsset.name] : null;
-
-    if (assetSources) {
-      asset.parsedSize = Buffer.byteLength(assetSources.src);
-      asset.gzipSize = gzipSize.sync(assetSources.src);
-    }
-
-    // Picking modules from current bundle script
-    const assetModules = modules.filter(statModule => assetHasModule(statAsset, statModule));
-
-    // Adding parsed sources
-    if (parsedModules) {
-      const unparsedEntryModules = [];
-
-      for (const statModule of assetModules) {
-        if (parsedModules[statModule.id]) {
-          statModule.parsedSrc = parsedModules[statModule.id];
-        } else if (isEntryModule(statModule)) {
-          unparsedEntryModules.push(statModule);
-        }
-      }
-
-      // Webpack 5 changed bundle format and now entry modules are concatenated and located at the end of it.
-      // Because of this they basically become a concatenated module, for which we can't even precisely determine its
-      // parsed source as it's located in the same scope as all Webpack runtime helpers.
-      if (unparsedEntryModules.length && assetSources) {
-        if (unparsedEntryModules.length === 1) {
-          // So if there is only one entry we consider its parsed source to be all the bundle code excluding code
-          // from parsed modules.
-          unparsedEntryModules[0].parsedSrc = assetSources.runtimeSrc;
-        } else {
-          // If there are multiple entry points we move all of them under synthetic concatenated module.
-          _.pullAll(assetModules, unparsedEntryModules);
-          assetModules.unshift({
-            identifier: './entry modules',
-            name: './entry modules',
-            modules: unparsedEntryModules,
-            size: unparsedEntryModules.reduce((totalSize, module) => totalSize + module.size, 0),
-            parsedSrc: assetSources.runtimeSrc
-          });
-        }
-      }
-    }
-
-    asset.modules = assetModules;
-    asset.tree = createModulesTree(asset.modules);
-    return result;
-  }, {});
-
-  return Object.entries(assets).map(([filename, asset]) => ({
-    label: filename,
-    isAsset: true,
-    // Not using `asset.size` here provided by Webpack because it can be very confusing when `UglifyJsPlugin` is used.
-    // In this case all module sizes from stats file will represent unminified module sizes, but `asset.size` will
-    // be the size of minified bundle.
-    // Using `asset.size` only if current asset doesn't contain any modules (resulting size equals 0)
-    statSize: asset.tree.size || asset.size,
-    parsedSize: asset.parsedSize,
-    gzipSize: asset.gzipSize,
-    groups: _.invokeMap(asset.tree.children, 'toChartData')
-  }));
-}
-
-function readStatsFromFile(filename) {
-  return JSON.parse(
-    fs.readFileSync(filename, 'utf8')
-  );
-}
-
-function getChildAssetBundles(bundleStats, assetName) {
-  return (bundleStats.children || []).find((c) =>
-    _(c.assetsByChunkName)
-      .values()
-      .flatten()
-      .includes(assetName)
-  );
-}
-
-function getBundleModules(bundleStats) {
-  return _(bundleStats.chunks)
-    .map('modules')
-    .concat(bundleStats.modules)
-    .compact()
-    .flatten()
-    .uniqBy('id')
-    // Filtering out Webpack's runtime modules as they don't have ids and can't be parsed (introduced in Webpack 5)
-    .reject(isRuntimeModule)
-    .value();
-}
-
-function assetHasModule(statAsset, statModule) {
-  // Checking if this module is the part of asset chunks
-  return (statModule.chunks || []).some(moduleChunk =>
-    statAsset.chunks.includes(moduleChunk)
-  );
-}
-
-function isEntryModule(statModule) {
-  return statModule.depth === 0;
-}
-
-function isRuntimeModule(statModule) {
-  return statModule.moduleType === 'runtime';
-}
-
-function createModulesTree(modules) {
-  const root = new Folder('.');
-
-  modules.forEach(module => root.addModule(module));
-  root.mergeNestedFolders();
-
-  return root;
-}

package/src/bin/analyzer.js

@@ -1,168 +0,0 @@
-#! /usr/bin/env node
-
-const {resolve, dirname} = require('path');
-
-const commander = require('commander');
-const {magenta} = require('chalk');
-
-const analyzer = require('../analyzer');
-const viewer = require('../viewer');
-const Logger = require('../Logger');
-const utils = require('../utils');
-
-const SIZES = new Set(['stat', 'parsed', 'gzip']);
-
-const program = commander
-  .version(require('../../package.json').version)
-  .usage(
-`<bundleStatsFile> [bundleDir] [options]
-
-  Arguments:
-  
-    bundleStatsFile  Path to Webpack Stats JSON file.
-    bundleDir        Directory containing all generated bundles.
-                     You should provided it if you want analyzer to show you the real parsed module sizes.
-                     By default a directory of stats file is used.`
-  )
-  .option(
-    '-m, --mode <mode>',
-    'Analyzer mode. Should be `server`,`static` or `json`.' +
-      br('In `server` mode analyzer will start HTTP server to show bundle report.') +
-      br('In `static` mode single HTML file with bundle report will be generated.') +
-      br('In `json` mode single JSON file with bundle report will be generated.'),
-    'server'
-  )
-  .option(
-    // 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.',
-    8888
-  )
-  .option(
-    '-r, --report <file>',
-    'Path to bundle report file that will be generated in `static` mode.'
-  )
-  .option(
-    '-t, --title <title>',
-    'String to use in title element of html report.'
-  )
-  .option(
-    '-s, --default-sizes <type>',
-    'Module sizes to show in treemap by default.' +
-    br(`Possible values: ${[...SIZES].join(', ')}`),
-    'parsed'
-  )
-  .option(
-    '-O, --no-open',
-    "Don't open report in default browser automatically."
-  )
-  .option(
-    '-e, --exclude <regexp>',
-    'Assets that should be excluded from the report.' +
-    br('Can be specified multiple times.'),
-    array()
-  )
-  .option(
-    '-l, --log-level <level>',
-    'Log level.' +
-    br(`Possible values: ${[...Logger.levels].join(', ')}`),
-    Logger.defaultLevel
-  )
-  .parse(process.argv);
-
-let {
-  mode,
-  host,
-  port,
-  report: reportFilename,
-  title: reportTitle,
-  defaultSizes,
-  logLevel,
-  open: openBrowser,
-  exclude: excludeAssets,
-  args: [bundleStatsFile, bundleDir]
-} = program;
-const logger = new Logger(logLevel);
-
-if (typeof reportTitle === 'undefined') {
-  reportTitle = utils.defaultTitle;
-}
-
-if (!bundleStatsFile) showHelp('Provide path to Webpack Stats file as first argument');
-if (mode !== 'server' && mode !== 'static' && mode !== 'json') {
-  showHelp('Invalid mode. Should be either `server`, `static` or `json`.');
-}
-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);
-
-if (!bundleDir) bundleDir = dirname(bundleStatsFile);
-
-let bundleStats;
-try {
-  bundleStats = analyzer.readStatsFromFile(bundleStatsFile);
-} catch (err) {
-  logger.error(`Couldn't read webpack bundle stats from "${bundleStatsFile}":\n${err}`);
-  logger.debug(err.stack);
-  process.exit(1);
-}
-
-if (mode === 'server') {
-  viewer.startServer(bundleStats, {
-    openBrowser,
-    port,
-    host,
-    defaultSizes,
-    reportTitle,
-    bundleDir,
-    excludeAssets,
-    logger: new Logger(logLevel)
-  });
-} else if (mode === 'static') {
-  viewer.generateReport(bundleStats, {
-    openBrowser,
-    reportFilename: resolve(reportFilename || 'report.html'),
-    reportTitle,
-    defaultSizes,
-    bundleDir,
-    excludeAssets,
-    logger: new Logger(logLevel)
-  });
-} else if (mode === 'json') {
-  viewer.generateJSONReport(bundleStats, {
-    reportFilename: resolve(reportFilename || 'report.json'),
-    bundleDir,
-    excludeAssets,
-    logger: new Logger(logLevel)
-  });
-}
-
-function showHelp(error) {
-  if (error) console.log(`\n  ${magenta(error)}\n`);
-  program.outputHelp();
-  process.exit(1);
-}
-
-function br(str) {
-  return `\n${' '.repeat(28)}${str}`;
-}
-
-function array() {
-  const arr = [];
-  return (val) => {
-    arr.push(val);
-    return arr;
-  };
-}

package/src/index.js

@@ -1,6 +0,0 @@
-const {start} = require('./viewer');
-
-module.exports = {
-  start,
-  BundleAnalyzerPlugin: require('./BundleAnalyzerPlugin')
-};