Feature flags allow developers to turn features of their software on and off in form of configuration. This package provides functions for creating feature flags in code. It exposes an interface for defining own feature flags which are enabled based on custom criteria.
The featureflag package provides a feature flag (also called as
feature toggles, feature switches) implementation for R. Feature flags
allow developers to turn functionalities on and off based on
configuration.
If you are interested in learning more about feature flags, check out those great resources:
The featureflag package is available on CRAN and can be installed
with:
install.packages("featureflag")
Install the development version from GitHub with:
# install.packages("devtools")
devtools::install_github("szymanskir/featureflag")
The featureflag package currently supports the following types of
feature flags:
library(featureflag)
my_feature_flag <- create_bool_feature_flag(TRUE)
if (is_enabled(my_feature_flag)) {
print("My feature is enabled!")
} else {
print("My feature is not enabled!")
}
featureflag provides helpers that allow you to omit boilerplate code
such as if or if/else. They can be replace by the usage of
feature_if or feature_ifelse accordingly:
feature_ifelse(
my_feature_flag,
print("My feature is enabled!"),
print("My feature is not enabled!")
)
The source code of all examples is available in the examples folder of the repository.
Feature flags can be especially useful when developing shiny applications. The example below shows how feature flags can be used to turn parts application on and off – in this case an extra instance of the counter module.
FLAGS <- list(
extra_counter_flag = create_bool_feature_flag(value = FALSE)
)
ui <- fluidPage(
counterButton("counter1", "Always Visible Counter"),
feature_if(FLAGS$extra_counter_flag, {
counterButton("flagged_counter", "Flagged Counter")
})
)
server <- function(input, output, session) {
counterServer("counter1")
feature_if(FLAGS$extra_counter_flag, {
counterServer("flagged_counter")
})
}
The featureflag package can also be used in combination with the
config package by using the
R code execution feature:
default:
extra_counter_flag: !expr featureflag::create_bool_feature_flag(value = TRUE)
test:
extra_counter_flag: !expr featureflag::create_bool_feature_flag(value = TRUE)
production:
extra_counter_flag: !expr featureflag::create_bool_feature_flag(value = FALSE)
You can create feature flags that are turned on based on your own custom criteria. The procedure on how to define your own feature flag is presented in this tutorial