prepare 1.4.0 release

.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
@@ -17,24 +18,37 @@ globals:
   jest: true
   beforeEach: true
   afterEach: true
-  window: true
-  document: true
+  window: false # client-side Node SDK 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'
@@ -43,12 +57,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
@@ -60,51 +80,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.json

@@ -44,7 +44,7 @@
   },
   "dependencies": {
     "launchdarkly-eventsource": "1.0.0",
-    "launchdarkly-js-sdk-common": "3.1.1",
+    "launchdarkly-js-sdk-common": "3.2.2",
     "node-localstorage": "^1.3.1",
     "original": "^1.0.0",
     "winston": "^2.4.1"

src/__tests__/LDClient-events-test.js

@@ -1,5 +1,7 @@
 const LDClient = require('../index');
 
+const { TestHttpHandlers, TestHttpServers, withCloseable } = require('launchdarkly-js-test-helpers');
+
 describe('LDClient', () => {
   const envName = 'UNKNOWN_ENVIRONMENT_ID';
   const user = { key: 'user' };
@@ -9,33 +11,55 @@ describe('LDClient', () => {
   // should.
 
   describe('event generation', () => {
-    function stubEventProcessor() {
-      const ep = { events: [] };
-      ep.start = function() {};
-      ep.flush = function() {};
-      ep.stop = function() {};
-      ep.enqueue = function(e) {
-        ep.events.push(e);
-      };
-      return ep;
-    }
-
     // This tests that the client calls our platform's getCurrentUrl() and isDoNotTrack() methods.
-    it('sends an event for track()', done => {
-      const ep = stubEventProcessor();
-      const client = LDClient.initialize(envName, user, { eventProcessor: ep, bootstrap: {} });
-      const data = { thing: 'stuff' };
-      client.on('ready', () => {
-        client.track('eventkey', data);
+    it('sends an event for track()', async () => {
+      await withCloseable(TestHttpServers.start, async server => {
+        const config = { bootstrap: {}, eventsUrl: server.url, diagnosticOptOut: true };
+        const client = LDClient.initialize(envName, user, config);
+        await withCloseable(client, async () => {
+          const data = { thing: 'stuff' };
+          await client.waitForInitialization();
+
+          client.track('eventkey', data);
+          await client.flush();
+
+          const req = await server.nextRequest();
+          expect(req.path).toEqual('/events/bulk/' + envName);
+          const events = JSON.parse(req.body);
+          expect(events.length).toEqual(2); // first is identify event
+          const trackEvent = events[1];
+          expect(trackEvent.kind).toEqual('custom');
+          expect(trackEvent.key).toEqual('eventkey');
+          expect(trackEvent.userKey).toEqual(user.key);
+          expect(trackEvent.data).toEqual(data);
+          expect(trackEvent.url).toEqual(null);
+        });
+      });
+    });
+  });
 
-        expect(ep.events.length).toEqual(2);
-        const trackEvent = ep.events[1];
-        expect(trackEvent.kind).toEqual('custom');
-        expect(trackEvent.key).toEqual('eventkey');
-        expect(trackEvent.user).toEqual(user);
-        expect(trackEvent.data).toEqual(data);
-        expect(trackEvent.url).toEqual(null);
-        done();
+  describe('diagnostic events', () => {
+    it('sends diagnostic init event', async () => {
+      await withCloseable(TestHttpServers.start, async server => {
+        server.byDefault(TestHttpHandlers.respond(202));
+        const config = { bootstrap: {}, eventsUrl: server.url };
+        const client = LDClient.initialize(envName, user, config);
+        await withCloseable(client, async () => {
+          const req0 = await server.nextRequest();
+          const req1 = await server.nextRequest();
+          // We should have received both the client's usual identify event and a diagnostic init event, but we can't be sure of the ordering.
+          const expectedPath = '/events/diagnostic/' + envName;
+          expect([req0.path, req1.path]).toContain(expectedPath);
+          const req = req0.path === expectedPath ? req0 : req1;
+          const data = JSON.parse(req.body);
+          expect(data.kind).toEqual('diagnostic-init');
+          expect(data.platform).toMatchObject({
+            name: 'Node',
+          });
+          expect(data.sdk).toMatchObject({
+            name: 'node-client-sdk',
+          });
+        });
       });
     });
   });

src/__tests__/LDClient-tls-test.js

@@ -29,6 +29,7 @@ describe('LDClient TLS configuration', () => {
         baseUrl: server.url,
         sendEvents: false,
         tlsParams: { ca: server.certificate },
+        diagnosticOptOut: true,
       };
       await withCloseable(LDClient.initialize(envName, user, config), async client => {
         await client.waitForInitialization();
@@ -43,6 +44,7 @@ describe('LDClient TLS configuration', () => {
         baseUrl: server.url,
         sendEvents: false,
         logger: stubLogger,
+        diagnosticOptOut: true,
       };
       await withCloseable(LDClient.initialize(envName, user, config), async client => {
         await expect(client.waitForInitialization()).rejects.toThrow(/network error.*self signed/);
@@ -64,6 +66,7 @@ describe('LDClient TLS configuration', () => {
           streaming: true,
           sendEvents: false,
           tlsParams: { ca: server.certificate },
+          diagnosticOptOut: true,
         };
         await withCloseable(LDClient.initialize(envName, user, config), async client => {
           const changeEvents = eventSink(client, 'change:flag');
@@ -86,6 +89,7 @@ describe('LDClient TLS configuration', () => {
         baseUrl: server.url,
         eventsUrl: server.url + '/events',
         tlsParams: { ca: server.certificate },
+        diagnosticOptOut: true,
       };
       await withCloseable(LDClient.initialize(envName, user, config), async client => {
         await client.waitForInitialization();

src/nodePlatform.js

@@ -1,7 +1,9 @@
 const { LocalStorage } = require('node-localstorage');
 const { EventSource } = require('launchdarkly-eventsource');
+const os = require('os');
 const path = require('path');
 const newHttpRequest = require('./httpRequest');
+const packageJson = require('../package.json');
 
 function makeNodePlatform(options) {
   const tlsParams = filterTlsParams(options.tlsParams);
@@ -48,10 +50,38 @@ function makeNodePlatform(options) {
   ret.eventSourceAllowsReport = true;
 
   ret.userAgent = 'NodeClientSide';
+  ret.version = packageJson.version;
+
+  ret.diagnosticSdkData = {
+    name: 'node-client-sdk',
+    version: packageJson.version,
+  };
+
+  ret.diagnosticPlatformData = {
+    name: 'Node',
+    nodeVersion: process.versions.node,
+    osArch: os.arch(),
+    osName: normalizePlatformName(os.platform()),
+    osVersion: os.release(),
+  };
 
   return ret;
 }
 
+function normalizePlatformName(platformName) {
+  // The following logic is based on how Node.js reports the platform name
+  switch (platformName) {
+    case 'darwin':
+      return 'MacOS';
+    case 'win32':
+      return 'Windows';
+    case 'linux':
+      return 'Linux';
+    default:
+      return platformName;
+  }
+}
+
 const httpsOptions = [
   'pfx',
   'key',

typings.d.ts

@@ -23,7 +23,12 @@ declare module 'launchdarkly-node-client-sdk' {
 //// DOCBUILD-END-REPLACE
 
   /**
-   * Creates an instance of the LaunchDarkly client to be used in the main process.
+   * Creates an instance of the LaunchDarkly client.
+   *
+   * Applications should instantiate a single instance for the lifetime of the application.
+   * The client will begin attempting to connect to LaunchDarkly as soon as it is created. To
+   * determine when it is ready to use, call [[LDClient.waitForInitialization]], or register an
+   * event listener for the `"ready"` event using [[LDClient.on]].
    *
    * @param envKey
    *   The LaunchDarkly environment ID.