Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

Latest commit

 

History

History
161 lines (121 loc) · 6.58 KB

README.md

File metadata and controls

161 lines (121 loc) · 6.58 KB
Raw

Optimizely Express Middleware

This repository houses the Express.js integration for use with Optimizely Full Stack and Optimizely Rollouts.

Optimizely Full Stack is A/B testing and feature flag management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/platform/full-stack/, or see the documentation.

Optimizely Rollouts is free feature flags for development teams. Easily roll out and roll back features in any application without code deploys. Mitigate risk for every feature on your roadmap. Learn more at https://www.optimizely.com/rollouts/, or see the documentation.

Installation

Using NPM:

npm install @optimizely/express --save

Using yarn:

yarn add @optimizely/express

Configuration

const optimizelyExpress = require('@optimizely/express');
const optimizely = optimizelyExpress.initialize({
  sdkKey: 'CZsVVgn6j9ce6fNPt2ZEiB',
  datafileOptions: {
    autoUpdate: true,
    updateInterval: 600000 // 10 minutes in milliseconds
  },
});

The autoUpdate parameter indicates that your feature flags will get automatically updated from changes made in Optimizely's user interface. The updateInterval indicates how frequently the Optimizely Express SDK will poll for changes.

Usage

optimizely.middleware

app.use(optimizely.middleware);

The above middleware adds the following object on the express request object

req.optimizely:

req.optimizely = {
  datafile: A representation of all of your feature flags and experiments as defined in Optimizely
  client: The Optimizely SDK client instance which has methods for `isFeatureEnabled`, `activate`, `track`, etc.
}

Once the middleware is installed, you can use the standard Optimizely JavaScript SDK APIs like isFeatureEnabled

app.get('/', function(req, res, next) {
  const isEnabled = req.optimizely.client.isFeatureEnabled('checkout_flow', '123');
  res.render('index', {
    title: 'Express: ' + (isEnabled ? 'feature on!' : 'feature off')
  });
});

optimizely.webhookRequest

If you would rather that your server not poll for changes made in Optimizely's configuration but rather get updated as quickly as possible when changes occur, you can use the following secure webhook implementation. Note, this requires following the documentation on setting up a secure webhook in the Optimizely UI.

app.use('/webhooks/optimizely', bodyParser.text({ type: '*/*' }), optimizely.webhookRequest);

Once you have successfully implemented the webhook, you can turn off the polling completely by setting the autoUpdate attribute to false above in the configuration step.

Note: If you deploy your server to multiple different machines, this will not ensure that the two machines are in-sync with the latest configuration. If you would like to see support for cross-machine syncing via webhooks, please let us know by opening an issue on this repository.

optimizely.datafileRoute

If you would like to see the latest configuration of your feature flags and experiments as defined in Optimizely's UI, you can see the datafile by installing this route on your server:

app.use('/optimizely/datafile', optimizely.datafileRoute);

Demo

See the full demo of usage, reproduced below:

const optimizelyExpressSdk = require('@optimizely/express');
const optimizely = optimizelyExpressSdk.initialize({
  sdkKey: 'CZsVVgn6j9ce6fNPt2ZEiB',
  datafileOptions: {
    autoUpdate: true,
    updateInterval: 600000 // 10 minutes in milliseconds
  },
});

app.use(optimizely.middleware);

app.use('/webhooks/optimizely', bodyParser.text({ type: '*/*' }), optimizely.webhookRequest);

app.use('/optimizely/datafile', optimizely.datafileRoute);

app.get('/', function(req, res, next) {
  const isEnabled = req.optimizely.client.isFeatureEnabled('checkout_flow', '123');
  res.render('index', {
    title: 'Express: ' + (isEnabled ? 'feature on!' : 'feature off')
  });
});

About

@optimizely/express is developed and maintained by Optimizely and many contributors. If you're interested in learning more about what Optimizely X Full Stack can do for your company, please get in touch!

Contributing

Please see CONTRIBUTING.

Credits

This repository includes code from the following open source projects:

body-parser
Copyright (c) 2014 Jonathan Ong [email protected]
Copyright (c) 2014-2015 Douglas Christopher Wilson [email protected]
License (MIT): https://github.com/expressjs/body-parser

cookie-parser
Copyright (c) 2014 TJ Holowaychuk [email protected]
Copyright (c) 2015 Douglas Christopher Wilson [email protected]
License (MIT): https://github.com/expressjs/cookie-parser

debug
Copyright (c) 2014 TJ Holowaychuk [email protected]
License (MIT): https://github.com/visionmedia/debug

express
Copyright (c) 2009-2014 TJ Holowaychuk [email protected]
Copyright (c) 2013-2014 Roman Shtylman [email protected]
Copyright (c) 2014-2015 Douglas Christopher Wilson [email protected]
License (MIT): https://github.com/expressjs/express

http-errors
Copyright (c) 2014 Jonathan Ong [email protected]
Copyright (c) 2016 Douglas Christopher Wilson [email protected]
License (MIT): https://github.com/jshttp/http-errors

jade
Copyright (c) 2009-2014 TJ Holowaychuk [email protected]
License (MIT): https://github.com/dscape/jade

morgan
Copyright (c) 2014 Jonathan Ong [email protected]
Copyright (c) 2014-2017 Douglas Christopher Wilson [email protected]
License (MIT): https://github.com/expressjs/morgan

Additional Code

This software may be used with additional code that is separately downloaded by you. These components are subject to their own license terms, which you should review carefully.

request
Copyright (c) 2010-2012 Mikeal Rogers
License (Apache 2.0): https://github.com/request/request

request-promise
Copyright (c) 2017, Nicolai Kamenzky, Ty Abonil, and contributors
License (ISC): https://github.com/request/request-promise