This repo contains the frontend and backend for the Lighthouse CI server.
Lighthouse can be setup as part of your CI on Travis. As new pull requests come in, the Lighthouse CI tests the changes and reports back the new score.
To audit pull requests, do the following:
-
Add lighthousebot as a collaborator on your repo. This is so the Lighthouse CI can update the status of your PRs. Don't worry. It's OAuth token is very limited in scope and only has permission for
repo:status
. -
Add an
after_success
section totravis.yaml
:after_success: - ./deploy.sh # TODO(you): deploy the PR changes to your staging server. - export LH_MIN_PASS_SCORE=96 - export LH_TEST_URL=https://staging.example.com - node runLighthouse.js $LH_TEST_URL $LH_MIN_PASS_SCORE
ENV variable Description LH_MIN_PASS_SCORE
Specifies the minimum Lighthouse score for the PR to be considered "passing". LH_TEST_URL
Specifies the URL of your staging server.
The first thing in after_success
is to deploy the PR changes to a staging server. Since this is different for every hosting environment, it's left to the reader to figure out the details on doing that.
Tip: if you're using Google App Engine, check out
deploy_pr_gae.sh
, which shows how to install the GAE SDK and deploy PR changes programmatically.
Why a staging server? Can I use localhost? Yes, but we recommend that you deploy the PR to a real staging server instead of running a local server on Travis. The reason is that a staging environment will be more accurate and reflect your production setup. As an example, Lighthouse performance numbers will be more realistic.
The last step in after_success
is to call runLighthouse.js
. Copy this file to your repo. When you call it in travis.yml
, pass the minimum Lighthouse score you expect and a URL to test:
node runLighthouse.js 96 https://staging.example.com
This repo contains several different pieces for the Lighthouse CI: a backend, frontend, and frontend UI.
Quick way to try Lighthouse: https://lighthouse-ci.appspot.com/try
Relevant source:
frontend/public/
- Frontend UI for https://lighthouse-ci.appspot.com/try.
Server that responds to requests from Travis.
Handlers:
https://lighthouse-ci.appspot.com/run_on_chrome
https://lighthouse-ci.appspot.com/run_on_wpt
Example - raw endpoint usage
Note: this is what runLighthouse.js
does for you.
POST https://lighthouse-ci.appspot.com/run_on_chrome
Content-Type: application/json
{
testUrl: "https://staging.example.com",
minPassScore: 96,
repo: {
owner: "<REPO_OWNER>",
name: "<REPO_NAME>"
},
pr: {
number: <PR_NUMBER>,
sha: "<PR_SHA>"
}
}
Relevant source:
frontend/server.js
- server which accepts Github pull requests and updates the status of your PR. Contains endpoints for running Lighthouse directly on Chrome (/run_on_chrome
) or using the WebPageTest integration (/run_on_wpt
).
By default, runLighthouse.js
will use the CI builder to run Ligthhouse using Chrome. As an alternative, you can test PRs on readl devices using the WebPageTest integration.
At the bottom of runLighthouse.js
, change the runner to use RUNNERS.wpt
instead of RUNNERS.chrome
:
// Only run LH if this is a PR.
if (process.env.TRAVIS_EVENT_TYPE === 'pull_request') {
run(RUNNERS.wpt);
} else {
console.log('Lighthouse is not run for non-PR commits');
}
At the end of testing, your PR will be updated with a link to the WebPageTest results containing the Lighthouse report!
Server that runs Lighthouse against a URL, using Chrome.
Handlers:
https://lighthouse-ci.appspot.com/ci
Contains example Dockerfiles for running Lighthouse using Headless Chrome and full Chrome. Both setups us Google App Engine Flexible containers (Node).
Relevant source:
builder/Dockerfile.nonheadless
- Dockerfile for running full Chrome.builder/Dockerfile.headless
- Dockerfile for running headless Chrome.builder/server.js
- The/ci
endpoint that runs Lighthouse.
Example - raw usage of endpoint
Note: this is what runLighthouse.js
does for you.
curl -X POST \
-H "Content-Type: application/json" \
--data '{"format": "json", "url": "https://staging.example.com"}' \
https://builder-dot-lighthouse-ci.appspot.com/ci
Initial setup:
- Ask an existing dev for the oauth2 token. If you need to regenerate one, see below.
- Create
frontend/.oauth_token
and copy in the token value.
Run the dev server:
yarn start
This will start a web server and use the token in .oauth_token
. The token is used to update PR status in Github.
Follow the steps in Testing a Github PR for setting up your repo.
Notes:
- If you want to make changes to the builder, you'll need Docker and the GAE Node SDK.
- To make changes to the CI server, you'll probably want to run ngrok so you can test against a local server instead of deploying for each change.
If you need to generate a new OAuth token:
- Sign in to the `lighthousebot Github account. The credentials are in the usual v password tool.
- Visit personal access tokens: https://github.com/settings/tokens.
- Regenerate the token. Important: this invalidates the existing token so other developers will need to be informed.
- Update token in
frontend/.oauth_token
.
Deploy the frontend:
./deploy.sh YYYY-MM-DD frontend
Deploy the CI builder backend:
./deploy.sh YYYY-MM-DD builder