Merge pull request #9 from launchdarkly/jko/hide-specific-attrs

Hide specific user attributes, either globally or per user

src/main/java/com/launchdarkly/client/EventProcessor.java

@@ -41,12 +41,6 @@ boolean sendEvent(Event e) {
       return true;
     }
 
-    // If all user data is hidden, or this user is marked hidden, replace the user with a new user
-    // containing only the key and the hidden attribute
-    if (config.hideUserData || (e.user.getHidden() != null && e.user.getHidden().getAsBoolean())) {
-      e.user = new LDUser.Builder(e.user.getKeyAsString()).hidden(true).build();
-    }
-
     return queue.offer(e);
   }
 
@@ -84,10 +78,10 @@ public void flush() {
 
     private void postEvents(List<Event> events) {
 
-      String json = LDConfig.gson.toJson(events);
+      String json = config.gson.toJson(events);
       logger.debug("Posting " + events.size() + " event(s) to " + config.eventsURI + " with payload: " + json);
 
-      String content = LDConfig.gson.toJson(events);
+      String content = config.gson.toJson(events);
 
       Request request = config.getRequestBuilder(sdkKey)
           .url(config.eventsURI.toString() + "/bulk")

src/main/java/com/launchdarkly/client/FeatureFlag.java

@@ -28,12 +28,12 @@ class FeatureFlag {
   private final List<JsonElement> variations;
   private final boolean deleted;
 
-  static FeatureFlag fromJson(String json) {
-    return LDConfig.gson.fromJson(json, FeatureFlag.class);
+  static FeatureFlag fromJson(LDConfig config, String json) {
+    return config.gson.fromJson(json, FeatureFlag.class);
   }
 
-  static Map<String, FeatureFlag> fromJsonMap(String json) {
-    return LDConfig.gson.fromJson(json, mapType);
+  static Map<String, FeatureFlag> fromJsonMap(LDConfig config, String json) {
+    return config.gson.fromJson(json, mapType);
   }
 
   FeatureFlag(String key, int version, boolean on, List<Prerequisite> prerequisites, String salt, List<Target> targets, List<Rule> rules, VariationOrRollout fallthrough, Integer offVariation, List<JsonElement> variations, boolean deleted) {

src/main/java/com/launchdarkly/client/FeatureRequestor.java

@@ -21,12 +21,12 @@ class FeatureRequestor {
 
   Map<String, FeatureFlag> getAllFlags() throws IOException {
     String body = get(GET_LATEST_FLAGS_PATH);
-    return FeatureFlag.fromJsonMap(body);
+    return FeatureFlag.fromJsonMap(config, body);
   }
 
   FeatureFlag getFlag(String featureKey) throws IOException {
     String body = get(GET_LATEST_FLAGS_PATH + "/" + featureKey);
-    return FeatureFlag.fromJson(body);
+    return FeatureFlag.fromJson(config, body);
   }
 
   private String get(String path) throws IOException {

src/main/java/com/launchdarkly/client/LDConfig.java

@@ -2,6 +2,7 @@
 
 import com.google.common.io.Files;
 import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
 import okhttp3.Authenticator;
 import okhttp3.Cache;
 import okhttp3.ConnectionPool;
@@ -18,14 +19,17 @@
 import java.net.InetSocketAddress;
 import java.net.Proxy;
 import java.net.URI;
+import java.util.Arrays;
+import java.util.HashSet;
+import java.util.Set;
 import java.util.concurrent.TimeUnit;
 
 /**
  * This class exposes advanced configuration options for the {@link LDClient}. Instances of this class must be constructed with a {@link com.launchdarkly.client.LDConfig.Builder}.
  */
 public final class LDConfig {
   private static final Logger logger = LoggerFactory.getLogger(LDConfig.class);
-  static final Gson gson = new Gson();
+  final Gson gson = new GsonBuilder().registerTypeAdapter(LDUser.class, new LDUser.UserAdapter(this)).create();
 
   private static final URI DEFAULT_BASE_URI = URI.create("https://app.launchdarkly.com");
   private static final URI DEFAULT_EVENTS_URI = URI.create("https://events.launchdarkly.com");
@@ -57,7 +61,8 @@ public final class LDConfig {
   final FeatureStore featureStore;
   final boolean useLdd;
   final boolean offline;
-  final boolean hideUserData;
+  final boolean privateUserData;
+  final Set<String> privateAttrNames;
   final long pollingIntervalMillis;
   final long startWaitMillis;
   final int samplingInterval;
@@ -77,7 +82,8 @@ protected LDConfig(Builder builder) {
     this.featureStore = builder.featureStore;
     this.useLdd = builder.useLdd;
     this.offline = builder.offline;
-    this.hideUserData = builder.hideUserData;
+    this.privateUserData = builder.privateUserData;
+    this.privateAttrNames = new HashSet<>(builder.privateAttrNames);
     if (builder.pollingIntervalMillis < DEFAULT_POLLING_INTERVAL_MILLIS) {
       this.pollingIntervalMillis = DEFAULT_POLLING_INTERVAL_MILLIS;
     } else {
@@ -144,12 +150,13 @@ public static class Builder {
     private boolean stream = true;
     private boolean useLdd = false;
     private boolean offline = false;
-    private boolean hideUserData = false;
+    private boolean privateUserData = false;
     private long pollingIntervalMillis = DEFAULT_POLLING_INTERVAL_MILLIS;
     private FeatureStore featureStore = new InMemoryFeatureStore();
     private long startWaitMillis = DEFAULT_START_WAIT_MILLIS;
     private int samplingInterval = DEFAULT_SAMPLING_INTERVAL;
     private long reconnectTimeMillis = DEFAULT_RECONNECT_TIME_MILLIS;
+    private Set<String> privateAttrNames = new HashSet<>();
 
     /**
      * Creates a builder with all configuration parameters set to the default
@@ -373,11 +380,11 @@ public Builder offline(boolean offline) {
 
     /**
      * Set whether or not user data (other than the key) should be sent back to LaunchDarkly.
-     * @param hideUserData
+     * @param privateUserData
      * @return the builder
      */
-    public Builder hideUserData(boolean hideUserData) {
-      this.hideUserData = hideUserData;
+    public Builder privateUserData(boolean privateUserData) {
+      this.privateUserData = privateUserData;
       return this;
     }
 
@@ -434,6 +441,18 @@ public Builder reconnectTimeMs(long reconnectTimeMs) {
       return this;
     }
 
+    /**
+     *
+     * Mark a set of attribute names private. Any users sent to LaunchDarkly with this configuration
+     * active will have attributes with these names removed.
+     *
+     * @param names a set of names that will be removed from user data set to LaunchDarkly
+     * @return the builder
+     */
+    public Builder privateAttrNames(String... names) {
+      this.privateAttrNames = new HashSet<>(Arrays.asList(names));
+      return this;
+    }
 
     // returns null if none of the proxy bits were configured. Minimum required part: port.
     Proxy proxy() {