77c1020193
Every patch to Firefox should also go to firefox-stable. This patch starts re-using Firefox-beta checkout for firefox-stable, making possible to easily rebaseline work atop of firefox-stable. With this patch, working on a patch in Firefox is a 2-step process: 1. work on a patch against Firefox-Beta 2. rebaseline your work atop of Firefox-Stable Working on Firefox-Beta is as usual: - setup an up-to-date firefox checkout: ```sh $ ./browser_patches/prepare_checkout.sh firefox ``` - create a new branch for your firefox work off `playwright-build`: ```sh $ cd ./browser_patches/firefox/checkout $ git checkout -b my-feature ``` - once work is done, export your branch: ```sh $ ./browser_patches/export.sh firefox ``` Rebaselining your work for Firefox-Stable takes advantage of a single checkout: - prepare a firefox-stable checkout: ```sh $ ./browser_patches/prepare_checkout.sh ff-stable ``` - rebaseline your feature branch atop of stable: ```sh $ cd ./browser_patches/firefox/checkout $ git checkout my-feature $ git rebase -i playwright-build ``` - make sure firefox-stable compiles: ```sh $ ./browser_patches/firefox-stable/build.sh ``` - export firefox-stable: ```sh $ ./browser_patches/export.sh ff-stable ```
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.
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_upstreamremote in the checkout - create a
playwright-buildbranch 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.shif necessary - bump the
./browser_patches/firefox/BUILD_NUMBERnumber.
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
Cheatsheet
FireFox
Stack trace
In //mozglue/misc/StackWalk.cpp add
#define MOZ_DEMANGLE_SYMBOLS 1
In native code use
nsTraceRefcnt::WalkTheStack(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");
WebKit
Debugging windows
In Source\WTF\wtf\win\DbgHelperWin.cpp replace
#if !defined(NDEBUG) with #if 1
Then regular WTFReportBacktrace() works.
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