Kale-client-java

Java client library to call kale API

Feature

• Circuit-Breaker
• Http Retry (TBD)

Usage

Add the JitPack repository to your root build file

repositories {
    maven { url 'https://jitpack.io' }
}

Add the dependency

dependencies {
    implementation 'com.github.sayurbox:kale-client-java:<release-version>'
}

FeatureFlag Example

KaleConfig config = new KaleConfig.Builder()
        // required
        .withBaseUrl("http://localhost:9494")
        // optional: default is 5_000ms (5s) 
        .withExecutionTimeout(1000)
        // optional: default is true 
        .withCircuitBreakerEnabled(true)
        // optional: default is 10, equivalent to "slidingWindowSize"
        .withCircuitBreakerFailureVolumeThreshold(5)
        // optional: default is 10_000ms (1s), equivalent to "slowCallDurationThreshold"
        .withCircuitBreakerSlowResponseThreshold(500)
        // optional: default is 20_000ms (20s), equivalent to "waitDurationInOpenState"
        .withCircuitBreakerWaitDurationOpenState(15_000)
        .build();

FeatureFlagClient ff = new FeatureFlagClientImpl(config);
// check if user is allocated to a feature ?
boolean isAllocate = ff.isAllocate("ae2802be-86b6-47dd-a17a-864e4c76b49d",
        "cSExFZtCP8ee9cfr7yJVVmcsi5A3");
if (isAllocate) {
    System.out.println("user is allocated");
} else {
    System.out.println("user is not allocated");
}

AB-Test Example

// Init config same as feature-flag
ABTestClient abTest = new ABTestClientImpl(config);

// Get all experiments allocated to this users within the universe id
GetUniverseAllocationResponse universeAllocation = abTest.getUniverseAllocation(
        "qFA88l70U4RxscuJZFUwEZpHUUUF", "0b95519c-1b32-47fe-aa8c-55cb65d6f8c4");

// Create properties map fo filtered experiments
// This is optional, can be passed as the last parameter to getExperiments
// Supported properties are defined in the Backend
HashMap<String, String> properties = new HashMap<String, String>(1) {{
    put("wh_code", "JK01");
}};

// Get all experiments allocated to this users within the universe id
        GetUniverseAllocationResponse universeAllocation = abTest.getUniverseAllocation(
        "qFA88l70U4RxscuJZFUwEZpHUUUF", "0b95519c-1b32-47fe-aa8c-55cb65d6f8c4", properties);
        
// Get all experiments allocated to this users in all universe
List<GetUniverseAllocationResponse> allUniverseAllocations = abTest.getAllUniverseAllocations(
        "qFA88l70U4RxscuJZFUwEZpHUUUF");

logger.info("Universe: {} Experiment: {} Variant: {} Configs: {} User: {}\n",
        universeAllocation.getUniverseId(),
        universeAllocation.getExperimentId(),
        universeAllocation.getVariantId(),
        universeAllocation.getConfigs(),
        universeAllocation.getUserId());

for (GetUniverseAllocationResponse allocation : allUniverseAllocations) {
        logger.info("\nUniverse: {} Experiment: {} Variant: {} Configs: {} User: {}",
            allocation.getUniverseId(),
            allocation.getExperimentId(),
            allocation.getVariantId(),
            allocation.getConfigs(),
            allocation.getUserId());
}