prepare 4.2.0 release (#72)

LaunchDarklyReleaseBot · eli-darkly · zmdavis · web-flow · commit b29d4d40a54a · 2022-10-03T13:03:50.000-07:00
* 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 * remove deprecated things (#48) * remove deprecated options and function * rm references to obsolete function * restore deprecation logic, just leave the data empty * remove samplingInterval from TS test code * fix TS test code again * fix EvaluationDetail.reason to be nullable so we can get rid of NonNullableLDEvaluationReason type (#49) * remove deprecated options and function * rm references to obsolete function * restore deprecation logic, just leave the data empty * remove samplingInterval from TS test code * fix TS test code again * fix EvaluationDetail.reason to be nullable so we can get rid of NonNullableLDEvaluationReason type * fix TS test code * re-bump uuid package (#50) * Revert "Revert "update uuid package version (#39)"" This reverts commit 89359b1bf4ddbe6b2fedb95f1dc11240483c60f7. * remove lockfile (sc-107301) * use regular User-Agent header name unless overridden by js-client-sdk (#52) * switch to publishing js-sdk-common as a regular Node module (#51) * fix CI * remove `version` constant which can't be exported from js-sdk-common (#53) * catch errors in JSON parsing of stream data (#54) * catch errors in JSON parsing of stream data * lint * backport sc-142333 fix * 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> * Releasing version 3.5.1 * rm obsolete file to fix merge * Releasing version 3.5.1 * make URL path concatenation work right whether base URL has a trailing slash or not (#61) * make URL path concatenation work right whether base URL has a trailing slash or not * lint * Implement support for application tags. (#55) * Fix typing of LDOptionsBase. (#63) * Implement application tags for 3.x. (#62) * lint * Add a line to refer to sendEventsOnlyForVariation * don't include deleted flags in allFlags (#66) * Enforce 64 character limit for tag value. (#68) * Enforce 64 character limit for tag value. * Lint. Comments. Remove unused param. * Remove the last seen cache, deprecate allowFrequentDuplicateEvents. (#73) 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> Co-authored-by: Ryan Lamb <4955475+kinyoklion@users.noreply.github.com>
diff --git a/src/__tests__/configuration-test.js b/src/__tests__/configuration-test.js
@@ -44,26 +44,24 @@ describe('configuration', () => {
     await listener.expectNoErrors();
   }
 
-  // As of the latest major version, there are no deprecated options. This logic can be restored
-  // the next time we deprecate something.
-  // function checkDeprecated(oldName, newName, value) {
-  //   const desc = newName
-  //     ? 'allows "' + oldName + '" as a deprecated equivalent to "' + newName + '"'
-  //     : 'warns that "' + oldName + '" is deprecated';
-  //   it(desc, async () => {
-  //     const listener = errorListener();
-  //     const config0 = {};
-  //     config0[oldName] = value;
-  //     const config1 = configuration.validate(config0, listener.emitter, null, listener.logger);
-  //     if (newName) {
-  //       expect(config1[newName]).toBe(value);
-  //       expect(config1[oldName]).toBeUndefined();
-  //     } else {
-  //       expect(config1[oldName]).toEqual(value);
-  //     }
-  //     await listener.expectWarningOnly(messages.deprecated(oldName, newName));
-  //   });
-  // }
+  function checkDeprecated(oldName, newName, value) {
+    const desc = newName
+      ? 'allows "' + oldName + '" as a deprecated equivalent to "' + newName + '"'
+      : 'warns that "' + oldName + '" is deprecated';
+    it(desc, async () => {
+      const listener = errorListener();
+      const config0 = {};
+      config0[oldName] = value;
+      const config1 = configuration.validate(config0, listener.emitter, null, listener.logger);
+      if (newName) {
+        expect(config1[newName]).toBe(value);
+        expect(config1[oldName]).toBeUndefined();
+      } else {
+        expect(config1[oldName]).toEqual(value);
+      }
+      await listener.expectWarningOnly(messages.deprecated(oldName, newName));
+    });
+  }
 
   function checkBooleanProperty(name) {
     it('enforces boolean type and default for "' + name + '"', async () => {
@@ -103,13 +101,14 @@ describe('configuration', () => {
   checkBooleanProperty('allAttributesPrivate');
   checkBooleanProperty('sendLDHeaders');
   checkBooleanProperty('inlineUsersInEvents');
-  checkBooleanProperty('allowFrequentDuplicateEvents');
   checkBooleanProperty('sendEventsOnlyForVariation');
   checkBooleanProperty('useReport');
   checkBooleanProperty('evaluationReasons');
   checkBooleanProperty('diagnosticOptOut');
   checkBooleanProperty('streaming');
 
+  checkDeprecated('allowFrequentDuplicateEvents', undefined, true);
+
   function checkNumericProperty(name, validValue) {
     it('enforces numeric type and default for "' + name + '"', async () => {
       await expectDefault(name);
diff --git a/src/__tests__/diagnosticEvents-test.js b/src/__tests__/diagnosticEvents-test.js
@@ -101,7 +101,6 @@ describe('DiagnosticsManager', () => {
   };
   const defaultConfigInEvent = {
     allAttributesPrivate: false,
-    allowFrequentDuplicateEvents: false,
     autoAliasingOptOut: false,
     bootstrapMode: false,
     customBaseURI: false,
@@ -189,7 +188,6 @@ describe('DiagnosticsManager', () => {
     it('sends init event on start() with custom config', async () => {
       const configAndResultValues = [
         [{ allAttributesPrivate: true }, { allAttributesPrivate: true }],
-        [{ allowFrequentDuplicateEvents: true }, { allowFrequentDuplicateEvents: true }],
         [{ bootstrap: {} }, { bootstrapMode: true }],
         [{ baseUrl: 'http://other' }, { customBaseURI: true }],
         [{ eventsUrl: 'http://other' }, { customEventsURI: true }],
diff --git a/src/configuration.js b/src/configuration.js
@@ -78,9 +78,10 @@ function validate(options, emitter, extraOptionDefs, logger) {
   const optionDefs = utils.extend({ logger: { default: logger } }, baseOptionDefs, extraOptionDefs);
 
   const deprecatedOptions = {
-    // As of the latest major version, there are no deprecated options. Next time we deprecate
-    // something, add an item here where the property name is the deprecated name, and the
-    // property value is the preferred name if any, or null/undefined if there is no replacement.
+    // The property name is the deprecated name, and the property value is the preferred name if
+    // any, or null/undefined if there is no replacement. This should be removed, along with
+    // the option, in the next major version.
+    allowFrequentDuplicateEvents: undefined,
   };
 
   function checkDeprecatedOptions(config) {
diff --git a/src/diagnosticEvents.js b/src/diagnosticEvents.js
@@ -201,7 +201,6 @@ function DiagnosticsManager(
       usingSecureMode: !!config.hash,
       bootstrapMode: !!config.bootstrap,
       fetchGoalsDisabled: !config.fetchGoals,
-      allowFrequentDuplicateEvents: !!config.allowFrequentDuplicateEvents,
       sendEventsOnlyForVariation: !!config.sendEventsOnlyForVariation,
       autoAliasingOptOut: !!config.autoAliasingOptOut,
     };
diff --git a/src/index.js b/src/index.js
@@ -63,7 +63,6 @@ function initialize(env, user, specifiedOptions, platform, extraOptionDefs) {
 
   const requestor = Requestor(platform, options, environment);
 
-  const seenRequests = {};
   let flags = {};
   let useLocalStorage;
   let streamActive;
@@ -181,15 +180,6 @@ function initialize(env, user, specifiedOptions, platform, extraOptionDefs) {
     const user = ident.getUser();
     const now = new Date();
     const value = detail ? detail.value : null;
-    if (!options.allowFrequentDuplicateEvents) {
-      const cacheKey = JSON.stringify(value) + (user && user.key ? user.key : '') + key; // see below
-      const cached = seenRequests[cacheKey];
-      // cache TTL is five minutes
-      if (cached && now - cached < 300000) {
-        return;
-      }
-      seenRequests[cacheKey] = now;
-    }
 
     const event = {
       kind: 'feature',
diff --git a/typings.d.ts b/typings.d.ts
@@ -173,10 +173,13 @@ declare module 'launchdarkly-js-sdk-common' {
     inlineUsersInEvents?: boolean;
 
     /**
-     * Whether or not to send an analytics event for a flag evaluation even if the same flag was
-     * evaluated with the same value within the last five minutes.
+     * This option is deprecated, and setting it has no effect.
      *
-     * By default, this is false (duplicate events within five minutes will be dropped).
+     * The behavior is now to allow frequent duplicate events.
+     *
+     * This is not a problem because most events will be summarized, and
+     * events which are not summarized are important to the operation of features such as
+     * experimentation.
      */
     allowFrequentDuplicateEvents?: boolean;
 
