prepare 3.0.0 release (#264)

* 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) * Switch to 5.0 of the SDK common. * Use a combination of dependencies that is compatible. (#269) * Use a combination of dependencies that is compatible. (#269) (#270) * Update js-sdk-common to 3.7.0 (#271) * Update node version used during release. (#272) * Update common to 3.8.1 (#273) * Update common version for jitter and backoff. (#274) * Update typedoc and make associated documentation changes. (#275) * Update to prerelease package. (#276) * Update release config to use node 14. * Update typedoc and make associated documentation changes. (#275) (#277) * Update to pre-release common 5.0.0-alpha.2 * Update typings.d.ts (#278) Co-authored-by: Yusinto Ngadiman <[email protected]> * Update to js-sdk-common 5.0.0-alpha.3 * [sc-177790] Replaced getUser with getContext (#279) * Replaced getUser with getContext * Remove contextKind * Update GoalManager.js Co-authored-by: Yusinto Ngadiman <[email protected]> * Update GoalManager.js (#280) * Switch to 5.0 of the SDK common. * Use a combination of dependencies that is compatible. (#269) * Update to prerelease package. (#276) * Update release config to use node 14. * Update typedoc and make associated documentation changes. (#275) (#277) * Update to pre-release common 5.0.0-alpha.2 * Update typings.d.ts (#278) Co-authored-by: Yusinto Ngadiman <[email protected]> * Update to js-sdk-common 5.0.0-alpha.3 * [sc-177790] Replaced getUser with getContext (#279) * Replaced getUser with getContext * Remove contextKind * Update GoalManager.js Co-authored-by: Yusinto Ngadiman <[email protected]> * Update GoalManager.js Co-authored-by: Ryan Lamb <[email protected]> Co-authored-by: Yusinto Ngadiman <[email protected]> * Update GoalManager.js (#281) Co-authored-by: Yusinto Ngadiman <[email protected]> * Update SDK common version. (#282) * Update release metadata. Co-authored-by: Ben Woskow <[email protected]> Co-authored-by: Eli Bishop <[email protected]> Co-authored-by: LaunchDarklyCI <[email protected]> Co-authored-by: Gavin Whelan <[email protected]> Co-authored-by: Ben Woskow <[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]> Co-authored-by: Yusinto Ngadiman <[email protected]> Co-authored-by: Yusinto Ngadiman <[email protected]>
launchdarkly · Dec 7, 2022 · 7548768 · 7548768
1 parent 874b105
commit 7548768
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 43 deletions.
diff --git a/.ldrelease/config.yml b/.ldrelease/config.yml
@@ -4,6 +4,11 @@ repo:
   public: js-client-sdk
   private: js-client-sdk-private
 
+branches:
+- name: main
+  description: 3.x
+- name: 2.x
+
 publications:
   - url: https://www.npmjs.com/package/launchdarkly-js-client-sdk
     description: npm

diff --git a/example/example.js b/example/example.js
@@ -139,13 +139,13 @@ $(function() {
   // client.variation() to get individual values by flag key, but here we are iterating through them all.
 
   function showAllFlags(changes) {
-    var userJson = JSON.stringify(client.getUser(), null, ' ');
+    var contextJson = JSON.stringify(client.getContext(), null, ' ');
     var allFlags = client.allFlags();
     var keys = Object.keys(allFlags).sort();
 
     $content = $('<div></div>');
     $content.append('These are the feature flag values from the current environment for the user:');
-    $content.append($('<code></code>').text(' ' + userJson)).append('<br><br>');
+    $content.append($('<code></code>').text(' ' + contextJson)).append('<br><br>');
 
     var $table = $('<table></table>').addClass('table').addClass('table-sm');
     var $thead = $('<thead></thead>');

diff --git a/jest.config.js b/jest.config.js
@@ -9,6 +9,9 @@ module.exports = {
   transform: {
     '^.+\\.js$': ['babel-jest', { rootMode: 'upward' }],
   },
+  transformIgnorePatterns: [
+    "node_modules/(?!uuid)"
+  ],
   globals: {
     window: true,
     VERSION: version,

diff --git a/package.json b/package.json
@@ -77,7 +77,7 @@
   },
   "dependencies": {
     "escape-string-regexp": "^4.0.0",
-    "launchdarkly-js-sdk-common": "3.8.2"
+    "launchdarkly-js-sdk-common": "5.0.0"
   },
   "repository": {
     "type": "git",

diff --git a/src/GoalManager.js b/src/GoalManager.js
@@ -23,20 +23,16 @@ export default function GoalManager(clientVars, readyCallback) {
   }
 
   function sendGoalEvent(kind, goal) {
-    const user = clientVars.ident.getUser();
+    const context = clientVars.ident.getContext();
     const event = {
       kind: kind,
       key: goal.key,
       data: null,
       url: window.location.href,
-      user: user,
       creationDate: new Date().getTime(),
+      contextKeys: common.getContextKeys(context),
     };
 
-    if (user && user.anonymous) {
-      event.contextKind = 'anonymousUser';
-    }
-
     if (kind === 'click') {
       event.selector = goal.selector;
     }

diff --git a/src/__tests__/LDClient-events-test.js b/src/__tests__/LDClient-events-test.js
@@ -40,7 +40,7 @@ describe('LDClient', () => {
       const trackEvent = ep.events[1];
       expect(trackEvent.kind).toEqual('custom');
       expect(trackEvent.key).toEqual('eventkey');
-      expect(trackEvent.user).toEqual(user);
+      expect(trackEvent.context).toEqual(user);
       expect(trackEvent.data).toEqual(data);
       expect(trackEvent.url).toEqual(urlShouldBe);
     });
@@ -74,7 +74,7 @@ describe('LDClient', () => {
       const trackEvent = ep.events[1];
       expect(trackEvent.kind).toEqual('custom');
       expect(trackEvent.key).toEqual('eventkey');
-      expect(trackEvent.user).toEqual(user);
+      expect(trackEvent.context).toEqual(user);
       expect(trackEvent.url).toEqual(urlShouldBe);
     });
   });

diff --git a/src/browserPlatform.js b/src/browserPlatform.js
@@ -1,7 +1,9 @@
 import newHttpRequest from './httpRequest';
 
 export default function makeBrowserPlatform(options) {
-  const ret = {};
+  const ret = {
+    userAgentHeaderName: 'X-LaunchDarkly-User-Agent',
+  };
 
   ret.synchronousFlush = false; // this will be set to true by index.js if the page is closing
 

diff --git a/test-types.ts b/test-types.ts
@@ -4,11 +4,13 @@
 
 import * as ld from 'launchdarkly-js-client-sdk';
 
-var ver: string = ld.version;
+import LaunchDarkly from 'launchdarkly-js-client-sdk';
 
-var emptyOptions: ld.LDOptions = {};
-var logger: ld.LDLogger = ld.basicLogger({ level: 'info' });
-var allOptions: ld.LDOptions = {
+const ver: string = LaunchDarkly.version;
+
+const emptyOptions: ld.LDOptions = {};
+const logger: ld.LDLogger = ld.basicLogger({ level: 'info' });
+const allOptions: ld.LDOptions = {
   bootstrap: { },
   hash: '',
   baseUrl: '',
@@ -21,21 +23,17 @@ var allOptions: ld.LDOptions = {
   fetchGoals: true,
   sendEvents: true,
   allAttributesPrivate: true,
-  privateAttributeNames: [ 'x' ],
-  inlineUsersInEvents: true,
-  allowFrequentDuplicateEvents: true,
+  privateAttributes: [ 'x' ],
   sendEventsOnlyForVariation: true,
   flushInterval: 1,
-  samplingInterval: 1,
   streamReconnectDelay: 1,
   eventUrlTransformer: url => url + 'x',
   disableSyncEventPost: true,
   logger: logger,
-  autoAliasingOptOut: true
 };
-var userWithKeyOnly: ld.LDUser = { key: 'user' };
-var anonymousUser: ld.LDUser = { key: 'anon-user', anonymous: true };
-var user: ld.LDUser = {
+const userWithKeyOnly: ld.LDUser = { key: 'user' };
+const anonymousUser: ld.LDUser = { key: 'anon-user', anonymous: true };
+const user: ld.LDUser = {
   key: 'user',
   name: 'name',
   firstName: 'first',
@@ -55,7 +53,35 @@ var user: ld.LDUser = {
   },
   privateAttributeNames: [ 'name', 'email' ]
 };
-var client: ld.LDClient = ld.initialize('env', user, allOptions);
+
+const singleKindContext: ld.LDContext = {
+  kind: 'user',
+  key: 'user',
+  aCustomValue: {
+    some: 'value'
+  },
+  _meta: {
+    privateAttributes: ['aCustomValue']
+  }
+}
+
+const multiKindContext: ld.LDContext = {
+  kind: 'multi',
+  user: {
+    key: 'user',
+    aCustomValue: {
+      some: 'value'
+    },
+    _meta: {
+      privateAttributes: ['aCustomValue']
+    }
+  },
+  device: {
+    key: 'device'
+  }
+}
+
+const client: ld.LDClient = ld.initialize('env', user, allOptions);
 
 client.waitUntilReady().then(() => {});
 client.waitForInitialization().then(() => {});
@@ -65,21 +91,27 @@ client.identify(user).then(() => {});
 client.identify(user, undefined, () => {});
 client.identify(user, 'hash').then(() => {});
 
-client.alias(user, anonymousUser);
+client.identify(singleKindContext).then(() => {});
+client.identify(singleKindContext, undefined, () => {});
+client.identify(singleKindContext, 'hash').then(() => {});
+
+client.identify(multiKindContext).then(() => {});
+client.identify(multiKindContext, undefined, () => {});
+client.identify(multiKindContext, 'hash').then(() => {});
 
-var user: ld.LDUser = client.getUser();
+const context: ld.LDContext = client.getContext();
 
 client.flush(() => {});
 client.flush().then(() => {});
 
-var boolFlagValue: ld.LDFlagValue = client.variation('key', false);
-var numberFlagValue: ld.LDFlagValue = client.variation('key', 2);
-var stringFlagValue: ld.LDFlagValue = client.variation('key', 'default');
+const boolFlagValue: ld.LDFlagValue = client.variation('key', false);
+const numberFlagValue: ld.LDFlagValue = client.variation('key', 2);
+const stringFlagValue: ld.LDFlagValue = client.variation('key', 'default');
 
-var detail: ld.LDEvaluationDetail = client.variationDetail('key', 'default');
-var detailValue: ld.LDFlagValue = detail.value;
-var detailIndex: number | undefined = detail.variationIndex;
-var detailReason: ld.LDEvaluationReason = detail.reason;
+const detail: ld.LDEvaluationDetail = client.variationDetail('key', 'default');
+const detailValue: ld.LDFlagValue = detail.value;
+const detailIndex: number | undefined = detail.variationIndex;
+const detailReason: ld.LDEvaluationReason | undefined = detail.reason;
 
 client.setStreaming(true);
 client.setStreaming();
@@ -92,8 +124,8 @@ client.track('event');
 client.track('event', { someData: 'x' });
 client.track('event', null, 3.5);
 
-var flagSet: ld.LDFlagSet = client.allFlags();
-var flagSetValue: ld.LDFlagValue = flagSet['key'];
+const flagSet: ld.LDFlagSet = client.allFlags();
+const flagSetValue: ld.LDFlagValue = flagSet['key'];
 
 client.close(() => {});
 client.close().then(() => {});
diff --git a/typings.d.ts b/typings.d.ts
@@ -6,9 +6,9 @@ declare module 'launchdarkly-js-client-sdk' {
   import {
     BasicLoggerOptions,
     LDClientBase,
+    LDContext,
     LDLogger,
     LDOptionsBase,
-    LDUser
   } from 'launchdarkly-js-sdk-common';
 //// DOCBUILD-END-REPLACE
 
@@ -24,28 +24,28 @@ declare module 'launchdarkly-js-client-sdk' {
    *
    *     // Preferred usage:
    *     import { initialize } from 'launchdarkly-js-client-sdk';
-   *     const client = initialize(envKey, user, options);
+   *     const client = initialize(envKey, context, options);
    *
    *     // Deprecated usage:
    *     import LaunchDarkly from 'launchdarkly-js-client-sdk';
    *     const client = LaunchDarkly.initialize(envKey, user, options);
    *
    * @param envKey
    *   The environment ID.
-   * @param user
-   *   The initial user properties. These can be changed later with [[LDClient.identify]].
+   * @param context
+   *   The initial context properties. These can be changed later with [[LDClient.identify]].
    * @param options
    *   Optional configuration settings.
    * @return
    *   The new client instance.
    */
-  export function initialize(envKey: string, user: LDUser, options?: LDOptions): LDClient;
+  export function initialize(envKey: string, context: LDContext, options?: LDOptions): LDClient;
 
   // This is @ignored because TypeDoc does not show default exports correctly. We'll just explain
   // the export situation in the comment for initialize().
   /** @ignore */
   const LaunchDarkly: {
-    initialize: (envKey: string, user: LDUser, options?: LDOptions) => LDClient;
+    initialize: (envKey: string, context: LDContext, options?: LDOptions) => LDClient;
     version: string;
   };
 
@@ -57,7 +57,7 @@ declare module 'launchdarkly-js-client-sdk' {
    */
   export interface LDOptions extends LDOptionsBase {
     /**
-     * The signed user key for Secure Mode.
+     * The signed context key for Secure Mode.
      *
      * For more information, see the JavaScript SDK Reference Guide on
      * [Secure mode](https://docs.launchdarkly.com/sdk/features/secure-mode#configuring-secure-mode-in-the-javascript-client-side-sdk).