FeatureProbe Server Side SDK for Java

Feature Probe is an open source feature management service. This SDK is used to control features in java programs. This SDK is designed primarily for use in multi-user systems such as web servers and applications.

Basic Terms

Reading the short Basic Terms will help to understand the code blow more easily. 中文

Try Out Demo Code

We provide a runnable demo code for you to understand how FeatureProbe SDK is used.

1. a、Start FeatureProbe Service with docker composer. How to

   b、Start FeatureProbe Service with featureprobe.io. Quick try

2. Download this repo and run the demo program:

   git clone https://github.com/FeatureProbe/server-sdk-java.git
   cd server-sdk-java
   mvn package
   java -jar ./target/server-sdk-java-1.2.1.jar

3. Find the Demo code in example, do some change and run the program again.

   mvn package
   java -jar ./target/server-sdk-java-1.2.1.jar

Step-by-Step Guide

In this guide we explain how to use feature toggles in your own Java application using FeatureProbe.

Step 1. Install the Java SDK

First, install the FeatureProbe SDK as a dependency in your application.

Apache Maven

<dependency>
    <groupId>com.featureprobe</groupId>
    <artifactId>server-sdk-java</artifactId>
    <version>1.2.0</version>
</dependency>

Gradle Groovy DSL

implementation 'com.featureprobe:server-sdk-java:1.2.0'

Step 2. Create a FeatureProbe instance

After you install and import the SDK, create a single, shared instance of the FeatureProbe sdk.

public class Demo {
    private static final FPConfig config = FPConfig.builder()
            // FeatureProbe server URL for local docker
            // .remoteUri("http://127.0.0.1:4007")
            // FeatureProbe server URL for featureprobe.io
            .eventUrl(new URL("https://featureprobe.io/server/api/events"))
            .synchronizerUrl(new URL("https://featureprobe.io/server/api/server-sdk/toggles"))
            .pollingMode(Duration.ofSeconds(3))
            .useMemoryRepository()
            .build();

    private static final FeatureProbe fpClient = new FeatureProbe("server-8ed48815ef044428826787e9a238b9c6a479f98c",
            config);
}

Step 3. Use the feature toggle

You can use sdk to check which variation a particular user will receive for a given feature flag.

public class Demo {
    private static final FPConfig config = FPConfig.builder()
            // FeatureProbe server URL for local docker
            // .remoteUri("http://127.0.0.1:4007")
            // FeatureProbe server URL for featureprobe.io
            .eventUrl(new URL("https://featureprobe.io/server/api/events"))
            .synchronizerUrl(new URL("https://featureprobe.io/server/api/server-sdk/toggles"))
            .pollingMode(Duration.ofSeconds(3))
            .useMemoryRepository()
            .build();

    private static final FeatureProbe fpClient = new FeatureProbe("server-8ed48815ef044428826787e9a238b9c6a479f98c",
            config);

    public void test() {
        String uniqueUserId = /* uniqueUserId */;
        FPUser user = new FPUser(uniqueUserId).with("city", /* city */).with("gender", /* gender */).with("userId", /* userId */);
        boolean boolValue = fpClient.boolValue("bool_toggle_key", user, false);
        if (boolValue) {
            // application code to show the feature
        } else {
            // the code to run if the feature is off
        }
    }
}

Testing

We have unified integration tests for all our SDKs. Integration test cases are added as submodules for each SDK repo. So be sure to pull submodules first to get the latest integration tests before running tests.

git pull --recurse-submodules
mvn test

Mock

1、Add powermock SDK to your project:

<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-api-mockito2</artifactId>
    <version>2.0.9</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.powermock</groupId>
    <artifactId>powermock-module-junit4</artifactId>
    <version>2.0.9</version>
    <scope>test</scope>
</dependency>

2、Mock Toggle

target method

@AllArgsConstructor
@Service
public class DemoService {

    FeatureProbe fp;

    public boolean isTester(String userId, String tel) {
        FPUser fpUser = new FPUser(userId);
        fpUser.with("tel", tel);
        return fp.boolValue("is_tester", fpUser, false);
    }
}

unit test

@RunWith(PowerMockRunner.class)
@PrepareForTest({FeatureProbe.class})
public class FeatureProbeTest {

    @Test
    public void test() {
        FeatureProbe fp = PowerMockito.mock(FeatureProbe.class);
        DemoService demoService = new DemoService(fp);
        Mockito.when(fp.boolValue(anyString(), any(FPUser.class), anyBoolean())).thenReturn(true);
        boolean tester = demoService.isTester("user123", "12397347232");
        assert tester;
    }

}

Contributing

We are working on continue evolving FeatureProbe core, making it flexible and easier to use. Development of FeatureProbe happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.

Please read CONTRIBUTING for details on our code of conduct, and the process for taking part in improving FeatureProbe.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.