Decide methods

Use the Decide methods to return flag decisions for a user. The flag decision includes flag enabled/disabled status and flag variation.

This page describes the following Decide methods:

Decide

Version

SDK 4.5 and higher

Description

Returns 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.

Decide is a method of the UserContext object. See OptimizelyUserContext for details.

See the OptimizelyDecision for details of the returned decision object.

Parameters

The following table describes parameters for the Decide method:

Parameter	Type	Description
flagKey	String	The key of the feature flag
options (optional)	Array	Array of OptimizelyDecideOption enums. See following table.

OptimizelyDecideOption

The following example shows how you can set options individually on any Decide method, or as global defaults when you instantiate the Optimizely client. See Initialize SDK.

const optimizelySdk = require('@optimizely/optimizely-sdk');
const optimizelyOptions = require('@optimizely/optimizely-sdk').OptimizelyDecideOption;
// set global default decide options when initializing the client
const optimizelyClient = optimizelySdk.createInstance({
    sdkKey: '<YOUR_SDK_KEY>',
    defaultDecideOptions: [optimizelyOptions.DISABLE_DECISION_EVENT],
});
optimizelyClient.onReady().then(() => {
    const user = optimizelyClient.createUserContext('user123');
    // set additional options in a decide call
    const decisionResultsMap = user.decideAll(
        [
            optimizelyOptions.ENABLED_FLAGS_ONLY,
            optimizelyOptions.IGNORE_USER_PROFILE_SERVICE,
        ]
    );
});

The following table shows details for the OptimizelyDecideOption.

OptimizelyDecideOption enum	If set:
OptimizelyDecideOption.DISABLE_DECISION_EVENT	Prevents the visitor from firing an impression while still being served the variation, which disables displaying results of the Decide method on the Optimizely application's Results page. This setting can be why the Decision Event Dispatched enum is false in the returned `OptimizelyDecision` object or the DECIDE notification listener payload.
OptimizelyDecideOption.ENABLED_FLAGS_ONLY	Return decisions for enabled flags only. This is a valid option only for methods that decide multiple flags, like the Decide All method. This option is ignored if it is invalid. When this option is not set, the SDK returns all decisions regardless of whether the flag is enabled or not.
OptimizelyDecideOption.IGNORE_USER_PROFILE_SERVICE	When set, the SDK bypasses UPS (both lookup and save) for the decision. When this option is not set, UPS overrides audience targeting, traffic allocation, and experiment mutual exclusion groups.
OptimizelyDecideOption.INCLUDE_REASONS	Return log messages in the Reasons field of OptimizelyDecision object. Note that unlike info or debug messages, critical error messages are always returned, regardless of this setting.
OptimizelyDecideOption.EXCLUDE_VARIABLES	Exclude flag variable values from the decision result. Use this option to minimize the returned decision by skipping large JSON variables.

Returns

The Decide method returns an OptimizelyDecision object. For more information, see OptimizelyDecision.

If the method encounters a critical error (SDK not ready, invalid flag key, etc), then it returns a decision with a null Variation Key field and populates the Reasons field with error messages (regardless of the Include Reasons option).

Example Decision

The following is an example of calling the Decide method and accessing the returned OptimizelyDecision object:

// create the user and decide which flag rule & variation they bucket into 
var attributes = {
   logged_in: true
};
var user = optimizelyClient.createUserContext('user123', attributes);
var decision = user.decide('product_sort');

var variationKey = decision['variationKey'];

// Did the decision fail with a critical error?
if (variationKey === null) {
   console.log(' decision error: ', decision['reasons']);
 }

// flag enabled state:
var enabled = decision['enabled'];

// String variable value:
var value = decision.variables['sort_method'];

// all variable values
var allVarValues = decision['variables'];

// variation. if null, decision fail with a critical error
var variationKey = decision['variationKey'];

// flag decision reasons
var reasons = decision['reasons'];

// user for which the decision was made
var userContext = decision['userContext'];

Side Effects

Invokes the DECISION notification listener if this listener is enabled.

Decide All

Returns decisions for all active (unarchived) flags for a user.

See OptimizelyDecision for details.

Version

SDK 4.5 and higher

Description

Use the Decide All method to return a map of flag decisions for a user.

Parameters

The following table describes parameters for the Decide All method:

Parameter	Type	Description
options (optional)	Array	Array of OptimizelyDecideOption enums. See OptimizelyDecideOption.

Returns

The Decide All method returns a map of OptimizelyDecisions. For more information, see OptimizelyDecision.

If the method fails for all flags (for example, the SDK isn't ready or the user context is invalid), then it returns an empty map. If the method detects an error for a specific flag, it returns error messages in the Reasons field of the decision for that flag.

Examples

The following is an example of getting flags for the user with the Decide All call:

var attributes = {
  logged_in: true
};

var user = optimizelyClient.createUserContext('user123', attributes);
// make decisions for all active (unarchived) flags in the project for a user
var decisions = user.decideAll();
// or only for enabled flags
var decisions = user.decideAll([OptimizelyDecideOption.ENABLED_FLAGS_ONLY]);

var flagKeys = Object.keys(decisions);
var decisionForFlag1 = decisions['flag_1'];

Side effects

Invokes the DECISION notification listener for each decision if this listener is enabled.

Decide For Keys

The Decide For Keys method returns an object of decision results mapped by flag keys.

Version

SDK v4.5 and higher

Description

Get a map of flag decisions for an array of flag keys.

Parameters

The following table describes the parameters for the Decide For Keys method:

Parameter	Type	Description
keys	Array	Array of string flag keys.
options (optional)	Array	Array of OptimizelyDecideOption enums. See OptimizelyDecideOption.

Returns

Returns a map of OptimizelyDecisions. For more information, see OptimizelyDecision.

Example

The following is an example of getting specified flags for the user:

// make a decisions for specific enabled  flags
var keys = ['flag_1', 'flag_2'];
var decisions = user.decideForKeys(keys);
var decision1 = decisions['flag_1'];
var decision2 = decisions['flag_2'];

Side effects

Invokes the DECISION notification listener for each decision if this listener is enabled.

Source files

The language/platform source files containing the implementation for JavaScript is index.js