prepare 5.1.0 release (#98)

## [5.1.0] - 2024-03-19
### Changed:
- Redact anonymous attributes within feature events
- Always inline contexts for feature events

### Fixed:
- Pin dev version of node to compatible types.

### Removed:
- HTTP fallback ping

---------

Co-authored-by: Eli Bishop <[email protected]>
Co-authored-by: LaunchDarklyCI <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Michael Siadak <[email protected]>
Co-authored-by: Ben Woskow <[email protected]>
Co-authored-by: Jeff Wen <[email protected]>
Co-authored-by: Andrey Krasnov <[email protected]>
Co-authored-by: Gavin Whelan <[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: Zach Davis <[email protected]>
Co-authored-by: Ryan Lamb <[email protected]>
Co-authored-by: Mateusz Sikora <[email protected]>
Co-authored-by: Yusinto Ngadiman <[email protected]>
Co-authored-by: Yusinto Ngadiman <[email protected]>
Co-authored-by: Ember Stevens <[email protected]>
Co-authored-by: Ember Stevens <[email protected]>
Co-authored-by: ld-repository-standards[bot] <113625520+ld-repository-standards[bot]@users.noreply.github.com>
Co-authored-by: Kane Parkinson <[email protected]>
Co-authored-by: Matthew M. Keeler <[email protected]>

Author: 18 people

CODEOWNERS

@@ -0,0 +1,2 @@
+# Repository Maintainers
+* @launchdarkly/team-sdk

README.md

@@ -4,7 +4,7 @@
 
 ## LaunchDarkly overview
 
-[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves over 100 billion feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
+[LaunchDarkly](https://www.launchdarkly.com) is a feature management platform that serves trillions of feature flags daily to help teams build better software, faster. [Get started](https://docs.launchdarkly.com/home/getting-started) using LaunchDarkly today!
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/launchdarkly.svg?style=social&label=Follow&maxAge=2592000)](https://twitter.com/intent/follow?screen_name=launchdarkly)
 
@@ -27,7 +27,7 @@ We encourage pull requests and other contributions from the community. Check out
     * Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
     * Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
     * Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
-* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+* LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
 * Explore LaunchDarkly
     * [launchdarkly.com](https://www.launchdarkly.com/ "LaunchDarkly Main Website") for more information
     * [docs.launchdarkly.com](https://docs.launchdarkly.com/  "LaunchDarkly Documentation") for our documentation and SDK reference guides

package.json

@@ -28,6 +28,7 @@
     "@babel/runtime": "7.6.3",
     "@rollup/plugin-replace": "^2.2.0",
     "@types/jest": "^27.4.1",
+    "@types/node": "12.12.6",
     "babel-eslint": "^10.1.0",
     "babel-jest": "^25.1.0",
     "cross-env": "^5.1.4",

src/ContextFilter.js

@@ -16,23 +16,27 @@ function ContextFilter(config) {
    * @param {Object} context
    * @returns {string[]} A list of the attributes to filter.
    */
-  const getAttributesToFilter = context =>
-    (allAttributesPrivate
+  const getAttributesToFilter = (context, redactAnonymous) =>
+    (allAttributesPrivate || (redactAnonymous && context.anonymous)
       ? Object.keys(context)
       : [...privateAttributes, ...((context._meta && context._meta.privateAttributes) || [])]
     ).filter(attr => !protectedAttributes.some(protectedAttr => AttributeReference.compare(attr, protectedAttr)));
 
   /**
    * @param {Object} context
+   * @param {boolean} redactAnonymous
    * @returns {Object} A copy of the context with private attributes removed,
    * and the redactedAttributes meta populated.
    */
-  const filterSingleKind = context => {
+  const filterSingleKind = (context, redactAnonymous) => {
     if (typeof context !== 'object' || context === null || Array.isArray(context)) {
       return undefined;
     }
 
-    const { cloned, excluded } = AttributeReference.cloneExcluding(context, getAttributesToFilter(context));
+    const { cloned, excluded } = AttributeReference.cloneExcluding(
+      context,
+      getAttributesToFilter(context, redactAnonymous)
+    );
     cloned.key = String(cloned.key);
     if (excluded.length) {
       if (!cloned._meta) {
@@ -57,18 +61,19 @@ function ContextFilter(config) {
 
   /**
    * @param {Object} context
+   * @param {boolean} redactAnonymous
    * @returns {Object} A copy of the context with the private attributes removed,
    * and the redactedAttributes meta populated for each sub-context.
    */
-  const filterMultiKind = context => {
+  const filterMultiKind = (context, redactAnonymous) => {
     const filtered = {
       kind: context.kind,
     };
     const contextKeys = Object.keys(context);
 
     for (const contextKey of contextKeys) {
       if (contextKey !== 'kind') {
-        const filteredContext = filterSingleKind(context[contextKey]);
+        const filteredContext = filterSingleKind(context[contextKey], redactAnonymous);
         if (filteredContext) {
           filtered[contextKey] = filteredContext;
         }
@@ -121,13 +126,13 @@ function ContextFilter(config) {
     return filtered;
   };
 
-  filter.filter = context => {
+  filter.filter = (context, redactAnonymous = false) => {
     if (context.kind === undefined || context.kind === null) {
-      return filterSingleKind(legacyToSingleKind(context));
+      return filterSingleKind(legacyToSingleKind(context), redactAnonymous);
     } else if (context.kind === 'multi') {
-      return filterMultiKind(context);
+      return filterMultiKind(context, redactAnonymous);
     } else {
-      return filterSingleKind(context);
+      return filterSingleKind(context, redactAnonymous);
     }
   };
 

src/EventProcessor.js

@@ -50,6 +50,9 @@ function EventProcessor(
     if (e.kind === 'identify') {
       // identify events always have an inline context
       ret.context = contextFilter.filter(e.context);
+    } else if (e.kind === 'feature') {
+      // feature events always have an inline context
+      ret.context = contextFilter.filter(e.context, true);
     } else {
       ret.contextKeys = getContextKeysFromEvent(e);
       delete ret['context'];
@@ -136,8 +139,7 @@ function EventProcessor(
     }
     queue = [];
     logger.debug(messages.debugPostingEvents(eventsToSend.length));
-    return eventSender.sendEvents(eventsToSend, mainEventsUrl).then(responses => {
-      const responseInfo = responses && responses[0];
+    return eventSender.sendEvents(eventsToSend, mainEventsUrl).then(responseInfo => {
       if (responseInfo) {
         if (responseInfo.serverTime) {
           lastKnownPastTime = responseInfo.serverTime;

src/EventSender.js

@@ -3,12 +3,8 @@ const utils = require('./utils');
 const { v1: uuidv1 } = require('uuid');
 const { getLDHeaders, transformHeaders } = require('./headers');
 
-const MAX_URL_LENGTH = 2000;
-
 function EventSender(platform, environmentId, options) {
-  const imageUrlPath = '/a/' + environmentId + '.gif';
   const baseHeaders = utils.extend({ 'Content-Type': 'application/json' }, getLDHeaders(platform, options));
-  const httpFallbackPing = platform.httpFallbackPing; // this will be set for us if we're in the browser SDK
   const sender = {};
 
   function getResponseInfo(result) {
@@ -23,7 +19,11 @@ function EventSender(platform, environmentId, options) {
     return ret;
   }
 
-  sender.sendChunk = (events, url, isDiagnostic, usePost) => {
+  sender.sendEvents = (events, url, isDiagnostic) => {
+    if (!platform.httpRequest) {
+      return Promise.resolve();
+    }
+
     const jsonBody = JSON.stringify(events);
     const payloadId = isDiagnostic ? null : uuidv1();
 
@@ -55,31 +55,7 @@ function EventSender(platform, environmentId, options) {
         });
     }
 
-    if (usePost) {
-      return doPostRequest(true).catch(() => {});
-    } else {
-      httpFallbackPing && httpFallbackPing(url + imageUrlPath + '?d=' + utils.base64URLEncode(jsonBody));
-      return Promise.resolve(); // we don't wait for this request to complete, it's just a one-way ping
-    }
-  };
-
-  sender.sendEvents = function(events, url, isDiagnostic) {
-    if (!platform.httpRequest) {
-      return Promise.resolve();
-    }
-    const canPost = platform.httpAllowsPost();
-    let chunks;
-    if (canPost) {
-      // no need to break up events into chunks if we can send a POST
-      chunks = [events];
-    } else {
-      chunks = utils.chunkEventsForUrl(MAX_URL_LENGTH - url.length, events);
-    }
-    const results = [];
-    for (let i = 0; i < chunks.length; i++) {
-      results.push(sender.sendChunk(chunks[i], url, isDiagnostic, canPost));
-    }
-    return Promise.all(results);
+    return doPostRequest(true).catch(() => {});
   };
 
   return sender;

src/__tests__/ContextFilter-test.js

@@ -283,6 +283,11 @@ describe('when handling single kind contexts', () => {
     expect(uf.filter(anonymousContext)).toEqual(contextWithAllAttrsHidden);
   });
 
+  it('all attributes are redacted when anonymous', () => {
+    const uf = ContextFilter({});
+    expect(uf.filter(anonymousContext, true)).toEqual(contextWithAllAttrsHidden);
+  });
+
   it('converts non-boolean anonymous to boolean.', () => {
     const uf = ContextFilter({});
     expect(uf.filter({ kind: 'user', key: 'user', anonymous: 'string' })).toEqual({
@@ -330,6 +335,7 @@ describe('when handling mult-kind contexts', () => {
     user: {
       key: 'abc',
       name: 'alphabet',
+      anonymous: true,
       letters: ['a', 'b', 'c'],
       order: 3,
       object: {
@@ -342,6 +348,25 @@ describe('when handling mult-kind contexts', () => {
     },
   };
 
+  const orgAndUserContextWithAnonymousRedaction = {
+    kind: 'multi',
+    organization: {
+      key: 'LD',
+      rocks: true,
+      name: 'name',
+      department: {
+        name: 'sdk',
+      },
+    },
+    user: {
+      key: 'abc',
+      anonymous: true,
+      _meta: {
+        redactedAttributes: ['/letters', '/name', '/object', '/order'],
+      },
+    },
+  };
+
   const orgAndUserContextAllPrivate = {
     kind: 'multi',
     organization: {
@@ -352,6 +377,7 @@ describe('when handling mult-kind contexts', () => {
     },
     user: {
       key: 'abc',
+      anonymous: true,
       _meta: {
         redactedAttributes: ['/letters', '/name', '/object', '/order'],
       },
@@ -373,6 +399,7 @@ describe('when handling mult-kind contexts', () => {
     user: {
       key: 'abc',
       order: 3,
+      anonymous: true,
       object: {
         a: 'a',
       },
@@ -395,6 +422,7 @@ describe('when handling mult-kind contexts', () => {
     user: {
       key: 'abc',
       name: 'alphabet',
+      anonymous: true,
       order: 3,
       object: {
         a: 'a',
@@ -415,6 +443,11 @@ describe('when handling mult-kind contexts', () => {
     expect(uf.filter(orgAndUserContext)).toEqual(orgAndUserContextAllPrivate);
   });
 
+  it('it should remove attributes from all anonymous contexts', () => {
+    const uf = ContextFilter({});
+    expect(uf.filter(orgAndUserContext, true)).toEqual(orgAndUserContextWithAnonymousRedaction);
+  });
+
   it('it should apply private attributes from the context to the context.', () => {
     const uf = ContextFilter({});
     expect(uf.filter(orgAndUserContext)).toEqual(orgAndUserContextIncludedPrivate);

src/__tests__/EventProcessor-test.js

@@ -75,7 +75,7 @@ describe.each([
     expect(e.value).toEqual(source.value);
     expect(e.default).toEqual(source.default);
     expect(e.reason).toEqual(source.reason);
-    checkUserInline(e, source, inlineUser);
+    expect(e.context).toEqual(inlineUser);
   }
 
   function checkCustomEvent(e, source) {
@@ -136,7 +136,7 @@ describe.each([
       expect(mockEventSender.calls.length()).toEqual(1);
       const output = (await mockEventSender.calls.take()).events;
       expect(output.length).toEqual(2);
-      checkFeatureEvent(output[0], event, false);
+      checkFeatureEvent(output[0], event, false, eventContext);
       checkSummaryEvent(output[1]);
     });
   });
@@ -159,7 +159,7 @@ describe.each([
       expect(mockEventSender.calls.length()).toEqual(1);
       const output = (await mockEventSender.calls.take()).events;
       expect(output.length).toEqual(2);
-      checkFeatureEvent(output[0], event, false);
+      checkFeatureEvent(output[0], event, false, eventContext);
       checkSummaryEvent(output[1]);
     });
   });
@@ -236,7 +236,7 @@ describe.each([
       expect(mockEventSender.calls.length()).toEqual(1);
       const output = (await mockEventSender.calls.take()).events;
       expect(output.length).toEqual(3);
-      checkFeatureEvent(output[0], e, false);
+      checkFeatureEvent(output[0], e, false, { ...context, kind: context.kind || 'user' });
       checkFeatureEvent(output[1], e, true, { ...context, kind: context.kind || 'user' });
       checkSummaryEvent(output[2]);
     });