0
Files
src/docs/optimizing_web_uis.md
dpapad 468d67cc44 WebUI: Update a few docs, make it clear that CSS Mixins no longer work.
Bug: 1374865
Change-Id: I4d9e6b40360d2405547d1a2bc6e173d8e3e5f647
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3971059
Auto-Submit: Demetrios Papadopoulos <dpapad@chromium.org>
Commit-Queue: Rebekah Potter <rbpotter@chromium.org>
Reviewed-by: Rebekah Potter <rbpotter@chromium.org>
Cr-Commit-Position: refs/heads/main@{#1062396}
2022-10-21 23:06:00 +00:00

73 lines
2.2 KiB
Markdown

# Optimizing Chrome Web UIs
## How do I do it?
In order to build with a fast configuration, try setting these options in your
GN args:
```
optimize_webui = true
is_debug = false
```
## How is the code optimized?
### Bundling
[JS Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
are used heavily throughout the code. Fetching all imports and their transitive
dependencies can be slow, especially when there are too many requests during
initial page load.
To reduce this latency, Chrome uses [Rollup](https://rollupjs.org) to bundle the
code into a couple JS bundle files (usually one or two). This greatly decreases
latency of initial load, by eliminating the overhead that is associated with
each individual request.
### JavaScript Minification
In order to minimize disk size, we run
[terser](https://github.com/terser/terser) on all combined JavaScript. This
reduces installer and the size of resources required to load to show a UI.
Code like this:
```js
function fizzBuzz() {
for (var i = 1; i <= 100; i++) {
var fizz = i % 3 == 0 ? 'fizz' : '';
var buzz = i % 5 == 0 ? 'buzz' : '';
console.log(fizz + buzz || i);
}
}
fizzBuzz();
```
would be minified to:
```js
function fizzBuzz(){for(var z=1;100>=z;z++){var f=z%3==0?"fizz":"",o=z%5==0?"buzz":"";console.log(f+o||z)}}fizzBuzz();
```
If you'd like to more easily debug minified code, click the "{}" prettify button
in Chrome's developer tools, which will beautify the code and allow setting
breakpoints on the un-minified version.
### Gzip compression of web resources
As of [r761031](https://chromium.googlesource.com/chromium/src/+/6b83ee683f6c545be29ee807c6d0b6ac1508a549)
all HTML, JS, CSS and SVG resources are compressed by default with gzip
Previously this was only happening if the `compress="gzip"` attribute was
specified as follows in the corresponding .grd file:
```xml
<include name="IDR_MY_PAGE" file="my/page.html" type="BINDATA" compress="gzip" />
```
This is no longer necessary, and should be omitted. Only specify the `compress`
attribute if the value is `false` or `brotli`.
Compressed resources are uncompressed at a fairly low layer within
ResourceBundle, and WebUI authors typically do not need to do anything special
to serve those files to the UI.