initCache = createInitCache();
private String prefix;
private ListeningExecutorService executorService;
- /**
- * Creates a new store instance that connects to Redis with the provided host, port, prefix, and cache timeout. Uses a default
- * connection pool configuration.
- *
- * @param host the host for the Redis connection
- * @param port the port for the Redis connection
- * @param prefix a namespace prefix for all keys stored in Redis
- * @param cacheTimeSecs an optional timeout for the in-memory cache. If set to 0, no in-memory caching will be performed
- * @deprecated as of 1.1. Please use the {@link RedisFeatureStoreBuilder#build()} for a more flexible way of constructing a {@link RedisFeatureStore}.
- */
- @Deprecated
- public RedisFeatureStore(String host, int port, String prefix, long cacheTimeSecs) {
- this(host, port, prefix, cacheTimeSecs, getPoolConfig());
- }
-
- /**
- * Creates a new store instance that connects to Redis with the provided URI, prefix, and cache timeout. Uses a default
- * connection pool configuration.
- *
- * @param uri the URI for the Redis connection
- * @param prefix a namespace prefix for all keys stored in Redis
- * @param cacheTimeSecs an optional timeout for the in-memory cache. If set to 0, no in-memory caching will be performed
- * @deprecated as of 1.1. Please use the {@link RedisFeatureStoreBuilder#build()} for a more flexible way of constructing a {@link RedisFeatureStore}.
- */
- @Deprecated
- public RedisFeatureStore(URI uri, String prefix, long cacheTimeSecs) {
- this(uri, prefix, cacheTimeSecs, getPoolConfig());
- }
-
- /**
- * Creates a new store instance that connects to Redis with the provided host, port, prefix, cache timeout, and connection pool settings.
- *
- * @param host the host for the Redis connection
- * @param port the port for the Redis connection
- * @param prefix a namespace prefix for all keys stored in Redis
- * @param cacheTimeSecs an optional timeout for the in-memory cache. If set to 0, no in-memory caching will be performed
- * @param poolConfig an optional pool config for the Jedis connection pool
- * @deprecated as of 1.1. Please use the {@link RedisFeatureStoreBuilder#build()} for a more flexible way of constructing a {@link RedisFeatureStore}.
- */
- @Deprecated
- public RedisFeatureStore(String host, int port, String prefix, long cacheTimeSecs, JedisPoolConfig poolConfig) {
- pool = new JedisPool(poolConfig, host, port);
- setPrefix(prefix);
- createCache(cacheTimeSecs);
- }
-
- /**
- * Creates a new store instance that connects to Redis with the provided URI, prefix, cache timeout, and connection pool settings.
- *
- * @param uri the URI for the Redis connection
- * @param prefix a namespace prefix for all keys stored in Redis
- * @param cacheTimeSecs an optional timeout for the in-memory cache. If set to 0, no in-memory caching will be performed
- * @param poolConfig an optional pool config for the Jedis connection pool
- * @deprecated as of 1.1. Please use the {@link RedisFeatureStoreBuilder#build()} for a more flexible way of constructing a {@link RedisFeatureStore}.
- */
- @Deprecated
- public RedisFeatureStore(URI uri, String prefix, long cacheTimeSecs, JedisPoolConfig poolConfig) {
- pool = new JedisPool(poolConfig, uri);
- setPrefix(prefix);
- createCache(cacheTimeSecs);
+ private static class CacheKey {
+ final VersionedDataKind kind;
+ final String key;
+
+ public CacheKey(VersionedDataKind kind, String key) {
+ this.kind = kind;
+ this.key = key;
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (other instanceof CacheKey) {
+ CacheKey o = (CacheKey) other;
+ return o.kind.getNamespace().equals(this.kind.getNamespace()) &&
+ o.key.equals(this.key);
+ }
+ return false;
+ }
+
+ @Override
+ public int hashCode() {
+ return kind.getNamespace().hashCode() * 31 + key.hashCode();
+ }
}
-
+
/**
* Creates a new store instance that connects to Redis based on the provided {@link RedisFeatureStoreBuilder}.
*
@@ -151,11 +116,11 @@ private void createCache(long cacheTimeSecs, boolean refreshStaleValues, boolean
}
}
- private CacheLoader> createDefaultCacheLoader() {
- return new CacheLoader>() {
+ private CacheLoader> createDefaultCacheLoader() {
+ return new CacheLoader>() {
@Override
- public Optional load(String key) throws Exception {
- return Optional.fromNullable(getRedis(key));
+ public Optional load(CacheKey key) throws Exception {
+ return Optional.fromNullable(getRedis(key.kind, key.key));
}
};
}
@@ -171,7 +136,7 @@ private void createRefreshCache(long cacheTimeSecs, boolean asyncRefresh) {
ThreadFactory threadFactory = new ThreadFactoryBuilder().setNameFormat(CACHE_REFRESH_THREAD_POOL_NAME_FORMAT).setDaemon(true).build();
ExecutorService parentExecutor = Executors.newSingleThreadExecutor(threadFactory);
executorService = MoreExecutors.listeningDecorator(parentExecutor);
- CacheLoader> cacheLoader = createDefaultCacheLoader();
+ CacheLoader> cacheLoader = createDefaultCacheLoader();
if (asyncRefresh) {
cacheLoader = CacheLoader.asyncReloading(cacheLoader, executorService);
}
@@ -197,72 +162,50 @@ public Boolean load(String key) throws Exception {
});
}
- /**
- * Returns the {@link FeatureFlag} to which the specified key is mapped, or
- * null if the key is not associated or the associated {@link FeatureFlag} has
- * been deleted.
- *
- * @param key the key whose associated {@link FeatureFlag} is to be returned
- * @return the {@link FeatureFlag} to which the specified key is mapped, or
- * null if the key is not associated or the associated {@link FeatureFlag} has
- * been deleted.
- */
+ @SuppressWarnings("unchecked")
@Override
- public FeatureFlag get(String key) {
- FeatureFlag featureFlag;
+ public T get(VersionedDataKind kind, String key) {
+ T item;
if (cache != null) {
- featureFlag = cache.getUnchecked(key).orNull();
+ item = (T) cache.getUnchecked(new CacheKey(kind, key)).orNull();
} else {
- featureFlag = getRedis(key);
+ item = getRedis(kind, key);
}
- if (featureFlag != null) {
- logger.debug("[get] Key: " + key + " with version: " + featureFlag.getVersion() + " found in feature store.");
+ if (item != null) {
+ logger.debug("[get] Key: {} with version: {} found in \"{}\".", key, item.getVersion(), kind.getNamespace());
}
- return featureFlag;
+ return item;
}
- /**
- * Returns a {@link java.util.Map} of all associated features. This implementation does not take advantage
- * of the in-memory cache, so fetching all features will involve a fetch from Redis.
- *
- * @return a map of all associated features.
- */
@Override
- public Map all() {
+ public Map all(VersionedDataKind kind) {
try (Jedis jedis = pool.getResource()) {
- Map featuresJson = jedis.hgetAll(featuresKey());
- Map result = new HashMap<>();
+ Map allJson = jedis.hgetAll(itemsKey(kind));
+ Map result = new HashMap<>();
Gson gson = new Gson();
- Type type = new TypeToken() {
- }.getType();
-
- for (Map.Entry entry : featuresJson.entrySet()) {
- FeatureFlag featureFlag = gson.fromJson(entry.getValue(), type);
- if (!featureFlag.isDeleted()) {
- result.put(entry.getKey(), featureFlag);
+ for (Map.Entry entry : allJson.entrySet()) {
+ T item = gson.fromJson(entry.getValue(), kind.getItemClass());
+ if (!item.isDeleted()) {
+ result.put(entry.getKey(), item);
}
}
return result;
}
}
- /**
- * Initializes (or re-initializes) the store with the specified set of features. Any existing entries
- * will be removed.
- *
- * @param features the features to set the store
- */
@Override
- public void init(Map features) {
+ public void init(Map, Map> allData) {
try (Jedis jedis = pool.getResource()) {
Gson gson = new Gson();
Transaction t = jedis.multi();
- t.del(featuresKey());
-
- for (FeatureFlag f : features.values()) {
- t.hset(featuresKey(), f.getKey(), gson.toJson(f));
+ for (Map.Entry, Map> entry: allData.entrySet()) {
+ String baseKey = itemsKey(entry.getKey());
+ t.del(baseKey);
+ for (VersionedData item: entry.getValue().values()) {
+ t.hset(baseKey, item.getKey(), gson.toJson(item));
+ }
}
t.exec();
@@ -271,36 +214,29 @@ public void init(Map features) {
initCache.put(INIT_KEY, true);
}
- /**
- * Deletes the feature associated with the specified key, if it exists and its version
- * is less than or equal to the specified version.
- *
- * @param key the key of the feature to be deleted
- * @param version the version for the delete operation
- */
@Override
- public void delete(String key, int version) {
+ public void delete(VersionedDataKind kind, String key, int version) {
Jedis jedis = null;
try {
Gson gson = new Gson();
jedis = pool.getResource();
- jedis.watch(featuresKey());
+ String baseKey = itemsKey(kind);
+ jedis.watch(baseKey);
- FeatureFlag feature = getRedis(key, jedis);
+ VersionedData item = getRedis(kind, key, jedis);
- if (feature != null && feature.getVersion() >= version) {
- logger.warn("Attempted to delete flag: " + key + " version: " + feature.getVersion() +
- " with a version that is the same or older: " + version);
+ if (item != null && item.getVersion() >= version) {
+ logger.warn("Attempted to delete key: {} version: {}" +
+ " with a version that is the same or older: {} in \"{}\"",
+ key, item.getVersion(), version, kind.getNamespace());
return;
}
- FeatureFlagBuilder newBuilder = new FeatureFlagBuilder(feature);
- newBuilder.deleted(true);
- newBuilder.version(version);
- jedis.hset(featuresKey(), key, gson.toJson(newBuilder.build()));
+ VersionedData deletedItem = kind.makeDeletedItem(key, version);
+ jedis.hset(baseKey, key, gson.toJson(deletedItem));
if (cache != null) {
- cache.invalidate(key);
+ cache.invalidate(new CacheKey(kind, key));
}
} finally {
if (jedis != null) {
@@ -310,33 +246,28 @@ public void delete(String key, int version) {
}
}
- /**
- * Update or insert the feature associated with the specified key, if its version
- * is less than or equal to the version specified in the argument feature.
- *
- * @param key
- * @param feature
- */
@Override
- public void upsert(String key, FeatureFlag feature) {
+ public void upsert(VersionedDataKind kind, T item) {
Jedis jedis = null;
try {
jedis = pool.getResource();
Gson gson = new Gson();
- jedis.watch(featuresKey());
+ String baseKey = itemsKey(kind);
+ jedis.watch(baseKey);
- FeatureFlag f = getRedisEvenIfDeleted(key, jedis);
+ VersionedData old = getRedisEvenIfDeleted(kind, item.getKey(), jedis);
- if (f != null && f.getVersion() >= feature.getVersion()) {
- logger.warn("Attempted to update flag: " + key + " version: " + f.getVersion() +
- " with a version that is the same or older: " + feature.getVersion());
+ if (old != null && old.getVersion() >= item.getVersion()) {
+ logger.warn("Attempted to update key: {} version: {}" +
+ " with a version that is the same or older: {} in \"{}\"",
+ item.getKey(), old.getVersion(), item.getVersion(), kind.getNamespace());
return;
}
- jedis.hset(featuresKey(), key, gson.toJson(feature));
+ jedis.hset(baseKey, item.getKey(), gson.toJson(item));
if (cache != null) {
- cache.invalidate(key);
+ cache.invalidate(new CacheKey(kind, item.getKey()));
}
} finally {
if (jedis != null) {
@@ -346,11 +277,6 @@ public void upsert(String key, FeatureFlag feature) {
}
}
- /**
- * Returns true if this store has been initialized
- *
- * @return true if this store has been initialized
- */
@Override
public boolean initialized() {
// The LoadingCache takes care of both coalescing multiple simultaneous requests and memoizing
@@ -362,7 +288,7 @@ public boolean initialized() {
/**
* Releases all resources associated with the store. The store must no longer be used once closed.
*
- * @throws IOException
+ * @throws IOException if an underlying service threw an exception
*/
public void close() throws IOException {
logger.info("Closing LaunchDarkly RedisFeatureStore");
@@ -387,41 +313,41 @@ public CacheStats getCacheStats() {
return null;
}
- private String featuresKey() {
- return prefix + ":features";
+ private String itemsKey(VersionedDataKind kind) {
+ return prefix + ":" + kind.getNamespace();
}
private Boolean getInit() {
try (Jedis jedis = pool.getResource()) {
- return jedis.exists(featuresKey());
+ return jedis.exists(itemsKey(FEATURES));
}
}
- private FeatureFlag getRedis(String key) {
+ private T getRedis(VersionedDataKind kind, String key) {
try (Jedis jedis = pool.getResource()) {
- return getRedis(key, jedis);
+ return getRedis(kind, key, jedis);
}
}
- private FeatureFlag getRedis(String key, Jedis jedis) {
- FeatureFlag f = getRedisEvenIfDeleted(key, jedis);
- if (f != null && f.isDeleted()) {
- logger.debug("[get] Key: " + key + " has been deleted. Returning null");
+ private T getRedis(VersionedDataKind kind, String key, Jedis jedis) {
+ T item = getRedisEvenIfDeleted(kind, key, jedis);
+ if (item != null && item.isDeleted()) {
+ logger.debug("[get] Key: {} has been deleted in \"{}\". Returning null", key, kind.getNamespace());
return null;
}
- return f;
+ return item;
}
- private FeatureFlag getRedisEvenIfDeleted(String key, Jedis jedis) {
+ private T getRedisEvenIfDeleted(VersionedDataKind kind, String key, Jedis jedis) {
Gson gson = new Gson();
- String featureJson = jedis.hget(featuresKey(), key);
+ String json = jedis.hget(itemsKey(kind), key);
- if (featureJson == null) {
- logger.debug("[get] Key: " + key + " not found in feature store. Returning null");
+ if (json == null) {
+ logger.debug("[get] Key: {} not found in \"{}\". Returning null", key, kind.getNamespace());
return null;
}
- return gson.fromJson(featureJson, FeatureFlag.class);
+ return gson.fromJson(json, kind.getItemClass());
}
private static JedisPoolConfig getPoolConfig() {
diff --git a/src/main/java/com/launchdarkly/client/RedisFeatureStoreBuilder.java b/src/main/java/com/launchdarkly/client/RedisFeatureStoreBuilder.java
index 2d75b2686..ebebffbf8 100644
--- a/src/main/java/com/launchdarkly/client/RedisFeatureStoreBuilder.java
+++ b/src/main/java/com/launchdarkly/client/RedisFeatureStoreBuilder.java
@@ -52,7 +52,7 @@ public RedisFeatureStoreBuilder(URI uri, long cacheTimeSecs) {
* @param host the hostname to connect to
* @param port the port to connect to
* @param cacheTimeSecs the cache time in seconds. See {@link RedisFeatureStoreBuilder#cacheTime(long, TimeUnit)} for more information.
- * @throws URISyntaxException
+ * @throws URISyntaxException if the URI is not valid
*/
public RedisFeatureStoreBuilder(String scheme, String host, int port, long cacheTimeSecs) throws URISyntaxException {
this.uri = new URI(scheme, null, host, port, null, null, null);
@@ -110,7 +110,7 @@ public RedisFeatureStoreBuilder asyncRefresh(boolean enabled) {
/**
* Optionally configures the namespace prefix for all keys stored in Redis.
*
- * @param prefix
+ * @param prefix the namespace prefix
* @return the builder
*/
public RedisFeatureStoreBuilder prefix(String prefix) {
diff --git a/src/main/java/com/launchdarkly/client/Rule.java b/src/main/java/com/launchdarkly/client/Rule.java
index f240a9741..6009abc74 100644
--- a/src/main/java/com/launchdarkly/client/Rule.java
+++ b/src/main/java/com/launchdarkly/client/Rule.java
@@ -20,12 +20,12 @@ class Rule extends VariationOrRollout {
this.clauses = clauses;
}
- boolean matchesUser(LDUser user) {
+ boolean matchesUser(FeatureStore store, LDUser user) {
for (Clause clause : clauses) {
- if (!clause.matchesUser(user)) {
+ if (!clause.matchesUser(store, user)) {
return false;
}
}
return true;
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/com/launchdarkly/client/Segment.java b/src/main/java/com/launchdarkly/client/Segment.java
new file mode 100644
index 000000000..eb7fc24d8
--- /dev/null
+++ b/src/main/java/com/launchdarkly/client/Segment.java
@@ -0,0 +1,148 @@
+package com.launchdarkly.client;
+
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+import com.google.gson.reflect.TypeToken;
+
+class Segment implements VersionedData {
+
+ private static final Type mapType = new TypeToken>() { }.getType();
+
+ private String key;
+ private List included;
+ private List excluded;
+ private String salt;
+ private List rules;
+ private int version;
+ private boolean deleted;
+
+ static Segment fromJson(LDConfig config, String json) {
+ return config.gson.fromJson(json, Segment.class);
+ }
+
+ static Map fromJsonMap(LDConfig config, String json) {
+ return config.gson.fromJson(json, mapType);
+ }
+
+ // We need this so Gson doesn't complain in certain java environments that restrict unsafe allocation
+ Segment() {}
+
+ private Segment(Builder builder) {
+ this.key = builder.key;
+ this.included = builder.included;
+ this.excluded = builder.excluded;
+ this.salt = builder.salt;
+ this.rules = builder.rules;
+ this.version = builder.version;
+ this.deleted = builder.deleted;
+ }
+
+ public String getKey() {
+ return key;
+ }
+
+ public Iterable getIncluded() {
+ return included;
+ }
+
+ public Iterable getExcluded() {
+ return excluded;
+ }
+
+ public String getSalt() {
+ return salt;
+ }
+
+ public Iterable getRules() {
+ return rules;
+ }
+
+ public int getVersion() {
+ return version;
+ }
+
+ public boolean isDeleted() {
+ return deleted;
+ }
+
+ public boolean matchesUser(LDUser user) {
+ String key = user.getKeyAsString();
+ if (key == null) {
+ return false;
+ }
+ if (included.contains(key)) {
+ return true;
+ }
+ if (excluded.contains(key)) {
+ return false;
+ }
+ for (SegmentRule rule: rules) {
+ if (rule.matchUser(user, key, salt)) {
+ return true;
+ }
+ }
+ return false;
+ }
+
+ public static class Builder {
+ private String key;
+ private List included = new ArrayList<>();
+ private List excluded = new ArrayList<>();
+ private String salt = "";
+ private List rules = new ArrayList<>();
+ private int version = 0;
+ private boolean deleted;
+
+ public Builder(String key) {
+ this.key = key;
+ }
+
+ public Builder(Segment from) {
+ this.key = from.key;
+ this.included = new ArrayList<>(from.included);
+ this.excluded = new ArrayList<>(from.excluded);
+ this.salt = from.salt;
+ this.rules = new ArrayList<>(from.rules);
+ this.version = from.version;
+ this.deleted = from.deleted;
+ }
+
+ public Segment build() {
+ return new Segment(this);
+ }
+
+ public Builder included(Collection included) {
+ this.included = new ArrayList<>(included);
+ return this;
+ }
+
+ public Builder excluded(Collection excluded) {
+ this.excluded = new ArrayList<>(excluded);
+ return this;
+ }
+
+ public Builder salt(String salt) {
+ this.salt = salt;
+ return this;
+ }
+
+ public Builder rules(Collection rules) {
+ this.rules = new ArrayList<>(rules);
+ return this;
+ }
+
+ public Builder version(int version) {
+ this.version = version;
+ return this;
+ }
+
+ public Builder deleted(boolean deleted) {
+ this.deleted = deleted;
+ return this;
+ }
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/com/launchdarkly/client/SegmentRule.java b/src/main/java/com/launchdarkly/client/SegmentRule.java
new file mode 100644
index 000000000..4498eb7d6
--- /dev/null
+++ b/src/main/java/com/launchdarkly/client/SegmentRule.java
@@ -0,0 +1,34 @@
+package com.launchdarkly.client;
+
+import java.util.List;
+
+public class SegmentRule {
+ private final List clauses;
+ private final Integer weight;
+ private final String bucketBy;
+
+ public SegmentRule(List clauses, Integer weight, String bucketBy) {
+ this.clauses = clauses;
+ this.weight = weight;
+ this.bucketBy = bucketBy;
+ }
+
+ public boolean matchUser(LDUser user, String segmentKey, String salt) {
+ for (Clause c: clauses) {
+ if (!c.matchesUserNoSegments(user)) {
+ return false;
+ }
+ }
+
+ // If the Weight is absent, this rule matches
+ if (weight == null) {
+ return true;
+ }
+
+ // All of the clauses are met. See if the user buckets in
+ String by = (bucketBy == null) ? "key" : bucketBy;
+ double bucket = VariationOrRollout.bucketUser(user, segmentKey, by, salt);
+ double weight = (double)this.weight / 100000.0;
+ return bucket < weight;
+ }
+}
\ No newline at end of file
diff --git a/src/main/java/com/launchdarkly/client/StreamProcessor.java b/src/main/java/com/launchdarkly/client/StreamProcessor.java
index bae1da257..15fce2a04 100644
--- a/src/main/java/com/launchdarkly/client/StreamProcessor.java
+++ b/src/main/java/com/launchdarkly/client/StreamProcessor.java
@@ -1,5 +1,8 @@
package com.launchdarkly.client;
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
+import static com.launchdarkly.client.VersionedDataKind.SEGMENTS;
+
import java.io.IOException;
import java.net.URI;
import java.util.concurrent.Future;
@@ -8,8 +11,10 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import com.google.common.annotations.VisibleForTesting;
import com.google.common.util.concurrent.SettableFuture;
import com.google.gson.Gson;
+import com.google.gson.JsonElement;
import com.launchdarkly.eventsource.ConnectionErrorHandler;
import com.launchdarkly.eventsource.EventHandler;
import com.launchdarkly.eventsource.EventSource;
@@ -78,26 +83,41 @@ public void onClosed() throws Exception {
public void onMessage(String name, MessageEvent event) throws Exception {
Gson gson = new Gson();
switch (name) {
- case PUT:
- store.init(FeatureFlag.fromJsonMap(config, event.getData()));
+ case PUT: {
+ PutData putData = gson.fromJson(event.getData(), PutData.class);
+ store.init(FeatureRequestor.toVersionedDataMap(putData.data));
if (!initialized.getAndSet(true)) {
initFuture.set(null);
logger.info("Initialized LaunchDarkly client.");
}
break;
+ }
case PATCH: {
- FeaturePatchData data = gson.fromJson(event.getData(), FeaturePatchData.class);
- store.upsert(data.key(), data.feature());
+ PatchData data = gson.fromJson(event.getData(), PatchData.class);
+ if (FEATURES.getKeyFromStreamApiPath(data.path) != null) {
+ store.upsert(FEATURES, gson.fromJson(data.data, FeatureFlag.class));
+ } else if (SEGMENTS.getKeyFromStreamApiPath(data.path) != null) {
+ store.upsert(SEGMENTS, gson.fromJson(data.data, Segment.class));
+ }
break;
}
case DELETE: {
- FeatureDeleteData data = gson.fromJson(event.getData(), FeatureDeleteData.class);
- store.delete(data.key(), data.version());
+ DeleteData data = gson.fromJson(event.getData(), DeleteData.class);
+ String featureKey = FEATURES.getKeyFromStreamApiPath(data.path);
+ if (featureKey != null) {
+ store.delete(FEATURES, featureKey, data.version);
+ } else {
+ String segmentKey = SEGMENTS.getKeyFromStreamApiPath(data.path);
+ if (segmentKey != null) {
+ store.delete(SEGMENTS, segmentKey, data.version);
+ }
+ }
break;
}
case INDIRECT_PUT:
try {
- store.init(requestor.getAllFlags());
+ FeatureRequestor.AllData allData = requestor.getAllData();
+ store.init(FeatureRequestor.toVersionedDataMap(allData));
if (!initialized.getAndSet(true)) {
initFuture.set(null);
logger.info("Initialized LaunchDarkly client.");
@@ -107,10 +127,19 @@ public void onMessage(String name, MessageEvent event) throws Exception {
}
break;
case INDIRECT_PATCH:
- String key = event.getData();
+ String path = event.getData();
try {
- FeatureFlag feature = requestor.getFlag(key);
- store.upsert(key, feature);
+ String featureKey = FEATURES.getKeyFromStreamApiPath(path);
+ if (featureKey != null) {
+ FeatureFlag feature = requestor.getFlag(featureKey);
+ store.upsert(FEATURES, feature);
+ } else {
+ String segmentKey = SEGMENTS.getKeyFromStreamApiPath(path);
+ if (segmentKey != null) {
+ Segment segment = requestor.getSegment(segmentKey);
+ store.upsert(SEGMENTS, segment);
+ }
+ }
} catch (IOException e) {
logger.error("Encountered exception in LaunchDarkly client", e);
}
@@ -133,8 +162,19 @@ public void onError(Throwable throwable) {
}
};
- EventSource.Builder builder = new EventSource.Builder(handler, URI.create(config.streamURI.toASCIIString() + "/flags"))
- .connectionErrorHandler(connectionErrorHandler)
+ es = createEventSource(handler,
+ URI.create(config.streamURI.toASCIIString() + "/all"),
+ connectionErrorHandler,
+ headers);
+ es.start();
+ return initFuture;
+ }
+
+ @VisibleForTesting
+ protected EventSource createEventSource(EventHandler handler, URI streamUri, ConnectionErrorHandler errorHandler,
+ Headers headers) {
+ EventSource.Builder builder = new EventSource.Builder(handler, URI.create(config.streamURI.toASCIIString() + "/all"))
+ .connectionErrorHandler(errorHandler)
.headers(headers)
.reconnectTimeMs(config.reconnectTimeMs)
.connectTimeoutMs(config.connectTimeoutMillis)
@@ -151,11 +191,9 @@ public void onError(Throwable throwable) {
}
}
- es = builder.build();
- es.start();
- return initFuture;
+ return builder.build();
}
-
+
@Override
public void close() throws IOException {
logger.info("Closing LaunchDarkly StreamProcessor");
@@ -172,43 +210,29 @@ public boolean initialized() {
return initialized.get();
}
- FeatureFlag getFeature(String key) {
- return store.get(key);
+ private static final class PutData {
+ FeatureRequestor.AllData data;
+
+ public PutData() {
+
+ }
}
-
- private static final class FeaturePatchData {
+
+ private static final class PatchData {
String path;
- FeatureFlag data;
-
- public FeaturePatchData() {
+ JsonElement data;
- }
-
- String key() {
- return path.substring(1);
- }
+ public PatchData() {
- FeatureFlag feature() {
- return data;
}
-
}
- private static final class FeatureDeleteData {
+ private static final class DeleteData {
String path;
int version;
- public FeatureDeleteData() {
-
- }
-
- String key() {
- return path.substring(1);
- }
+ public DeleteData() {
- int version() {
- return version;
}
-
}
-}
+}
\ No newline at end of file
diff --git a/src/main/java/com/launchdarkly/client/TestFeatureStore.java b/src/main/java/com/launchdarkly/client/TestFeatureStore.java
index d8605ba14..d69e06d2a 100644
--- a/src/main/java/com/launchdarkly/client/TestFeatureStore.java
+++ b/src/main/java/com/launchdarkly/client/TestFeatureStore.java
@@ -1,19 +1,22 @@
package com.launchdarkly.client;
-import com.google.gson.JsonElement;
-import com.google.gson.JsonPrimitive;
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
import java.util.Arrays;
import java.util.List;
+import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;
+import com.google.gson.JsonElement;
+import com.google.gson.JsonPrimitive;
+
/**
* A decorated {@link InMemoryFeatureStore} which provides functionality to create (or override) true or false feature flags for all users.
*
* Using this store is useful for testing purposes when you want to have runtime support for turning specific features on or off.
*/
public class TestFeatureStore extends InMemoryFeatureStore {
- private static List TRUE_FALSE_VARIATIONS = Arrays.asList(
+ static List TRUE_FALSE_VARIATIONS = Arrays.asList(
(JsonElement) (new JsonPrimitive(true)),
(JsonElement) (new JsonPrimitive(false))
);
@@ -34,45 +37,29 @@ public void setBooleanValue(String key, Boolean value) {
.variations(TRUE_FALSE_VARIATIONS)
.version(version.incrementAndGet())
.build();
- upsert(key, newFeature);
+ upsert(FEATURES, newFeature);
}
/**
* Turns a feature, identified by key, to evaluate to true for every user. If the feature rules already exist in the store then it will override it to be true for every {@link LDUser}.
* If the feature rule is not currently in the store, it will create one that is true for every {@link LDUser}.
*
- * @param key the key of the feature flag to evaluate to true.
+ * @param key the key of the feature flag to evaluate to true
*/
public void setFeatureTrue(String key) {
setBooleanValue(key, true);
}
-
- /**
- * @deprecated use {@link #setFeatureTrue(String key)}
- */
- @Deprecated
- public void turnFeatureOn(String key) {
- setFeatureTrue(key);
- }
-
+
/**
* Turns a feature, identified by key, to evaluate to false for every user. If the feature rules already exist in the store then it will override it to be false for every {@link LDUser}.
* If the feature rule is not currently in the store, it will create one that is false for every {@link LDUser}.
*
- * @param key the key of the feature flag to evaluate to false.
+ * @param key the key of the feature flag to evaluate to false
*/
public void setFeatureFalse(String key) {
setBooleanValue(key, false);
}
-
- /**
- * @deprecated use {@link #setFeatureFalse(String key)}
- */
- @Deprecated
- public void turnFeatureOff(String key) {
- setFeatureFalse(key);
- }
-
+
/**
* Sets the value of an integer multivariate feature flag, for all users.
* @param key the key of the flag
@@ -112,12 +99,12 @@ public void setJsonValue(String key, JsonElement value) {
.variations(Arrays.asList(value))
.version(version.incrementAndGet())
.build();
- upsert(key, newFeature);
+ upsert(FEATURES, newFeature);
}
@Override
- public void init(java.util.Map features) {
- super.init(features);
+ public void init(Map, Map> allData) {
+ super.init(allData);
initializedForTests = true;
}
diff --git a/src/main/java/com/launchdarkly/client/UpdateProcessor.java b/src/main/java/com/launchdarkly/client/UpdateProcessor.java
index d5d2876f7..5a240260d 100644
--- a/src/main/java/com/launchdarkly/client/UpdateProcessor.java
+++ b/src/main/java/com/launchdarkly/client/UpdateProcessor.java
@@ -4,7 +4,7 @@
import java.io.IOException;
import java.util.concurrent.Future;
-public interface UpdateProcessor extends Closeable {
+interface UpdateProcessor extends Closeable {
/**
* Starts the client.
@@ -14,7 +14,7 @@ public interface UpdateProcessor extends Closeable {
/**
* Returns true once the client has been initialized and will never return false again.
- * @return
+ * @return true if the client has been initialized
*/
boolean initialized();
diff --git a/src/main/java/com/launchdarkly/client/VariationType.java b/src/main/java/com/launchdarkly/client/VariationType.java
index cd8b7e904..8d8228f1b 100644
--- a/src/main/java/com/launchdarkly/client/VariationType.java
+++ b/src/main/java/com/launchdarkly/client/VariationType.java
@@ -3,7 +3,7 @@
import com.google.gson.JsonElement;
-public enum VariationType {
+enum VariationType {
Boolean {
@Override
void assertResultType(JsonElement result) throws EvaluationException {
diff --git a/src/main/java/com/launchdarkly/client/VersionedData.java b/src/main/java/com/launchdarkly/client/VersionedData.java
new file mode 100644
index 000000000..6e01b9997
--- /dev/null
+++ b/src/main/java/com/launchdarkly/client/VersionedData.java
@@ -0,0 +1,11 @@
+package com.launchdarkly.client;
+
+/**
+ * Common interface for string-keyed, versioned objects that can be kept in a {@link FeatureStore}.
+ * @since 3.0.0
+ */
+public interface VersionedData {
+ String getKey();
+ int getVersion();
+ boolean isDeleted();
+}
diff --git a/src/main/java/com/launchdarkly/client/VersionedDataKind.java b/src/main/java/com/launchdarkly/client/VersionedDataKind.java
new file mode 100644
index 000000000..05ce87f33
--- /dev/null
+++ b/src/main/java/com/launchdarkly/client/VersionedDataKind.java
@@ -0,0 +1,82 @@
+package com.launchdarkly.client;
+
+/**
+ * The descriptor for a specific kind of {@link VersionedData} objects that may exist in a {@link FeatureStore}.
+ * @since 3.0.0
+ */
+public abstract class VersionedDataKind {
+
+ /**
+ * A short string that serves as the unique name for the collection of these objects, e.g. "features".
+ * @return a namespace string
+ */
+ public abstract String getNamespace();
+
+ /**
+ * The Java class for objects of this type.
+ * @return a Java class
+ */
+ public abstract Class getItemClass();
+
+ /**
+ * The path prefix for objects of this type in events received from the streaming API.
+ * @return the URL path
+ */
+ public abstract String getStreamApiPath();
+
+ /**
+ * Return an instance of this type with the specified key and version, and deleted=true.
+ * @param key the unique key
+ * @param version the version number
+ * @return a new instance
+ */
+ public abstract T makeDeletedItem(String key, int version);
+
+ /**
+ * Used internally to match data URLs in the streaming API.
+ * @param path path from an API message
+ * @return the parsed key if the path refers to an object of this kind, otherwise null
+ */
+ String getKeyFromStreamApiPath(String path) {
+ return path.startsWith(getStreamApiPath()) ? path.substring(getStreamApiPath().length()) : null;
+ }
+
+
+ public static VersionedDataKind FEATURES = new VersionedDataKind() {
+
+ public String getNamespace() {
+ return "features";
+ }
+
+ public Class getItemClass() {
+ return FeatureFlag.class;
+ }
+
+ public String getStreamApiPath() {
+ return "/flags/";
+ }
+
+ public FeatureFlag makeDeletedItem(String key, int version) {
+ return new FeatureFlagBuilder(key).deleted(true).version(version).build();
+ }
+ };
+
+ public static VersionedDataKind SEGMENTS = new VersionedDataKind() {
+
+ public String getNamespace() {
+ return "segments";
+ }
+
+ public Class getItemClass() {
+ return Segment.class;
+ }
+
+ public String getStreamApiPath() {
+ return "/segments/";
+ }
+
+ public Segment makeDeletedItem(String key, int version) {
+ return new Segment.Builder(key).deleted(true).version(version).build();
+ }
+ };
+}
diff --git a/src/test/java/com/launchdarkly/client/FeatureFlagTest.java b/src/test/java/com/launchdarkly/client/FeatureFlagTest.java
index 4c27d6f1d..9f4c568d8 100644
--- a/src/test/java/com/launchdarkly/client/FeatureFlagTest.java
+++ b/src/test/java/com/launchdarkly/client/FeatureFlagTest.java
@@ -1,14 +1,16 @@
package com.launchdarkly.client;
-
import com.google.gson.JsonElement;
import com.google.gson.JsonPrimitive;
+
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import java.util.Arrays;
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
+import static com.launchdarkly.client.VersionedDataKind.SEGMENTS;
import static java.util.Collections.singletonList;
public class FeatureFlagTest {
@@ -26,7 +28,7 @@ public void testPrereqDoesNotExist() throws EvaluationException {
String keyB = "keyB";
FeatureFlag f1 = newFlagWithPrereq(keyA, keyB);
- featureStore.upsert(f1.getKey(), f1);
+ featureStore.upsert(FEATURES, f1);
LDUser user = new LDUser.Builder("userKey").build();
FeatureFlag.EvalResult actual = f1.evaluate(user, featureStore);
@@ -44,9 +46,9 @@ public void testPrereqCollectsEventsForPrereqs() throws EvaluationException {
FeatureFlag flagB = newFlagWithPrereq(keyB, keyC);
FeatureFlag flagC = newFlagOff(keyC);
- featureStore.upsert(flagA.getKey(), flagA);
- featureStore.upsert(flagB.getKey(), flagB);
- featureStore.upsert(flagC.getKey(), flagC);
+ featureStore.upsert(FEATURES, flagA);
+ featureStore.upsert(FEATURES, flagB);
+ featureStore.upsert(FEATURES, flagC);
LDUser user = new LDUser.Builder("userKey").build();
@@ -66,6 +68,30 @@ public void testPrereqCollectsEventsForPrereqs() throws EvaluationException {
Assert.assertEquals(0, flagCResult.getPrerequisiteEvents().size());
}
+ @Test
+ public void testSegmentMatchClauseRetrievesSegmentFromStore() throws Exception {
+ Segment segment = new Segment.Builder("segkey")
+ .included(Arrays.asList("foo"))
+ .version(1)
+ .build();
+ featureStore.upsert(SEGMENTS, segment);
+
+ FeatureFlag flag = segmentMatchBooleanFlag("segkey");
+ LDUser user = new LDUser.Builder("foo").build();
+
+ FeatureFlag.EvalResult result = flag.evaluate(user, featureStore);
+ Assert.assertEquals(new JsonPrimitive(true), result.getValue());
+ }
+
+ @Test
+ public void testSegmentMatchClauseFallsThroughIfSegmentNotFound() throws Exception {
+ FeatureFlag flag = segmentMatchBooleanFlag("segkey");
+ LDUser user = new LDUser.Builder("foo").build();
+
+ FeatureFlag.EvalResult result = flag.evaluate(user, featureStore);
+ Assert.assertEquals(new JsonPrimitive(false), result.getValue());
+ }
+
private FeatureFlag newFlagWithPrereq(String featureKey, String prereqKey) {
return new FeatureFlagBuilder(featureKey)
.prerequisites(singletonList(new Prerequisite(prereqKey, 0)))
@@ -82,4 +108,15 @@ private FeatureFlag newFlagOff(String featureKey) {
.on(false)
.build();
}
+
+ private FeatureFlag segmentMatchBooleanFlag(String segmentKey) {
+ Clause clause = new Clause("", Operator.segmentMatch, Arrays.asList(new JsonPrimitive(segmentKey)), false);
+ Rule rule = new Rule(Arrays.asList(clause), 1, null);
+ return new FeatureFlagBuilder("key")
+ .variations(Arrays.asList(new JsonPrimitive(false), new JsonPrimitive(true)))
+ .fallthrough(new VariationOrRollout(0, null))
+ .on(true)
+ .rules(Arrays.asList(rule))
+ .build();
+ }
}
diff --git a/src/test/java/com/launchdarkly/client/FeatureStoreTestBase.java b/src/test/java/com/launchdarkly/client/FeatureStoreTestBase.java
index c93758176..e82ef1012 100644
--- a/src/test/java/com/launchdarkly/client/FeatureStoreTestBase.java
+++ b/src/test/java/com/launchdarkly/client/FeatureStoreTestBase.java
@@ -1,14 +1,14 @@
package com.launchdarkly.client;
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
import static org.junit.Assert.assertEquals;
-import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;
import java.util.HashMap;
+import java.util.Map;
-import org.junit.Assert;
import org.junit.Test;
public abstract class FeatureStoreTestBase {
@@ -29,7 +29,9 @@ protected void initStore() {
HashMap flags = new HashMap<>();
flags.put(feature1.getKey(), feature1);
flags.put(feature2.getKey(), feature2);
- store.init(flags);
+ Map, Map> allData = new HashMap<>();
+ allData.put(FEATURES, flags);
+ store.init(allData);
}
@Test
@@ -41,14 +43,14 @@ public void storeInitializedAfterInit() {
@Test
public void getExistingFeature() {
initStore();
- FeatureFlag result = store.get(feature1.getKey());
+ FeatureFlag result = store.get(FEATURES, feature1.getKey());
assertEquals(feature1.getKey(), result.getKey());
}
@Test
public void getNonexistingFeature() {
initStore();
- assertNull(store.get("biz"));
+ assertNull(store.get(FEATURES, "biz"));
}
@Test
@@ -57,8 +59,8 @@ public void upsertWithNewerVersion() {
FeatureFlag newVer = new FeatureFlagBuilder(feature1)
.version(feature1.getVersion() + 1)
.build();
- store.upsert(newVer.getKey(), newVer);
- FeatureFlag result = store.get(newVer.getKey());
+ store.upsert(FEATURES, newVer);
+ FeatureFlag result = store.get(FEATURES, newVer.getKey());
assertEquals(newVer.getVersion(), result.getVersion());
}
@@ -68,8 +70,8 @@ public void upsertWithOlderVersion() {
FeatureFlag oldVer = new FeatureFlagBuilder(feature1)
.version(feature1.getVersion() - 1)
.build();
- store.upsert(oldVer.getKey(), oldVer);
- FeatureFlag result = store.get(oldVer.getKey());
+ store.upsert(FEATURES, oldVer);
+ FeatureFlag result = store.get(FEATURES, oldVer.getKey());
assertEquals(feature1.getVersion(), result.getVersion());
}
@@ -79,37 +81,37 @@ public void upsertNewFeature() {
FeatureFlag newFeature = new FeatureFlagBuilder("biz")
.version(99)
.build();
- store.upsert(newFeature.getKey(), newFeature);
- FeatureFlag result = store.get(newFeature.getKey());
+ store.upsert(FEATURES, newFeature);
+ FeatureFlag result = store.get(FEATURES, newFeature.getKey());
assertEquals(newFeature.getKey(), result.getKey());
}
@Test
public void deleteWithNewerVersion() {
initStore();
- store.delete(feature1.getKey(), feature1.getVersion() + 1);
- assertNull(store.get(feature1.getKey()));
+ store.delete(FEATURES, feature1.getKey(), feature1.getVersion() + 1);
+ assertNull(store.get(FEATURES, feature1.getKey()));
}
@Test
public void deleteWithOlderVersion() {
initStore();
- store.delete(feature1.getKey(), feature1.getVersion() - 1);
- assertNotNull(store.get(feature1.getKey()));
+ store.delete(FEATURES, feature1.getKey(), feature1.getVersion() - 1);
+ assertNotNull(store.get(FEATURES, feature1.getKey()));
}
@Test
public void deleteUnknownFeature() {
initStore();
- store.delete("biz", 11);
- assertNull(store.get("biz"));
+ store.delete(FEATURES, "biz", 11);
+ assertNull(store.get(FEATURES, "biz"));
}
@Test
public void upsertOlderVersionAfterDelete() {
initStore();
- store.delete(feature1.getKey(), feature1.getVersion() + 1);
- store.upsert(feature1.getKey(), feature1);
- assertNull(store.get(feature1.getKey()));
+ store.delete(FEATURES, feature1.getKey(), feature1.getVersion() + 1);
+ store.upsert(FEATURES, feature1);
+ assertNull(store.get(FEATURES, feature1.getKey()));
}
}
diff --git a/src/test/java/com/launchdarkly/client/LDClientTest.java b/src/test/java/com/launchdarkly/client/LDClientTest.java
index a16a933ee..30b2646ec 100644
--- a/src/test/java/com/launchdarkly/client/LDClientTest.java
+++ b/src/test/java/com/launchdarkly/client/LDClientTest.java
@@ -11,12 +11,15 @@
import org.junit.Test;
import java.io.IOException;
+import java.util.Arrays;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
+import static com.launchdarkly.client.VersionedDataKind.SEGMENTS;
import static org.easymock.EasyMock.anyObject;
import static org.easymock.EasyMock.expect;
import static org.junit.Assert.*;
@@ -349,6 +352,50 @@ public void testIsFlagKnownCallBeforeInitializationButFeatureStoreIsInited() thr
verifyAll();
}
+ @Test
+ public void testFeatureMatchesUserBySegment() throws Exception {
+ TestFeatureStore testFeatureStore = new TestFeatureStore();
+ testFeatureStore.setInitialized(true);
+ LDConfig config = new LDConfig.Builder()
+ .startWaitMillis(10L)
+ .stream(false)
+ .featureStore(testFeatureStore)
+ .build();
+
+ expect(initFuture.get(10L, TimeUnit.MILLISECONDS)).andReturn(new Object());
+ expect(pollingProcessor.start()).andReturn(initFuture);
+ expect(pollingProcessor.initialized()).andReturn(true).times(1);
+ expect(eventProcessor.sendEvent(anyObject(Event.class))).andReturn(true).times(1);
+ replayAll();
+
+ client = createMockClient(config);
+
+ Segment segment = new Segment.Builder("segment1")
+ .version(1)
+ .included(Arrays.asList("user"))
+ .build();
+ testFeatureStore.upsert(SEGMENTS, segment);
+
+ Clause clause = new Clause(
+ "",
+ Operator.segmentMatch,
+ Arrays.asList(new JsonPrimitive("segment1")),
+ false);
+ Rule rule = new Rule(Arrays.asList(clause), 0, null);
+ FeatureFlag feature = new FeatureFlagBuilder("test-feature")
+ .version(1)
+ .rules(Arrays.asList(rule))
+ .variations(TestFeatureStore.TRUE_FALSE_VARIATIONS)
+ .on(true)
+ .fallthrough(new VariationOrRollout(1, null))
+ .build();
+ testFeatureStore.upsert(FEATURES, feature);
+
+ assertTrue(client.boolVariation("test-feature", new LDUser("user"), false));
+
+ verifyAll();
+ }
+
@Test
public void testUseLdd() throws IOException {
LDConfig config = new LDConfig.Builder()
@@ -556,4 +603,4 @@ protected EventProcessor createEventProcessor(String sdkKey, LDConfig config) {
}
};
}
-}
+}
\ No newline at end of file
diff --git a/src/test/java/com/launchdarkly/client/LDUserTest.java b/src/test/java/com/launchdarkly/client/LDUserTest.java
index 085476034..f80184dce 100644
--- a/src/test/java/com/launchdarkly/client/LDUserTest.java
+++ b/src/test/java/com/launchdarkly/client/LDUserTest.java
@@ -4,6 +4,8 @@
import com.google.gson.JsonElement;
import com.google.gson.JsonPrimitive;
import com.google.gson.reflect.TypeToken;
+
+import org.junit.Assert;
import org.junit.Test;
import java.lang.reflect.Type;
@@ -198,6 +200,38 @@ public void testLDUserCustomMarshalWithBuiltInAttributesRedactsCorrectAttrs() {
Type type = new TypeToken>(){}.getType();
Map privateJson = config.gson.fromJson(config.gson.toJson(user), type);
assertNull(privateJson.get("email"));
-
+ }
+
+ @Test
+ public void getValueGetsBuiltInAttribute() {
+ LDUser user = new LDUser.Builder("key")
+ .name("Jane")
+ .build();
+ assertEquals(new JsonPrimitive("Jane"), user.getValueForEvaluation("name"));
+ }
+
+ @Test
+ public void getValueGetsCustomAttribute() {
+ LDUser user = new LDUser.Builder("key")
+ .custom("height", 5)
+ .build();
+ assertEquals(new JsonPrimitive(5), user.getValueForEvaluation("height"));
+ }
+
+ @Test
+ public void getValueGetsBuiltInAttributeEvenIfCustomAttrHasSameName() {
+ LDUser user = new LDUser.Builder("key")
+ .name("Jane")
+ .custom("name", "Joan")
+ .build();
+ assertEquals(new JsonPrimitive("Jane"), user.getValueForEvaluation("name"));
+ }
+
+ @Test
+ public void getValueReturnsNullIfNotFound() {
+ LDUser user = new LDUser.Builder("key")
+ .name("Jane")
+ .build();
+ assertNull(user.getValueForEvaluation("height"));
}
}
diff --git a/src/test/java/com/launchdarkly/client/PollingProcessorTest.java b/src/test/java/com/launchdarkly/client/PollingProcessorTest.java
index c2062319d..30d06bb99 100644
--- a/src/test/java/com/launchdarkly/client/PollingProcessorTest.java
+++ b/src/test/java/com/launchdarkly/client/PollingProcessorTest.java
@@ -20,8 +20,8 @@ public void testConnectionOk() throws Exception {
FeatureRequestor requestor = createStrictMock(FeatureRequestor.class);
PollingProcessor pollingProcessor = new PollingProcessor(LDConfig.DEFAULT, requestor);
- expect(requestor.getAllFlags())
- .andReturn(new HashMap())
+ expect(requestor.getAllData())
+ .andReturn(new FeatureRequestor.AllData(new HashMap(), new HashMap()))
.once();
replayAll();
@@ -37,7 +37,7 @@ public void testConnectionProblem() throws Exception {
FeatureRequestor requestor = createStrictMock(FeatureRequestor.class);
PollingProcessor pollingProcessor = new PollingProcessor(LDConfig.DEFAULT, requestor);
- expect(requestor.getAllFlags())
+ expect(requestor.getAllData())
.andThrow(new IOException("This exception is part of a test and yes you should be seeing it."))
.once();
replayAll();
@@ -53,4 +53,4 @@ public void testConnectionProblem() throws Exception {
pollingProcessor.close();
verifyAll();
}
-}
+}
\ No newline at end of file
diff --git a/src/test/java/com/launchdarkly/client/SegmentTest.java b/src/test/java/com/launchdarkly/client/SegmentTest.java
new file mode 100644
index 000000000..0bc45f7a5
--- /dev/null
+++ b/src/test/java/com/launchdarkly/client/SegmentTest.java
@@ -0,0 +1,141 @@
+package com.launchdarkly.client;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+import java.util.Arrays;
+
+import org.junit.Test;
+
+import com.google.gson.JsonPrimitive;
+
+public class SegmentTest {
+
+ private int maxWeight = 100000;
+
+ @Test
+ public void explicitIncludeUser() {
+ Segment s = new Segment.Builder("test")
+ .included(Arrays.asList("foo"))
+ .salt("abcdef")
+ .version(1)
+ .build();
+ LDUser u = new LDUser.Builder("foo").build();
+
+ assertTrue(s.matchesUser(u));
+ }
+
+ @Test
+ public void explicitExcludeUser() {
+ Segment s = new Segment.Builder("test")
+ .excluded(Arrays.asList("foo"))
+ .salt("abcdef")
+ .version(1)
+ .build();
+ LDUser u = new LDUser.Builder("foo").build();
+
+ assertFalse(s.matchesUser(u));
+ }
+
+ @Test
+ public void explicitIncludeHasPrecedence() {
+ Segment s = new Segment.Builder("test")
+ .included(Arrays.asList("foo"))
+ .excluded(Arrays.asList("foo"))
+ .salt("abcdef")
+ .version(1)
+ .build();
+ LDUser u = new LDUser.Builder("foo").build();
+
+ assertTrue(s.matchesUser(u));
+ }
+
+ @Test
+ public void matchingRuleWithFullRollout() {
+ Clause clause = new Clause(
+ "email",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("test@example.com")),
+ false);
+ SegmentRule rule = new SegmentRule(
+ Arrays.asList(clause),
+ maxWeight,
+ null);
+ Segment s = new Segment.Builder("test")
+ .salt("abcdef")
+ .rules(Arrays.asList(rule))
+ .build();
+ LDUser u = new LDUser.Builder("foo").email("test@example.com").build();
+
+ assertTrue(s.matchesUser(u));
+ }
+
+ @Test
+ public void matchingRuleWithZeroRollout() {
+ Clause clause = new Clause(
+ "email",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("test@example.com")),
+ false);
+ SegmentRule rule = new SegmentRule(Arrays.asList(clause),
+ 0,
+ null);
+ Segment s = new Segment.Builder("test")
+ .salt("abcdef")
+ .rules(Arrays.asList(rule))
+ .build();
+ LDUser u = new LDUser.Builder("foo").email("test@example.com").build();
+
+ assertFalse(s.matchesUser(u));
+ }
+
+ @Test
+ public void matchingRuleWithMultipleClauses() {
+ Clause clause1 = new Clause(
+ "email",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("test@example.com")),
+ false);
+ Clause clause2 = new Clause(
+ "name",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("bob")),
+ false);
+ SegmentRule rule = new SegmentRule(
+ Arrays.asList(clause1, clause2),
+ null,
+ null);
+ Segment s = new Segment.Builder("test")
+ .salt("abcdef")
+ .rules(Arrays.asList(rule))
+ .build();
+ LDUser u = new LDUser.Builder("foo").email("test@example.com").name("bob").build();
+
+ assertTrue(s.matchesUser(u));
+ }
+
+ @Test
+ public void nonMatchingRuleWithMultipleClauses() {
+ Clause clause1 = new Clause(
+ "email",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("test@example.com")),
+ false);
+ Clause clause2 = new Clause(
+ "name",
+ Operator.in,
+ Arrays.asList(new JsonPrimitive("bill")),
+ false);
+ SegmentRule rule = new SegmentRule(
+ Arrays.asList(clause1, clause2),
+ null,
+ null);
+ Segment s = new Segment.Builder("test")
+ .salt("abcdef")
+ .rules(Arrays.asList(rule))
+ .build();
+ LDUser u = new LDUser.Builder("foo").email("test@example.com").name("bob").build();
+
+ assertFalse(s.matchesUser(u));
+ }
+}
\ No newline at end of file
diff --git a/src/test/java/com/launchdarkly/client/StreamProcessorTest.java b/src/test/java/com/launchdarkly/client/StreamProcessorTest.java
new file mode 100644
index 000000000..94382d1c1
--- /dev/null
+++ b/src/test/java/com/launchdarkly/client/StreamProcessorTest.java
@@ -0,0 +1,338 @@
+package com.launchdarkly.client;
+
+import com.launchdarkly.eventsource.ConnectionErrorHandler;
+import com.launchdarkly.eventsource.EventHandler;
+import com.launchdarkly.eventsource.EventSource;
+import com.launchdarkly.eventsource.MessageEvent;
+import com.launchdarkly.eventsource.UnsuccessfulResponseException;
+
+import org.easymock.EasyMockSupport;
+import org.junit.Before;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URI;
+import java.util.Collections;
+import java.util.concurrent.Future;
+
+import static com.launchdarkly.client.VersionedDataKind.FEATURES;
+import static com.launchdarkly.client.VersionedDataKind.SEGMENTS;
+import static org.easymock.EasyMock.expect;
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import okhttp3.Headers;
+
+public class StreamProcessorTest extends EasyMockSupport {
+
+ private static final String SDK_KEY = "sdk_key";
+ private static final URI STREAM_URI = URI.create("http://stream.test.com");
+ private static final String FEATURE1_KEY = "feature1";
+ private static final int FEATURE1_VERSION = 11;
+ private static final FeatureFlag FEATURE = new FeatureFlagBuilder(FEATURE1_KEY).version(FEATURE1_VERSION).build();
+ private static final String SEGMENT1_KEY = "segment1";
+ private static final int SEGMENT1_VERSION = 22;
+ private static final Segment SEGMENT = new Segment.Builder(SEGMENT1_KEY).version(SEGMENT1_VERSION).build();
+
+ private InMemoryFeatureStore featureStore;
+ private LDConfig.Builder configBuilder;
+ private FeatureRequestor mockRequestor;
+ private EventSource mockEventSource;
+ private EventHandler eventHandler;
+ private URI actualStreamUri;
+ private ConnectionErrorHandler errorHandler;
+ private Headers headers;
+
+ @Before
+ public void setup() {
+ featureStore = new InMemoryFeatureStore();
+ configBuilder = new LDConfig.Builder().featureStore(featureStore);
+ mockRequestor = createStrictMock(FeatureRequestor.class);
+ mockEventSource = createStrictMock(EventSource.class);
+ }
+
+ @Test
+ public void streamUriHasCorrectEndpoint() {
+ LDConfig config = configBuilder.streamURI(STREAM_URI).build();
+ createStreamProcessor(SDK_KEY, config).start();
+ assertEquals(URI.create(STREAM_URI.toString() + "/all"), actualStreamUri);
+ }
+
+ @Test
+ public void headersHaveAuthorization() {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ assertEquals(SDK_KEY, headers.get("Authorization"));
+ }
+
+ @Test
+ public void headersHaveUserAgent() {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ assertEquals("JavaClient/" + LDClient.CLIENT_VERSION, headers.get("User-Agent"));
+ }
+
+ @Test
+ public void headersHaveAccept() {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ assertEquals("text/event-stream", headers.get("Accept"));
+ }
+
+ @Test
+ public void putCausesFeatureToBeStored() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ MessageEvent event = new MessageEvent("{\"data\":{\"flags\":{\"" +
+ FEATURE1_KEY + "\":" + featureJson(FEATURE1_KEY, FEATURE1_VERSION) + "}," +
+ "\"segments\":{}}}");
+ eventHandler.onMessage("put", event);
+
+ assertFeatureInStore(FEATURE);
+ }
+
+ @Test
+ public void putCausesSegmentToBeStored() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ MessageEvent event = new MessageEvent("{\"data\":{\"flags\":{},\"segments\":{\"" +
+ SEGMENT1_KEY + "\":" + segmentJson(SEGMENT1_KEY, SEGMENT1_VERSION) + "}}}");
+ eventHandler.onMessage("put", event);
+
+ assertSegmentInStore(SEGMENT);
+ }
+
+ @Test
+ public void storeNotInitializedByDefault() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ assertFalse(featureStore.initialized());
+ }
+
+ @Test
+ public void putCausesStoreToBeInitialized() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("put", emptyPutEvent());
+ assertTrue(featureStore.initialized());
+ }
+
+ @Test
+ public void processorNotInitializedByDefault() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ sp.start();
+ assertFalse(sp.initialized());
+ }
+
+ @Test
+ public void putCausesProcessorToBeInitialized() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ sp.start();
+ eventHandler.onMessage("put", emptyPutEvent());
+ assertTrue(sp.initialized());
+ }
+
+ @Test
+ public void futureIsNotSetByDefault() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ Future future = sp.start();
+ assertFalse(future.isDone());
+ }
+
+ @Test
+ public void putCausesFutureToBeSet() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ Future future = sp.start();
+ eventHandler.onMessage("put", emptyPutEvent());
+ assertTrue(future.isDone());
+ }
+
+ @Test
+ public void patchUpdatesFeature() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("put", emptyPutEvent());
+
+ String path = "/flags/" + FEATURE1_KEY;
+ MessageEvent event = new MessageEvent("{\"path\":\"" + path + "\",\"data\":" +
+ featureJson(FEATURE1_KEY, FEATURE1_VERSION) + "}");
+ eventHandler.onMessage("patch", event);
+
+ assertFeatureInStore(FEATURE);
+ }
+
+ @Test
+ public void patchUpdatesSegment() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("put", emptyPutEvent());
+
+ String path = "/segments/" + SEGMENT1_KEY;
+ MessageEvent event = new MessageEvent("{\"path\":\"" + path + "\",\"data\":" +
+ segmentJson(SEGMENT1_KEY, SEGMENT1_VERSION) + "}");
+ eventHandler.onMessage("patch", event);
+
+ assertSegmentInStore(SEGMENT);
+ }
+
+ @Test
+ public void deleteDeletesFeature() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("put", emptyPutEvent());
+ featureStore.upsert(FEATURES, FEATURE);
+
+ String path = "/flags/" + FEATURE1_KEY;
+ MessageEvent event = new MessageEvent("{\"path\":\"" + path + "\",\"version\":" +
+ (FEATURE1_VERSION + 1) + "}");
+ eventHandler.onMessage("delete", event);
+
+ assertNull(featureStore.get(FEATURES, FEATURE1_KEY));
+ }
+
+ @Test
+ public void deleteDeletesSegment() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("put", emptyPutEvent());
+ featureStore.upsert(SEGMENTS, SEGMENT);
+
+ String path = "/segments/" + SEGMENT1_KEY;
+ MessageEvent event = new MessageEvent("{\"path\":\"" + path + "\",\"version\":" +
+ (SEGMENT1_VERSION + 1) + "}");
+ eventHandler.onMessage("delete", event);
+
+ assertNull(featureStore.get(SEGMENTS, SEGMENT1_KEY));
+ }
+
+ @Test
+ public void indirectPutRequestsAndStoresFeature() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ setupRequestorToReturnAllDataWithFlag(FEATURE);
+ replayAll();
+
+ eventHandler.onMessage("indirect/put", new MessageEvent(""));
+
+ assertFeatureInStore(FEATURE);
+ }
+
+ @Test
+ public void indirectPutInitializesStore() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ setupRequestorToReturnAllDataWithFlag(FEATURE);
+ replayAll();
+
+ eventHandler.onMessage("indirect/put", new MessageEvent(""));
+
+ assertTrue(featureStore.initialized());
+ }
+
+ @Test
+ public void indirectPutInitializesProcessor() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ sp.start();
+ setupRequestorToReturnAllDataWithFlag(FEATURE);
+ replayAll();
+
+ eventHandler.onMessage("indirect/put", new MessageEvent(""));
+
+ assertTrue(featureStore.initialized());
+ }
+
+ @Test
+ public void indirectPutSetsFuture() throws Exception {
+ StreamProcessor sp = createStreamProcessor(SDK_KEY, configBuilder.build());
+ Future future = sp.start();
+ setupRequestorToReturnAllDataWithFlag(FEATURE);
+ replayAll();
+
+ eventHandler.onMessage("indirect/put", new MessageEvent(""));
+
+ assertTrue(future.isDone());
+ }
+
+ @Test
+ public void indirectPatchRequestsAndUpdatesFeature() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ expect(mockRequestor.getFlag(FEATURE1_KEY)).andReturn(FEATURE);
+ replayAll();
+
+ eventHandler.onMessage("put", emptyPutEvent());
+ eventHandler.onMessage("indirect/patch", new MessageEvent("/flags/" + FEATURE1_KEY));
+
+ assertFeatureInStore(FEATURE);
+ }
+
+ @Test
+ public void indirectPatchRequestsAndUpdatesSegment() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ expect(mockRequestor.getSegment(SEGMENT1_KEY)).andReturn(SEGMENT);
+ replayAll();
+
+ eventHandler.onMessage("put", emptyPutEvent());
+ eventHandler.onMessage("indirect/patch", new MessageEvent("/segments/" + SEGMENT1_KEY));
+
+ assertSegmentInStore(SEGMENT);
+ }
+
+ @Test
+ public void unknownEventTypeDoesNotThrowException() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ eventHandler.onMessage("what", new MessageEvent(""));
+ }
+
+ @Test
+ public void streamWillReconnectAfterGeneralIOException() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ ConnectionErrorHandler.Action action = errorHandler.onConnectionError(new IOException());
+ assertEquals(ConnectionErrorHandler.Action.PROCEED, action);
+ }
+
+ @Test
+ public void streamWillReconnectAfterHttp500Error() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ UnsuccessfulResponseException e = new UnsuccessfulResponseException(500);
+ ConnectionErrorHandler.Action action = errorHandler.onConnectionError(e);
+ assertEquals(ConnectionErrorHandler.Action.PROCEED, action);
+ }
+
+ @Test
+ public void streamWillCloseAfterHttp401Error() throws Exception {
+ createStreamProcessor(SDK_KEY, configBuilder.build()).start();
+ UnsuccessfulResponseException e = new UnsuccessfulResponseException(401);
+ ConnectionErrorHandler.Action action = errorHandler.onConnectionError(e);
+ assertEquals(ConnectionErrorHandler.Action.SHUTDOWN, action);
+ }
+
+ private StreamProcessor createStreamProcessor(String sdkKey, LDConfig config) {
+ return new StreamProcessor(sdkKey, config, mockRequestor) {
+ @Override
+ protected EventSource createEventSource(EventHandler handler, URI streamUri, ConnectionErrorHandler errorHandler,
+ Headers headers) {
+
+ StreamProcessorTest.this.eventHandler = handler;
+ StreamProcessorTest.this.actualStreamUri = streamUri;
+ StreamProcessorTest.this.errorHandler = errorHandler;
+ StreamProcessorTest.this.headers = headers;
+ return mockEventSource;
+ }
+ };
+ }
+
+ private String featureJson(String key, int version) {
+ return "{\"key\":\"" + key + "\",\"version\":" + version + ",\"on\":true}";
+ }
+
+ private String segmentJson(String key, int version) {
+ return "{\"key\":\"" + key + "\",\"version\":" + version + ",\"includes\":[],\"excludes\":[],\"rules\":[]}";
+ }
+
+ private MessageEvent emptyPutEvent() {
+ return new MessageEvent("{\"data\":{\"flags\":{},\"segments\":{}}}");
+ }
+
+ private void setupRequestorToReturnAllDataWithFlag(FeatureFlag feature) throws Exception {
+ FeatureRequestor.AllData data = new FeatureRequestor.AllData(
+ Collections.singletonMap(feature.getKey(), feature), Collections.emptyMap());
+ expect(mockRequestor.getAllData()).andReturn(data);
+ }
+
+ private void assertFeatureInStore(FeatureFlag feature) {
+ assertEquals(feature.getVersion(), featureStore.get(FEATURES, feature.getKey()).getVersion());
+ }
+
+ private void assertSegmentInStore(Segment segment) {
+ assertEquals(segment.getVersion(), featureStore.get(SEGMENTS, segment.getKey()).getVersion());
+ }
+}