Web Replay is a performance testing tool written in Golang for recording and replaying web pages. Originally based on Catapult > Web Page Replay.
In order for the web_replay server to be trusted by the browser, certificates minted and used by web_replay must be trusted. Multiple options are possible to support this:
Specify public key hashes for the browser to ignore using --ignore-certificate-errors-spki-list.
Run utils\create_pk_hash.sh <cert> to output the hash to include. The following ignores the included
two leaf certificates:
--ignore-certificate-errors-spki-list=2FBkVuYq8NvFRbHkFRFnXLd/FJK5tu7m/b+V7s/TUL4=,P0/jlVD2vgAtt9UmEeZf7IrHAva3Fs8N+4V9glmvwkc=
Install the certificate chain on a test machine using install_certs.ps1. Use this with care
as installing a root CA compromises your machine.
The certificates listed in .\certs are used by default. These can be modified by replacing the
chain with a different one.
Modify the host resolver rules of the browser by using --host-resolver-rules:
--host-resolver-rules="MAP *:80 <host>:<http_port>,MAP *:443 <host>:<https_port>"
set_args.ps1 and remove_args.ps1 handle setting and removing this argument
for the specified browser located on the taskbar. Use in the following way:
.\set_args.ps1 web_replay <host> <http_port> <https_port> <browser>
.\remove_args.ps1 <browser>
<browser> is optional and is one of (default is edge):
edge
edgedev
edgebeta
edgecanary
chrome
Another method for pointing the browser to web_replay is by configuring proxy settings. This can
be done within the browser settings itself, using the browser parameter --proxy-server, or within
system settings.
Note: it may be necessary to terminate all the browser processes before launching for the command-line parameters to be included.
Standard method:
.\bin\web_replay.exe record --host=<host> --http_port=<http_port> --https_port=<https_port> <archive>
Proxy method:
.\bin\web_replay.exe record --host=<host> --http_proxy_port=<http_proxy_port> <archive>
<archive> is either a single file or a folder.
Standard method:
.\bin\web_replay.exe replay --host=<host> --http_port=<http_port> --https_port=<https_port> <archive>
Proxy method:
.\bin\web_replay.exe replay --host=<host> --http_proxy_port=<http_proxy_port> <archive>
<archive> is either a single file or a folder.
The optional parameter --excludes_list accepts a space-separated list of domains for
which web_replay will always fetch data from the live internet.
The following table includes some common special URL paths that perform custom web_replay actions during a recording or replay:
| Path | Details |
|---|---|
| /web-page-replay-generate-200 | Generate a 200 ok response |
| /web-page-replay-command-exit | Shutdown web_replay server |
| /web-page-replay-change-archive?n={n} | Change active archive file. {n} is the archive file without the .json.gz suffix |
Use the following command to merge multiple archives. Designate one as the base, and one as input:
.\bin\archive.exe merge <base_file> <input_file> <output_file>
- Golang version 1.21
- Cgo compilation
.\build.ps1 web_replay
.\build.ps1 archive
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.