Skip to content
Juggler - Firefox Automation Protocol for implementing the Puppeteer API.
Branch: master
Clone or download
Pull request Compare This branch is 43806 commits ahead, 16162 commits behind mozilla:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cargo
.ci
.vscode
accessible
browser
build
caps
chrome
config
db
devtools
docshell
dom
editor
embedding
extensions
gfx
gradle/wrapper
hal
image
intl
ipc
js
layout
media
memory
mfbt
mobile
modules
mozglue
netwerk
nsprpub
other-licenses
parser
python
security
services
servo
startupcache
storage
taskcluster
testing
third_party
toolkit
tools
uriloader
view
widget
xpcom
xpfe/appshell
.arcconfig
.clang-format
.clang-format-ignore
.cron.yml
.eslintignore
.eslintrc.js
.flake8
.gdbinit
.gdbinit_python
.git-blame-ignore-revs
.gitignore
.hg-annotate-ignore-revs
.hg-format-source
.hgignore
.hgtags
.lldbinit
.mailmap
.taskcluster.yml
.trackerignore
.yamllint
.ycm_extra_conf.py
AUTHORS
CLOBBER
Cargo.lock
Cargo.toml
GNUmakefile
LEGAL
LICENSE
Makefile.in
README.md
aclocal.m4
build.gradle
client.mk
client.py
configure.in
configure.py
gradle.properties
gradlew
mach
moz.build
moz.configure
mozilla-config.h.in
old-configure.in
package-lock.json
package.json
settings.gradle
test.mozbuild

README.md

Juggler

Juggler - Firefox Automation Protocol for implementing the Puppeteer API.

This repository is a fork of the Firefox browser with additional support for the "Juggler" remote debugging protocol. Juggler can be found in //testing/juggler/.

Protocol

See //testing/juggler/Protocol.js.

Building FF with Juggler

  1. Clone the Juggler repository (without history to make things faster)
git clone --depth 1 https://github.com/Puppeteer/juggler
cd juggler
  1. Bootstrap a host environment for the Firefox build and compile Firefox locally
# OPTIONAL - bootstrap host environment.
./mach bootstrap --application-choice=browser --no-interactive
# Compile browser
./mach build

Troubleshooting when building FF on Mac

Black screen after FF Build

As of Jan. 2019 there is a known bug that will cause an entirely black screen when running the nightly build of firefox built with the MacOSX SDK version 10.14.

The easiest fix right now is downgrading your MacOSX SDK.

To do so:

  1. Go to this repo and install any SDK version < 10.14 (e.g. 10.13 works fine)

  2. In the juggler/firefox folder:

echo "ac_add_options --with-macos-sdk=path/to/sdk" >> .mozconfig
# your SDK might be located at
# /Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/
  1. run ./mach build again

Missing headers in /usr/include

On MacOS 10.14 (Mojave) you might run into issues when building FF.

The error is related to a change in the xcode-select installation

To workaround this issue you can simply run:

# Write missing headers to /usr/include
sudo installer -pkg /Library/Developer/CommandLineTools/Packages/macOS_SDK_headers_for_macOS_10.14.pkg -target /

Running Firefox with Juggler

Juggle adds a -juggler CLI flag that accepts a port to expose a remote protocol on. Pass 0 to pick a random port - Juggler will print its port to STDOUT.

./mach run -- -juggler 0

Uploading builds to Google Storage

QUICK: on Linux and OSX, just use //.ci/scripts/build_and_upload.sh

Firefox builds with Juggler support are uploaded to the gs://juggler-builds/ bucket.

Project maintainers can upload builds. To upload a build, do the following:

  1. Install gcloud if you haven't yet.
  2. Authenticate in the cloud and select the project
gcloud auth login
gcloud config set project juggler-builds
  1. Make sure firefox is compiled. After that, package a build for redistribution:
./mach package
  1. Archive the build and copy it to the gbucket

We want to ship *.zip archives so that it will be easy to decompress them on the node-side.

  • Linux: .ci/scripts/upload_linux.sh
  • Mac: .ci/scripts/upload_mac.sh
You can’t perform that action at this time.