Scenario.js
A lightweight A/B Testing library for use with MixPanel
Install
<script type="text/javascript" src="mixpanel.js"></script>
<script type="text/javascript" src="scenario.js"></script>Usage
In order to wait until Mixpanel's library is loaded, we will utilize .init({'loaded':}). To make sure that your Scenario function calls are run after Mixpanel loads, please update the tail end of your mixpanel library with:
mixpanel.init('<YOUR_PROJ_TOKEN>',{'loaded' : function() {
var test = new Scenario({
name: 'My Test Name',
})
.test({
name: 'Test A',
weight: 3, // The optional weight of the test. Each test has a weight of 1 by default
className: 'foobar' // An optional class to add to the body tag. If left empty, the test name will be turned into a slug (i.e. "test-a")
})
.test({
name: 'Test B'
callback: function(){ console.log('I was chosen!'); } // An optional callback if the test is chosen
})
.go();
}
})
// At a later point
test.complete();API
Scenario( String testName ): Initializes a new test and returns two functions,test, andgo.test([, String testName, Int weight, Function fn] ): Adds a test variant.testNameis the name of the variant,weightis the tests weight (compared to the default1), andfn, a function, may be passed in that will execute if the test case is chosen. In addition, thebodyhas the test cases name added to it in the form of a slug, so"Test Case A"will be added to the body as"test-case-a".
It is useful to note that the order of parameters do not matter.go(): Rolls the dice and calls one of the variants. Returns the instance based method(s)complete.complete(Function fn): Finishes the test sequence. An optional function may be passed as a mixpanel callback. Good for delaying links so he mixpanel call may finish before the page changes.
Creating the Funnel
Navigate to MixPanel and click Funnels. Create a funnel that includes the testName Start and testName Finish, then click Save.
Practical Examples
var test = new Scenario({
name: 'Homepage Signup Conversions',
tracker: function(text, props, cb){ // This is the default, you may omit it
return mixpanel.track(text, props, cb);
}
})
.test({
name: 'Home V1',
weight: 10 // Test weight is 10/15, or 66%
})
.test({
name: 'Home V2',
weight: 5 // Test weight is 5/15, or 33%
})
.go();
signup.on('click', function(){
test.complete();
});This results in the body tag being appended with a css class like the following:
<body class="home-v1">Alternatively, you can handle your test differences with JavaScript:
var test = new Scenario( 'Homepage Signup Conversions' )
.test({
name: 'Home V1',
callback: function(info){
// Do something optional
// `info` contains information about the chosen test, including weights and odds
}
})
.test({
name: 'Home V2',
callback: function(info){
// Do something optional
// `info` contains information about the chosen test, including weights and odds
}
})
.go();
signup.on('click', function(){
test.complete(fn);
});Licensing
MIT Copyright (c) 2013 Maker Studios
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.