rb-ab-test v2.0.1

RB AB TEST

Table of Contents

• A/B Testing React Components
  • Installation
  • Usage
    • Standalone Component
    • Coordinate Multiple Components
    • Weighting Variants
    • Debugging
  • API Reference
    • <Experiment />
    • <Variant />
    • emitter
      • emitter.emitWin(experimentName)
      • emitter.addActiveVariantListener([experimentName, ] callback)
      • emitter.addPlayListener([experimentName, ] callback)
      • emitter.addWinListener([experimentName, ] callback)
      • emitter.defineVariants(experimentName, variantNames [, variantWeights])
      • emitter.setActiveVariant(experimentName, variantName)
      • emitter.getActiveVariant(experimentName)
      • emitter.getSortedVariants(experimentName)
    • Subscription
      • subscription.remove()
    • experimentDebugger
      • experimentDebugger.enable()
      • experimentDebugger.disable()
    • Running Tests

A/B Testing React Components

Wrap components in <Variant /> and nest in <Experiment />. A variant is chosen randomly and saved to local storage.

<Experiment name="My Example">
  <Variant name="A">
    <div>Version A</div>
  </Variant>
  <Variant name="B">
    <div>Version B</div>
  </Variant>
</Experiment>

Report to your analytics provider using the emitter.

emitter.addPlayListener(function(experimentName, variantName){});

Installation

npm install rb-ab-test

Usage

Standalone Component

Try it on JSFiddle

var Experiment = require("rb-ab-test/lib/Experiment");
var Variant = require("rb-ab-test/lib/Variant");
var emitter = require("rb-ab-test/lib/emitter");

var App = React.createClass({
  onButtonClick: function(e){
    this.refs.experiment.win();
  },
  render: function(){
    return <div>
      <Experiment ref="experiment" name="My Example">
        <Variant name="A">
          <div>Section A</div>
        </Variant>
        <Variant name="B">
          <div>Section B</div>
        </Variant>
      </Experiment>
      <button onClick={this.onButtonClick}>Emit a win</button>
    </div>;
  }
});

// Called when the experiment is displayed to the user.
emitter.addPlayListener(function(experimentName, variantName){
  console.log("Displaying experiment ‘" + experimentName + "’ variant ‘" + variantName + "’");
});

// Called when a 'win' is emitted, in this case by this.refs.experiment.win()
emitter.addWinListener(function(experimentName, variantName){
  console.log("Variant ‘" + variantName + "’ of experiment ‘" + experimentName + "’  was clicked");
});

Coordinate Multiple Components

var Experiment = require("rb-ab-test/lib/Experiment");
var Variant = require("rb-ab-test/lib/Variant");
var emitter = require("rb-ab-test/lib/emitter");

// Define variants in advance.
emitter.defineVariants("My Example", ["A", "B", "C"]);

var Component1 = React.createClass({
  render: function(){
    return <Experiment name="My Example">
      <Variant name="A">
        <div>Section A</div>
      </Variant>
      <Variant name="B">
        <div>Section B</div>
      </Variant>
    </Experiment>;
  }
});

var Component2 = React.createClass({
  render: function(){
    return <Experiment name="My Example">
      <Variant name="A">
        <div>Subsection A</div>
      </Variant>
      <Variant name="B">
        <div>Subsection B</div>
      </Variant>
      <Variant name="C">
        <div>Subsection C</div>
      </Variant>
    </Experiment>;
  }
});

var Component3 = React.createClass({
  onButtonClick: function(e){
    emitter.emitWin("My Example");
  },
  render: function(){
    return <button onClick={this.onButtonClick}>Emit a win</button>;
  }
});

var App = React.createClass({
  render: function(){
    return <div>
      <Component1 />
      <Component2 />
      <Component3 />
    </div>;
  }
});

// Called when the experiment is displayed to the user.
emitter.addPlayListener(function(experimentName, variantName){
  console.log("Displaying experiment ‘" + experimentName + "’ variant ‘" + variantName + "’");
});

// Called when a 'win' is emitted, in this case by emitter.emitWin()
emitter.addWinListener(function(experimentName, variantName){
  console.log("Variant ‘" + variantName + "’ of experiment ‘" + experimentName + "’ was clicked");
});

Weighting Variants

Use emitter.defineVariants() to optionally define the ratios by which variants are chosen.

var Experiment = require("rb-ab-test/lib/Experiment");
var Variant = require("rb-ab-test/lib/Variant");
var emitter = require("rb-ab-test/lib/emitter");

// Define variants and weights in advance.
emitter.defineVariants("My Example", ["A", "B", "C"], [10, 40, 40]);

var App = React.createClass({
  render: function(){
    return <div>
      <Experiment ref="experiment" name="My Example">
        <Variant name="A">
          <div>Section A</div>
        </Variant>
        <Variant name="B">
          <div>Section B</div>
        </Variant>
        <Variant name="C">
          <div>Section C</div>
        </Variant>
      </Experiment>
    </div>;
  }
});

Debugging

The debugger attaches a fixed-position panel to the bottom of the <body> element that displays mounted experiments and enables the user to change active variants in real-time.

var Experiment = require("rb-ab-test/lib/Experiment");
var Variant = require("rb-ab-test/lib/Variant");
var experimentDebugger = require("rb-ab-test/lib/debugger");

experimentDebugger.enable();

var App = React.createClass({
  render: function(){
    return <div>
      <Experiment ref="experiment" name="My Example">
        <Variant name="A">
          <div>Section A</div>
        </Variant>
        <Variant name="B">
          <div>Section B</div>
        </Variant>
      </Experiment>
    </div>;
  }
});

#### Example

