Labs/Test Pilot/ExperimentAPI: Difference between revisions

Jump to navigation Jump to search

Labs/Test Pilot/ExperimentAPI (view source)

Revision as of 23:14, 2 February 2016

1,575 bytes removed ,  2 February 2016
Replaced content with "{{warning|The original Mozilla Labs Test Pilot project has been retired. Click the 'View History' link on this page to read the old content.}} As of January 2016 a simil..."
(Created page with '== General == Test Pilot experiments and surveys are implemented as Javascript Securable Modules. They will be loaded using Cuddlefish. They are expected to export objects wit…')
 
(Replaced content with "{{warning|The original Mozilla Labs Test Pilot project has been retired. Click the 'View History' link on this page to read the old content.}} As of January 2016 a simil...")
 
(38 intermediate revisions by one other user not shown)
Line 1: Line 1:
== General ==
{{warning|The original Mozilla Labs Test Pilot project has been retired.  Click the 'View History' link on this page to read the old content.}}


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.
As of January 2016 a similar initiative, formerly named Idea Town, has been [http://micropipes.com/blog/2016/01/27/meet-the-new-test-pilot/ named Test Pilot].


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.
'''[[Test_Pilot|Learn more about the new Test Pilot!]]'''
 
== Surveys ==
 
Surveys are very simple to write, because we currently use SurveyMonkey to host the actual questions, meaning that the JS file on testpilot.mozillalabs.com only has to provide metadata.  The survey js file simply has to export an object called surveyInfo which has the following properties:
 
* 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.
* surveyName: a string containing the human-readable name of the survey, which will be displayed in the extension's menus, etc.
* surveyUrl: the URL where the survey is hosted - users who choose to take the survey will be sent here.
* 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).
 
=== 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"
};
Clouserw
Confirmed users, Bureaucrats and Sysops emeriti
1,737

edits

Retrieved from "https://wiki.mozilla.org/Special:MobileDiff/181056...1115546"

Navigation menu