web_replay

Web Replay

Web Replay is a performance testing tool written in Golang for recording and replaying web pages. Originally based on Catapult > Web Page Replay.

Sample Usage

Certificate installation

In order for the web_replay server on the HOST PC to be trusted by the browser on the Device Under Test (DUT), the certificates generated and used by web_replay can either be added to the trusted certificate store on the DUT, or use the '--ignore-certificate-errors-spki-list' browser parameter instead:

Browser Parameter

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=

Certificate Store

Install the certificate chain on a DUT 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.

Point browser to web_replay on DUT

Modify the host resolver rules of the browser on a DUT by using --host-resolver-rules:

--host-resolver-rules="MAP *:80 <host>:<http_port>,MAP *:443 <host>:<https_port>"

For example:

--host-resolver-rules="MAP *:80 192.168.0.1:8000,MAP *:443 192.168.0.1:8001"

set_args.ps1 and remove_args.ps1 are PowerShell scripts that handle setting and removing browser arguments for the specified browser located on the taskbar of a DUT. set_args.ps1 modifies the browser shortcut to include the specified arguments, while remove_args.ps1 restores the shortcut to its original state. Use them in the following way:

.\set_args.ps1 web_replay <host> <http_port> <https_port> <browser>

For example:

.\set_args.ps1 web_replay 192.168.0.1 8000 8001 edge

If you want to restore the browser shortcut to its original state, use:

.\remove_args.ps1 <browser>

For example:

.\remove_args.ps1 edge

<browser> is optional and is one of (default is edge):

edge
edgedev
edgebeta
edgecanary
chrome

Another method for pointing the browser on a DUT to web_replay is by configuring the proxy settings. This can be done within the browser settings itself, using the browser parameter --proxy-server, or within system settings.

[!WARNING] It may be necessary to terminate all the browser processes before launching for the command-line parameters to be included. If Edge's Startup Boost feature is enabled, terminating all browser processes will be required.

Record an archive on HOST PC

The web_replay server on the HOST PC can be started in two ways: Standard and Proxy. The Standard method is recommended for most cases, while the Proxy method is useful when the DUT cannot be configured to point to the HOST PC directly.

Standard method:

.\bin\web_replay.exe record --host=<host> --http_port=<http_port> --https_port=<https_port> <archive>

For example:

.\bin\web_replay.exe record --host=192.168.0.1 --http_port=8000 --https_port=8001 c:\temp\archive

[!WARNING] Run under the root web_replay directory.

[!NOTE] Once you have finished recording, use Ctrl+C to stop the recording process.

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. Using a folder is recommended as it can handle multiple DUTs simultaneously.

[!NOTE] The ports specified in --http_port and --https_port may need to be added to the firewall. One method of adding is the following:

netsh advfirewall firewall add rule name="web_replay" protocol=TCP dir=in localport=8000,8001 action=allow

Replay an archive on HOST PC

Standard method:

.\bin\web_replay.exe replay --host=<host> --http_port=<http_port> --https_port=<https_port> <archive>

For example:

.\bin\web_replay.exe replay --host=192.168.0.1 --http_port=8000 --https_port=8001 c:\temp\archive

[!WARNING] Run under the root web_replay directory.

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. Using a folder is recommended as it can handle multiple DUTs simultaneously.

[!TIP] The optional parameter --excludes_list accepts a space-separated list of domains for which web_replay will always fetch data from the live internet.

[!NOTE] A single HOST PC can handle multiple DUTs simultaneously, although issues may arise when the expected active archive file has changed.

Special URL Paths

The following table includes some common special URL paths that perform custom web_replay actions during a recording or replay:

Using archive editor

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>

Building

Build pre-reqs

• Golang version 1.21
• Cgo compilation

Build web replay

.\build.ps1 web_replay

Build archive editor

.\build.ps1 archive

Contributing

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.

Trademarks

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.