launchdarkly-js-sdk-common 4.1.0 → 4.2.0

package/.ldrelease/config.yml

@@ -5,7 +5,7 @@ repo:
   private: js-sdk-common-private
 
 branches:
-  - name: master
+  - name: main
     description: 4.x
   - name: 3.x
 

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to the `launchdarkly-js-sdk-common` package will be documented in this file. Changes that affect the dependent SDKs such as `launchdarkly-js-client-sdk` should also be logged in those projects, in the next release that uses the updated version of this package. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [4.1.1] - 2022-06-07
+### Changed:
+- Enforce a 64 character limit for `application.id` and `application.version` configuration options.
+
+### Fixed:
+- Do not include deleted flags in `allFlags`.
+
+## [4.1.0] - 2022-04-21
+### Added:
+- `LDOptionsBase.application`, for configuration of application metadata that may be used in LaunchDarkly analytics or other product features. This does not affect feature flag evaluations.
+
+### Fixed:
+- The `baseUrl`, `streamUrl`, and `eventsUrl` properties now work properly regardless of whether the URL string has a trailing slash. Previously, a trailing slash would cause request URL paths to have double slashes.
+
 ## [4.0.3] - 2022-02-16
 ### Fixed:
 - If the SDK receives invalid JSON data from a streaming connection (possibly as a result of the connection being cut off), it now uses its regular error-handling logic: the error is emitted as an `error` event or, if there are no `error` event listeners, it is logged. Previously, it would be thrown as an unhandled exception.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "launchdarkly-js-sdk-common",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "LaunchDarkly SDK for JavaScript - common code",
   "author": "LaunchDarkly <team@launchdarkly.com>",
   "license": "Apache-2.0",

package/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);
@@ -230,6 +229,13 @@ describe('configuration', () => {
     await listener.expectWarningOnly(messages.invalidTagValue('application.id'));
   });
 
+  it('logs a warning when a tag value is too long', async () => {
+    const listener = errorListener();
+    const configIn = { application: { id: 'a'.repeat(65), version: 'b'.repeat(64) } };
+    expect(configuration.validate(configIn, listener.emitter, null, listener.logger).application.id).toBeUndefined();
+    await listener.expectWarningOnly(messages.tagValueTooLong('application.id'));
+  });
+
   it('handles a valid application version', async () => {
     const listener = errorListener();
     const configIn = { application: { version: 'test-version' } };

package/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 }],

package/src/configuration.js

@@ -48,24 +48,28 @@ const allowedTagCharacters = /^(\w|\.|-)+$/;
 
 /**
  * Verify that a value meets the requirements for a tag value.
- * @param {Object} config
  * @param {string} tagValue
+ * @param {Object} logger
  */
-function validateTagValue(name, config, tagValue, logger) {
+function validateTagValue(name, tagValue, logger) {
   if (typeof tagValue !== 'string' || !tagValue.match(allowedTagCharacters)) {
     logger.warn(messages.invalidTagValue(name));
     return undefined;
   }
+  if (tagValue.length > 64) {
+    logger.warn(messages.tagValueTooLong(name));
+    return undefined;
+  }
   return tagValue;
 }
 
-function applicationConfigValidator(name, config, value, logger) {
+function applicationConfigValidator(name, value, logger) {
   const validated = {};
   if (value.id) {
-    validated.id = validateTagValue(`${name}.id`, config, value.id, logger);
+    validated.id = validateTagValue(`${name}.id`, value.id, logger);
   }
   if (value.version) {
-    validated.version = validateTagValue(`${name}.version`, config, value.version, logger);
+    validated.version = validateTagValue(`${name}.version`, value.version, logger);
   }
   return validated;
 }
@@ -74,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) {
@@ -136,7 +141,7 @@ function validate(options, emitter, extraOptionDefs, logger) {
           const expectedType = optionDef.type || typeDescForValue(optionDef.default);
           const validator = optionDef.validator;
           if (validator) {
-            const validated = validator(name, config, config[name], logger);
+            const validated = validator(name, config[name], logger);
             if (validated !== undefined) {
               ret[name] = validated;
             } else {

package/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,
     };

package/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',
@@ -313,7 +303,7 @@ function initialize(env, user, specifiedOptions, platform, extraOptionDefs) {
     }
 
     for (const key in flags) {
-      if (utils.objectHasOwnProperty(flags, key)) {
+      if (utils.objectHasOwnProperty(flags, key) && !flags[key].deleted) {
         results[key] = variationDetailInternal(key, null, !options.sendEventsOnlyForVariation).value;
       }
     }

package/src/messages.js

@@ -182,6 +182,8 @@ const debugPostingDiagnosticEvent = function(event) {
 
 const invalidTagValue = name => `Config option "${name}" must only contain letters, numbers, ., _ or -.`;
 
+const tagValueTooLong = name => `Value of "${name}" was longer than 64 characters and was discarded.`;
+
 module.exports = {
   bootstrapInvalid,
   bootstrapOldFormat,
@@ -217,6 +219,7 @@ module.exports = {
   streamClosing,
   streamConnecting,
   streamError,
+  tagValueTooLong,
   unknownCustomEventKey,
   unknownOption,
   userNotSpecified,

package/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;
 
@@ -701,7 +704,8 @@ declare module 'launchdarkly-js-sdk-common' {
     alias(user: LDUser, previousUser: LDUser): void;
 
     /**
-     * Returns a map of all available flags to the current user's values.
+     * Returns a map of all available flags to the current user's values. This will send analytics
+     * events unless [[LDOptions.sendEventsOnlyForVariation]] is true.
      *
      * @returns
      *   An object in which each key is a feature flag key and each value is the flag value.