Merge branch 'rlamb/EMSR-326/per-context-summary-events' into rlamb/5.7.0-prerelease

Author: kinyoklion

src/EventProcessor.js

@@ -124,7 +124,7 @@ function EventProcessor(
     const eventsToSend = queue;
     const summaries = await summarizer.getSummaries();
 
-    summaries.forEach((summary) => {
+    summaries.forEach(summary => {
       if (Object.keys(summary.features).length) {
         eventsToSend.push(summary);
       }

src/MultiEventSummarizer.js

@@ -1,76 +1,76 @@
 import { hashContext } from './context';
 import EventSummarizer from './EventSummarizer';
 /**
- * 
- * @param {{filter: (context: any) => any}} contextFilter 
- * @param {() => {update: (value: string) => void, digest: (format: string) => Promise<string>}} hasherFactory 
+ *
+ * @param {{filter: (context: any) => any}} contextFilter
+ * @param {() => {update: (value: string) => void, digest: (format: string) => Promise<string>}} hasherFactory
  */
 function MultiEventSummarizer(contextFilter, hasherFactory) {
-    let summarizers = {};
-    let contexts = {};
-    const pendingPromises = [];
+  let summarizers = {};
+  let contexts = {};
+  const pendingPromises = [];
 
-    /**
-     * Summarize the given event.
-     * @param {{
-     *   kind: string,
-     *   context?: any,
-     * }} event 
-     */
-    function summarizeEvent(event) {
-        // This will execute asynchronously, which means that a flush could happen before the event
-        // is summarized. When that happens, then the event will just be in the next batch of summaries.
-        const promise = (async () => {
-            if(event.kind === 'feature') {
-                const hash = await hashContext(event.context, hasherFactory());
-                if(!hash) {
-                    return;
-                }
+  /**
+   * Summarize the given event.
+   * @param {{
+   *   kind: string,
+   *   context?: any,
+   * }} event
+   */
+  function summarizeEvent(event) {
+    // This will execute asynchronously, which means that a flush could happen before the event
+    // is summarized. When that happens, then the event will just be in the next batch of summaries.
+    const promise = (async () => {
+      if (event.kind === 'feature') {
+        const hash = await hashContext(event.context, hasherFactory());
+        if (!hash) {
+          return;
+        }
 
-                let summarizer = summarizers[hash];
-                if(!summarizer) {
-                    summarizers[hash] = EventSummarizer();
-                    summarizer = summarizers[hash];
-                    contexts[hash] = event.context;
-                }
-                
-                summarizer.summarizeEvent(event);
-            }
-        })();
-        pendingPromises.push(promise);
-        promise.finally(() => {
-            const index = pendingPromises.indexOf(promise);
-            if(index !== -1) {
-                pendingPromises.splice(index, 1);
-            }
-        });
-    }
+        let summarizer = summarizers[hash];
+        if (!summarizer) {
+          summarizers[hash] = EventSummarizer();
+          summarizer = summarizers[hash];
+          contexts[hash] = event.context;
+        }
 
-    /**
-     * Get the summaries of the events that have been summarized.
-     * @returns {any[]}
-     */
-    async function getSummaries() {
-        // Wait for any pending summarizations to complete
-        // Additional tasks queued while waiting will not be waited for.
-        await Promise.all([...pendingPromises]);
+        summarizer.summarizeEvent(event);
+      }
+    })();
+    pendingPromises.push(promise);
+    promise.finally(() => {
+      const index = pendingPromises.indexOf(promise);
+      if (index !== -1) {
+        pendingPromises.splice(index, 1);
+      }
+    });
+  }
 
-        const summarizersToFlush = summarizers;
-        const contextsForSummaries = contexts;
+  /**
+   * Get the summaries of the events that have been summarized.
+   * @returns {any[]}
+   */
+  async function getSummaries() {
+    // Wait for any pending summarizations to complete
+    // Additional tasks queued while waiting will not be waited for.
+    await Promise.all([...pendingPromises]);
 
-        summarizers = {};
-        contexts = {};
-        return Object.entries(summarizersToFlush).map(([hash, summarizer]) => {
-            const summary = summarizer.getSummary();
-            summary.context = contextFilter.filter(contextsForSummaries[hash]);
-            return summary;
-        }); 
-    }
+    const summarizersToFlush = summarizers;
+    const contextsForSummaries = contexts;
 
-    return {
-        summarizeEvent,
-        getSummaries
-    };
+    summarizers = {};
+    contexts = {};
+    return Object.entries(summarizersToFlush).map(([hash, summarizer]) => {
+      const summary = summarizer.getSummary();
+      summary.context = contextFilter.filter(contextsForSummaries[hash]);
+      return summary;
+    });
+  }
+
+  return {
+    summarizeEvent,
+    getSummaries,
+  };
 }
 
-module.exports = MultiEventSummarizer;
+module.exports = MultiEventSummarizer;

src/__tests__/MultiEventSummarizer-test.js

@@ -2,14 +2,12 @@ const MultiEventSummarizer = require('../MultiEventSummarizer');
 const ContextFilter = require('../ContextFilter');
 
 function mockHasher() {
-  let state = "";
+  let state = '';
   return {
-    update: (input) => {
+    update: input => {
       state += input;
     },
-    digest: () => {
-      return state;
-    },
+    digest: () => state,
   };
 }
 
@@ -35,7 +33,7 @@ describe('with mocked crypto and hasher', () => {
     summarizer = MultiEventSummarizer(contextFilter, mockHasher);
   });
 
-  test('creates new summarizer for new context hash', async () => {
+  it('creates new summarizer for new context hash', async () => {
     const context = { kind: 'user', key: 'user1' };
     const event = { kind: 'feature', context };
 
@@ -45,7 +43,7 @@ describe('with mocked crypto and hasher', () => {
     expect(summaries).toHaveLength(1);
   });
 
-  test('uses existing summarizer for same context hash', async () => {
+  it('uses existing summarizer for same context hash', async () => {
     const context = { kind: 'user', key: 'user1' };
     const event1 = { kind: 'feature', context, value: 'value1' };
     const event2 = { kind: 'feature', context, value: 'value2' };
@@ -57,7 +55,7 @@ describe('with mocked crypto and hasher', () => {
     expect(summaries).toHaveLength(1);
   });
 
-  test('ignores non-feature events', async () => {
+  it('ignores non-feature events', async () => {
     const context = { kind: 'user', key: 'user1' };
     const event = { kind: 'identify', context };
 
@@ -67,7 +65,7 @@ describe('with mocked crypto and hasher', () => {
     expect(summaries).toHaveLength(0);
   });
 
-  test('handles multiple different contexts', async () => {
+  it('handles multiple different contexts', async () => {
     const context1 = { kind: 'user', key: 'user1' };
     const context2 = { kind: 'user', key: 'user2' };
     const event1 = { kind: 'feature', context: context1 };
@@ -80,7 +78,7 @@ describe('with mocked crypto and hasher', () => {
     expect(summaries).toHaveLength(2);
   });
 
-  test('automatically clears summaries when summarized', async () => {
+  it('automatically clears summaries when summarized', async () => {
     const context = { kind: 'user', key: 'user1' };
     const event = { kind: 'feature', context };
 
@@ -92,7 +90,7 @@ describe('with mocked crypto and hasher', () => {
     expect(summariesB).toHaveLength(0);
   });
 
-  test('increments counters for feature events across multiple contexts', async () => {
+  it('increments counters for feature events across multiple contexts', async () => {
     const context1 = { kind: 'user', key: 'user1' };
     const context2 = { kind: 'user', key: 'user2' };
 
@@ -157,4 +155,4 @@ describe('with mocked crypto and hasher', () => {
       },
     });
   });
-});
+});

src/__tests__/canonicalize-test.js

@@ -8,7 +8,7 @@ const testInputDir = path.join(__dirname, 'testdata', 'input');
 const testOutputDir = path.join(__dirname, 'testdata', 'output');
 const testFiles = fs.readdirSync(testInputDir);
 
-it.each(testFiles)('should correctly canonicalize %s', (filename) => {
+it.each(testFiles)('should correctly canonicalize %s', filename => {
   // Load the input and expected output files
   const inputPath = path.join(testInputDir, filename);
   const outputPath = path.join(testOutputDir, filename);
@@ -83,4 +83,4 @@ it('should throw an error for objects with cycles', () => {
   a.b = b;
 
   expect(() => canonicalize(a)).toThrow('Cycle detected');
-});
+});

src/__tests__/context-test.js

@@ -201,14 +201,12 @@ describe('getContextKeys', () => {
 });
 
 function mockHasher() {
-  let state = "";
+  let state = '';
   return {
-    update: (input) => {
+    update: input => {
       state += input;
     },
-    digest: () => {
-      return state;
-    },
+    digest: () => state,
   };
 }
 
@@ -529,4 +527,4 @@ it('produces the same value for the given context', async () => {
   expect(await hashContext(complexContext, mockHasher())).toBe(
     '{"customer":{"bird":"party parrot","chicken":"hen","key":"testKey","name":"testName","nested":{"level1":{"level2":{"_meta":{"thisShouldBeInTheHash":true},"value":"deep"}}}},"kind":"multi","org":{"_meta":{"privateAttributes":["/a/b/c","cat","custom/dog"]},"anonymous":true,"cat":"calico","dog":"lab","key":"testKey","name":"testName","nestedArray":[[1,2],[3,4]]}}'
   );
-});
+});

src/__tests__/stubPlatform.js

@@ -45,15 +45,13 @@ export function defaults() {
     diagnosticPlatformData: { name: 'stub-platform' },
     getCurrentUrl: () => currentUrl,
     isDoNotTrack: () => doNotTrack,
-    hasherFactory: (algorithm) => {
+    hasherFactory: (/*algorithm*/) => {
       let content = '';
       return {
-        update: (value) => {
+        update: value => {
           content += value;
         },
-        digest: (format) => {
-          return content;
-        },
+        digest: (/*format*/) => content,
       };
     },
     eventSourceFactory: (url, options) => {

src/canonicalize.js

@@ -9,33 +9,33 @@
  * @returns {string} The canonicalized JSON string.
  */
 function canonicalize(object, visited = []) {
-    // For JavaScript the default JSON serialization will produce canonicalized output for basic types.
-    if (object === null || typeof object !== 'object') {
-      return JSON.stringify(object);
-    }
-  
-    if (visited.includes(object)) {
-      throw new Error('Cycle detected');
-    }
-  
-    if (Array.isArray(object)) {
-      const values = object
-        .map((item) => canonicalize(item, [...visited, object]))
-        .map((item) => (item === undefined ? 'null' : item));
-      return `[${values.join(',')}]`;
-    }
-  
-    const values = Object.keys(object)
-      .sort()
-      .map((key) => {
-        const value = canonicalize(object[key], [...visited, object]);
-        if (value !== undefined) {
-          return `${JSON.stringify(key)}:${value}`;
-        }
-        return undefined;
-      })
-      .filter((item) => item !== undefined);
-    return `{${values.join(',')}}`;
+  // For JavaScript the default JSON serialization will produce canonicalized output for basic types.
+  if (object === null || typeof object !== 'object') {
+    return JSON.stringify(object);
   }
 
-module.exports = canonicalize;
+  if (visited.includes(object)) {
+    throw new Error('Cycle detected');
+  }
+
+  if (Array.isArray(object)) {
+    const values = object
+      .map(item => canonicalize(item, [...visited, object]))
+      .map(item => (item === undefined ? 'null' : item));
+    return `[${values.join(',')}]`;
+  }
+
+  const values = Object.keys(object)
+    .sort()
+    .map(key => {
+      const value = canonicalize(object[key], [...visited, object]);
+      if (value !== undefined) {
+        return `${JSON.stringify(key)}:${value}`;
+      }
+      return undefined;
+    })
+    .filter(item => item !== undefined);
+  return `{${values.join(',')}}`;
+}
+
+module.exports = canonicalize;