78 lines
1.9 KiB
Markdown
78 lines
1.9 KiB
Markdown
|
# Juggler
|
||
|
|
|
||
|
|
> Juggler - Firefox Automation Protocol for implementing the Puppeteer API.
|
||
|
|
|
||
|
|
## Protocol
|
||
|
|
|
||
|
|
See [`//src/Protocol.js`](https://github.com/GoogleChrome/puppeteer/blob/master/experimental/juggler/src/Protocol.js).
|
||
|
|
|
||
|
|
## Building FF with Juggler
|
||
|
|
|
||
|
|
1. Clone Juggler repository
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/aslushnikov/juggler
|
||
|
|
cd juggler
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Checkout [pinned Firefox revision](https://github.com/aslushnikov/juggler/blob/master/FIREFOX_SHA) from mozilla [github mirror](https://github.com/mozilla/gecko-dev) into `//firefox` folder.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
SOURCE=$PWD bash scripts/fetch_firefox.sh
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Apply juggler patches to Firefox source code
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd firefox
|
||
|
|
git am ../patches/*
|
||
|
|
ln -s $PWD/../src $PWD/testing/juggler
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Bootstrap host environment for Firefox build and compile firefox locally
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# OPTIONAL - bootstrap host environment.
|
||
|
|
./mach bootstrap --application-choice=browser --no-interactive
|
||
|
|
# Compile browser
|
||
|
|
./mach build
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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
|
||
|
|
|
||
|
|
Firefox builds with Juggler support are uploaded to gs://juggler-builds/ bucket.
|
||
|
|
|
||
|
|
Project maintainers can upload builds.
|
||
|
|
To upload a build, do the following:
|
||
|
|
|
||
|
|
1. Install [gcloud](https://cloud.google.com/sdk/install) if you haven't yet.
|
||
|
|
2. Authenticate in the cloud and select project
|
||
|
|
|
||
|
|
```bash
|
||
|
|
gcloud auth login
|
||
|
|
gcloud config set project juggler-builds
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Make sure **firefox is compiled**; after that, package a build for a redistribution:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd firefox
|
||
|
|
./mach package
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Archive build and copy to the gbucket
|
||
|
|
|
||
|
|
We want to ship `*.zip` archives so that it's easy to decompress them on the node-side.
|
||
|
|
|
||
|
|
- Linux: `./scripts/upload_linux.sh`
|
||
|
|
- Mac: `./scripts/upload_mac.sh`
|
||
|
|
|