View source for Labs/Test Pilot/ExperimentAPI

= General =

Test Pilot experiments and surveys are implemented as Javascript Securable Modules.  They will be loaded using Cuddlefish.  They are expected to export objects with certain specific names.

Test pilot experiments and surveys are hosted on https://testpilot.mozillalabs.com.  This URL is hard-coded into the Test Pilot extension.  Note that the experiments and surveys are served exclusively over SSL to reduce the possibility that a man-in-the-middle could substitute malicious code.

== index.json ==

TODO

== The Hg repository for experiment/survey code ==

TODO

== Working with Cuddlefish ==

TODO

== Surveys ==

Surveys are very simple to write, because we currently use SurveyMonkey to host the actual questions, meaning that the JS module on testpilot.mozillalabs.com only has to provide metadata.  The survey js file simply has to export an object named surveyInfo which has the following properties:

* surveyInfo.surveyId: a unique string that identifies this survey.  Can be anything but must be distinct from the ids of any other surveys.  Will be used as part of a Mozilla preference so it must not contain spaces.
* surveyInfo.surveyName: a string containing the human-readable name of the survey, which will be displayed in the extension's menus, etc.
* surveyInfo.surveyUrl: the URL where the survey is hosted - users who choose to take the survey will be sent here.
* surveyInfo.resultsUrl: the URL where the survey results are hosted - users who choose to see survey results will be sent here.  If there are no survey results yet (e.g. if it's a new survey), then resultsUrl should be undefined (i.e. don't specify it at all).

The presence or absence of the surveyInfo object is used by the extension to determine whether a JS module is a survey or an experiment.  Any JS module that exports an object named surveyInfo will be treated as a survey.  If you are writing an experiment, make sure not to export an object named surveyInfo!

=== Example ===

new_pilot_survey.js, the file providing the metadata for "Survey for New Test Pilots", is reproduced here in its entirety:

 exports.surveyInfo = {
   surveyId: "survey_for_new_pilots",
   surveyName: "Survey For New Test Pilots",
   surveyUrl: "http://www.surveymonkey.com/s.aspx?sm=bxR0HNhByEBfugh8GPASvQ_3d_3d",
   resultsUrl: "http://www.surveymonkey.com/sr.aspx?sm=oZPWdDCVgnJqkmPERROH6AWWPcmTImSDiMyFunw16b8_3d"
 };

== Experiments ==

Experiments are much more involved than surveys, and must export four objects, named as follows:

 # experimentInfo
 # dataStoreInfo
 # webContent
 # Observer

These are explained one by one in the following sections.

=== experimentInfo ===

This object contains metadata about the experiment: its name and id, its version number, when it is to be run and for how long, whether it recurs, whether it requires an additional layer of opt-in, and the URLs for further information about it.  It should contain the following fields:

* startDate: if null, then the experiment will start automatically as soon as it is installed.  If you want to instead schedule a date in the future for the test to start, instead set it to a parseable date string.
* duration: an integer, giving the number of days the test is to run for.  E.g. if duration is 14 then the test will run from startDate to startDate + 2 weeks.  Optional; duration defaults to 7 days if not specified.
* testName: The human readable name of the experiment, as it will be displayed in menus and status pages, etc.  Required.
* testId: Can be either a number or a string, but must be unique - an experiment must not have the same id as another experiment or survey.  These IDs will end up used in preference names, so it must not contain spaces.  Required.
* testInfoUrl: the URL of a page where the user can go to get more information about the experiment.
* testResultsUrl: the URL of a page where experiment results have been published.  If no results are published yet, leave this undefined.  The presence of a defined testResultsUrl property is what lets the Test Pilot extension know that a test has moved on into the results phase, and update its UI accordingly.
* optInRequired: Set this to true if the test should not start automatically on the start date, but should instead only start if the user explicitly tells it to start.  This should be the case for tests that change the Firefox UI, such as A-B tests.  Note that the UI to support optInRequired has not yet been implemented in the client as of version 0.3.
* recursAutomatically: Set this to true if the test should recur automatically after it ends.  Note that support for recurrence has not yet been implemented in the client as of version 0.3.
* recurrenceInterval: If recursAutomatically is true, then this is the number of days (measured from the startDate) after which the study will begin again. For obvious reasons, this must be longer than duration.  Has no effect if recursAutomatically is false.
* versionNumber: An integer for telling apart different versions of the same experiment.  Whenever a significant change is made to the experiment code, the versionNumber should be incremented.  The version number gets attached to the user's data upload when they submit results for the experiment; it can then be detected on the server side to tell apart submissions from different versions of the experiment.  Required.


==== Example ====

The experimentInfo object for the Tab open/close study is as follows:

 exports.experimentInfo = {
   startDate: null,
   duration: 7,
   testName: "Tab Open/Close Study",
   testId: 1,
   testInfoUrl: "https://testpilot.mozillalabs.com/testcases/tab-open-close.html",
   testResultsUrl: "https://testpilot.mozillalabs.com/testcases/tab-open-close/results.html",
   optInRequired: false,
   recursAutomatically: false,
   recurrenceInterval: 0,
   versionNumber: 2
 };

=== dataStoreInfo ===

=== webContent ===

=== Observer ===