playwright/browser_patches
2022-04-05 11:11:24 -07:00
..
chromium devops: fix Chromium clean script (#13330) 2022-04-05 11:11:24 -07:00
ffmpeg devops: move everyone to use xcode 13.2 (#12788) 2022-03-15 10:44:53 -07:00
firefox devops: support msys2 (#13194) 2022-03-31 15:09:38 -07:00
firefox-beta devops: support msys2 (#13194) 2022-03-31 15:09:38 -07:00
webkit browser(webkit): add missing header to fix linux build (#13328) 2022-04-05 10:53:01 -07:00
winldd devops: support msys2 (#13194) 2022-03-31 15:09:38 -07:00
build.sh devops: fix //browser_patches/{build.sh,clean.sh} scripts (#9515) 2021-10-14 11:48:01 -07:00
checkout_build_archive_upload.sh devops: support msys2 (#13194) 2022-03-31 15:09:38 -07:00
clean.sh devops: fix //browser_patches/{build.sh,clean.sh} scripts (#9515) 2021-10-14 11:48:01 -07:00
export.sh devops: move Firefox and WebKit checkouts to $HOME (#9485) 2021-10-14 10:20:06 -07:00
prepare_checkout.sh devops: fix Chromium build on Windows (#13310) 2022-04-05 01:24:49 -07:00
README.md chore: add webkit linux debugging note 2022-03-29 14:13:31 -07:00
repack-juggler.mjs devops: fix repack_juggler script (#10864) 2021-12-10 11:45:43 -08:00
sanitize_and_compress_log.js devops: use node.js to gzip logs 2020-04-20 02:52:26 -07:00
send_telegram_message.sh chore: quote all bash variables when used (#8066) 2021-08-07 05:32:18 -07:00
upload.sh devops: support msys2 (#13194) 2022-03-31 15:09:38 -07:00
utils.sh devops: bundle vcruntime140_1.dll with Firefox builds (#10099) 2021-11-05 15:28:44 -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

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

This will create a firefox checkout at $HOME/firefox

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 $HOME/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

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.

The script will assume Firefox checkout is located at $HOME/firefox

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

Cheatsheet

See browser stdout/stderr

Set the DEBUG=pw:browser environment variable to see it.

Firefox

Debug build

When compiling set the FF_DEBUG_BUILD=1 environment variable.

Stack trace

In //mozglue/misc/StackWalk.cpp add

#define MOZ_DEMANGLE_SYMBOLS 1

In native code use

#include "mozilla/StackWalk.h"
// ...
MozWalkTheStack(stderr);

If the stack trace is still mangled cat it to tools/rb/fix_linux_stack.py

Logging

Upstream documentation: https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Gecko_Logging

MOZ_LOG=nsHttp:5

Module name is a string passed to the mozilla::LazyLogModule of the corresponding component, e.g.:

LazyLogModule gHttpLog("nsHttp");

Inside Juggler, you can use dump('foo\n').

WebKit

Logging

Inside Objective-C you can use NSLog.

NSLog(@"Foobar value: %@", value);

Debugging windows

In Source\WTF\wtf\win\DbgHelperWin.cpp replace

#if !defined(NDEBUG) with #if 1

Then regular WTFReportBacktrace() works.

Debugging linux

WTFReportBacktrace() has been broken since r283707, see this comment. Revert that change locally to make backtraces work again. Otherwise addr2line -f can still be used to map addresses to function names.

Enable core dumps on Linux

mkdir -p /tmp/coredumps
sudo bash -c 'echo "/tmp/coredumps/core-pid_%p.dump" > /proc/sys/kernel/core_pattern'
ulimit -c unlimited

Then to read stack traces run the following command:

# To find out crashing process name
file core-pid_29652.dump
# Point gdb to the local binary of the crashed process and the core file
gdb $HOME/.cache/ms-playwright/webkit-1292/minibrowser-gtk/WebKitWebProcess core-pid_29652
# Inside gdb update .so library search path to the local one
set solib-search-path /home/yurys/.cache/ms-playwright/webkit-1292/minibrowser-gtk
# Finally print backtrace
bt