How to optimize webpack's build time using prefetchPlugin & analyse tool?

OptimizationWebpack

Optimization Problem Overview


Previous research:

As webpack's wiki says, it is possible to use the analyse tool to optimize build performance:

> from: https://github.com/webpack/docs/wiki/build-performance#hints-from-build-stats

> ## Hints from build stats > There is an analyse tool which visualise your build and also provides > some hint how build size and build performance can be optimized. > > You can generate the required JSON file by running webpack --profile > --json > stats.json


I generate the stats file (available here) uploaded it to webpack's analize tool
and under Hints tab I told to use the prefetchPlugin:

> from: http://webpack.github.io/analyse/#hints > ## Long module build chains > Use prefetching to increase build performance. > Prefetch a module from the middle of the chain.

>


I digged the web inside out to find the only documentation available on prefechPlugin is this:

> from: https://webpack.js.org/plugins/prefetch-plugin/

> ## PrefetchPlugin > new webpack.PrefetchPlugin([context], request)

> A request for a normal module, which is resolved and built even before > a require to it occurs. This can boost performance. Try to profile the > build first to determine clever prefetching points.



My questions:

  • How to properly use prefetchPlugin?
  • What is the right workflow to use it with the Analyse tool?
  • How do I know if the prefetchPlugin works? how can I measure it?
  • What it means to Prefetch a module from the middle of the chain?

I'll really appreciate some examples

Please help me make this question a valuable resource for the next developer who wants to use the prefechPlugin and the Analyse tools. Thank you.

Optimization Solutions


Solution 1 - Optimization

Yeah, The pre-fetch plugin documentation is pretty much non-existent. After figuring it out for myself, its pretty simple to use, and there's not much flexibility to it. Basically, it takes two arguments, the context (optional) and the module path (relative to context). The context in your case would be /absolute/path/to/your/project/node_modules/react-transform-har/ assuming that the tilde in your screenshot is referring to node_modules as per webpack's node_module resolution.

The actual prefetch module should be ideally no more than three module dependencies deep. So in your case isFunction.js is the module with the long build chain and ideally it should be pre-fetched at getNative.js

However, I suspect there's something funky in your config, because your build chain dependencies are referring to module dependencies, which should be automatically optimized by webpack. I'm not sure how you got that, but in our case, we don't see any warnings about long build chains in node_modules. Most of our long build chains are due to deeply nested react components which require scss. ie:

enter image description here

Regardless, you'll want to add a new plugin for each of the warnings, like so:

plugins: [
    new webpack.PrefetchPlugin('/web/', 'app/modules/HeaderNav.jsx'),
    new webpack.PrefetchPlugin('/web/', 'app/pages/FrontPage.jsx')
];

The second argument must be a string to the relative location of the module. Hope this makes sense.

Solution 2 - Optimization

The middle of your chain there is probably react-transform-hmr/index.js as it starts about half way through. You could try PrefetchPlugin('react-transform-hmr/index') and rerun your profile to see if it helps speed up your total time to build.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionAsaf KatzView Question on Stackoverflow
Solution 1 - Optimization4m1rView Answer on Stackoverflow
Solution 2 - OptimizationAaron JensenView Answer on Stackoverflow