prepare 3.5.1 release (#63)

* initial move of code from js-client-sdk-private

* changelog note

* rm obsolete comment

* add npm audit helper

* update babel, jest, rollup

* fix rollup config

* fix ES build, dependency cleanup

* add Releaser metadata

* Update babel config to work in `test` without `useBuiltIns`

* copyedits

* fix misnamed directory

* use spread operator instead of Object.assign

* add issue templates

* add babel-eslint

* add event capacity config property

* re-add deprecation warning on samplingInterval

* better config validation

* remove rollup-plugins-node-resolve

* use newer Rollup node-resolve plugin

* rm rollup-plugin-includepaths (unused)

* npm audit fix (handlebars dependency from jest)

* comment

* copyedit

* use new test helpers + misc test cleanup

* clean up stream testing logic

* fix hash parameter

* linter

* clearer way to model the config option defaults/types

* test improvements

* change internal param name

* comment

* fix default logger logic

* simpler way to enforce minimum values

* implement diagnostic events in common JS package (#11)

* add support for function type in config options

* add support for function type in config options (#13)

* add wrapper metadata options and fix custom header logic

* lint

* lint

* remove image-loading logic from common code, replace it with an abstraction

* add validation for options.streaming

* typo

* rm unused params

* typo in comment

* misc fixes to merged code from external PR

* add event payload ID header

* npm audit fix

* change exact dependencies to best-compatible

* standardize linting

* disallow "window" and "document"

* improve diag event tests + debug logging

* misc cleanup

* fix updating secure mode hash with identify()

* don't omit streamInits.failed when it's false

* clean up init state logic, prevent unhandled rejections

* lint

* less strict matching of json content-type header

* remove unsafe usage of hasOwnProperty

* console logger must tolerate console object not always existing

* fix double initialization of diagnostics manager

* fix TypeScript declaration for track() and add more TS compilation tests (#27)

* remove startsWith usage (#28)

* prevent poll caused by a stream ping from overwriting later poll for another user (#29)

* upgrade jest dependency and transitive yargs-parser dependency (#30)

* Add null to LDEvaluationDetail.reason type (#31)

* Revert "Add null to LDEvaluationDetail.reason type (#31)"

This reverts commit bcb1573.

* Revert "Add null to LDEvaluationDetail.reason type (#31)"

This reverts commit bcb1573.

* nullable evaluation reason (#32)

* adding alias event functionality (#33)

* set stream read timeout

* Add prepare script (#34)

* add a missing typescript verification (#36)

* Removed the guides link

* Correct doc link (#36)

* Fix typo in LDClient.on jsdoc (#37)

* add inlineUsersInEvents option in TypeScript (#37)

* Filter private attributes on debug event users. Send variation for debug events.

* update uuid package version (#39)

* use Releaser v2 config + newer CI image

* First half, add the type, create the new options, add the new util method, and add tests

* Second half, call the tranform util method before calling any HTTP requests

* Update the transform to work on a copy of headers instead of mutating it

* add comments about removing custom event warning logic in the future

* revert updating of UUID dependency (#43)

* Revert "update uuid package version (#39)"

This reverts commit 3b2ff6c.

* update package-lock.json

* better error handling for local storage operations (#44)

* better error handling for local storage operations

* lint

* fix obsolete comments

* add basic logger similar to server-side Node SDK (#45)

* fix exports and add validation of custom logger (#46)

* remove typedoc.js file that interferes with Releaser's docs build

* update typescript version

* add maintenance branch

* backport sc-142333 fix

Co-authored-by: Eli Bishop <eli@launchdarkly.com>
Co-authored-by: Zach Davis <zach@launchdarkly.com>
Co-authored-by: LaunchDarklyCI <dev@launchdarkly.com>
Co-authored-by: Ben Woskow <bwoskow@launchdarkly.com>
Co-authored-by: Ben Woskow <48036130+bwoskow-ld@users.noreply.github.com>
Co-authored-by: Michael Siadak <mike.siadak@gmail.com>
Co-authored-by: Jeff Wen <sinchangwen@gmail.com>
Co-authored-by: Andrey Krasnov <34657799+Doesntmeananything@users.noreply.github.com>
Co-authored-by: Gavin Whelan <gwhelan@launchdarkly.com>
Co-authored-by: LaunchDarklyReleaseBot <launchdarklyreleasebot@launchdarkly.com>
Co-authored-by: Louis Chan <lchan@launchdarkly.com>
Co-authored-by: Louis Chan <91093020+louis-launchdarkly@users.noreply.github.com>

Author: 11 people

.ldrelease/config.yml

@@ -4,6 +4,11 @@ repo:
   public: js-sdk-common
   private: js-sdk-common-private
 
+branches:
+  - name: master
+    description: 4.x
+  - name: 3.x
+
 publications:
   - url: https://www.npmjs.com/package/launchdarkly-js-sdk-common
     description: npm

docs/typedoc.js

@@ -1,3 +1,4 @@
+import * as messages from '../messages';
 import * as utils from '../utils';
 
 import { AsyncQueue, eventSink, sleepAsync, withCloseable } from 'launchdarkly-js-test-helpers';
@@ -650,6 +651,38 @@ describe('LDClient streaming', () => {
       });
     });
 
+    describe('emits error if malformed JSON is received', () => {
+      const doMalformedJsonEventTest = async (eventName, eventData) => {
+        // First, verify that there isn't an unhandled rejection if we're not listening for an error
+        await withClientAndServer({}, async client => {
+          await client.waitForInitialization();
+          client.setStreaming(true);
+
+          const stream = await expectStreamConnecting(fullStreamUrlWithUser);
+          stream.eventSource.mockEmit(eventName, { data: eventData });
+        });
+
+        // Then, repeat the test using a listener to observe the error event
+        await withClientAndServer({}, async client => {
+          const errorEvents = new AsyncQueue();
+          client.on('error', e => errorEvents.add(e));
+
+          await client.waitForInitialization();
+          client.setStreaming(true);
+
+          const stream = await expectStreamConnecting(fullStreamUrlWithUser);
+          stream.eventSource.mockEmit(eventName, { data: eventData });
+
+          const e = await errorEvents.take();
+          expect(e.message).toEqual(messages.invalidData());
+        });
+      };
+
+      it('in put event', async () => doMalformedJsonEventTest('put', '{no'));
+      it('in patch event', async () => doMalformedJsonEventTest('patch', '{no'));
+      it('in delete event', async () => doMalformedJsonEventTest('delete', '{no'));
+    });
+
     it('reconnects to stream if the user changes', async () => {
       const user2 = { key: 'user2' };
       const encodedUser2 = 'eyJrZXkiOiJ1c2VyMiJ9';

src/__tests__/LDClient-streaming-test.js

@@ -18,6 +18,7 @@ export const LDInvalidUserError = createCustomError('LaunchDarklyInvalidUserErro
 export const LDInvalidEventKeyError = createCustomError('LaunchDarklyInvalidEventKeyError');
 export const LDInvalidArgumentError = createCustomError('LaunchDarklyInvalidArgumentError');
 export const LDFlagFetchError = createCustomError('LaunchDarklyFlagFetchError');
+export const LDInvalidDataError = createCustomError('LaunchDarklyInvalidDataError');
 
 export function isHttpErrorRecoverable(status) {
   if (status >= 400 && status < 500) {

src/errors.js

@@ -386,6 +386,14 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
     if (!ident.getUser()) {
       return;
     }
+    const tryParseData = jsonData => {
+      try {
+        return JSON.parse(jsonData);
+      } catch (err) {
+        emitter.maybeReportError(new errors.LDInvalidDataError(messages.invalidData()));
+        return undefined;
+      }
+    };
     stream.connect(ident.getUser(), hash, {
       ping: function() {
         logger.debug(messages.debugStreamPing());
@@ -404,12 +412,20 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
           });
       },
       put: function(e) {
-        const data = JSON.parse(e.data);
+        const data = tryParseData(e.data);
+        if (!data) {
+          return;
+        }
         logger.debug(messages.debugStreamPut());
-        replaceAllFlags(data); // don't wait for this Promise to be resolved
+        replaceAllFlags(data);
+        // Don't wait for this Promise to be resolved; note that replaceAllFlags is guaranteed
+        // never to have an unhandled rejection
       },
       patch: function(e) {
-        const data = JSON.parse(e.data);
+        const data = tryParseData(e.data);
+        if (!data) {
+          return;
+        }
         // If both the flag and the patch have a version property, then the patch version must be
         // greater than the flag version for us to accept the patch.  If either one has no version
         // then the patch always succeeds.
@@ -432,7 +448,10 @@ export function initialize(env, user, specifiedOptions, platform, extraOptionDef
         }
       },
       delete: function(e) {
-        const data = JSON.parse(e.data);
+        const data = tryParseData(e.data);
+        if (!data) {
+          return;
+        }
         if (!flags[data.key] || flags[data.key].version < data.version) {
           logger.debug(messages.debugStreamDelete(data.key));
           const mods = {};

src/index.js

@@ -68,6 +68,10 @@ export const invalidUser = function() {
   return 'Invalid user specified.' + docLink;
 };
 
+export const invalidData = function() {
+  return 'Invalid data received from LaunchDarkly; connection may have been interrupted';
+};
+
 export const bootstrapOldFormat = function() {
   return (
     'LaunchDarkly client was initialized with bootstrap data that did not include flag metadata. ' +