prepare 2.23.0 release (#257)

* add new JS SDK test/demo page

* misc doc edits

* fixing merge error

* fixing merge error

* fix broken links on npmjs.com (#193)

* update lockfiles for new packages

* fix changelog formatting error that messes up the release script

* Specify unpkg default target file in package.json for
launchdarkly-js-client-sdk and launchdarkly-js-sdk-common.

* Correct requestor call to fetch flags on a received ping event.

* Implement Hooks API (#196)

* Initial commit reusing withLDProvider

* Added sitenav. Cleaned up filenames.

* Updated readme with hooks api docs. Fixed linting errors.

* Fixed linting errors.

* Update README.md

* bumping our lerna version to resolve transitive dependency vulnerabilities with fstream and tar (#198)

* fix goals query logic for Electron, also fix handling of invalid content type

* add ability to alter URL in events

* Update browserPlatform definition to detect when an EventSource
polyfill is available and has published that it supports setting the
method used for the stream. When this is the case, the platform
publishes that it supports using REPORT with EventSource and will
provide the polyfill implementation if the SDK attempts a EventSource
connection with the method set to REPORT.

* Fix initial linter warnings.

* Fix another linter warning.

* fix a broken readme link (#202)

* removing a stray character in the readme

* fix stream reconnect logic and add stream connection logging

* linter

* assume logger always exists, as we do in other components

* fix and simplify how the logger object is passed around

* make it so eventUrlTransformer actually does something

* linter

* copy flags object to prevent subtle update problem in Electron

* additional fix + test

* make bootstrapped flags available immediately

* Refactor some of the EventSource constructor selection logic.

* Change browserPlatform.js to check config options when determining
EventSource implementation to use. Added tests for EventSource factory
in browserPlatform.js

* Deal with linter.

* change how supported options are detected in EventSource polyfill

* fix broken homepage attributes (#209)

* improve bad initialization messages (#210)

* improve bad initialization messages

* remove the spaces

* fixing a broken link in a logged message (#212)

* add jsdelivr attribute to js packages (#213)

* adding an option to disable the camel-casing of flag keys (#214)

* adding an option disabling the camel-casing of flag keys

* update comment

* update comment

* fix linter errors

* address pr feedback

* updated readme

* [ch45487] useCamelCaseFlagKeys option (#215)

* Initial commit

* Update initLDClient.ts

* PR fixes. Added prettier.

* Update withLDProvider.test.tsx

* Fixed lint errors. Added test for useCamelCase false on server changes.

* Removed prettier.

* Re-added prettier

* Update yarn.lock

* Update prettier and lock files.

* Fixed more linting issues.

* fix a typo

* use persistent anonymous user logic by default in react sdk (#216)

* use persistent anonymous user logic by default in react sdk

* added a comment

* minor test change

* missed a line

* remove React package from monorepo

* make link text match link

* improve log format and add configurable prefix

* fix test

* linter

* deprecate samplingInterval

* linter

* improve log message for stream connection failures (#221)

* improve log message for stream connection failures

* update the reconnection warning so that it only displays for the first set of each reconnection attempts

* also test that the original put is getting called

* updating tests

* updating tests

* Revert "updating tests"

This reverts commit 84163cdf8b5af6a6e969d777b946a8a2973919ed.

* better abstraction

* minor change

* updating the js-common readme to mention client-side node (#222)

* remove common package, no more monorepo

* add Releaser metadata

* npm audit fix

* unify Rollup config

* migrate new demo code to new package structure

* moved example folder

* syntax fix in demo

* fix directory name

* fix linting

* use spread operator instead of Object.assign

* don't close client on beforeunload, but do flush events

* typo

* clarify test postconditions

* misc test app improvements for testing beforeunload handler

* rm unused yarn.lock

* rm typedoc dependency, don't commit installation of it during release

* fix paths

* fix file copying logic

* pr template

* revert

* fix programmatically reported version string

* upgrade Typescript to avoid Typedoc incompatibility

* Revert "upgrade Typescript to avoid Typedoc incompatibility"

This reverts commit 34d9a0f.

* update Babel, Jest, Rollup

* remove old releaser (#229)

* remove unused Rollup plugins, update dependencies

* use new config validation mechanism in js-sdk-common 3.x

* add image-loading event delivery logic factored out of js-sdk-common

* enable diagnostic events in JS SDK

* lint

* fix tests

* use common 3.0.0-beta2

* use 3.1.0-beta3, fix property name

* lint

* use js-sdk-common 3.1.0

* use js-sdk-common 3.1.1 for event payload ID fix

* use js-sdk-common 3.1.2 and loosen our other dependency

* fix license

* use js-sdk-common 3.2.0-beta1

* SDK name should be js-client-sdk

* misc fixes

* use js-sdk-common 3.2.0

* use js-sdk-common 3.2.0

* standardize linting

* use js-sdk-common 3.2.1

* use js-sdk-common 3.2.2

* update package-lock

* update js-sdk-common dependency for initialization error bugfix

* update js-sdk-common for content type bugfix; update some dev dependencies

* remove unsafe usage of hasOwnProperty

* use js-sdk-common 3.2.5

* resolve security vulnerability in acorn dependency (#240)

* update js-sdk-common to get console logging IE bugfix

* update js-sdk-common for duplicate diagnostic event fix

* update js-sdk-common for TS decl fix, improve TS compilation test (#243)

* bump to 3.2.9 to get startsWith fix (#244)

* add option to disable sync event flush (#245)

* update js-sdk-common + some dev dependencies

* No longer remove non-section hash in substring and regex matching

* linting

* the linting target to run in CI is "lint:all", not "lint"

* new js-common-sdk version (#249)

* resolve node-notifier vulnerability by updating jest dep (#250)

* adding contextKind to goal events, bumping js-common to get alias function (#251)

* pin typedoc to unblock our releases (#252)

* Removed the guides link

* add inlineUsersToEvents to TypeScript defs by updating js-sdk-common

* Update common JS SDK library to use fixes for debug event generation issues.

* Update package lock.

* use Releaser v2 config + newer CI image (#256)

* Updated readme headers (#258)

* don't log a warning about custom goal being unknown

* lint + comment

* Release js-client-sdk with the header transformation change

* Updates docs link

* bump js-sdk-common version for better localstorage error handling

* Update launchdarkly-js-sdk-common for JSON error handling fix (sc-142333)

* update lockfile

* add basicLogger export

* Update common for application tags support. (#265)

* Re-remove package-lock.json and add it to the .gitignore. (#266)

* Use a combination of dependencies that is compatible. (#269) (#270)

* Update js-sdk-common to 3.7.0 (#271)

Co-authored-by: Eli Bishop <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Gavin Whelan <[email protected]>
Co-authored-by: LaunchDarklyCI <[email protected]>
Co-authored-by: Yusinto Ngadiman <[email protected]>
Co-authored-by: Zach Davis <[email protected]>
Co-authored-by: Elliot <[email protected]>
Co-authored-by: LaunchDarklyReleaseBot <[email protected]>
Co-authored-by: Louis Chan <[email protected]>
Co-authored-by: Louis Chan <[email protected]>
Co-authored-by: Ember Stevens <[email protected]>
Co-authored-by: ember-stevens <[email protected]>
Co-authored-by: Ryan Lamb <[email protected]>

Author: 12 people

.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: cimg/node:12.22
+      - image: cimg/node:14.20
     steps:
       - checkout
 

.eslintrc.yaml

@@ -1,5 +1,5 @@
 ---
-  parser: babel-eslint
+  parser: "@babel/eslint-parser"
   root: true
   extends:
     - prettier

jest.config.js

@@ -7,11 +7,14 @@ module.exports = {
   setupFiles: ['jest-localstorage-mock', './jest.setup.js'],
   testMatch: ['**/__tests__/**/*-test.js'],
   transform: {
-    '^.+\\.js$': 'babel-jest',
+    '^.+\\.js$': ['babel-jest', { rootMode: 'upward' }],
   },
   globals: {
     window: true,
     VERSION: version,
   },
-  testURL: 'https://mydomain.com/some/path',
+  testEnvironmentOptions: {
+    url: 'https://mydomain.com/some/path',
+  },
+  testEnvironment: 'jsdom',
 };

package.json

@@ -41,46 +41,43 @@
     "prepublishOnly": "npm run build:min"
   },
   "devDependencies": {
-    "@babel/cli": "^7.11.6",
-    "@babel/core": "^7.11.6",
-    "@babel/plugin-transform-regenerator": "7.10.4",
-    "@babel/plugin-transform-runtime": "7.11.5",
-    "@babel/preset-env": "^7.11.5",
-    "@babel/runtime": "^7.11.2",
-    "@rollup/plugin-node-resolve": "^6.0.0",
-    "@rollup/plugin-replace": "^2.2.0",
-    "babel-eslint": "^10.1.0",
-    "babel-jest": "^26.3.0",
-    "chai": "^4.1.2",
-    "cross-env": "^5.1.4",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^2.9.0",
-    "eslint-config-xo": "^0.20.1",
-    "eslint-formatter-pretty": "^1.3.0",
-    "eslint-plugin-babel": "^5.0.0",
-    "eslint-plugin-prettier": "^2.6.0",
-    "jest": "^26.6.3",
-    "jest-junit": "^11.1.0",
-    "jest-localstorage-mock": "^2.4.3",
-    "jsdom": "^11.12.0",
-    "prettier": "1.11.1",
-    "readline-sync": "1.4.9",
+    "@babel/cli": "^7.19.3",
+    "@babel/core": "^7.19.3",
+    "@babel/eslint-parser": "7.19.1",
+    "@babel/plugin-transform-regenerator": "7.18.6",
+    "@babel/plugin-transform-runtime": "7.19.1",
+    "@babel/preset-env": "^7.19.3",
+    "@babel/runtime": "^7.19.0",
+    "@rollup/plugin-node-resolve": "^14.1.0",
+    "@rollup/plugin-replace": "^4.0.0",
+    "babel-jest": "^29.1.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.24.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-xo": "^0.42.0",
+    "eslint-formatter-pretty": "^4.1.0",
+    "eslint-plugin-babel": "^5.3.1",
+    "eslint-plugin-prettier": "^4.2.1",
+    "jest": "^29.1.1",
+    "jest-environment-jsdom": "^29.1.1",
+    "jest-junit": "^14.0.1",
+    "jest-localstorage-mock": "^2.4.22",
+    "jsdom": "^20.0.0",
+    "prettier": "2.7.1",
     "rimraf": "^3.0.2",
-    "rollup": "^1.26.0",
-    "rollup-plugin-babel": "^4.3.3",
+    "rollup": "^2.79.1",
+    "rollup-plugin-babel": "^4.4.0",
     "rollup-plugin-commonjs": "^10.1.0",
-    "rollup-plugin-filesize": "^6.2.1",
+    "rollup-plugin-filesize": "^9.1.2",
     "rollup-plugin-node-globals": "^1.4.0",
     "rollup-plugin-terser": "^7.0.2",
-    "rollup-plugin-uglify": "^6.0.4",
-    "semver": "^7.1.3",
-    "semver-compare": "^1.0.0",
-    "sinon": "7.2.7",
-    "typescript": "^3.7.5"
+    "sinon": "^14.0.0",
+    "typescript": "^4.8.4",
+    "@types/estree": "^1.0.0"
   },
   "dependencies": {
-    "escape-string-regexp": "^1.0.5",
-    "launchdarkly-js-sdk-common": "3.6.0"
+    "escape-string-regexp": "^4.0.0",
+    "launchdarkly-js-sdk-common": "3.7.0"
   },
   "repository": {
     "type": "git",

rollup.config.js

@@ -1,10 +1,9 @@
 const pkg = require('./package.json');
-const resolve = require('@rollup/plugin-node-resolve');
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
 const commonjs = require('rollup-plugin-commonjs');
 const babel = require('rollup-plugin-babel');
 const replace = require('@rollup/plugin-replace');
 const { terser } = require('rollup-plugin-terser');
-const { uglify } = require('rollup-plugin-uglify');
 const filesize = require('rollup-plugin-filesize');
 
 const env = process.env.NODE_ENV || 'development';
@@ -17,7 +16,7 @@ const basePlugins = [
     'process.env.NODE_ENV': JSON.stringify(env),
     VERSION: JSON.stringify(version),
   }),
-  resolve({
+  nodeResolve({
     mainFields: ['browser', 'module', 'main'],
     preferBuiltins: true,
   }),
@@ -29,12 +28,6 @@ const basePlugins = [
 ];
 
 const plugins = env === 'production' ?
-  basePlugins.concat(
-    uglify()
-  ) :
-  basePlugins;
-
-const esPlugins = env === 'production' ?
   basePlugins.concat(
     terser()
   ) : basePlugins;
@@ -66,7 +59,7 @@ const configs = [
       format: 'es',
       sourcemap: true,
     },
-    plugins: esPlugins,
+    plugins: plugins,
   },
 ];
 

src/GoalManager.js

@@ -75,15 +75,15 @@ export default function GoalManager(clientVars, readyCallback) {
 
   clientVars.requestor
     .fetchJSON(getGoalsPath())
-    .then(g => {
+    .then((g) => {
       if (g && g.length > 0) {
         goals = g;
         goalTracker = GoalTracker(goals, sendGoalEvent);
         watchLocation(locationWatcherInterval, refreshGoalTracker);
       }
       readyCallback();
     })
-    .catch(err => {
+    .catch((err) => {
       clientVars.emitter.maybeReportError(
         new common.errors.LDUnexpectedResponseError('Error fetching goals: ' + (err && err.message) ? err.message : err)
       );

src/GoalTracker.js

@@ -75,7 +75,7 @@ export default function GoalTracker(goals, onEvent) {
   }
 
   if (clickGoals.length > 0) {
-    listenerFn = function(event) {
+    listenerFn = function (event) {
       const goals = findGoalsForClick(event, clickGoals);
       for (let i = 0; i < goals.length; i++) {
         onEvent('click', goals[i]);
@@ -85,7 +85,7 @@ export default function GoalTracker(goals, onEvent) {
     document.addEventListener('click', listenerFn);
   }
 
-  tracker.dispose = function() {
+  tracker.dispose = function () {
     document.removeEventListener('click', listenerFn);
   };
 

src/__tests__/LDClient-events-test.js

@@ -17,10 +17,10 @@ describe('LDClient', () => {
   describe('event generation', () => {
     function stubEventProcessor() {
       const ep = { events: [] };
-      ep.start = function() {};
-      ep.flush = function() {};
-      ep.stop = function() {};
-      ep.enqueue = function(e) {
+      ep.start = function () {};
+      ep.flush = function () {};
+      ep.stop = function () {};
+      ep.enqueue = function (e) {
         ep.events.push(e);
       };
       return ep;
@@ -65,7 +65,7 @@ describe('LDClient', () => {
       const client = LDClient.initialize(envName, user, {
         eventProcessor: ep,
         bootstrap: {},
-        eventUrlTransformer: url => url + suffix,
+        eventUrlTransformer: (url) => url + suffix,
       });
       await client.waitForInitialization();
       client.track('eventkey');

src/__tests__/LDClient-test.js

@@ -116,7 +116,7 @@ describe('LDClient', () => {
       expect(server.requests[0].url).toMatch(/sdk\/eval/);
     });
 
-    it('should resolve waitUntilGoalsReady when goals are loaded', done => {
+    it('should resolve waitUntilGoalsReady when goals are loaded', (done) => {
       const handleGoalsReady = jest.fn();
       const client = LDClient.initialize(envName, user, { bootstrap: {}, sendEvents: false });
 

src/__tests__/browserPlatform-test.js

@@ -95,7 +95,7 @@ describe('browserPlatform', () => {
     });
 
     it('calls URL transformer if specified', () => {
-      const p = browserPlatform({ eventUrlTransformer: url => url + '/x' });
+      const p = browserPlatform({ eventUrlTransformer: (url) => url + '/x' });
       expect(p.getCurrentUrl()).toEqual(expectedUrl + '/x');
     });
   });

src/__tests__/internal-test.js

@@ -1,12 +1,12 @@
 import { doesUrlMatch } from '../GoalTracker';
 
 describe('url matching', () => {
-  const getHash = url => {
+  const getHash = (url) => {
     const idx = url.indexOf('#');
     return idx === -1 ? '' : url.substring(idx, url.length);
   };
 
-  const getSearch = url => {
+  const getSearch = (url) => {
     const idx = url.indexOf('?');
     return idx === -1 ? '' : url.substring(idx, url.length);
   };
@@ -208,9 +208,9 @@ describe('url matching', () => {
     },
   ];
 
-  tests.forEach(method => {
+  tests.forEach((method) => {
     describe(method.type + ' matching', () => {
-      method.tests.forEach(each => {
+      method.tests.forEach((each) => {
         it(`expects \`${each.goal}\` to ${each.match ? 'match' : 'not match'} \`${each.path}\``, async () => {
           method.matcher(each.path, each.goal).toEqual(each.match);
         });

src/browserPlatform.js

@@ -25,7 +25,7 @@ export default function makeBrowserPlatform(options) {
   };
 
   // Image-based mechanism for sending events if POST isn't available
-  ret.httpFallbackPing = url => {
+  ret.httpFallbackPing = (url) => {
     const img = new window.Image();
     img.src = url;
   };
@@ -48,17 +48,17 @@ export default function makeBrowserPlatform(options) {
   try {
     if (window.localStorage) {
       ret.localStorage = {
-        get: key =>
-          new Promise(resolve => {
+        get: (key) =>
+          new Promise((resolve) => {
             resolve(window.localStorage.getItem(key));
           }),
         set: (key, value) =>
-          new Promise(resolve => {
+          new Promise((resolve) => {
             window.localStorage.setItem(key, value);
             resolve();
           }),
-        clear: key =>
-          new Promise(resolve => {
+        clear: (key) =>
+          new Promise((resolve) => {
             window.localStorage.removeItem(key);
             resolve();
           }),
@@ -116,7 +116,7 @@ export default function makeBrowserPlatform(options) {
       return new eventSourceConstructor(url, esOptions);
     };
 
-    ret.eventSourceIsActive = es =>
+    ret.eventSourceIsActive = (es) =>
       es.readyState === window.EventSource.OPEN || es.readyState === window.EventSource.CONNECTING;
   }
 

src/httpRequest.js

@@ -43,7 +43,7 @@ export default function newHttpRequest(method, url, headers, body, pageIsClosing
         }
         resolve({
           status: xhr.status,
-          header: key => xhr.getResponseHeader(key),
+          header: (key) => xhr.getResponseHeader(key),
           body: xhr.responseText,
         });
       });

src/index.js

@@ -21,7 +21,7 @@ export function initialize(env, user, options = {}) {
   const validatedOptions = clientVars.options;
   const emitter = clientVars.emitter;
 
-  const goalsPromise = new Promise(resolve => {
+  const goalsPromise = new Promise((resolve) => {
     const onGoals = emitter.on(goalsEvent, () => {
       emitter.off(goalsEvent, onGoals);
       resolve();