My feature flag is not returned in the Frontend API/Edge/Proxy
By default, these endpoints will not return feature flags that are not enabled. This is mainly to save on bandwidth but it makes it a bit difficult to debug when features are not being returned.
The first thing to look into is to validate that the feature is well configured and then check the token used from the SDK because it determines the set of accessible features. Last, verify that the context you're providing contains all the required data.
- Check that the feature is properly enabled:
- Verify that the feature has a strategy associated to it that will return true for your context (ref: add a strategy)
- Verify that the feature has been enabled in the environment used by the client application (ref: enabling a feature flag)
- Check that your token is of the right type. To connect to the Frontend API, Edge or Proxy, you need to use a Front-end token
- Check that your token has access to the feature flag. The token access configuration is immutable post-creation and defines the set of features that the token can access. The different parts of a token determine what projects and environment can be accessed:
- Access to all projects (current and future) - Tokens with a leading asterisk will provide access to all projects in a particular environment. For example, the token
*:production:xyz123etc...
will provide access to flags in the production environment of all projects. - Access to a discrete list of projects - Tokens with a leading set of square brackets (empty) will be given access to a subset of projects in a particular environment. The token will look similar to the following:
[]:production:xyz123etc...
. Which projects the token has access to can be found on the API Tokens page in the Unleash admin UI. - Single project access - Tokens that lead with a project name are bound to the specified project and environment. For example,
my_fullstack_app:production:xyz123etc...
will only have access to flags in the "my_fullstack_app" project as set in the production environment.
- Access to all projects (current and future) - Tokens with a leading asterisk will provide access to all projects in a particular environment. For example, the token
- When using a gradual rollout strategy, be mindful of the stickiness value. When evaluating a flag, if the provided context does not include the field used in the stickiness configuration, the gradual rollout strategy will be evaluated to
false
and therefore it will not be returned by the API. - Feature activation strategies can be combined in different ways, which may lead to complex scenarios. Try using the Playground to verify that the feature is properly configured and responding as expected.
If you want to return a flag no matter if it's disabled or enabled you can move the disabled/enabled information into the strategy variants.
This flag itself is enabled in development and adds 50%/50% split between disabled/enabled variants. This is essentially the same as a gradual rollout of 50% but using variants.
Remember to use getVariant
call instead of isEnabled
call in your SDK.
You can combine this approach with more complex constraint based targeting.
This flag returns enabled variant for the client with the explicit semver
and performs percentage split for the remaining clients.