1,007
edits
Labs/Test Pilot/ExperimentAPI: Difference between revisions
→The Index files
| Line 9: | Line 9: | ||
The server holds an index file which lists experiments to run. The clients check this file (on startup, then once per day thereafter) and then download the experiments they find listed there. To release a new experiment or survey, we add it to the index file. To stop giving out an experiment or survey, we take it out of the index file. (Clients who already have it will keep running it). | The server holds an index file which lists experiments to run. The clients check this file (on startup, then once per day thereafter) and then download the experiments they find listed there. To release a new experiment or survey, we add it to the index file. To stop giving out an experiment or survey, we take it out of the index file. (Clients who already have it will keep running it). | ||
The canonical index file is at [https://testpilot.mozillalabs.com/testcases/index.json]. You can go have a look at it right now. It's human readable and fairly self-explanatory. | The canonical index file is at [https://testpilot.mozillalabs.com/testcases/index.json https://testpilot.mozillalabs.com/testcases/index.json]. You can go have a look at it right now. It's human readable and fairly self-explanatory. | ||
The top level of the JSON has a property called experiments, which is an array of objects with names and filenames: | The top level of the JSON has a property called experiments, which is an array of objects with names and filenames: | ||
| Line 20: | Line 20: | ||
In order to develop and test experiments that we're not ready to deploy, we have an alternate index file for developers only. This lives at [https://testpilot.mozillalabs.com/testcases/index-dev.json]. To make your copy of the Test Pilot client use this file: | In order to develop and test experiments that we're not ready to deploy, we have an alternate index file for developers only. This lives at [https://testpilot.mozillalabs.com/testcases/index-dev.json https://testpilot.mozillalabs.com/testcases/index-dev.json]. To make your copy of the Test Pilot client use this file: | ||
# go to about:config | # go to about:config | ||
| Line 26: | Line 26: | ||
# change its value to index-dev.json | # change its value to index-dev.json | ||
Once you make that switch, you will start getting all the studies that are still in development, as well as some dummy studies which exist for testing purposes only. If you want to develop your own study, you should start using index-dev.json. | |||
== Version control for experiment/survey code == | == Version control for experiment/survey code == | ||