OptimizelyDecision for the JavaScript SDK v6+

5 min

Minimum SDK version

v6.0.0+

For versions 5.3.5 and below, see JavaScript (Browser) SDKJavaScript (Browser) SDK or JavaScript (Node) SDKJavaScript (Node) SDK. See the SDK compatibility matrixSDK compatibility matrix documentation for a list of current SDK releases and the features they support.

Object model

The following code shows the interface of the OptimizelyDecision object:

interface OptimizelyDecision {
  variationKey: string | null;
  enabled: boolean;
  variables: { [variableKey: string]: unknown };
  ruleKey: string | null;
  flagKey: string;
  userContext: OptimizelyUserContext;
  reasons: string[];
}

The following table describes the fields of the OptimizelyDecision object:

Field	Type	Description
enabled	Boolean	Whether the flag is enabled or not. Optimizely Feature Experimentation never returns null for this field. It returns false when it fails to make a decision due to an error.
variables	map	Key-value pairs of all the flag variables. When there are no variables defined for the flag or SDK cannot get variables, this field returns an empty map. When the SDK fails to get variables for a decision, the `reasons` field includes the error messages regardless of the `include reasons` option.
variationKey	String (nullable)	When the SDK fails to make a decision, this field returns null and the `reasons` field includes the log messages if the `include reasons` option is set.
ruleKey	String (nullable)	The key of the flag rule that the user bucketed into for this decision.\ When a valid rule key is not available, returns a copy of the experiment key.\ Returns null if neither a valid rule key nor experiment key is found.
flagKey	String	The key of the flag for which the decision was made.
userContext	OptimizelyUserContext	The user associated with the call to the decide method.
reasons	Array	An array of relevant error and log messages, in chronological order. Optimizely Feature Experimentation returns messages in this field in the following situations: When errors are detected while making decisions. When the `INCLUDE_REASONS` option is set on the decide method. An empty array when there are no messages. See the following section for information.

Reasons

The returned decision object includes error and log messages in the reasons field.

Error reasons

For the sake of consistency with other decision results, Optimizely Feature Experimentation returns a decision with null fields instead of throwing errors or exceptions.

Critical errors are always included in the reasons field of the returned decision object regardless of the include reasons option you set on the decide method.

Error	Possible reasons
null `variationKey`	Optimizely Feature Experimentation SDK not configured properly yet User context is not valid No flag was found for key
empty `variables`	Invalid variables for OptimizelyJSON Variable value for key is invalid or wrong type

Log reasons

Optimizely Feature Experimentation collects log messages in the reasons field of the returned OptimizelyDecision object in the order in which they are logged.

The following types of log messages are only included in the reasons field if you set the include reasons option on the decide method:

Log messages related to bucketing users based on audiences or attributes.

Log messages related to bucketing users based on traffic percentages.

Examples

The language and platform source files containing the implementation for JavaScript are available on GitHub.