/testpilot-containers

Test Pilot experiment for Firefox Containers

Primary LanguageJavaScriptMozilla Public License 2.0MPL-2.0

Containers: Test Pilot Experiment

Soon to be Available on Test Pilot

Embedded Web Extension to experiment with Containers in Firefox Test Pilot to learn:

  • Will a general Firefox audience understand the Containers feature?
  • Is the UI as currently implemented in Nightly clear or discoverable?

See the Product Hypothesis Document for more details.

Requirements

  • node 7+ (for jpm)
  • Firefox 51+

Run it

See Development

Development

Development Environment

Add-on development is better with a particular environment. One simple way to get that environment set up is to install the DevPrefs add-on. You can make a custom Firefox profile that includes the DevPrefs add-on, and use that profile when you run the code in this repository.

  1. Make a new profile by running /path/to/firefox -P, which launches the profile editor. "Create Profile" -- name it whatever you wish (e.g. 'addon_dev') and store it in the default location. It's probably best to deselect the option to "Use without asking," since you probably don't want to use this as your default profile.

  2. Once you've created your profile, click "Start Firefox". A new instance of Firefox should launch. Go to Tools->Add-ons and search for "DevPrefs". Install it. Quit Firefox.

  3. Now you have a new, vanilla Firefox profile with the DevPrefs add-on installed. You can use your new profile with the code in this repository like so:

Beta building

To build this for 51 beta just using the downloaded version of beta will not work as XPI signature checking is disabled fully.

The only way to run the experiment is using an unbranded version build or to build beta yourself:

  1. Download the mozilla-beta repo
  2. Create a mozconfig file - probably optional
  3. cd <reponame>
  4. ./mach bootstrap
  5. ./mach build
  6. Follow the above instructions by creating the new profile via: ~/<reponame>/obj-x86_64-pc-linux-gnu/dist/bin/firefox -P (Where "obj-x86_64-pc-linux-gnu" may be different depending on platform obj-...)

Run with jpm

  1. git clone git@github.com:mozilla/testpilot-containers.git
  2. cd testpilot-containers
  3. npm install
  4. ./node_modules/.bin/jpm run -p /Path/To/Firefox/Profiles/{junk}.addon_dev -b FirefoxBeta (where FirefoxBeta might be: ~//obj-x86_64-pc-linux-gnu/dist/bin/firefox or ~//firefox)

Check out the Browser Toolbox for more information about debugging add-on code.

Building .xpi

To build a local .xpi, use the plain jpm xpi command.

Signing an .xpi

To sign an .xpi, use jpm sign command.

Note: You will need to be an author on the AMO add-on.

Testing

TBD

Distributing

TBD