This repository houses the React SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy).
Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams that enables you to experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at Optimizely.com, or see the developer documentation.
Optimizely Rollouts is free feature flags for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap.
Refer to the React SDK's developer documentation for detailed instructions on getting started with using the SDK.
For React Native, review the React Native developer documentation for installation and implementation detail.
- Automatic datafile downloading
- User ID + attributes memoization
- Render blocking until datafile is ready via a React API
- Optimizely timeout (only block rendering up to the number of milliseconds you specify)
- Library of React components and hooks to use with feature flags
The React SDK is compatible with React 16.8.0 +
import {
createInstance,
OptimizelyProvider,
useDecision,
} from '@optimizely/react-sdk';
const optimizelyClient = createInstance({
sdkKey: 'your-optimizely-sdk-key',
});
function MyComponent() {
const [decision] = useDecision('sort-algorithm');
return (
<React.Fragment>
<SearchComponent algorithm={decision.variables.algorithm} />
{ decision.variationKey === 'relevant_first' && <RelevantFirstList /> }
{ decision.variationKey === 'recent_first' && <RecentFirstList /> }
</React.Fragment>
);
}
class App extends React.Component {
render() {
return (
<OptimizelyProvider
optimizely={optimizelyClient}
timeout={500}
user={{ id: window.userId, attributes: { plan_type: 'bronze' } }}
>
<MyComponent />
</OptimizelyProvider>
);
}
}npm install @optimizely/react-sdk
The ReactSDKClient client created via createInstance is the programmatic API to evaluating features and experiments and tracking events. The ReactSDKClient is what powers the rest of the ReactSDK internally.
arguments
config : objectObject with SDK configuration parameters. This has the same format as the object passed to thecreateInstancemethod of the core@optimizely/javascript-sdkmodule. For details on this object, see the following pages from the developer docs:
returns
- A
ReactSDKClientinstance.
import { OptimizelyProvider, createInstance } from '@optimizely/react-sdk';
const optimizely = createInstance({
datafile: window.optimizelyDatafile,
});Required at the root level. Leverages React’s Context API to allow access to the ReactSDKClient to the useDecision hook.
props
optimizely : ReactSDKClientcreated fromcreateInstanceuser: { id: string; attributes?: { [key: string]: any } } | PromiseUser info object -idandattributeswill be passed to the SDK for every feature flag, A/B test, ortrackcall, or aPromisefor the same kind of objecttimeout : Number(optional) The amount of time foruseDecisionto returnnullflag Decision while waiting for the SDK instance to become ready, before resolving.isServerSide : Boolean(optional) must passtruehere for server side renderinguserId : String(optional) Deprecated, prefer usinguserinstead. Another way to provide user id. Theuserobject prop takes precedence when both are provided.userAttributes : Object: (optional) Deprecated, prefer usinguserinstead. Another way to provide user attributes. Theuserobject prop takes precedence when both are provided.
Before rendering real content, both the datafile and the user must be available to the SDK.
Synchronous loading is the preferred method to ensure that Optimizely is always ready and doesn't add any delay or asynchronous complexity to your application. When initializing with both the SDK key and datafile, the SDK will use the given datafile to start, then download the latest version of the datafile in the background.
import { OptimizelyProvider, createInstance } from '@optimizely/react-sdk';
const optimizelyClient = createInstance({
datafile: window.optimizelyDatafile,
sdkKey: 'your-optimizely-sdk-key', // Optimizely environment key
});
class AppWrapper extends React.Component {
render() {
return (
<OptimizelyProvider optimizely={optimizelyClient} user={{ id: window.userId }}>
<App />
</OptimizelyProvider>
);
}
}If you don't have the datafile downloaded, the ReactSDKClient can fetch the datafile for you. However, instead of waiting for the datafile to fetch before you render your app, you can immediately render your app and provide a timeout option to <OptimizelyProvider optimizely={optimizely} timeout={200}>. The useDecision hook returns isClientReady and didTimeout. You can use these to block rendering of component until the datafile loads or the timeout is over.
import { OptimizelyProvider, createInstance, useDecision } from '@optimizely/react-sdk';
const optimizelyClient = createInstance({
sdkKey: 'your-optimizely-sdk-key', // Optimizely environment key
});
function MyComponent() {
const [decision, isClientReady, didTimeout] = useDecision('the-flag');
return (
<React.Fragment>
{ isClientReady && <div>The Component</div> }
{ didTimeout && <div>Default Component</div>}
{ /* If client is not ready and time out has not occured yet, do not render anything */ }
</React.Fragment>
);
}
class App extends React.Component {
render() {
return (
<OptimizelyProvider
optimizely={optimizelyClient}
timeout={500}
user={{ id: window.userId, attributes: { plan_type: 'bronze' } }}
>
<MyComponent />
</OptimizelyProvider>
);
}
}If user information is synchronously available, it can be provided as the user object prop, as in prior examples. But, if user information must be fetched asynchronously, the user prop can be a Promise for a user object with the same properties (id and attributes):
import { OptimizelyProvider, createInstance } from '@optimizely/react-sdk';
import { fetchUser } from './user';
const optimizely = createInstance({
datafile: window.optimizelyDatafile,
});
const userPromise = fetchUser(); // fetchUser returns a Promise for an object with { id, attributes }
class AppWrapper extends React.Component {
render() {
return (
<OptimizelyProvider optimizely={optimizely} user={userPromise}>
<App />
</OptimizelyProvider>
);
}
}A React Hook to retrieve the decision result for a flag key, optionally auto updating that decision based on underlying user or datafile changes.
arguments
flagKey : stringThe key of the feature flag.options : ObjectautoUpdate : boolean(optional) If true, this hook will update the flag decision in response to datafile or user changes. Default:false.timeout : number(optional) Client timeout as described in theOptimizelyProvidersection. Overrides any timeout set on the ancestorOptimizelyProvider.decideOption: OptimizelyDecideOption[](optional) Array of OptimizelyDecideOption enums.
overrides : ObjectoverrideUserId : string(optional) Override the userId to be used to obtain the decision result for this hook.overrideAttributes : optimizely.UserAttributes(optional) Override the user attributes to be used to obtain the decision result for this hook.
returns
-
Arrayof:decision : OptimizelyDecision- Decision result for the flag key.clientReady : boolean- Whether or not the underlyingReactSDKClientinstance is ready or not.didTimeout : boolean- Whether or not the underlyingReactSDKClientbecame ready within the allowedtimeoutrange.
Note:
clientReadycan be true even ifdidTimeoutis also true. This indicates that the client became ready after the timeout period.
import { useEffect } from 'react';
import { useDecision } from '@optimizely/react-sdk';
function LoginComponent() {
const [decision, clientReady] = useDecision(
'login-flag',
{ autoUpdate: true },
{
/* (Optional) User overrides */
}
);
useEffect(() => {
document.title = decision.enabled ? 'login-new' : 'login-default';
}, [decision.enabled]);
return (
<p>
<a href={decision.enabled ? '/login-new' : '/login-default'}>Click to login</a>
</p>
);
}Any component under the <OptimizelyProvider> can access the Optimizely ReactSDKClient via the higher-order component (HoC) withOptimizely.
arguments
Component : React.ComponentComponent which will be enhanced with the following props:optimizely : ReactSDKClientThe client object which was passed to theOptimizelyProvideroptimizelyReadyTimeout : number | undefinedThe timeout which was passed to theOptimizelyProviderisServerSide : booleanValue that was passed to theOptimizelyProvider
returns
- A wrapped component with additional props as described above
import { withOptimizely } from '@optimizely/react-sdk';
class MyComp extends React.Component {
constructor(props) {
super(props);
const { optimizely } = this.props;
const decision = optimizely.decide('feat1');
this.state = {
decision.enabled,
decision.variables,
};
}
render() {}
}
const WrappedMyComponent = withOptimizely(MyComp);Note: The optimizely client object provided via withOptimizely is automatically associated with the user prop passed to the ancestor OptimizelyProvider - the id and attributes from that user object will be automatically forwarded to all appropriate SDK method calls. So, there is no need to pass the userId or attributes arguments when calling methods of the optimizely client object, unless you wish to use different userId or attributes than those given to OptimizelyProvider.
Any component under the <OptimizelyProvider> can access the Optimizely ReactSDKClient via the OptimizelyContext with useContext.
arguments
OptimizelyContext : React.Context<OptimizelyContextInterface>The Optimizely context initialized in a parent component (or App).
returns
- Wrapped object:
optimizely : ReactSDKClientThe client object which was passed to theOptimizelyProviderisServerSide : booleanValue that was passed to theOptimizelyProvidertimeout : number | undefinedThe timeout which was passed to theOptimizelyProvider
import React, { useContext } from 'react';
import { OptimizelyContext } from '@optimizely/react-sdk';
function MyComponent() {
const { optimizely, isServerSide, timeout } = useContext(OptimizelyContext);
const decision = optimizely.decide('my-feature');
const onClick = () => {
optimizely.track('signup-clicked');
// rest of your click handling code
};
return (
<>
{ decision.enabled && <p>My feature is enabled</p> }
{ !decision.enabled && <p>My feature is disabled</p> }
{ decision.variationKey === 'control-variation' && <p>Current Variation</p> }
{ decision.variationKey === 'experimental-variation' && <p>Better Variation</p> }
<button onClick={onClick}>Sign Up!</button>
</>
);
}Use the built-in useTrackEvent hook to access the track method of optimizely instance
import { useTrackEvent } from '@optimizely/react-sdk';
function SignupButton() {
const [track, clientReady, didTimeout] = useTrackEvent()
const handleClick = () => {
if(clientReady) {
track('signup-clicked')
}
}
return (
<button onClick={handleClick}>Signup</button>
)
}Or you can use the withOptimizely HoC.
import { withOptimizely } from '@optimizely/react-sdk';
class SignupButton extends React.Component {
onClick = () => {
const { optimizely } = this.props;
optimizely.track('signup-clicked');
// rest of click handler
};
render() {
<button onClick={this.onClick}>Signup</button>;
}
}
const WrappedSignupButton = withOptimizely(SignupButton);Note: As mentioned above, the optimizely client object provided via withOptimizely is automatically associated with the user prop passed to the ancestor OptimizelyProvider. There is no need to pass userId or attributes arguments when calling track, unless you wish to use different userId or attributes than those given to OptimizelyProvider.
The following type definitions are used in the ReactSDKClient interface:
UserAttributes : { [name: string]: any }User : { id: string | null, attributes: userAttributes }VariableValuesObject : { [key: string]: any }EventTags : { [key: string]: string | number | boolean; }
ReactSDKClient instances have the methods/properties listed below. Note that in general, the API largely matches that of the core @optimizely/optimizely-sdk client instance, which is documented on the Optimizely Feature Experimentation developer docs site. The major exception is that, for most methods, user id & attributes are optional arguments. ReactSDKClient has a current user. This user's id & attributes are automatically applied to all method calls, and overrides can be provided as arguments to these method calls if desired.
onReady(opts?: { timeout?: number }): Promise<onReadyResult>Returns a Promise that fulfills with anonReadyResultobject representing the initialization process. The instance is ready when it has fetched a datafile and a user is available (viasetUserbeing called with an object, or a Promise passed tosetUserbecoming fulfilled). If thetimeoutperiod happens before the client instance is ready, theonReadyResultobject will contain an additional key,dataReadyPromise, which can be used to determine when, if ever, the instance does become ready.user: UserThe current user associated with this client instancesetUser(userInfo: User | Promise<User>): voidCall this to update the current useronUserUpdate(handler: (userInfo: User) => void): () => voidSubscribe a callback to be called when this instance's current user changes. Returns a function that will unsubscribe the callback.decide(key: string, options?: optimizely.OptimizelyDecideOption[], overrideUserId?: string, overrideAttributes?: optimizely.UserAttributes): OptimizelyDecisionReturns a decision result for a flag key for a user. The decision result is returned in an OptimizelyDecision object, and contains all data required to deliver the flag rule.decideAll(options?: optimizely.OptimizelyDecideOption[], overrideUserId?: string, overrideAttributes?: optimizely.UserAttributes): { [key: string]: OptimizelyDecision }Returns decisions for all active (unarchived) flags for a user.decideForKeys(keys: string[], options?: optimizely.OptimizelyDecideOption[], overrideUserId?: string, overrideAttributes?: optimizely.UserAttributes): { [key: string]: OptimizelyDecision }Returns an object of decision results mapped by flag keys.activate(experimentKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): string | nullActivate an experiment, and return the variation for the given user.getVariation(experimentKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): string | nullReturn the variation for the given experiment and user.getFeatureVariables(featureKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): VariableValuesObject: Decide and return variable values for the given feature and user
Warning: Deprecated since 2.1.0
getAllFeatureVariablesis added in JavaScript SDK which is similarly returning all the feature variables, but it sends only single notification of typeall-feature-variablesinstead of sending for each variable. AsgetFeatureVariableswas added when this functionality wasn't provided byJavaScript SDK, so there is no need of it now and it would be removed in next major releasegetFeatureVariableString(featureKey: string, variableKey: string, overrideUserId?: string, overrideAttributes?: optimizely.UserAttributes): string | null: Decide and return the variable value for the given feature, variable, and usergetFeatureVariableInteger(featureKey: string, variableKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): number | nullDecide and return the variable value for the given feature, variable, and usergetFeatureVariableBoolean(featureKey: string, variableKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): boolean | nullDecide and return the variable value for the given feature, variable, and usergetFeatureVariableDouble(featureKey: string, variableKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): number | nullDecide and return the variable value for the given feature, variable, and userisFeatureEnabled(featureKey: string, overrideUserId?: string, overrideAttributes?: UserAttributes): booleanReturn the enabled status for the given feature and usergetEnabledFeatures(overrideUserId?: string, overrideAttributes?: UserAttributes): Array<string>: Return the keys of all features enabled for the given usertrack(eventKey: string, overrideUserId?: string | EventTags, overrideAttributes?: UserAttributes, eventTags?: EventTags): voidTrack an event to the Optimizely results backendsetForcedVariation(experiment: string, overrideUserIdOrVariationKey: string, variationKey?: string | null): booleanSet a forced variation for the given experiment, variation, and user. Note: callingsetForcedVariationon a given client will trigger a re-render of alluseExperimenthooks andOptimizelyExperimentcomponents that are using that client.getForcedVariation(experiment: string, overrideUserId?: string): string | nullGet the forced variation for the given experiment, variation, and user
To rollout or experiment on a feature by user rather than by random percentage, you will use Attributes and Audiences. To do this, follow the documentation on how to run a beta using the React code samples.
Right now server side rendering is possible with a few caveats.
Caveats
-
You must download the datafile manually and pass in via the
datafileoption. Can not usesdkKeyto automatically download. -
Rendering of components must be completely synchronous (this is true for all server side rendering), thus the Optimizely SDK assumes that the optimizely client has been instantiated and fired it's
onReadyevent already.
Similar to browser side rendering you will need to wrap your app (or portion of the app using Optimizely) in the <OptimizelyProvider> component. A new prop
isServerSide must be equal to true.
<OptimizelyProvider optimizely={optimizely} user={{ id: 'user1' }} isServerSide={true}>
<App />
</OptimizelyProvider>All other Optimizely components, such as <OptimizelyFeature> and <OptimizelyExperiment> can remain the same.
import * as React from 'react';
import * as ReactDOMServer from 'react-dom/server';
import {
createInstance,
OptimizelyProvider,
useDecision,
} from '@optimizely/react-sdk';
const fetch = require('node-fetch');
function MyComponent() {
const [decision] = useDecision('flag1');
return (
<React.Fragment>
{ decision.enabled && <p>The feature is enabled</p> }
{ !decision.enabled && <p>The feature is not enabled</p> }
{ decision.variationKey === 'variation1' && <p>Variation 1</p> }
{ decision.variationKey === 'variation2' && <p>Variation 2</p> }
</React.Fragment>
);
}
async function main() {
const resp = await fetch('https://cdn.optimizely.com/datafiles/<Your-SDK-Key>.json');
const datafile = await resp.json();
const optimizelyClient = createInstance({
datafile,
});
const output = ReactDOMServer.renderToString(
<OptimizelyProvider optimizely={optimizelyClient} user={{ id: 'user1' }} isServerSide={true}>
<MyComponent />
</OptimizelyProvider>
);
console.log('output', output);
}
main();To disable sending all events to Optimizely's results backend, use the logOnlyEventDispatcher when creating a client:
import { createInstance, logOnlyEventDispatcher } from '@optimizely/react-sdk';
const optimizely = createInstance({
datafile: window.optimizelyDatafile,
eventDispatcher: logOnlyEventDispatcher,
});This repository includes the following third party open source code:
hoist-non-react-statics Copyright © 2015 Yahoo!, Inc. License: BSD
js-tokens Copyright © 2014, 2015, 2016, 2017, 2018, 2019 Simon Lydell License: MIT
json-schema Copyright © 2005-2015, The Dojo Foundation License: BSD
lodash Copyright © JS Foundation and other contributors License: MIT
loose-envify Copyright © 2015 Andres Suarez [email protected] License: MIT
node-murmurhash Copyright © 2012 Gary Court, Derek Perez License: MIT
object-assign Copyright © Sindre Sorhus (sindresorhus.com) License: MIT
promise-polyfill Copyright © 2014 Taylor Hakes Copyright © 2014 Forbes Lindesay License: MIT
prop-types Copyright © 2013-present, Facebook, Inc. License: MIT
react-is Copyright © Facebook, Inc. and its affiliates. License: MIT
react Copyright © Facebook, Inc. and its affiliates. License: MIT
scheduler Copyright © Facebook, Inc. and its affiliates. License: MIT
utility-types Copyright © 2016 Piotr Witek [email protected] License: MIT
node-uuid Copyright © 2010-2016 Robert Kieffer and other contributors License: MIT
To regenerate the dependencies use by this package, run the following command:
npx license-checker --production --json | jq 'map_values({ licenses, publisher, repository }) | del(.[][] | nulls)'Please see CONTRIBUTING for more information.
First-party code subject to copyrights held by Optimizely, Inc. and its contributors and licensed to you under the terms of the Apache 2.0 license.
-
Flutter - https://github.com/optimizely/optimizely-flutter-sdk
-
JavaScript - https://github.com/optimizely/javascript-sdk
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent