Refactoring: Pull all fullscreen code out of Document and into its own helper class
[WebKit-https.git] / Websites / perf.webkit.org / ReadMe.md
1 # WebKit Performance Dashboard
2
3 The WebKit performane dashboard is a website to track various performance metrics of WebKit: https://perf.webkit.org/
4
5 ## 1. Checking Out the Code and Installing Required Applications
6
7 The instructions assume you're using macOS as the host server and installing this application at `/Volumes/Data/perf.webkit.org`.
8
9 You can choose between using Server.app or install the required tools separately.
10
11 1. Install Server.app but do **NOT** launch/open it. (if you don't want to use Server.app, install PostgreSQL: http://www.postgresql.org/download/macosx/)
12 2. Install node.
13 3. Install Xcode with command line tools (only needed for svn)
14 4. `svn co https://svn.webkit.org/repository/webkit/trunk/Websites/perf.webkit.org /Volumes/Data/perf.webkit.org`
15 5. Inside `/Volumes/Data/perf.webkit.org`, run `npm install pg` and `mkdir -m 755 public/data/`
16
17 ## 2. Testing Local UI Changes with Production Data
18
19 The front end has the capability to pull data from a production server without replicating the database locally on OS X Yosemite and later.
20 To use this feature to test local UI changes, modify `config.json`'s `remoteServer` entry so that "remoteServer.url" points to your production server,
21 and "remoteServer.basicAuth" specifies the username and the password that is used by the production sever.
22
23 Remove "basicAuth" entry for production servers that doesn't require a basic authentication (e.g. perf.webkit.org).
24
25 ```json
26 {
27     "url": "http://perf.webkit.org",
28     "basicAuth": {
29         "username": "webkitten",
30         "password": "webkitten's secret password"
31     }
32 }
33 ```
34
35 Then run `tools/remote-cache-server.py start`. This launches a httpd server on port 8080.
36
37 The script caches remote server's responses under `public/data/remote-cache` and never revalidates them (to allow offline work).
38 If you needed the latest content, delete caches stored in this directory by running `tools/remote-cache-server.py reset`.
39
40 ## 3. Running Tests
41
42 There are three kinds of tests in directories of the same name: `unit-tests`, `server tests`, and `browser-tests`.
43
44  - `unit-tests`: These tests various models and common JS code used in v3 UI and tools. They mock JSON APIs and model object.
45  - `server-tests`: Server tests use a real Apache server in accordance with `testServer` in `config.json` and a Postgres database by the name of `testDatabaseName` specified in `config.json`. They're functional tests and may test both the backend database schema, PHP, and corresponding front-end code although many of them directly queries and modifies the database.
46  - `browser-tests`: These are tests to be ran inside a Web browser, and tests v3 UI's interaction with browser's DOM API.
47
48 To run `unit-tests` and `server-tests`, simply run `./tools/run-tests.py` after installing dependencies (1) and configuring the PostgreSQL (4).
49 If you've previously setup a remote cache server (3), then you have to stop the server before running the tests.
50
51 To run `browser-tests`, open `browser-tests/index.html` inside a Web browser.
52
53 ## 4. Configuring PostgreSQL
54
55 Run the following command to setup a Postgres server at `/Volumes/Data/perf.webkit.org/PostgresSQL` (or wherever you'd prefer):
56 `python ./tools/setup-database.py /Volumes/Data/perf.webkit.org/PostgresSQL`
57
58 It automatically retrieves the database name, the username, and the password from `config.json`. Create one from `config.json.sample`
59
60 ### Starting PostgreSQL
61
62 The setup script automatically starts the database but you may need to run the following command to manually start the database after reboot.
63
64 - Starting the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_ctl -D /Volumes/Data/perf.webkit.org/PostgresSQL -l /Volumes/Data/perf.webkit.org/PostgresSQL/logfile -o "-k /Volumes/Data/perf.webkit.org/PostgresSQL" start`
65 - Stopping the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_ctl -D /Volumes/Data/perf.webkit.org/PostgresSQL -l /Volumes/Data/perf.webkit.org/PostgresSQL/logfile -o "-k /Volumes/Data/perf.webkit.org/PostgresSQL" stop`
66
67 ### Initializing the Database
68
69 Run `database/init-database.sql` in psql as `webkit-perf-db-user`:
70 `/Applications/Server.app/Contents/ServerRoot/usr/bin/psql webkit-perf-db -h localhost --username webkit-perf-db-user -f init-database.sql`
71
72 ### Making a Backup and Restoring
73
74 Use `pg_dump` and `pg_restore` to backup and restore the database. If you're replicating the production database for development purposes, you may consider excluding `run_iterations` table, which takes up 2/3 of the storage space, to reduce the size of the database for your local copy. Adjust the number of concurrent processes to use by `--jobs` and adjust the compression level by `--compress` (0 is no compression, 9 is most compressed).
75
76 - Making the fullbackup of the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_dump -h localhost webkit-perf-db --format=directory --jobs=4 --no-owner --compress=7 --file=<path to backup directory>`
77
78 - Making an abridged backup without `run_iterations` table: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_dump -h localhost webkit-perf-db --format=directory --jobs=4 --no-owner --compress=7 --exclude-table=run_iterations --file=<path to backup directory>`
79
80 - Restoring the database: `/Applications/Server.app/Contents/ServerRoot/usr/bin/pg_restore --format=directory --jobs=4 --no-owner --host localhost --username=webkit-perf-db-user --dbname=webkit-perf-db <path to backup directory>`
81
82 ## 5. Configuring Apache
83
84 ### Instructions if you've never launched Server.app as instructed
85
86  - Edit `/private/etc/apache2/httpd.conf`
87
88      1. Change DocumentRoot to `/Volumes/Data/perf.webkit.org/public/`
89      2. Uncomment `LoadModule php5_module libexec/apache2/libphp5.so`
90      3. Uncomment `LoadModule rewrite_module libexec/apache2/mod_rewrite.so`
91      4. Uncomment `LoadModule deflate_module libexec/apache2/mod_deflate.so`
92
93  - In Mavericks and later, copy php.ini to load pdo_pgsql.so pgsql.so.
94     `sudo cp /Applications/Server.app/Contents/ServerRoot/etc/php.ini /etc/`
95  - In El Capitan and later, you may need to comment out the `LockFile` directive in `/private/etc/apache2/extra/httpd-mpm.conf`
96    as the directive has been superseded by `Mutex` directive.
97
98 ### Instructions if you've accidentally launched Server.app
99
100  - Enable PHP web applications
101  - Go to Server Website / Store Site Files In, change it to `/Volumes/Data/perf.webkit.org/public/`
102  - Go to Server Website / Edit advanced settings, enable Allow overrides using .htaccess files
103  - httpd config file is located at `/Library/Server/Web/Config/apache2/sites/0000_any_80.conf` (and/or 0000_any_`PORT#`.conf)
104
105 ### Starting Apache
106
107 You can use apachectl to start/stop/restart apache server from the command line:
108
109 - Starting httpd: `sudo apachectl start`
110 - Stopping httpd: `sudo apachectl stop`
111 - Restarting httpd: `sudo apachectl restart`
112
113 The apache logs are located at `/private/var/log/apache2`.
114
115 ### Production Configurations
116
117  1. Update ServerAdmin to your email address
118  2. Add the following directives to enable gzip:
119
120         <IfModule mod_deflate.c>
121             AddOutputFilterByType DEFLATE text/html text/xml text/javascript application/javascript text/plain application/json application/xml application/xhtml+xml
122         </IfModule>
123
124  3. Add the following directives to enable zlib compression and MultiViews on DocumentRoot (perf.webkit.org/public):
125
126         Options Indexes MultiViews
127         php_flag zlib.output_compression on
128
129  4. Increase the maximum upload size as needed for accepting custom roots:
130
131         <IfModule php5_module>
132         php_value upload_max_filesize 100M
133         php_value post_max_size 100M
134         </IfModule>
135
136 ### Protecting the Administrative Pages to Prevent Execution of Arbitrary Code
137
138 By default, the application gives the administrative privilege to everyone. Anyone can add, remove, or edit tests,
139 builders, and other entities in the database.
140
141 We recommend protecting the administrative pages via Digest Auth on https connection.
142
143 Generate a password file via `htdigest -c <path> <realm> <username>`, and then create admin/.htaccess with the following directives
144 where `<Realm>` is replaced with the realm of your choice, which will be displayed on the username/password input box:
145
146 ```
147 AuthType Digest
148 AuthName "<Realm>"
149 AuthDigestProvider file
150 AuthUserFile "<Realm>"
151 Require valid-user
152 ```
153
154 ## 6. Concepts
155
156  - **Test** - A test is a collection of metrics such as frame rate and malloced bytes. It can have a children and a parent and form a tree of tests.
157  - **Metric** - A specific metric of a test such as frame rate, runs per second, and time. The list of supported metrics are:
158    - *FrameRate* - Frame rate per second
159    - *Runs* - Runs per second
160    - *Time* and *Duration* - Duration measured in milliseconds
161    - *Size* - Bytes
162    - *Score* - Unit-less scores for benchmarks. Unit is pt or points.
163
164    Metrics can also be an aggreagte of child tests' metrics of the same name. For example, Speedometer benchmark's Time metric is the sum total of subtests' time. The list of supported aggregation types are:
165    - *Arithmetic* - [The arithmetic mean](https://en.wikipedia.org/wiki/Arithmetic_mean)
166    - *Geometric* - [The geometric mean](https://en.wikipedia.org/wiki/Geometric_mean)
167    - *Harmonic* - [The harmonic mean](https://en.wikipedia.org/wiki/Harmonic_mean)
168    - *Total* - [The sum](https://en.wikipedia.org/wiki/Summation)
169
170  - **Platform** - A platform is an environmental configuration under which performance tests run. This is typically an operating system such as Lion, Mountain Lion, or Windows 7, or a combination of an operating system, a particular device, and a configuration: e.g. macOS Sierra MacBookAir7,1.
171  - **Repository** - A repository refers to the name of a collection of software whose verions or revisions need to be associated with a particular data point submitted to the dashboard. For example, WebKit is a repository because each data point submitted to the dashboard has to identify its WebKit revision. Operating systems such as macOS could also be considered as a repository if its version may change over time if an operating system may get updated across data points.
172  - **Commit** - A commit is a specific revision or a version of a repository. e.g. r211196 of WebKit.
173  - **Committer** - A committer is the author of the change in a given repository for a specific commit. e.g. the author of r211196 in WebKit is Ryosuke Niwa.
174  - **Builder** - Like a builder in buildbot, a builder submits data points to the dashboard in terms of a sequence of builds. For example, a builder named "El Capitan MacBookAir7,1" may submit data points for benchmarks ran on MacBookAir7,1 with El Capitan.
175  - (Build) **Slave** - Like a buildlsave in buildbot, a slave is a physical machine that submit data points to the dashboard. e.g. it could be a bot205 which submits data points as either "El Capitan MacBookAir7,1" or "Sierra MacBookAir7,1".
176  - **Build** - A build represents a set of data points reported by a specific builder. e.g. "El Capitan MacBookAir7,1" may report Speedometer score along with its subtests' results. All those data points being to a single build. This is a different concept from a build of software. A single build of WebKit, for example, could be ran on multiple builders (e.g. one MacBookAir and another MacBookPro) to generate two builds in the dashboard.
177  - **Bug Tracker** - A bug or an issue tracking tool such as Bugzilla and Radar.
178  - **Bug** - A bug number associated with a particular bug tracker.
179  - **Analysis Task** - An analysis task is created to analyze a progression or a regression across a range of data points for a specific test metric on a specific platform. Each analysis task can have multiple test groups.
180  - **Test Group** - A specific set of A/B testing tasks. Each group may have multiple build requests for each set A and B.
181  - **Build Request** - A specific testing task in a test group.
182
183 See [init-database.sql](init-database.sql) for the complete database schema.
184
185 ## 7. Data Models for Test Results
186
187 In the performance dashboard, each test can have a parent test or arbitrary many child tests or subtests. Each test can then have multiple metrics to measure a specific unit'ed value. For example, Speedometer benchmark has the top level score, which is computed by the total time of running subtests. As such, the top level test has two metrics: *Score* and *Time* which is the aggregated total sum of *Time* metrics of the subtests:
188
189 **Speedometer** (A test)
190  + *Score* (A metric of "Speedometer")
191  + *Time : Total* (An aggregated metric of "Speedometer"; total sum of "Time" metrics of all subtests)
192  + **AngularJS-TodoMVC** (A subtest of "Speedometer")
193     - *Time* (A metric of "AngularJS-TodoMVC")
194  + **BackboneJS-TodoMVC** (A subtest of "Speedometer")
195     - *Time* (A metric of "BackboneJS-TodoMVC")
196  + ...
197
198 Since each test metric can be measured on arbitrarily platforms (e.g. MacBookAir7,1 on macOS Sierra), the dashboard supports showing the *baseline* results (e.g. benchmark scores on Safari 10) in addition to the results from the *current* sofware (the trunk WebKit build), we use a triple (test metric, platform, type) called a *test configuration* to group a collection of data points reported to the dashboard.
199
200 Then each test configuration has arbitrary *test runs*. A test run represents the score or more broadly the result of a single test metric on a specific platform at a particular time. For example, running Speedometer once and reporting the results to the performance dashboard results in the creation of a test run for each of *Score* and *Time : Total* metrics as well as *Time* metrics of all subtests (e.g. AngularJS-TodoMVC). Each test run can then have arbitrarily many *iteration values* which are indivisual measurement of some test metric within the benchmark. For example, Speedometer runs the same test twenty times and uses the average time and the score of those twenty iterations to compute the final score. Each one of twenty iterations constitutes a single iteration value.
201
202 Each *test run* are related to one another via *builds* which is uniquely identified by its *builder* and a *build number*. For example in the following sample data points for Speedometer, two test runs 789 and 791 are reported by a build 1001, and test runs 876 and 878 are reported by build 1002. Because Speedometer's total score is computed using the time took to run subtests, a builder reported both values in a single build as expected.
203
204 (Speedometer's Score, Sierra MacBookAir7,1, "current")
205  + Test run 789 - Mean: 154, Build: 1001
206    + Iteration 1: 150
207    + Iteration 2: 159
208    + ...
209  + Test run 876 - Mean: 153, Build: 1002
210    + Iteration 1: 152
211    + Iteration 2: 157
212    + ...
213
214 (AngularJS-TodoMVC's Time, Sierra MacBookAir7,1, "current")
215  + Test run 791 - Mean: 373, Build: 1001
216    + Iteration 1: 450
217    + Iteration 2: 380
218    + ...
219  + Test run 878 - Mean: 380, Build: 1002
220    + Iteration 1: 448
221    + Iteration 2: 395
222    + ...
223
224 ## 8. Reporting Results
225
226 To submit a new *build*, or a set of data points to an instance of the performance dashboard, you need to do the following:
227
228  - Add a slave on `/admin/slaves` if the slave used in the report has not already been added.
229  - Make a HTTP POST request to `/api/report`.
230
231 ### Format of Results JSON
232
233 The JSON submitted to `/api/report` should be an array of dictionaries, and each dictionary should must contain the following key-value pairs representing a single run of tests and its subtests on a single build:
234
235 - `builderName` - The name of a builder. A single slave may submit to multiple builders.
236 - `slaveName` - The name of a slave present on `/admin/slaves`.
237 - `slavePassword` - The password associated with the slave.
238 - `buildNumber` - The string that uniquely identifies a given build on the builder.
239 - `buildTime` - The time at which this build started in **UTC** (Use ISO time format such as `2013-01-31T22:22:12.121051`). This is completely independent of timestamp of repository revisions.
240 - `platform` - The human-readable name of a platform such as `Mountain Lion` or `Windows 7`.
241 - `revisions` - A dictionary that maps a repository name to a dictionary with "revision" and optionally "timestamp" as keys each of which maps to, respectively, the revision in **string** associated with the build and the times at which the revision was committed to the repository respectively. e.g. `{"WebKit": {"revision": "123", "timestamp": "2001-09-10T17:53:19.000000Z"}}`
242 - `tests` - A dictionary that maps a test name to a dictionary that represents a test. The value of a test
243    itself is a dictionary with the following keys:
244     - `metrics` - A dictionary that maps a metric name to a dictionary of configuration types to an array of iteration values. e.g. `{"Time": {"current": [629.1, 654.8, 598.9], "target": [544, 585.1, 556]}}`
245       When a metric represents an aggregated value, it should be an array of aggregator names instead. e.g. `{"Time": ["Arithmetic", "Geometric"]}` **This format may change in near future**.
246     - `url` - The URL of the test. This value should not change over time as only the latest value is stored in the application.
247     - `tests` - A dictionary of tests; the same format as this dictionary.
248
249 In the example below, we have the top-level test named "PageLoadTime". It measures two metrics: `Time` and `FrameRate`.
250 `Time` metric is the arithmetic mean of each subtest's `Time` metric (webkit.org and www.w3.org).
251 The computed arithmetic means are `[965.6, 981.35, 947.15]` in this case.
252 The test also reports `FrameRate` but this metric is measured only for the entire suite not per each subtest.
253
254 ```json
255 [{
256     "buildNumber": "651",
257     "buildTime": "2013-01-31T22:22:12.121051",
258     "builderName": "Trunk Mountain Lion Performance Tests",
259     "slaveName": "bot-111",
260     "slavePassword": "somePassword",
261     "platform": "Mountain Lion",
262     "revisions": {
263         "OS X": {
264             "revision": "10.8.2"
265         },
266         "WebKit": {
267             "revision": "141469",
268             "timestamp": "2013-01-31T20:55:15.452267Z"
269         }
270     },
271     "tests": {
272         "PageLoadTime": {
273             "metrics": {
274                 "Time": ["Arithmetic"],
275                 "FrameRate": {
276                     "current": [31, 24, 29]
277                 }
278             },
279             "tests": {
280                 "webkit.org": {
281                     "metrics": {
282                         "Time": {
283                             "current": [629.1, 654.8, 598.9]
284                         }
285                     },
286                     "url": "https://webkit.org/"
287                 },
288                 "www.w3.org": {
289                     "metrics": {
290                         "Time": {
291                             "current": [1302.1, 1307.9, 1295.4]
292                         }
293                     },
294                     "url": "https://www.w3.org/"
295                 }
296             }
297         }
298     }
299 }]
300 ```