The component in [`Component.jsx`](https://github.com/ABTEST/rb-ab-test/blob/master/examples/isomorphic/Component.jsx):

```js

var React = require("react");
var Experiment = require("rb-ab-test/lib/Experiment");
var Variant = require("rb-ab-test/lib/Variant");

module.exports = React.createClass({
  propTypes: {
    userIdentifier: React.PropTypes.string.isRequired
  },
  render: function(){
    return <div>
      <Experiment ref="experiment" name="My Example" userIdentifier={this.props.userIdentifier}>
        <Variant name="A">
          <div>Section A</div>
        </Variant>
        <Variant name="B">
          <div>Section B</div>
        </Variant>
      </Experiment>
    </div>;
  }
});

API Reference

<Experiment />

Experiment container component. Children must be of type Variant.

• Properties:
  • name - Name of the experiment.
    • Required
    • Type: string
    • Example: "My Example"
  • userIdentifier - Distinct user identifier. When defined, this value is hashed to choose a variant if defaultVariantName or a stored value is not present. Useful for server side rendering.
    • Optional
    • Type: string
    • Example: "7cf61a4521f24507936a8977e1eee2d4"
  • defaultVariantName - Name of the default variant. When defined, this value is used to choose a variant if a stored value is not present. This property may be useful for server side rendering but is otherwise not recommended.
    • Optional
    • Type: string
    • Example: "A"

<Variant />

Variant container component.

• Properties:
  • name - Name of the variant.
    • Required
    • Type: string
    • Example: "A"

emitter

Event emitter responsible for coordinating and reporting usage. Extended from facebook/emitter.

emitter.emitWin(experimentName)

Emit a win event.

• Return Type: No return value
• Parameters:
  • experimentName - Name of an experiment.
    • Required
    • Type: string
    • Example: "My Example"

emitter.addActiveVariantListener([experimentName, ] callback)

Listen for the active variant specified by an experiment.

• Return Type: Subscription
• Parameters:
  • experimentName - Name of an experiment. If provided, the callback will only be called for the specified experiment.
    • Optional
    • Type: string
    • Example: "My Example"
  • callback - Function to be called when a variant is chosen.
    • Required
    • Type: function
    • Callback Arguments:
      • experimentName - Name of the experiment.
        • Type: string
      • variantName - Name of the variant.
        • Type: string

emitter.addPlayListener([experimentName, ] callback)

Listen for an experiment being displayed to the user. Trigged by the React componentWillMount lifecycle method.

• Return Type: Subscription
• Parameters:
  • experimentName - Name of an experiment. If provided, the callback will only be called for the specified experiment.
    • Optional
    • Type: string
    • Example: "My Example"
  • callback - Function to be called when an experiment is displayed to the user.
    • Required
    • Type: function
    • Callback Arguments:
      • experimentName - Name of the experiment.
        • Type: string
      • variantName - Name of the variant.
        • Type: string

emitter.addWinListener([experimentName, ] callback)

Listen for a successful outcome from the experiment. Trigged by the emitter.emitWin(experimentName) method.

• Return Type: Subscription
• Parameters:
  • experimentName - Name of an experiment. If provided, the callback will only be called for the specified experiment.
    • Optional
    • Type: string
    • Example: "My Example"
  • callback - Function to be called when a win is emitted.
    • Required
    • Type: function
    • Callback Arguments:
      • experimentName - Name of the experiment.
        • Type: string
      • variantName - Name of the variant.
        • Type: string

emitter.defineVariants(experimentName, variantNames [, variantWeights])

Define experiment variant names and weighting. Required when an experiment spans multiple components containing different sets of variants.

If variantWeights are not specified variants will be chosen at equal rates.

The variants will be chosen according to the ratio of the numbers, for example variants ["A", "B", "C"] with weights [20, 40, 40] will be chosen 20%, 40%, and 40% of the time, respectively.

• Return Type: No return value
• Parameters:
  • experimentName - Name of the experiment.
    • Required
    • Type: string
    • Example: "My Example"
  • variantNames - Array of variant names.
    • Required
    • Type: Array.<string>
    • Example: ["A", "B", "C"]
  • variantWeights - Array of variant weights.
    • Optional
    • Type: Array.<number>
    • Example: [20, 40, 40]

emitter.setActiveVariant(experimentName, variantName)

Set the active variant of an experiment.

• Return Type: No return value
• Parameters:
  • experimentName - Name of the experiment.
    • Required
    • Type: string
    • Example: "My Example"
  • variantName - Name of the variant.
    • Required
    • Type: string
    • Example: "A"

emitter.getActiveVariant(experimentName)

Returns the variant name currently displayed by the experiment.

• Return Type: string
• Parameters:
  • experimentName - Name of the experiment.
    • Required
    • Type: string
    • Example: "My Example"

emitter.getSortedVariants(experimentName)

Returns a sorted array of variant names associated with the experiment.

• Return Type: Array.<string>
• Parameters:
  • experimentName - Name of the experiment.
    • Required
    • Type: string
    • Example: "My Example"

Subscription

Returned by the emitter's add listener methods. More information available in the facebook/emitter documentation.

subscription.remove()

Removes the listener subscription and prevents future callbacks.

• Parameters: No parameters

experimentDebugger

Debugging tool. Attaches a fixed-position panel to the bottom of the <body> element that displays mounted experiments and enables the user to change active variants in real-time.

The debugger is wrapped in a conditional if(process.env.NODE_ENV === "production") {...} and will not display on production builds using envify.

experimentDebugger.enable()

Attaches the debugging panel to the <body> element.

• Return Type: No return value

experimentDebugger.disable()

Removes the debugging panel from the <body> element.

• Return Type: No return value

Running Tests

Locally:

npm test

On Browserstack:

BROWSERSTACK_USERNAME=YOUR_USERNAME BROWSERSTACK_ACCESS_KEY=YOUR_ACCESS_KEY npm test