playwright/browser_patches
Andrey Lushnikov b2d9af5e15
browser(firefox): properly initialize debugging pipe on windows (#5514)
browser(firefox): properly initialize debugging pipe on windows

Firefox on Windows has 2 launch modes:
- default: a special "launcher process" is used to start browser as a
  sub-process
- non-default: browser process starts right away

Firefox has a logic to detect how successful was the use of the
launcher process to do self-recovery when things go wrong. Namely:
- when attempting to use launcher process, firefox records a timestamp
  of the attempt beginning
- once the launcher process successfully launches browser sub-process,
  firefox records another timestamp of the completion

On a new launch, firefox checks what timestamps are present. If there's
a timestamp that signifies start of launcher process, but no successful
timestamp, it decides that last "launcher process" use was not
successful and falls back to launching browser right away.

When launching 2 firefox processes right away, the first process
uses attempts to use launcher process and records the first timestamp.

At the same time, the second instance sees the first timestamp and
doesn't see the second timestamp, and falls back to launching browser
right away. Our debugging pipe code, however, does not support
non-launcher-process code path.

This patch adds support for remote debugging pipe in case of
non-launcher-process startup.

Drive-by:
- disable crashreporter altogether
- remove stray dcheck that breaks firefox debug compilation
- disable compilation of firefox update agent
- do not use WIN32_DISTRIB flag unless doing full builds since
  it kills incremental compilation


References #4660
2021-02-19 10:32:47 -08:00
..
buildbots devops: support apple silicon builds of Firefox (#4979) 2021-01-12 03:57:59 +03:00
chromium devops: refactor chromium automation scripts (#5486) 2021-02-17 14:43:19 -08:00
ffmpeg devops: bundle ffmpeg license file with our archives (#5301) 2021-02-03 19:36:10 -08:00
firefox browser(firefox): properly initialize debugging pipe on windows (#5514) 2021-02-19 10:32:47 -08:00
tools devops: automation to compile chromium for mac arm64 (#5101) 2021-01-22 11:27:40 +03:00
webkit browser(webkit): fix scrolling in mobile viewports (#5497) 2021-02-18 13:29:17 -08:00
winldd devops: trigger all builds with new windows buildbot (#4638) 2020-12-08 11:03:11 -08:00
checkout_build_archive_upload.sh browser(firefox): properly initialize debugging pipe on windows (#5514) 2021-02-19 10:32:47 -08:00
export.sh devops: suppport WK_CHECKOUT_PATH variable (#4617) 2020-12-07 08:42:20 -08:00
prepare_checkout.sh devops: refactor chromium automation scripts (#5486) 2021-02-17 14:43:19 -08:00
README.md chore: generate protocol during browser roll (#2719) 2020-07-01 15:22:29 -07:00
sanitize_and_compress_log.js devops: use node.js to gzip logs 2020-04-20 02:52:26 -07:00
upload.sh devops: use node.js to gzip logs 2020-04-20 02:52:26 -07:00

Contributing Browser Patches

Firefox and WebKit have additional patches atop to expose necessary capabilities.

Ideally, all these changes should be upstreamed. For the time being, it is possible to setup a browser checkout and develop from there.

WebKit upstream status

1. Setting up local browser checkout

From the playwright repo, run the following command:

$ ./browser_patches/prepare_checkout.sh firefox <path to checkout>

(you can optionally pass "webkit" for a webkit checkout)

If you don't have a checkout, don't pass a path and one will be created for you in ./browser_patches/firefox/checkout

NOTE: this command downloads GBs of data.

This command will:

  • create a browser_upstream remote in the checkout
  • create a playwright-build branch and apply all playwright-required patches to it.

2. Developing a new change

You want to create a new branch off the playwright-build branch.

Assuming that you're under ./browser_patches/firefox/checkout:

$ git checkout -b my-new-feature playwright-build
$ # develop my feature on the my-new-feature branch ....

3. Exporting your change to playwright repo

Once you're happy with the work you did in the browser-land, you want to export it to the playwright repo.

Assuming that you're in the root of the playwright repo and that your browser checkout has your feature branch checked out:

$ ./browser_patches/export.sh firefox <path to checkout>

This script will:

  • create a new patch and put it to the ./browser_patches/firefox/patches/
  • update the ./browser_patches/firefox/UPSTREAM_CONFIG.sh if necessary
  • bump the ./browser_patches/firefox/BUILD_NUMBER number.

If you omit the path to your checkout, the script will assume one is located at ./browser_patches/firefox/checkout

Send a PR to the Playwright repo to be reviewed.

4. Rolling Playwright to the new browser build

Once the patch has been committed, the build bots will kick in, compile and upload a new browser version to all the platforms. Then you can roll the browser:

$ node utils/roll_browser.js chromium 123456