feature-toggles-api/com.duckduckgo.feature.toggles.api/Toggle

Toggle

interface Toggle

Types

DefaultValue

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class DefaultValue(val defaultValue: Boolean)

This annotation is required. It specifies the default value of the feature flag when it's not remotely defined

Experiment

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class Experiment

This annotation should be used in feature flags that related to experimentation. It will make the feature flag to set the default variant if isEnabled is called BEFORE any variant has been allocated. It will make the feature flag to consider the target variants during the isEnabled evaluation.

FeatureName

data class FeatureName(val parentName: String?, val name: String)

The feature name the name of the feature parentName the name of the parent feature, or null if the feature has no parent (root feature)

InternalAlwaysEnabled

@Target(allowedTargets = [AnnotationTarget.FUNCTION])

annotation class InternalAlwaysEnabled

This annotation is optional. It will make the feature flag ALWAYS enabled for internal builds

State

data class State(val remoteEnableState: Boolean? = null, val enable: Boolean = false, val minSupportedVersion: Int? = null, val rollout: List<Double>? = null, val rolloutThreshold: Double? = null, val targets: List<Toggle.State.Target> = emptyList(), val metadataInfo: String? = null, val cohorts: List<Toggle.State.Cohort> = emptyList(), val assignedCohort: Toggle.State.Cohort? = null, val settings: String? = null)

This represents the state of a Toggle

Store

interface Store

TargetMatcherPlugin

interface TargetMatcherPlugin

It is possible to add feature Targets. To do that, just add the property inside the Target and implement the TargetMatcherPlugin to do the matching

Functions

featureName

abstract fun featureName(): Toggle.FeatureName

getCohort

abstract fun getCohort(): Toggle.State.Cohort?

getRawStoredState

abstract fun getRawStoredState(): Toggle.State?

The usage of this API is only useful for internal/dev settings/features If you find yourself having to call this method in production code, then YOU'RE DOING SOMETHING WRONG The raw state is the stored state. isEnabled method takes the raw state and computes whether the feature should be enabled or disabled. eg. by factoring in State.minSupportedVersion amongst others.

getSettings

abstract fun getSettings(): String?

isEnabled

abstract fun isEnabled(cohort: Toggle.State.CohortName = ANY_COHORT): Boolean

This is the method that SHALL be called to get whether a feature is enabled or not. DO NOT USE getRawStoredState for that

setRawStoredState

abstract fun setRawStoredState(state: Toggle.State)

The usage of this API is only useful for internal/dev settings/features If you find yourself having to call this method in production code, then YOU'RE DOING SOMETHING WRONG