QA/Telemetry/Developing a Telemetry Experiment: Difference between revisions

Jump to navigation Jump to search
Split out separate sections on beta testing, code review, signing
(→‎Deploying to staging: Move review notes from https://wiki.mozilla.org/Telemetry/Experiments#Repository_and_Reviews over to this page)
(Split out separate sections on beta testing, code review, signing)
Line 98: Line 98:
== Testing on Beta ==
== Testing on Beta ==


If you're testing on beta or release, you'll '''need''' to have the XPI signed, or rebuild beta to remove the requirement that experiments be signed, by [http://mxr.mozilla.org/mozilla-central/source/toolkit/mozapps/extensions/internal/XPIProvider.jsm?rev=002d7897c93c#240 removing this line].
If your experiment is going to run on beta or release, and you want to test on those channels, you'll '''need''' to have the XPI signed (see below), or rebuild beta to remove the requirement that experiments be signed, by [http://mxr.mozilla.org/mozilla-central/source/toolkit/mozapps/extensions/internal/XPIProvider.jsm?rev=002d7897c93c#240 removing this line]. It's probably better to use one of the following two workflows:


== Deploying to staging ==
* test on a local beta build modified to allow unsigned add-ons, then get code review, then sign the XPI, and then deploy to staging
* get code review, sign the XPI, test the signed XPI on a stock beta build, and then deploy to staging
 
These workflows put the signing step after code review, because the reviewer might request changes to the add-on which will require you to re-sign the updated version. Neither of these workflows are mandatory, though - do what makes sense.
 
== Code Review ==


Before deploying to staging, you should get your experiment reviewed. To request reviews, file a bug against the [https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox%20Health%20Report&component=Client%3A%20Desktop Firefox Health Report product, Desktop Client component].
Before deploying to staging, you should get your experiment reviewed. To request reviews, file a bug against the [https://bugzilla.mozilla.org/enter_bug.cgi?product=Firefox%20Health%20Report&component=Client%3A%20Desktop Firefox Health Report product, Desktop Client component].


Once everything looks good, everything is working perfectly, and you've got r+, you should push it to the repo.
== Signing the XPI ==
 
For testing on a stock Beta build, or for deployment, you'll need to have the experiment signed. Once {{bug|1271440}} is fixed, you can use the '''jpm''' tool to sign the experiment, using the instructions at [[EngineeringProductivity/HowTo/SignExtensions|How to Sign Extensions]].
 
Until that bug is fixed, you can file a bug against the addons.mozilla.org product, Addon Validation component, attach the xpi file, and request that it be signed. Ping Jason Thomas if you run into problems.
 
== Deploying to staging ==
 
Once everything looks good, everything is working perfectly, you've got r+, and the experiment signed, you should push it to the repo.


Pushing to the repo will build the server to the [https://telemetry-experiment-dev.allizom.org/ staging server]. You can then use the [https://telemetry-experiment-dev.allizom.org/firefox-manifest.json firefox-manifest.json] from the staging server to test your experiment.
Pushing to the repo will build the server to the [https://telemetry-experiment-dev.allizom.org/ staging server]. You can then use the [https://telemetry-experiment-dev.allizom.org/firefox-manifest.json firefox-manifest.json] from the staging server to test your experiment.
Confirmed users
586

edits

Navigation menu