launchdarkly-js-sdk-common 5.0.0-alpha.4 → 5.0.0-alpha.6

package/package.json

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

package/src/EventSummarizer.js

@@ -1,11 +1,24 @@
+const { getContextKinds } = require('./context');
+
+function getKinds(event) {
+  if (event.context) {
+    return getContextKinds(event.context);
+  }
+  if (event.contextKeys) {
+    return Object.keys(event.contextKeys);
+  }
+  return [];
+}
+
 function EventSummarizer() {
   const es = {};
 
   let startDate = 0,
     endDate = 0,
-    counters = {};
+    counters = {},
+    contextKinds = {};
 
-  es.summarizeEvent = function(event) {
+  es.summarizeEvent = event => {
     if (event.kind === 'feature') {
       const counterKey =
         event.key +
@@ -14,14 +27,21 @@ function EventSummarizer() {
         ':' +
         (event.version !== null && event.version !== undefined ? event.version : '');
       const counterVal = counters[counterKey];
+      let kinds = contextKinds[event.key];
+      if (!kinds) {
+        kinds = new Set();
+        contextKinds[event.key] = kinds;
+      }
+      getKinds(event).forEach(kind => kinds.add(kind));
+
       if (counterVal) {
         counterVal.count = counterVal.count + 1;
       } else {
         counters[counterKey] = {
           count: 1,
           key: event.key,
-          variation: event.variation,
           version: event.version,
+          variation: event.variation,
           value: event.value,
           default: event.default,
         };
@@ -35,16 +55,16 @@ function EventSummarizer() {
     }
   };
 
-  es.getSummary = function() {
+  es.getSummary = () => {
     const flagsOut = {};
     let empty = true;
-    for (const i in counters) {
-      const c = counters[i];
+    for (const c of Object.values(counters)) {
       let flag = flagsOut[c.key];
       if (!flag) {
         flag = {
           default: c.default,
           counters: [],
+          contextKinds: [...contextKinds[c.key]],
         };
         flagsOut[c.key] = flag;
       }
@@ -55,7 +75,7 @@ function EventSummarizer() {
       if (c.variation !== undefined && c.variation !== null) {
         counterOut.variation = c.variation;
       }
-      if (c.version) {
+      if (c.version !== undefined && c.version !== null) {
         counterOut.version = c.version;
       } else {
         counterOut.unknown = true;
@@ -72,10 +92,11 @@ function EventSummarizer() {
         };
   };
 
-  es.clearSummary = function() {
+  es.clearSummary = () => {
     startDate = 0;
     endDate = 0;
     counters = {};
+    contextKinds = {};
   };
 
   return es;

package/src/__tests__/EventProcessor-test.js

@@ -344,10 +344,12 @@ describe.each([
       expect(se.endDate).toEqual(2000);
       expect(se.features).toEqual({
         flagkey1: {
+          contextKinds: ['user'],
           default: 'default1',
           counters: [{ version: 11, variation: 1, value: 'value1', count: 1 }],
         },
         flagkey2: {
+          contextKinds: ['user'],
           default: 'default2',
           counters: [{ version: 22, variation: 1, value: 'value2', count: 1 }],
         },

package/src/__tests__/EventSummarizer-test.js

@@ -39,7 +39,7 @@ describe('EventSummarizer', () => {
       creationDate: 1000,
       key: key,
       version: version,
-      user: user,
+      context: user,
       variation: variation,
       value: value,
       default: defaultVal,
@@ -63,6 +63,7 @@ describe('EventSummarizer', () => {
     data.features.key1.counters.sort((a, b) => a.value - b.value);
     const expectedFeatures = {
       key1: {
+        contextKinds: ['user'],
         default: 111,
         counters: [
           { value: 100, variation: 1, version: 11, count: 2 },
@@ -70,10 +71,12 @@ describe('EventSummarizer', () => {
         ],
       },
       key2: {
+        contextKinds: ['user'],
         default: 222,
         counters: [{ value: 999, variation: 1, version: 22, count: 1 }],
       },
       badkey: {
+        contextKinds: ['user'],
         default: 333,
         counters: [{ value: 333, unknown: true, count: 1 }],
       },
@@ -94,10 +97,58 @@ describe('EventSummarizer', () => {
     data.features.key1.counters.sort((a, b) => a.value - b.value);
     const expectedFeatures = {
       key1: {
+        contextKinds: ['user'],
         default: 111,
         counters: [{ variation: 0, value: 100, version: 11, count: 1 }, { value: 111, version: 11, count: 2 }],
       },
     };
     expect(data.features).toEqual(expectedFeatures);
   });
+
+  it('includes keys from all kinds', () => {
+    const es = EventSummarizer();
+    const event1 = {
+      kind: 'feature',
+      creationDate: 1000,
+      key: 'key1',
+      version: 11,
+      context: { key: 'test' },
+      variation: 1,
+      value: 100,
+      default: 111,
+    };
+    const event2 = {
+      kind: 'feature',
+      creationDate: 1000,
+      key: 'key1',
+      version: 11,
+      context: { kind: 'org', key: 'test' },
+      variation: 1,
+      value: 100,
+      default: 111,
+    };
+    const event3 = {
+      kind: 'feature',
+      creationDate: 1000,
+      key: 'key1',
+      version: 11,
+      context: { kind: 'multi', bacon: { key: 'crispy' }, eggs: { key: 'scrambled' } },
+      variation: 1,
+      value: 100,
+      default: 111,
+    };
+    es.summarizeEvent(event1);
+    es.summarizeEvent(event2);
+    es.summarizeEvent(event3);
+    const data = es.getSummary();
+
+    const expectedFeatures = {
+      key1: {
+        default: 111,
+        counters: [{ variation: 1, value: 100, version: 11, count: 3 }],
+        contextKinds: ['user', 'org', 'bacon', 'eggs'],
+      },
+    };
+    expect(data.features).toEqual(expectedFeatures);
+  });
 });

package/src/context.js

@@ -3,6 +3,8 @@
  * @param {string} kind
  * @returns true if the kind is valid.
  */
+const { commonBasicLogger } = require('./loggers');
+
 function validKind(kind) {
   return typeof kind === 'string' && kind !== 'kind' && kind.match(/^(\w|\.|-)+$/);
 }
@@ -89,7 +91,7 @@ function getCanonicalKey(context) {
   }
 }
 
-function getContextKeys(context, logger) {
+function getContextKeys(context, logger = commonBasicLogger()) {
   if (!context) {
     return undefined;
   }
@@ -111,10 +113,10 @@ function getContextKeys(context, logger) {
         });
       break;
     case null:
-      logger?.warn(`null is not a valid context kind: ${context}`);
+      logger.warn(`null is not a valid context kind: ${context}`);
       break;
     case '':
-      logger?.warn(`'' is not a valid context kind: ${context}`);
+      logger.warn(`'' is not a valid context kind: ${context}`);
       break;
     default:
       keys[kind] = `${key}`;

package/test-types.ts

@@ -91,3 +91,5 @@ var flagSetValue: ld.LDFlagValue = flagSet['key'];
 
 client.close(() => {});
 client.close().then(() => {});
+
+var contextKeys = ld.getContextKeys(user);

package/typings.d.ts

@@ -984,6 +984,11 @@ declare module 'launchdarkly-js-sdk-common' {
    */
   export type LDLogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
 
+  export function getContextKeys(
+    context: LDContext,
+    logger?: LDLogger,
+  ): {[attribute: string]: string} | undefined;
+
   /**
    * Callback interface for collecting information about the SDK at runtime.
    *