Google Git
Sign in
chromium / infra / gerrit-plugins / binary-size / 7c45bd2e9b456c68e5edcce236ccf5d6b37f97a0
commit7c45bd2e9b456c68e5edcce236ccf5d6b37f97a0[log] [tgz]
authorAnthony Fandrianto <atyfto@google.com>Fri Oct 01 02:55:25 2021
committerAnthony Fandrianto <atyfto@google.com>Fri Oct 01 03:08:29 2021
treedf15aab295de7c258d09d86137be2614cb6fce56
parent45547f739b43f93859a1fbb3c232097a2ab6f1ae [diff]
[binary-size] Show "Creep budget" column

This change adds a "Creep budget" column to the binary size plugin,
which is shown if one or more rows contain the ".creepBudget" metadata
in build.output.properties["binary_sizes"]. If no rows contain the
".creepBudget" metadata, then the column will not be displayed (there
is no visible change to the UI for users who do not emit creep
budgets).

If the column is added, it is added to the right of the size delta
column.

Test: https://screenshot.googleplex.com/7WJAohKiw4PWnCJ on a CL which
      emitted size creep budgets (the budgets were all set to 1024 KiB
      as a placeholder). Tested on another CL which does not emit size
      creep budgets https://screenshot.googleplex.com/6UnnKixFzaBZVEV
      to confirm that there is no change to the UI.
Bug: fuchsia:85126
Change-Id: Ie4aff38a093c3f64f2fa6009f87b0fc2fa9db460
3 files changed
tree: df15aab295de7c258d09d86137be2614cb6fce56
  1. java/
  2. static/
  3. test/
  4. .eslintrc.json
  5. .gitignore
  6. BUILD
  7. codereview.settings
  8. LICENSE
  9. OWNERS
  10. package-lock.json
  11. package.json
  12. README.md
  13. run-with-prod-data.sh
  14. run-with-testsite.sh
  15. wct.conf.json
README.md

Binary Size Plugin for Gerrit

How it works

The plugin queries tryjobs for the current patchset on Gerrit, and gets the binary_sizes property from each of them. It also queries the equivalent CI jobs for the same base revision, and gets the same property from them. It then displays the results in a table, with rows being the files (keys in binary_sizes dict), and the columns being:

Size before | Size after | Size delta (including %) | Budget info | File | Builder

This is based on JSON output of the form:

{ “some binary name”: BINARY_SIZE_IN_BYTES, “some binary name.budget”: BINARY_SIZE_BUDGET_IN_BYTES, “some binary name.owner”: OWNER_URL, }

For example:

{ “foo”: 1024, “foo.budget”: 2048, “foo.owner”: “mailto:foo_owner@gmail.com” “bar”: 2048, }

Note that including a *.budget item for any given binary is optional. If no budget items are provided, then the “Budget info” column will be omitted from the results table. In the event that a *.budget item is specified, an addition *.owner item can be used to provide a URL for context/ownership related to the pertinent budget item (in the UI, the budget value is clickable, taking the user to the provided URL).

Usage

This plugin is configured via the binary-size.config file present in the repo‘s refs/meta/config ref, as well as the same file in all repositories in the repo’s inheritance chain (up to and including All-Projects).

See an example of binary-size.config:

https://webrtc.googlesource.com/src/+/refs/meta/config/binary-size.config

Also a short snippet below:

[host]
    git = "webrtc.googlesource.com"
    gerrit = "webrtc-review.googlesource.com"

[builder "luci.webrtc.try/linux_rel"]
    base = "luci.webrtc.ci/Linux64 Release"
    # Optional, needed if the base builder is triggered from a different repo
    # than the try builder. Assumed to be hosted on [host].git.
    baseRepo = "foo"

[builder "luci.webrtc.try/win_x64_clang_rel"]
    base = "luci.webrtc.ci/Win64 Release (Clang)"

This contains a mapping between tryjob builders and equivalent postsubmit builders. Equivalent in the sense that if they ran with the same code, they would produce the same binary_sizes. The plugin queries builds only from buckets that are mentioned at least once. It is OK to specify builders that don't provide a binary_sizes property, they will just be ignored.

Note that populating the binary_sizes property is a separate responsibility, and it is up to you to implement in your recipes. It needs to be a dict like {"some_file.so": 123456, ...}. The values of the dict are treated as sizes in bytes.

Builders also need to set the got_revision property. This is the commit hash on top of which the Gerrit patchset is applied, and is used to look up previous data for comparison.

All changes to binary-size.config files are instantly reflected. There is no caching period or need to restart the server.

Dependencies

This plugin requires the buildbucket plugin in order to search builds. Ensure that it is also installed, or prepare to see errors in the browser's console.

Development

git clone --recursive https://gerrit.googlesource.com/gerrit
cd gerrit/plugins

git clone https://chromium.googlesource.com/infra/gerrit-plugins/buildbucket
cd buildbucket
ln -s src/main/resources/static static  # May be unneeded in the future.
cd ..

git clone https://chromium.googlesource.com/infra/gerrit-plugins/binary-size
cd binary-size

Run the polygerrit-ui server against live data

Use the script run-with-prod-data.sh (based on polygerrit-ui/run-server.sh). You may change some paths by setting environment variables, for example:

# Install dependencies:
sudo apt-get install -y nodejs

GERRIT_DIR="$HOME/gerrit" ./run-with-prod-data.sh

Testing

Manual on live Gerrit instance

You can test on a live Gerrit instance by replacing the plugin JavaScript using Gerrit FE Dev Helper.

Note: this works only for frontend (JavaScript) changes. Not for changes to the backennd (Java) code.

  1. Build the JavaScript bundle and serve it via HTTP.
cd <root of gerrit checkout>
bazel build plugins/binary-size:all
# Ensure the bundle was built
BUNDLE_PATH=$(find bazel-out/ -name binary-size-bundle.js)
echo ${BUNDLE_PATH}
cd $(dirname ${BUNDLE_PATH})
python3 -m http.server 8080

  1. Install the Gerrit FE Dev Helper Chrome extension.

  2. Navigate to a Gerrit page that you expect to show size diffs. E.g. https://webrtc-review.googlesource.com/c/src/+/188502.

  3. Configure the Gerrit FE Dev Helper to redirect to your local binary-size-bundle.js. For example:

Target: https://webrtc-review.googlesource.com/plugins/binary-size/static/binary-size.js, Operator: redirect, Destination: http://localhost:8080/binary-size-bundle.js

Note it may also be necessary to redirect the CDN for the polygerrit_assets to reflect changes to static html etc in the bundled plugin. You can find the appropriate URL under the “Sources” section of Chrome's developer console. It will look something like this, but possibly with a different versioning number (e.g. 426.0):

https://cdn.googlesource.com/polygerrit_assets/426.0/plugins/binary-size/static/binary-size.js

This redirect should also go to http://localhost:8080/binary-size-bundle.js

  1. Click the Gerrit FE Dev Helper button to activate it. It should reload the page.

Automated

npm run wct-test

Note: Testing is disabled for Safari due to this issue.