Vercel Functions

Example for running Optimizely Feature Experimentation version feature flags and experiments utilizing Vercel Functions.

Suggest Edits

Vercel Functions lets you deliver content to your site's visitors with speed and personalization. They are deployed globally by default on Vercel's Edge Network and enable you to move server-side logic to the edge, close to your visitor's origin.

You can use Optimizely Feature Experimentation flags at the edge with NextJS applications deployed on Vercel. This example uses the Optimizely Feature Experimentation Javascript (Node) SDK inside Vercel Functions for you to start experimenting with your experiences at the Edge. For a general guide to getting started with Optimizely Feature Experimentation, see the Javascript (Node) SDK Quickstart.

Auto update with Optimizely webhooks and Vercel Functions

This example fetches the latest datafile from the Optimizely CDN during every build. Deploy Hooks from Vercel can be used with webhooks from Optimizely Feature Experimentation to keep the application up to date with the latest changes in the Optimizely project.

Identity management

Optimizely's Feature Experimentation SDKs require passing a user-provided identifier at runtime to drive experiment and feature flag decisions. This example generates a unique ID, stores it in a cookie, and reuses it to make the decisions sticky. Alternatively, you can use an existing unique identifier available within your application and pass it in as the value for the OPTIMIZELY_USER_ID cookie.

Bucketing

See How bucketing works.

Demo application

In the following example, you can create a demo application using Next.js. An example of this demo application is available on Vercel's GitHub.

Prerequisites

To run this example, you need:

An Optimizely Feature Experimentation account. If you do not have an account, you can sign up on Optimizely.com.
Have NPM or Yarn installed locally.
Before running locally, follow the quickstart for the JavaScript SDK to create the following:
- At least one flag.
- Your Optimizely Feature Experimentation SDK key.

Create a Deploy Hook in Vercel

Go to the Settings tab in your Vercel deployment.
Look for the Deploy Hooks section and create a Hook.
This will generate a URL that can be used to trigger a rebuild of the deployment.

Create a Webhook in Optimizely Feature Experimentation

Follow the instructions and configure a webhook in your Optimizely Feature Experimentation project.
Use the Deploy Hook URL generated from the previous section to create the Optimizely Feature Experimentation webhook.

How it works

When you make a change to the Feature Experimentation project using the UI, the webhook hits Vercel's Deploy Hook URL, which triggers a new build on Vercel. Every new build fetches the latest datafile and uses it in the application.

Clone and deploy locally

Execute create-next-app with NPM or Yarn to bootstrap the example:
```
npx create-next-app@latest
```
```
yarn create next-app
```

Generate the Next.js app using this example:

npx create-next-app --example https://github.com/vercel/examples/tree/main/edge-middleware/feature-flag-optimizely

yarn create-next-app --example https://github.com/vercel/examples/tree/main/edge-functions/feature-flag-optimizely feature-flag-optimizely

Create a local environment file from the example and add your Feature Experimentation SDK key:
```
cp .env.example .env.local
```

Run Next.js in development mode:

npm install
npm run dev

yarn  
yarn dev

Deploy your example app to the cloud using the Next.js documentation on Deploying.

Additional resources

Vercel example on GitHub
Vercel Functions documentation

Updated 5 months ago