@seoexperiments/frontend-package

Use case

The frontend-package allows for easy access of your seoexperiment.io experiment cohort using JavaScript!

Installation

@seoexperiments/frontend-package is an npm package and can be installed in many different ways. The easiest though is through npm

$ npm install @seoexperiments/frontend-package --save

Usage

Pull the package into the area of your codebase that has the logic you want to test. There are two ways of accessing your cohort:

• getCohort: (async) Make a request to SEO Experiment servers and get the cohort
• getCohortSync: (sync) Calculate the cohort locally

Example: getCohort (async) The following example is a noindex experiment. The SEO Experiment will change the output of the function shouldPageBeNoindexed, as we want to noindex pages based upon the experiment cohort.

import SEOExperiment from '@seoexperiments/frontend-package'

export const shouldPageBeNoindexed = async () => {
    const noindexExperiment = new SEOExperiment({
        experimentIdentifier: 42
    })
    const cohort = await noindexExperiment.getCohort({
        referrer: document.referrer,
        pageURL: window.location.href
    })
    if (cohort === 'enabled') {
        return true
    }
    return false
}

Example: getCohortSync The following example is a noindex experiment. The SEO Experiment will change the output of the function shouldPageBeNoindexed, as we want to noindex pages based upon the experiment cohort.

Because this function is synchronous, it does not contact seoexperiment servers to get the cohort. Instead it calculates the cohort on the client.

import SEOExperiment from '@seoexperiments/frontend-package'

export const shouldPageBeNoindexed = () => {
    const experiment = new SEOExperiment({
        experimentIdentifier: 29,
        cohortAllocations: [
          {
            name: 'enabled',
            allocation_percent: 50,
            is_status_quo: true,
          },
          {
            name: 'status_quo',
            allocation_percent: 50,
            is_status_quo: false,
          },
        ],
        experimentName: 'performance_experiment',
    startDate: '2020-01-30',
    })

    const cohort = experiment.getCohortSync({
        referrer: document.referrer,
        pageURL: window.location.href,
    })

    if (cohort === 'enabled') {
        return true
    }
    return false
}

Development

Want to contribute? Great!

If you find a bug, please open an issue on github and feel free to make a pull request. https://github.com/seoexperiments/frontend-package

Setup:

1. Clone repo from https://github.com/seoexperiments/frontend-package
2. npm install
3. Make changes to index_source.js
4. 'npm run build' to run babel and output new build to index.js

Deploy:

1. git tag with new version
2. bump version in package.json
3. 'npm publish --access public' License

---

MIT