Repository for feature flip library which provides various annotations to flip any feature. Works with Java8, Spring, Spring Boot
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
flips-core
flips-web
.gitignore
.travis.yml
README.md
pom.xml

README.md

Flips

Flips is an implementation of Feature Toggles pattern for Java. Feature Toggles are a powerful technique, allowing teams to modify system behavior without changing the code.

Build Status Coverage Status

Getting Started

Following feature toggle is going to switch bean with same signature method to go live on specific date time. Property allows to define different datetime specific to ENV and in ISO 8601 format.

@Component
class MyBean {

    @FlipBean(with = AnotherBean.class)
    @FlipOnDateTime(cutoffDateTimeProperty="datetime-property")
    public List<Article> getLatestArticles(){
        // OLD logic of getting latest articles
    }
}

@Component
class AnotherBean {

    public List<Article> getLatestArticles(){
      // NEW logic of getting latest articles
    }
}

Why another library for feature toggle ?

The idea behind Flips is to let the users implement toggles with minimum configuration and coding. This library is intended to work with Java8, Spring Core / Spring MVC / Spring Boot.

Where do I get sample project(s) ?

Sample projects can be found here.

Maven Configuration

Include flips-web if the project is a WEB project -

  <dependency>
    <groupId>com.github.feature-flip</groupId>
    <artifactId>flips-web</artifactId>
    <version>1.0.1</version>
  </dependency>

Otherwise flips-core,

  <dependency>
    <groupId>com.github.feature-flip</groupId>
    <artifactId>flips-core</artifactId>
    <version>1.0.1</version>
  </dependency>

Detail Description of all Annotations

Flips provides various annotations to flip a feature. Let's have a detailed walk-through of all the annotations -

@FlipOnEnvironmentProperty is used to flip a feature based on the value of an environment property.

Usage

@Component
class EmailSender{

  @FlipOnEnvironmentProperty(property="feature.send.email", expectedValue="true")
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is enabled if the property feature.send.email is set to true.

@FlipOnProfiles is used to flip a feature based on the envinronment in which the application is running.

Usage

@Component
class EmailSender{

  @FlipOnProfiles(activeProfiles={"dev", "qa"})
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is enabled if the current profile is either dev or qa.

@FlipOnDaysOfWeek is used to flip a feature based on the day of the week.

Usage

@Component
class EmailSender{

  @FlipOnDaysOfWeek(daysOfWeek={DayOfWeek.MONDAY,DayOfWeek.TUESDAY})
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is enabled if current day is either MONDAY or TUESDAY.

@FlipOnDateTime is used to flip a feature based on date and time.

Usage

@Component
class EmailSender{

  @FlipOnDateTime(cutoffDateTimeProperty="default.date.enabled")
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is enabled if current datetime is equal to or greater than the value defined by the default.date.enabled property.

@FlipOnSpringExpression is used to flip a feature based on the evaluation of spring expression.

Usage

@Component
class EmailSender{

  @FlipOnSpringExpression(expression = "T(java.lang.Math).sqrt(4) * 100.0 < T(java.lang.Math).sqrt(4) * 10.0")
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is enabled if the expression evaluates to TRUE.

@FlipBean is used to flip the invocation of a method with another method. It is most likely to be used in conjunction with @FlipOn... annotation.

Usage

@Component
class EmailSender{

  @FlipBean(with=SendGridEmailSender.class)
  public void sendEmail(EmailMessage emailMessage){
  }
}

will flip the invocation of sendEmail method with the one (having exactly same signature) defined in SendGridEmailSender.

@FlipOff is used to flip a feature off.

Usage

@Component
class EmailSender{

  @FlipOff
  public void sendEmail(EmailMessage emailMessage){
  }
}

Feature sendEmail is always DISABLED.

FAQs

1. Is there a way to combine these annotations ? Eg; I want a feature to be enabled only on PROD environment but after a given date.

Yes, these annotations can be combined. Currently, such combinations are treated as AND operations, meaning all the conditions MUST evaluate to TRUE for a feature to be enabled.

Usage

@Component
class EmailSender{

  @FlipOnProfiles(activeProfiles = "PROD")
  @FlipOnDateTime(cutoffDateTimeProperty = "sendemail.feature.active.after")
  public void sendEmail(EmailMessage emailMessage){
  }
}

this will throw FeatureNotEnabledException is either of the conditions evaluate to FALSE

2. Is there a way to flip a bean based on conditions ? Eg; I want a feature to be flipped with only in DEV.

Yes, @FlipBean can be used with conditions. If used with conditions, flip bean will be activated if all the conditions evaluate to TRUE

Usage

@Component
class EmailSender{

  @FlipBean(with=SendGridEmailSender.class)
  @FlipOnProfiles(activeProfiles = "DEV")
  public void sendEmail(EmailMessage emailMessage){
  }
}

this will flip the implementation of sendEmail with the same method defined in SendGridEmailSenderif active profile is DEV.

3. What date format is accepted in FlipOnDateTime ?

ISO-8601.

Usage

@Component
class EmailSender{

  @FlipOnDateTime(cutoffDateTimeProperty = "sendemail.feature.active.after")
  public void sendEmail(EmailMessage emailMessage){
  }
}

Assuming, today is 20th Sep 2018, one could set sendemail.feature.active.after to a value equal to before 20th Sep 2018. sendemail.feature.active.after=2018-09-16T00:00:00Z

4. What happens on invoking a disabled feature ?

FeatureNotEnabledException is thrown if a disabled feature is invoked. In case of a WEB application, one could use flips-web dependency which also provides ControllerAdvice meant to handle this exception. It returns a default response and a status code of 501.

5. Is it possible for the client of this library to override the response returned by ControllerAdvice ?

Yes, this is doable. You can register your ControllerAdvice with an exception handler meant for handling FeatureNotEnabledException. Please refer Sample Project.

6. What should be the signature of target method while using @FlipBean

The target method should have exactly the same signature as the method which is annotated with @FlipBean annotation.
Please refer "getArticleStatisticsByYear" method Sample Project.

7. How do I load Spring Configuration related to Flips ?

In order to bring all Flips related annotations in effect, FlipConfiguration needs to be imported.

Usage

@SpringBootApplication
@Import(FlipWebContextConfiguration.class)
class ApplicationConfig{
  public static void main(String[] args) {
    SpringApplication.run(ApplicationConfig.class, args);
  }
}

you will need to import FlipWebContextConfiguration as mentioned above. Please refer Sample Project.

8. Is there a way to create custom annotation(s) to flip a feature ?

Yes. You can create a custom annotation to fit your use case. Create a custom annotation at METHOD level which has a meta-annotation of type @FlipOnOff.

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@FlipOnOff(value = MyCustomCondition.class)
public @interface MyCustomAnnotation {
}

As a part of this annotation, specify the condition which will evaluate the result of this annotation.

@Component
public class MyCustomCondition implements FlipCondition {

  @Override
  public boolean evaluateCondition(FeatureContext featureContext, 
                                   FlipAnnotationAttributes flipAnnotationAttributes) {
    return false;
  }
}

This Condition class needs to implement FlipCondition and MUST be a Spring Component. This is it !!

9. How do I get to see all the methods which are annotated with Flip annotations along with their status ?

This functionality is available in flips-web as a REST endpoint. You can hit /describe/features to see the features and their status.

Want to contribute?

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Share feedback

Please use Github issues to share feedback, feature suggestions and report issues.

Credits

  1. A big Thank you to Sunit Parekh for providing his guidance
  2. Prateek Shah
  3. Yashica