mobify/split-test

An A/B split test library for persisting split choices

split-test

A support library to simplify split testing. We have a repository of working examples you can reference in https://github.com/mobify/adaptivejs-split-test-examples

Quickstart

Install split-test using npm:

$ npm install split-test --save-dev

Defining a split condition

var splitTest = SplitTest.init(
    {
        'A': 0.4,
        'B': 0.5,
        'C': 0.1
    },
    {
        namespace: 'foo'
    }
);

Obtaining the split value

splitTest.getChoice();

Methods

init

Adds a script to a custom container.

Parameter name	Type	Description
value	Object	The split condition
options	Object	The setup parameters

var splitTest = SplitTest.init(
    {
        'A': 0.4,
        'B': 0.5,
        'C': 0.1
    },
    {
        namespace: 'foo',
        cookieDomain: 'http://www.foo.com',
        lifetime: 15
    }
);

Available options

Options	Type	Description
namespace	String	The namespace of the cookie to prevent conflict between cookie names
cookieDomain	String	The domain of this cookie. Default to the hostname
lifetime	Integer (milliseconds)	The lifetime of the cookie. Default to 30 days.

getChoice

Returns the split choice key.

// This returns either 'A', 'B', or 'C'
var choice = splitTest.getChoice();

setChoice

Manually sets the split choice.

Parameter name	Type	Description
value	String	split choice key

splitTest.setChoice('C');

// This return 'C'
splitTest.getChoice();

How to create and ship a change

• Make your code changes and create a pull-request
• Ensure the tests still work (grunt test)
• Get your change reviewed and 👍'ed

Changelog

• 1.0.0: Remove bower dependencies and dist folder, distribute on npm
• 0.0.1: Initial commit

Where to get help

Talk to @jansepar or @dbader.

split-test's Issues

Unguarded incorrect init usage and overly relaxed regex for getCookie

You can initialize a split test variable like this:

SplitTest.init('my-cookie')

This creates an invalid SplitTest instance where cookieName is split.

When you getChoice on this instance, getCookie grabs the first cookie that matches split=cookieVaue <-- this ignores that fact that any cookie ending with split is also being matched (ie. optimizely-split=something will match if it was earlier in the cookie string)

Defining lifetime option in SplitTest.init does nothing

When initializing split test with the lifetime option, the cookie will always set to 30 days regardless what the lifetime options is set to.

This is due to lifetime not being passed in from setChoice to setCookie.

    SplitTest.prototype.setChoice = SplitTest.prototype.setValue = function(value) {
        // Splits are stored for 30 days.
        SplitTest.setCookie(this.cookieName, value, this.cookieDomain);
    };