Feature Flag Determination

📘

Feature flags are only available for SDK version 2.0.0 or higher.

When using feature flags, please apply SDK version 2.0.0 or higher when adding dependencies.

A feature flag has an on and off state. You will set different features according to each state.

Once a feature flag is applied, a specific user from your traffic should be able to either receive an off or on status. This on/off status determination can be done through the Hackle SDK.

IsFeatureOn

You can pass a feature key to the isFeatureOn() method to receive status results for the user. After receiving the status, we can then implement the logic according to each status.

In the example code below, we are passing feature key 42, and the user identifier of the user who will receive the status is "ae03e1adf".

// This should be executed once the SDK is ready. 
hackleClient.onReady(function() {
  
  // Determines the status of the feature flag to assign the user in a feature flag with a feature key of 42.
  // For undetermined cases, users are assigned to false (off status). 
  const featureOn = hackleClient.isFeatureOn(42, "ae03e1adf");

  // Logic by state
  if (featureOn) {
    // Logic for on status
  } else {
    // Logic for off status
  }
});

featureFlagDetail

The feature_flag_detail() method works like the isFeatureOn() method but additionally provides a reason for determining the status of a particular user. This can be useful when you want to check whether the manual allocation is working well or when you think that the traffic allocation you have set is not being reflected in your results.

You must pass a feature key as a parameter. For the example code below, we are passing feature key 42.

hackleClient.onReady(function() {
  // Status determination details
  const decision = hackleClient.featureFlagDetail(42, "ae03e1adf");
  // Feature flag on/off results 
  const featureOn = decision.isOn;
  // Reason for status determination
  const reason = decision.reason;
});

Please refer to the table below for the full list of all the different types of reasons behind different status determinations.

Reason

Description

Feature Status

SDK_NOT_READY

The SDK is not ready to use.
(e.g. Initialization with the wrong SDK key)

Default status(off)

EXPERIMENT_NOT_FOUND

No feature flags were found for the feature key you passed.
The feature key may be incorrect or the corresponding feature flag may be in an archived state.

Default status(off)

OVERRIDDEN

The user has been determined to have a specific feature flag status by manual assignment.

Manual assignment

TRAFFIC_ALLOCATED

User status has been determined.

Status determined

INVALID_INPUT

The input value is not valid.
(e.g. A letter type was inputting in a parameter that requires a numeric type)

Default status(off)

EXCEPTION

An unknown error has occurred.

Default status(off)


Did this page help you?