prepare 3.2.0 release (#12)

Author: LaunchDarklyCI

.eslintrc.yaml

@@ -3,6 +3,7 @@ parser: babel-eslint
 root: true
 extends:
   - prettier
+  - eslint:recommended # https://eslint.org/docs/rules/
 env:
   es6: true
   node: true
@@ -19,24 +20,37 @@ globals:
   afterAll: true
   beforeEach: true
   afterEach: true
-  window: true
-  document: true
+  window: false # platform-agnostic code should *not* reference "window" or "document"
+  document: false
 rules:
-  # https://github.com/prettier/eslint-plugin-prettier
-  prettier/prettier:
+  # https://eslint.org/docs/rules/array-callback-return
+  array-callback-return: error
+
+  # https://eslint.org/docs/rules/arrow-body-style
+  arrow-body-style:
     - error
-  
+    - as-needed
+
   # https://github.com/babel/eslint-plugin-babel
   babel/semi: error
 
-  # https://eslint.org/docs/rules/array-callback-return
-  array-callback-return: error
+  # Deprecations are required to turn enforce this
+  camelcase: warn
 
   # https://eslint.org/docs/rules/curly
   curly:
     - error
     - all
 
+  # https://eslint.org/docs/rules/eqeqeq
+  eqeqeq: error
+
+  # https://eslint.org/docs/rules/no-array-constructor
+  no-array-constructor: error
+
+  # https://eslint.org/docs/rules/no-eval
+  no-eval: error
+
   # https://eslint.org/docs/rules/no-implicit-coercion
   no-implicit-coercion:
     - 'off'
@@ -45,12 +59,18 @@ rules:
       string: true
       allow: []
 
-  # https://eslint.org/docs/rules/no-eval
-  no-eval: error
-
   # https://eslint.org/docs/rules/no-implied-eval
   no-implied-eval: error
 
+  # https://eslint.org/docs/rules/no-nested-ternary
+  no-nested-ternary: error
+
+  # https://eslint.org/docs/rules/no-new-object
+  no-new-object: error
+
+  # https://eslint.org/docs/rules/no-new-wrappers
+  no-new-wrappers: error
+
   # https://eslint.org/docs/rules/no-param-reassign
   no-param-reassign:
     - error
@@ -62,51 +82,23 @@ rules:
   # https://eslint.org/docs/rules/no-self-compare
   no-self-compare: error
 
-  # https://eslint.org/docs/rules/radix
-  radix: error
-
-  # https://eslint.org/docs/rules/no-array-constructor
-  no-array-constructor: error
-
-  # https://eslint.org/docs/rules/no-new-wrappers
-  no-new-wrappers: error
-
-  # https://eslint.org/docs/rules/no-cond-assign
-  no-cond-assign: error
-
   # https://eslint.org/docs/rules/no-use-before-define
   no-use-before-define:
     - error
     - functions: false
 
-  # https://eslint.org/docs/rules/eqeqeq
-  eqeqeq: error
-
-  # Deprecations are required to turn enforce this
-  camelcase: warn
-
-  # https://eslint.org/docs/rules/no-new-object
-  no-new-object: error
-
-  # https://eslint.org/docs/rules/no-nested-ternary
-  no-nested-ternary: error
-
-  # https://eslint.org/docs/rules/no-unused-vars
-  no-unused-vars: error
-
   # https://eslint.org/docs/rules/no-var
   no-var: error
 
-  # https://eslint.org/docs/rules/prefer-const
-  prefer-const: error
-
   # https://eslint.org/docs/rules/prefer-arrow-callback
   prefer-arrow-callback: error
 
-  # https://eslint.org/docs/rules/arrow-body-style
-  arrow-body-style:
-    - error
-    - as-needed
+  # https://eslint.org/docs/rules/prefer-const
+  prefer-const: error
 
-  # https://eslint.org/docs/rules/no-undef
-  no-undef: error
+  # https://github.com/prettier/eslint-plugin-prettier
+  prettier/prettier:
+    - error
+  
+  # https://eslint.org/docs/rules/radix
+  radix: error

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "3.1.2",
+  "version": "3.2.0-beta3",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",

package.json

@@ -5,9 +5,17 @@ import * as errors from './errors';
 import * as messages from './messages';
 import * as utils from './utils';
 
-export default function EventProcessor(platform, options, environmentId, emitter = null, sender = null) {
+export default function EventProcessor(
+  platform,
+  options,
+  environmentId,
+  diagnosticsAccumulator = null,
+  emitter = null,
+  sender = null
+) {
   const processor = {};
-  const eventSender = sender || EventSender(platform, options.eventsUrl, environmentId, options);
+  const eventSender = sender || EventSender(platform, environmentId, options);
+  const mainEventsUrl = options.eventsUrl + '/events/bulk/' + environmentId;
   const summarizer = EventSummarizer();
   const userFilter = UserFilter(options);
   const inlineUsers = options.inlineUsersInEvents;
@@ -62,6 +70,10 @@ export default function EventProcessor(platform, options, environmentId, emitter
         exceededCapacity = true;
         logger.warn(messages.eventCapacityExceeded());
       }
+      if (diagnosticsAccumulator) {
+        // For diagnostic events, we track how many times we had to drop an event due to exceeding the capacity.
+        diagnosticsAccumulator.incrementDroppedEvents();
+      }
     }
   }
 
@@ -109,12 +121,18 @@ export default function EventProcessor(platform, options, environmentId, emitter
       summary.kind = 'summary';
       eventsToSend.push(summary);
     }
+    if (diagnosticsAccumulator) {
+      // For diagnostic events, we record how many events were in the queue at the last flush (since "how
+      // many events happened to be in the queue at the moment we decided to send a diagnostic event" would
+      // not be a very useful statistic).
+      diagnosticsAccumulator.setEventsInLastBatch(eventsToSend.length);
+    }
     if (eventsToSend.length === 0) {
       return Promise.resolve();
     }
     queue = [];
     logger.debug(messages.debugPostingEvents(eventsToSend.length));
-    return eventSender.sendEvents(eventsToSend).then(responseInfo => {
+    return eventSender.sendEvents(eventsToSend, mainEventsUrl).then(responseInfo => {
       if (responseInfo) {
         if (responseInfo.serverTime) {
           lastKnownPastTime = responseInfo.serverTime;

src/EventProcessor.js

@@ -4,9 +4,9 @@ import uuidv1 from 'uuid/v1';
 
 const MAX_URL_LENGTH = 2000;
 
-export default function EventSender(platform, eventsUrl, environmentId, options) {
-  const postUrl = eventsUrl + '/events/bulk/' + environmentId;
-  const imageUrl = eventsUrl + '/a/' + environmentId + '.gif';
+export default function EventSender(platform, environmentId, options) {
+  const imageUrlPath = '/a/' + environmentId + '.gif';
+  const baseHeaders = utils.extend({ 'Content-Type': 'application/json' }, utils.getLDHeaders(platform, options));
   const httpFallbackPing = platform.httpFallbackPing; // this will be set for us if we're in the browser SDK
   const sender = {};
 
@@ -22,21 +22,19 @@ export default function EventSender(platform, eventsUrl, environmentId, options)
     return ret;
   }
 
-  function sendChunk(events, usePost) {
+  sender.sendChunk = (events, url, isDiagnostic, usePost) => {
     const jsonBody = JSON.stringify(events);
-    const payloadId = uuidv1();
+    const payloadId = isDiagnostic ? null : uuidv1();
 
     function doPostRequest(canRetry) {
-      const headers = utils.extend(
-        {
-          'Content-Type': 'application/json',
-          'X-LaunchDarkly-Event-Schema': '3',
-          'X-LaunchDarkly-Payload-ID': payloadId,
-        },
-        utils.getLDHeaders(platform, options)
-      );
+      const headers = isDiagnostic
+        ? baseHeaders
+        : utils.extend({}, baseHeaders, {
+            'X-LaunchDarkly-Event-Schema': '3',
+            'X-LaunchDarkly-Payload-ID': payloadId,
+          });
       return platform
-        .httpRequest('POST', postUrl, headers, jsonBody)
+        .httpRequest('POST', url, headers, jsonBody)
         .promise.then(result => {
           if (!result) {
             // This was a response from a fire-and-forget request, so we won't have a status.
@@ -59,12 +57,12 @@ export default function EventSender(platform, eventsUrl, environmentId, options)
     if (usePost) {
       return doPostRequest(true).catch(() => {});
     } else {
-      httpFallbackPing && httpFallbackPing(imageUrl + '?d=' + utils.base64URLEncode(jsonBody));
+      httpFallbackPing && httpFallbackPing(url + imageUrlPath + '?d=' + utils.base64URLEncode(jsonBody));
       return Promise.resolve(); // we don't wait for this request to complete, it's just a one-way ping
     }
-  }
+  };
 
-  sender.sendEvents = function(events) {
+  sender.sendEvents = function(events, url, isDiagnostic) {
     if (!platform.httpRequest) {
       return Promise.resolve();
     }
@@ -74,11 +72,11 @@ export default function EventSender(platform, eventsUrl, environmentId, options)
       // no need to break up events into chunks if we can send a POST
       chunks = [events];
     } else {
-      chunks = utils.chunkUserEventsForUrl(MAX_URL_LENGTH - eventsUrl.length, events);
+      chunks = utils.chunkUserEventsForUrl(MAX_URL_LENGTH - url.length, events);
     }
     const results = [];
     for (let i = 0; i < chunks.length; i++) {
-      results.push(sendChunk(chunks[i], canPost));
+      results.push(sender.sendChunk(chunks[i], url, isDiagnostic, canPost));
     }
     return Promise.all(results);
   };

src/EventSender.js

@@ -10,7 +10,7 @@ import { base64URLEncode, getLDHeaders } from './utils';
 //   it is in an active state (connected or connecting).
 // eventSourceAllowsReport: true if REPORT is supported.
 
-export default function Stream(platform, config, environment, hash) {
+export default function Stream(platform, config, environment, diagnosticsAccumulator, hash) {
   const baseUrl = config.streamUrl;
   const logger = config.logger;
   const stream = {};
@@ -22,6 +22,7 @@ export default function Stream(platform, config, environment, hash) {
   let firstConnectionErrorLogged = false;
   let es = null;
   let reconnectTimeoutReference = null;
+  let connectionAttemptStartTime;
   let user = null;
   let handlers = null;
 
@@ -35,6 +36,7 @@ export default function Stream(platform, config, environment, hash) {
         // We will decorate *all* handlers to do this to keep this abstraction agnostic
         // for different stream implementations.
         firstConnectionErrorLogged = false;
+        logConnectionResult(true);
         newHandlers[key] && newHandlers[key](e);
       };
     }
@@ -56,6 +58,7 @@ export default function Stream(platform, config, environment, hash) {
       logger.warn(messages.streamError(err, streamReconnectDelay));
       firstConnectionErrorLogged = true;
     }
+    logConnectionResult(false);
     closeConnection();
     tryConnect(streamReconnectDelay);
   }
@@ -100,6 +103,8 @@ export default function Stream(platform, config, environment, hash) {
 
       closeConnection();
       logger.info(messages.streamConnecting(url));
+      logConnectionStarted();
+
       es = platform.eventSourceFactory(url, options);
       for (const key in handlers) {
         if (handlers.hasOwnProperty(key)) {
@@ -119,5 +124,20 @@ export default function Stream(platform, config, environment, hash) {
     }
   }
 
+  function logConnectionStarted() {
+    connectionAttemptStartTime = new Date().getTime();
+  }
+
+  function logConnectionResult(success) {
+    if (connectionAttemptStartTime && diagnosticsAccumulator) {
+      diagnosticsAccumulator.recordStreamInit(
+        connectionAttemptStartTime,
+        !success,
+        new Date().getTime() - connectionAttemptStartTime
+      );
+    }
+    connectionAttemptStartTime = null;
+  }
+
   return stream;
 }

src/Stream.js

@@ -43,7 +43,6 @@ export default function UserValidator(localStorageProvider, logger) {
     if (userOut.key !== null && userOut.key !== undefined) {
       userOut.key = userOut.key.toString();
       return Promise.resolve(userOut);
-      return;
     }
     if (userOut.anonymous) {
       return getCachedUserId().then(cachedId => {