playwright/browser_patches
Andrey Lushnikov 2b495c9750
browser(firefox): fix SimpleChannel to await initialization (#4311)
As Joel noticed recently, MessageManager in firefox doesn't guarantee
message delivery if the opposite end hasn't been initialized yet. In
this case, message will be silently dropped on the ground.

To fix this, we establish a handshake in SimpleChannel to make sure that
both ends are initialized, end buffer outgoing messages until this
happens.

Drive-by: serialize dialog events to only deliver *after* the
`Page.ready` protocol event. Otherwise, we deliver dialog events to the
unreported page.
2020-11-02 16:21:34 -08:00
..
buildbots devops: build winldd on buildbots (#3917) 2020-09-18 09:43:43 -07:00
chromium browser(chromium): roll to 823078 (#4307) 2020-11-02 13:00:38 -08:00
ffmpeg devops(ffmpeg): compile zlib dependency that is needed for ffmpeg (#3940) 2020-09-21 14:54:22 -07:00
firefox browser(firefox): fix SimpleChannel to await initialization (#4311) 2020-11-02 16:21:34 -08:00
tools devops: notify when winldd is built 2020-09-18 11:26:59 -06:00
webkit browser(webkit): one more mac build fix after last roll (#4298) 2020-10-30 16:15:53 -07:00
winldd fix(winldd): make linker set checksum to make antiviruses happy (#4197) 2020-10-20 13:59:44 -07:00
checkout_build_archive_upload.sh devops: always ensure linux deps when building webkit (#4249) 2020-10-26 21:53:27 -07:00
export.sh devops: add signature to BUILD_NUMBER to force rebaseline (#2810) 2020-07-02 12:09:27 -07:00
prepare_checkout.sh devops: fix winldd build 2020-09-18 11:30:53 -06: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