NuxtJS module for A/B testing with Segment Analytics

• Main features
• Dependencies
• Setup
• Options
• Usage
• Credits
• License

• Run multiple experiments simultaneously
• TypeScript support
• Cookies to persist variants across users
• Force a specific variant via url or param. E.g. url?abs_experiment-x=1 or this.$abtest('experiment-x', 1);
• Disable all a/b tests by cookie (abs_disabled=1), which is useful for E2E tests in CI/CD pipelines

• nuxt-segment
• Or any other alternative to inject Segment Analytics

1. Add nuxt-ab-segment dependency to your project:

npm install nuxt-ab-segment

2. Add nuxt-ab-segment module and configuration to nuxt.config.js:

export default {
  // ...other config options
  modules: ["nuxt-ab-segment"];
  abSegment: {
    event: "AB Test", // optional
    experiments: '~/experiments.js', // optional
  }
}

3. Create the experiments.js in project's root with an array of your experiments. An example:

/**
 * {
 *  name: string; A name to identify the experiment on this.$abtest('NAME_HERE')
 *  maxAgeDays: number; Number of days to persist the cookie of user's active variant
 *  variants: number[]; An array of variants weights
 * }
 */
module.exports = [
  {
    name: "experiment-x",
    maxAgeDays: 15,
    variants: [50, 50],
  },
];

4. (Optional) TypeScript support. Add nuxt-ab-segment to the types section of tsconfig.json:

{
  "compilerOptions": {
    "types": ["nuxt-ab-segment"]
  }
}

• Type: String
• Default: AB Test

Event name reported to Segment.

• Type: String
• Default: ~/experiments.js

File path for your experiments definition.

It can be used inside components like:

{
  data: () => ({
    payBtnLabel: null as string | null,
    isScenarioA: true,
  }),
  mounted() {
    // Example 1: normal usage
    const activeVariant = this.$abtest('experiment-x');
    if (activeVariant === 0) {
      this.payBtnLabel = 'Place order';
    } else {
      this.payBtnLabel = 'Pay now!';
    }

    // Example 2: force variant 1
    if (this.isScenarioA) {
      this.$abtest('experiment-y', 1)
      // do something else..
    }
  }
}

An example of event properties reported to Segment:

{
  experiment: 'experiment-x',
  variant: 1
}

• Brandon Mills for weightedRandom()

See the LICENSE file for license rights and limitations (MIT).