Add capability to pass in custom telemetry keys

Author: suchitadoshi1987

lib/gather/gather-single-telemetry.js

@@ -1,9 +1,9 @@
 const puppeteer = require('puppeteer');
-const { setTelemetry, getTelemetry } = require('../utils/telemetry');
+const { setTelemetryWithKey } = require('../utils/telemetry');
 
 const DEFAULT_PUPPETEER_ARGS = { ignoreHTTPSErrors: true };
 
-module.exports = async function gatherSingleTelemetry(url, gatherFn, ...args) {
+module.exports = async function gatherSingleTelemetry(url, options = {}, gatherFn, ...args) {
   const browser = await puppeteer.launch(DEFAULT_PUPPETEER_ARGS);
   const page = await browser.newPage();
 
@@ -28,10 +28,7 @@ module.exports = async function gatherSingleTelemetry(url, gatherFn, ...args) {
     ...args
   );
 
-  // get the current telemetry and add the `single-telemetry` key to it.
-  const currentTelemetry = getTelemetry();
-  currentTelemetry['single-telemetry'] = telemetry;
-  setTelemetry(currentTelemetry);
+  setTelemetryWithKey(options.telemetryKey, telemetry);
   await browser.close();
 
   async function bridgeEvaluate(page, fn, ...rawArgs) {

lib/gather/gather-single-telemetry.test.js

@@ -2,6 +2,7 @@ const startApp = require('../../test/helpers/start-app');
 const gatherSingleTelemetry = require('./gather-single-telemetry');
 const { getTelemetry } = require('../utils/telemetry');
 const APP_TIMEOUT = 100000;
+const TELEMETRY_KEY = 'single-telemetry';
 
 function resolverWithoutArgs() {
   return { foo: 'bar' };
@@ -25,18 +26,27 @@ describe('Gather single telemetry', () => {
   }, APP_TIMEOUT);
 
   test('can determine base single telemetry case', async () => {
-    await gatherSingleTelemetry('http://localhost:4200', resolverWithoutArgs);
-    let telemetry = getTelemetry();
-    expect(telemetry['single-telemetry']).toEqual({
+    await gatherSingleTelemetry(
+      'http://localhost:4200',
+      { telemetryKey: TELEMETRY_KEY },
+      resolverWithoutArgs
+    );
+    let telemetry = getTelemetry(TELEMETRY_KEY);
+    expect(telemetry).toEqual({
       foo: 'bar',
     });
   });
 
   test('can determine single telemetry with arguments passed', async () => {
     const lookupNames = ['component:foo', 'helper:bar'];
-    await gatherSingleTelemetry('http://localhost:4200', resolverWithArgs, lookupNames);
-    let telemetry = getTelemetry();
-    expect(telemetry['single-telemetry']).toEqual([
+    await gatherSingleTelemetry(
+      'http://localhost:4200',
+      { telemetryKey: TELEMETRY_KEY },
+      resolverWithArgs,
+      lookupNames
+    );
+    let telemetry = getTelemetry(TELEMETRY_KEY);
+    expect(telemetry).toEqual([
       { name: 'foo', type: 'component' },
       { name: 'bar', type: 'helper' },
     ]);

lib/utils/telemetry.js

@@ -4,19 +4,23 @@ const { getModulePathFor } = require('./get-module-path-for');
 const CACHE_KEY = 'telemetry';
 
 function setTelemetry(newTelemetry) {
-  let data = JSON.stringify(newTelemetry);
+  setTelemetryWithKey(CACHE_KEY, newTelemetry);
+}
 
-  cache.set(CACHE_KEY, data);
+function setTelemetryWithKey(cacheKey, newTelemetry) {
+  let data = JSON.stringify(newTelemetry);
+  cache.set(cacheKey, data);
 }
 
-function getTelemetry() {
-  let telemetryExists = cache.has(CACHE_KEY);
+function getTelemetry(cacheKey) {
+  cacheKey = cacheKey || CACHE_KEY;
+  let telemetryExists = cache.has(cacheKey);
 
   if (!telemetryExists) {
     return {};
   }
 
-  let telemetryData = cache.get(CACHE_KEY).value;
+  let telemetryData = cache.get(cacheKey).value;
   let telemetry = {};
 
   try {
@@ -51,5 +55,6 @@ function _generateModuleKey(modulePath) {
 module.exports = {
   getTelemetry,
   setTelemetry,
+  setTelemetryWithKey,
   getTelemetryFor,
 };

lib/utils/telemetry.test.js

@@ -1,4 +1,4 @@
-const { getTelemetry, setTelemetry, getTelemetryFor } = require('./telemetry');
+const { getTelemetry, setTelemetry, setTelemetryWithKey, getTelemetryFor } = require('./telemetry');
 
 describe('get/set Telemetry', () => {
   test('can get the set telemetry', () => {
@@ -16,6 +16,22 @@ describe('get/set Telemetry', () => {
   });
 });
 
+describe('get/set Telemetry with keys', () => {
+  test('can get the set telemetry with keys', () => {
+    let fakeTelemetry = {
+      a: 1,
+      b: 2,
+    };
+
+    setTelemetryWithKey('fake-telemetry', fakeTelemetry);
+
+    let telemetry = getTelemetry('fake-telemetry');
+
+    expect(Object.keys(telemetry)).toEqual(Object.keys(fakeTelemetry));
+    expect(Object.values(telemetry)).toEqual(Object.values(fakeTelemetry));
+  });
+});
+
 describe('getTelemetryFor', () => {
   test('gets the data for the filePath', () => {
     let fakeTelemetry = { a: 1 };