api_key->sdk_key. Change logging when stream is reconnecting to be less spammy.

Author: Dan Richelson

README.md

@@ -18,9 +18,9 @@ Quick setup
 
         import com.launchdarkly.client.*;
 
-2. Create a new LDClient with your API key:
+2. Create a new LDClient with your SDK key:
 
-        LDClient ldClient = new LDClient("YOUR_API_KEY");
+        LDClient ldClient = new LDClient("YOUR_SDK_KEY");
 
 Your first feature flag
 -----------------------

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

@@ -21,12 +21,12 @@ class EventProcessor implements Closeable {
   private final ScheduledExecutorService scheduler;
   private final Random random = new Random();
   private final BlockingQueue<Event> queue;
-  private final String apiKey;
+  private final String sdkKey;
   private final LDConfig config;
   private final Consumer consumer;
 
-  EventProcessor(String apiKey, LDConfig config) {
-    this.apiKey = apiKey;
+  EventProcessor(String sdkKey, LDConfig config) {
+    this.sdkKey = sdkKey;
     this.queue = new ArrayBlockingQueue<>(config.capacity);
     this.consumer = new Consumer(config);
     this.config = config;
@@ -85,7 +85,7 @@ private void postEvents(List<Event> events) {
       Gson gson = new Gson();
       String json = gson.toJson(events);
 
-      HttpPost request = config.postEventsRequest(apiKey, "/bulk");
+      HttpPost request = config.postEventsRequest(sdkKey, "/bulk");
       StringEntity entity = new StringEntity(json, "UTF-8");
       entity.setContentType("application/json");
       request.setEntity(entity);

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

@@ -19,13 +19,13 @@
 class FeatureRequestor {
 
   public static final String GET_LATEST_FLAGS_PATH = "/sdk/latest-flags";
-  private final String apiKey;
+  private final String sdkKey;
   private final LDConfig config;
   private final CloseableHttpClient client;
   private static final Logger logger = LoggerFactory.getLogger(FeatureRequestor.class);
 
-  FeatureRequestor(String apiKey, LDConfig config) {
-    this.apiKey = apiKey;
+  FeatureRequestor(String sdkKey, LDConfig config) {
+    this.sdkKey = sdkKey;
     this.config = config;
     this.client = createClient();
   }
@@ -58,7 +58,7 @@ protected CloseableHttpClient createClient() {
   Map<String, FeatureFlag> makeAllRequest() throws IOException {
     HttpCacheContext context = HttpCacheContext.create();
 
-    HttpGet request = config.getRequest(apiKey, GET_LATEST_FLAGS_PATH);
+    HttpGet request = config.getRequest(sdkKey, GET_LATEST_FLAGS_PATH);
 
     CloseableHttpResponse response = null;
     try {
@@ -107,7 +107,7 @@ FeatureFlag makeRequest(String featureKey, boolean latest) throws IOException {
 
     String resource = latest ? "/api/eval/latest-features/" : "/api/eval/features/";
 
-    HttpGet request = config.getRequest(apiKey,resource + featureKey);
+    HttpGet request = config.getRequest(sdkKey,resource + featureKey);
 
     CloseableHttpResponse response = null;
     try {

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

@@ -36,7 +36,7 @@ public class LDClient implements Closeable {
   protected static final String CLIENT_VERSION = getClientVersion();
 
   private final LDConfig config;
-  private final String apiKey;
+  private final String sdkKey;
   private final FeatureRequestor requestor;
   private final EventProcessor eventProcessor;
   private UpdateProcessor updateProcessor;
@@ -45,24 +45,24 @@ public class LDClient implements Closeable {
    * Creates a new client instance that connects to LaunchDarkly with the default configuration. In most
    * cases, you should use this constructor.
    *
-   * @param apiKey the API key for your account
+   * @param sdkKey the SDK key for your LaunchDarkly environment
    */
-  public LDClient(String apiKey) {
-    this(apiKey, LDConfig.DEFAULT);
+  public LDClient(String sdkKey) {
+    this(sdkKey, LDConfig.DEFAULT);
   }
 
   /**
    * Creates a new client to connect to LaunchDarkly with a custom configuration. This constructor
    * can be used to configure advanced client features, such as customizing the LaunchDarkly base URL.
    *
-   * @param apiKey the API key for your account
+   * @param sdkKey the SDK key for your LaunchDarkly environment
    * @param config a client configuration object
    */
-  public LDClient(String apiKey, LDConfig config) {
+  public LDClient(String sdkKey, LDConfig config) {
     this.config = config;
-    this.apiKey = apiKey;
-    this.requestor = createFeatureRequestor(apiKey, config);
-    this.eventProcessor = createEventProcessor(apiKey, config);
+    this.sdkKey = sdkKey;
+    this.requestor = createFeatureRequestor(sdkKey, config);
+    this.eventProcessor = createEventProcessor(sdkKey, config);
 
     if (config.offline) {
       logger.info("Starting LaunchDarkly client in offline mode");
@@ -76,7 +76,7 @@ public LDClient(String apiKey, LDConfig config) {
 
     if (config.stream) {
       logger.info("Enabling streaming API");
-      this.updateProcessor = createStreamProcessor(apiKey, config, requestor);
+      this.updateProcessor = createStreamProcessor(sdkKey, config, requestor);
     } else {
       logger.info("Disabling streaming API");
       this.updateProcessor = createPollingProcessor(config);
@@ -101,18 +101,18 @@ public boolean initialized() {
   }
 
   @VisibleForTesting
-  protected FeatureRequestor createFeatureRequestor(String apiKey, LDConfig config) {
-    return new FeatureRequestor(apiKey, config);
+  protected FeatureRequestor createFeatureRequestor(String sdkKey, LDConfig config) {
+    return new FeatureRequestor(sdkKey, config);
   }
 
   @VisibleForTesting
-  protected EventProcessor createEventProcessor(String apiKey, LDConfig config) {
-    return new EventProcessor(apiKey, config);
+  protected EventProcessor createEventProcessor(String sdkKey, LDConfig config) {
+    return new EventProcessor(sdkKey, config);
   }
 
   @VisibleForTesting
-  protected StreamProcessor createStreamProcessor(String apiKey, LDConfig config, FeatureRequestor requestor) {
-    return new StreamProcessor(apiKey, config, requestor);
+  protected StreamProcessor createStreamProcessor(String sdkKey, LDConfig config, FeatureRequestor requestor) {
+    return new StreamProcessor(sdkKey, config, requestor);
   }
 
   @VisibleForTesting
@@ -382,7 +382,7 @@ public boolean isOffline() {
 
   /**
    * For more info: <a href=https://github.com/launchdarkly/js-client#secure-mode>https://github.com/launchdarkly/js-client#secure-mode</a>
-   * @param user The User to be hashed along with the api key
+   * @param user The User to be hashed along with the sdk key
    * @return the hash, or null if the hash could not be calculated.
      */
   public String secureModeHash(LDUser user) {
@@ -391,7 +391,7 @@ public String secureModeHash(LDUser user) {
     }
     try {
       Mac mac = Mac.getInstance(HMAC_ALGORITHM);
-      mac.init(new SecretKeySpec(apiKey.getBytes(), HMAC_ALGORITHM));
+      mac.init(new SecretKeySpec(sdkKey.getBytes(), HMAC_ALGORITHM));
       return Hex.encodeHexString(mac.doFinal(user.getKeyAsString().getBytes("UTF8")));
     } catch (InvalidKeyException | UnsupportedEncodingException | NoSuchAlgorithmException e) {
       logger.error("Could not generate secure mode hash", e);

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

@@ -376,12 +376,12 @@ private URIBuilder getEventsBuilder() {
         .setPort(eventsURI.getPort());
   }
 
-  HttpGet getRequest(String apiKey, String path) {
+  HttpGet getRequest(String sdkKey, String path) {
     URIBuilder builder = this.getBuilder().setPath(path);
 
     try {
       HttpGet request = new HttpGet(builder.build());
-      request.addHeader("Authorization", "api_key " + apiKey);
+      request.addHeader("Authorization", sdkKey);
       request.addHeader("User-Agent", "JavaClient/" + LDClient.CLIENT_VERSION);
 
       return request;
@@ -391,27 +391,12 @@ HttpGet getRequest(String apiKey, String path) {
     }
   }
 
-  HttpPost postRequest(String apiKey, String path) {
-    URIBuilder builder = this.getBuilder().setPath(path);
-
-    try {
-      HttpPost request = new HttpPost(builder.build());
-      request.addHeader("Authorization", "api_key " + apiKey);
-      request.addHeader("User-Agent", "JavaClient/" + LDClient.CLIENT_VERSION);
-
-      return request;
-    } catch (Exception e) {
-      logger.error("Unhandled exception in LaunchDarkly client", e);
-      return null;
-    }
-  }
-
-  HttpPost postEventsRequest(String apiKey, String path) {
+  HttpPost postEventsRequest(String sdkKey, String path) {
     URIBuilder builder = this.getEventsBuilder().setPath(eventsURI.getPath() + path);
 
     try {
       HttpPost request = new HttpPost(builder.build());
-      request.addHeader("Authorization", "api_key " + apiKey);
+      request.addHeader("Authorization", sdkKey);
       request.addHeader("User-Agent", "JavaClient/" + LDClient.CLIENT_VERSION);
 
       return request;

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

@@ -23,16 +23,16 @@ class StreamProcessor implements UpdateProcessor {
 
   private final FeatureStore store;
   private final LDConfig config;
-  private final String apiKey;
+  private final String sdkKey;
   private final FeatureRequestor requestor;
   private EventSource es;
   private AtomicBoolean initialized = new AtomicBoolean(false);
 
 
-  StreamProcessor(String apiKey, LDConfig config, FeatureRequestor requestor) {
+  StreamProcessor(String sdkKey, LDConfig config, FeatureRequestor requestor) {
     this.store = config.featureStore;
     this.config = config;
-    this.apiKey = apiKey;
+    this.sdkKey = sdkKey;
     this.requestor = requestor;
   }
 
@@ -41,7 +41,7 @@ public Future<Void> start() {
     final VeryBasicFuture initFuture = new VeryBasicFuture();
 
     Headers headers = new Headers.Builder()
-        .add("Authorization", "api_key " + this.apiKey)
+        .add("Authorization", this.sdkKey)
         .add("User-Agent", "JavaClient/" + LDClient.CLIENT_VERSION)
         .add("Accept", "text/event-stream")
         .build();
@@ -102,7 +102,8 @@ public void onMessage(String name, MessageEvent event) throws Exception {
 
       @Override
       public void onError(Throwable throwable) {
-        logger.warn("Encountered EventSource error", throwable);
+        logger.error("Encountered EventSource error: " + throwable.getMessage());
+        logger.debug("", throwable);
       }
     };
 

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

@@ -43,7 +43,7 @@ static boolean handleResponse(Logger logger, HttpRequestBase request, CloseableH
       return true;
     }
     if (statusCode == HttpStatus.SC_UNAUTHORIZED) {
-      logger.error("[401] Invalid API key when accessing URI: " + request.getURI().toString());
+      logger.error("[401] Invalid SDK key when accessing URI: " + request.getURI().toString());
     } else {
       logger.error("[" + statusCode + "] " + response.getStatusLine().getReasonPhrase() + " When accessing URI: " + request.getURI().toString());
     }

src/test/java/com/launchdarkly/client/LDClientTest.java

@@ -357,14 +357,14 @@ private void assertDefaultValueIsReturned() {
   }
 
   private LDClient createMockClient(LDConfig config) {
-    return new LDClient("API_KEY", config) {
+    return new LDClient("SDK_KEY", config) {
       @Override
-      protected FeatureRequestor createFeatureRequestor(String apiKey, LDConfig config) {
+      protected FeatureRequestor createFeatureRequestor(String sdkKey, LDConfig config) {
         return requestor;
       }
 
       @Override
-      protected StreamProcessor createStreamProcessor(String apiKey, LDConfig config, FeatureRequestor requestor) {
+      protected StreamProcessor createStreamProcessor(String sdkKey, LDConfig config, FeatureRequestor requestor) {
         return streamProcessor;
       }
 
@@ -374,7 +374,7 @@ protected PollingProcessor createPollingProcessor(LDConfig config) {
       }
 
       @Override
-      protected EventProcessor createEventProcessor(String apiKey, LDConfig config) {
+      protected EventProcessor createEventProcessor(String sdkKey, LDConfig config) {
         return eventProcessor;
       }
     };