com.statsig.Statsig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javacore Show documentation
A feature gating and a/b testing java library for statsig
The newest version!
package com.statsig;

import com.google.gson.Gson;
import com.statsig.internal.GsonUtil;

import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;

public class Statsig {
    private static final Gson gson = GsonUtil.getGson();

    private volatile String ref;
    private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);


    /**
     * Instantiates a new Statsig instance that connects to Statsig Service.
     * 
     * It is recommended to create a single instance for the entire application's lifecycle. In rare situations where
     * the application requires feature evaluation from different Statsig projects or environments, you may instantiate
     * multiple instances. However, these should be maintained throughout the application's lifecycle, rather than
     * being created for each request or thread.
     *
     * @param sdkKey  secret key to connect to Statsig Service
     * @param options a customized instance of StatsigOptions that configures the behavior of the
     *                Statsig instance.
     */
    public Statsig(String sdkKey, StatsigOptions options) {
        this.ref = StatsigJNI.statsigCreate(sdkKey, options.getRef());

        ResourceCleaner.register(this, () -> {
            if (ref != null) {
                StatsigJNI.statsigRelease(ref);
                ref = null;
            }
        });
    }

    public String getRef() {
        return ref;
    }

    public CompletableFuture initialize() {
        CompletableFuture future = new CompletableFuture<>();
        Runnable callback = () -> {
            // Complete the future when the native operation is done
            future.complete(null);
        };

        StatsigJNI.statsigInitialize(ref, callback);
        return future;
    }

    public CompletableFuture shutdown() {
        CompletableFuture future = new CompletableFuture<>();
        Runnable callback = () -> {
            scheduler.execute(() -> {
                StatsigJNI.statsigFinalizeShutdown(ref);
                future.complete(null);
                scheduler.shutdown();
            });
        };

        StatsigJNI.statsigSequencedShutdownPrepare(ref, callback);

        return future;
    }

    public boolean checkGate(StatsigUser user, String gateName) {
        return StatsigJNI.statsigCheckGate(ref, user.getRef(), gateName);
    }

    public Experiment getExperiment(StatsigUser user, String experimentName) {
        String experJson = StatsigJNI.statsigGetExperiment(ref, user.getRef(), experimentName);
        Experiment experiment = gson.fromJson(experJson, Experiment.class);
        if (experiment != null) {
            experiment.setRawJson(experJson);
        }
        return experiment;
    }

    public DynamicConfig getDynamicConfig(StatsigUser user, String configName) {
        String configJson = StatsigJNI.statsigGetDynamicConfig(ref, user.getRef(), configName);
        DynamicConfig dynamicConfig = gson.fromJson(configJson, DynamicConfig.class);
        if (dynamicConfig != null) {
            dynamicConfig.setRawJson(configJson);
        }
        return dynamicConfig;
    }

    public Layer getLayer(StatsigUser user, String layerName) {
        String layerJson = StatsigJNI.statsigGetLayer(ref, user.getRef(), layerName);
        Layer layer = gson.fromJson(layerJson, Layer.class);
        if (layer != null) {
            // Set the Statsig reference in the Layer instance
            layer.setStatsigInstance(this);
            layer.setRawJson(layerJson);
        }
        return layer;
    }

    public FeatureGate getFeatureGate(StatsigUser user, String gateName) {
        String gateJson = StatsigJNI.statsigGetFeatureGate(ref, user.getRef(), gateName);
        FeatureGate featureGate = gson.fromJson(gateJson, FeatureGate.class);
        featureGate.setRawJson(gateJson);
        return featureGate;
    }

    public void logEvent(StatsigUser user, String eventName, String value, Map metadata) {
        StatsigJNI.statsigLogEvent(ref, user.getRef(), eventName, value, metadata);
    }

    public CompletableFuture flushEvents() {
        CompletableFuture future = new CompletableFuture<>();
        Runnable callback = () -> {
            future.complete(null);
        };

        StatsigJNI.statsigFlushEvents(ref, callback);
        return future;
    }

    public String getClientInitializeResponse(StatsigUser user) {
        return StatsigJNI.statsigGetClientInitResponse(ref, user.getRef());
    }

    void logLayerParamExposure(String layerJson, String param) {
        StatsigJNI.statsigLogLayerParamExposure(ref, layerJson, param);
    }
}