Skip to content
Permalink
main
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
layout title authors description date codelabs tags
post
Incorporate performance budgets into your build process
mihajlija
The best way to keep an eye on your performance budget is to automate it. Find out how to choose a tool that best fits your needs and current setup.
2019-02-01
codelab-setting-performance-budgets-with-webpack
performance

Once you've defined a performance budget, it's time to set up the build process to keep track of it. There are a number of tools that let you define thresholds for chosen performance metrics and warn you if you go over budget. Find out how to choose one that best fits your needs and current setup. 🕵️‍♀️

Lighthouse performance budgets

Lighthouse is an auditing tool that tests sites in a few key areas—performance, accessibility, best practices and how well your site performs as a progressive web application.

The command line version of Lighthouse (v5+) supports setting performance budgets based on:

  • resource size
  • resource count

You can set budgets for any of the following resource types:

  • document
  • font
  • image
  • media
  • other
  • script
  • stylesheet
  • third-party
  • total

Budgets are set in a JSON file and after defining them the new "Over Budget" column tells you whether you're exceeding any limits.

{% Img src="image/admin/fsRNXJXQ5JESUuwsIlLn.png", alt="Budgets section in Lighthouse report", width="800", height="199", class="w-screenshot" %} "Budgets" section in Lighthouse report

Webpack performance hints

Webpack is a powerful build tool for optimizing how your code is delivered to the users. It also supports setting performance budgets based on asset size.

Turn on performance hints in webpack.config.js to get command line warnings or errors when your bundle size grows over the limit. It's a great way to stay mindful about asset sizes throughout the development.

After the build step, webpack outputs a color-coded list of assets and their sizes. Anything over budget is highlighted in yellow.

{% Img src="image/admin/G96Z2pZVL6aowVRa49rA.png", alt="Webpack output highlighting bundle.js", width="617", height="86", class="w-screenshot w-screenshot--filled" %} The highlighted bundle.js is bigger than your budget

The default limit for both assets and entry-points is 250 KB. You can set your own targets in the configuration file.

{% Img src="image/admin/StfxwSScNVzmeM70gwp4.jpg", alt="Webpack bundle size warning", width="566", height="104", class="w-screenshot w-screenshot--filled" %} Webpack bundle size warning ⚠️

The budgets are compared against uncompressed asset sizes. Uncompressed JavaScript size is related to the execution time and big files can take a long time to execute, especially on mobile devices.

{% Aside %} Compressed asset sizes affect the transfer time, which is very important on slow networks. {% endAside %}

{% Img src="image/admin/ogH1cMiF96iyhj8CiENK.jpg", alt="Webpack performance optimization recommendation", width="556", height="84", class="w-screenshot w-screenshot--filled" %} Bonus feature: webpack won’t only warn you, it will give you a recommendation on how to downsize your bundles. 💁

Bundlesize

Bundlesize is a simple npm package that tests asset size against a threshold you've set. It can run locally and integrate with your CI.

Bundlesize CLI

Run bundlesize CLI by specifying a threshold and the file that you want to test.

bundlesize -f "dist/bundle.js" -s 170kB

Bundlesize outputs color-coded test results in one line.

{% Img src="image/admin/6YsTnhpUlzbTB1ja23yP.png", alt="Failing bundlesize CLI test", width="473", height="36", class="w-screenshot w-screenshot--filled" %} Failing bundlesize CLI test {% Img src="image/admin/TjynyaIzZlRa6xE2uVcD.png", alt="Passing bundlesize CLI test", width="460", height="36", class="w-screenshot w-screenshot--filled" %} Passing bundlesize CLI test ✔️

Bundlesize for CI

You'll get the most value out of bundlesize if you integrate it with a CI to automatically enforce size limits on pull requests. If bundlesize test fails, that pull request is not merged. It works for pull requests on GitHub with Travis CI, CircleCI, Wercker, and Drone.

{% Img src="image/admin/RKpNwfcXRoKZ34qDoxcO.jpg", alt="Bundlesize check status on Github", width="800", height="326", class="screenshot" %} Bundlesize check status on Github

You may have a fast app today, but adding new code can often change this. Checking pull requests with bundlesize will help you avoid performance regressions. Bootstrap, Tinder, Trivago and many others use it to keep their budgets in check.

With bundlesize, it's possible to set thresholds for each file separately. This is especially useful if you are splitting a bundle in your application.

By default, it tests gzipped asset sizes. You can use the compression option to switch to brotli compression or turn it off completely.

Lighthouse Bot

{% Img src="image/admin/5zLlIEUm06wEbu3J1WjG.png", alt="Lighthouse Bot", width="800", height="267" %}

Lighthouse Bot integrates with Travis CI and enforces budgets based on any of the five Lighthouse audit categories. For example, a budget of 100 for your Lighthouse performance score. It's sometimes simpler to keep an eye on a single number than individual asset budgets and Lighthouse scores take many things into account.

{% Img src="image/admin/6yVLSYcr0eCytJixZ1bK.png", alt="Lighthouse scores 💯", width="800", height="211", class="screenshot" %} Lighthouse scores 💯

Lighthouse Bot runs an audit after you deploy a site to staging server. In .travis.yml set budgets for particular Lighthouse categories with --perf, --a11y, --bp, --seo or --pwa options. Aim to stay in the green zone with scores of at least 90.

after_success:
  - ./deploy.sh # Deploy the PR changes to staging server
  - npm run lh -- --perf=96 https://staging.example.com # Run Lighthouse test

If the scores for a pull request on GitHub fall below the threshold you've set, Lighthouse Bot can prevent pull request from being merged.

{% Img src="image/admin/nVDqJAA1DZDFqpOaQA9J.png", alt="Lighthouse Bot check status on Github", width="800", height="175", class="screenshot" %} Lighthouse Bot check status on Github

Lighthouse Bot then comments on your pull request with updated scores. This is a neat feature which encourages conversation about performance as code changes are happening.

{% Img src="image/admin/q1BUp838y2oSs70Suxyb.png", alt="Lighthouse reporting scores on pull request", width="800", height="383" %} Lighthouse reporting scores on pull request 💬

If you find your pull request blocked by a poor Lighthouse score, run an audit with Lighthouse CLI or in Dev Tools. It generates a report with details about bottlenecks and hints for simple optimizations.

Summary

Tool CLI CI Summary
Lighthouse ✔️
  • Budgets for different types of resources based on their size or count.
webpack ✔️
  • Budgets based on sizes of assets generated by webpack.
  • Checks uncompressed sizes.
bundlesize ✔️ ✔️
  • Budgets based on sizes of specific resources.
  • Checks compressed or uncompressed sizes.
Lighthouse Bot ✔️
  • Budgets based on Lighthouse scores.