Merge pull request #28 from ember-codemods/suchita/single-telemetry

Add single telemetry support

Author: suchitadoshi1987

lib/gather/gather-single-telemetry.js

@@ -0,0 +1,42 @@
+const puppeteer = require('puppeteer');
+const { setTelemetryWithKey } = require('../utils/telemetry');
+
+const DEFAULT_PUPPETEER_ARGS = { ignoreHTTPSErrors: true };
+
+module.exports = async function gatherSingleTelemetry(url, options = {}, gatherFn, ...args) {
+  const browser = await puppeteer.launch(DEFAULT_PUPPETEER_ARGS);
+  const page = await browser.newPage();
+
+  await page.goto(url);
+
+  await page.exposeFunction('logErrorInNodeProcess', message => {
+    console.error(message); // eslint-disable-line no-console
+  });
+
+  const telemetry = await bridgeEvaluate(
+    page,
+    async (gFn, ...supportFns) => {
+      supportFns.forEach(fn => {
+        this[fn.name] = fn;
+      });
+      let telemetry = {};
+
+      telemetry = await gFn(...supportFns);
+      return telemetry;
+    },
+    gatherFn,
+    ...args
+  );
+
+  setTelemetryWithKey(options.telemetryKey, telemetry);
+  await browser.close();
+
+  async function bridgeEvaluate(page, fn, ...rawArgs) {
+    const args = await Promise.all(
+      rawArgs.map(arg => {
+        return typeof arg === 'function' ? page.evaluateHandle(`(${arg.toString()})`) : arg;
+      })
+    );
+    return page.evaluate(fn, ...args);
+  }
+};

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

@@ -0,0 +1,59 @@
+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' };
+}
+
+function resolverWithArgs(lookupNames) {
+  if (lookupNames) {
+    return lookupNames.map(item => {
+      const lookupSplit = item.split(':');
+      return { name: lookupSplit[1], type: lookupSplit[0] };
+    });
+  }
+}
+
+describe('Gather single telemetry', () => {
+  let app;
+  let localAppPath = './test/fixtures/classic-app';
+  beforeAll(async () => {
+    app = await startApp(localAppPath);
+    console.log(`Spawned PID: ${app.emberServe.pid}`);
+  }, APP_TIMEOUT);
+
+  test('can determine base single telemetry case', async () => {
+    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',
+      { telemetryKey: TELEMETRY_KEY },
+      resolverWithArgs,
+      lookupNames
+    );
+    let telemetry = getTelemetry(TELEMETRY_KEY);
+    expect(telemetry).toEqual([
+      { name: 'foo', type: 'component' },
+      { name: 'bar', type: 'helper' },
+    ]);
+  });
+
+  afterAll(async () => {
+    console.log(`Killing PID: ${app.emberServe.pid}`);
+    await app.emberServe.shutdown();
+  }, APP_TIMEOUT);
+});

lib/gather/gather-telemetry.test.js

@@ -69,8 +69,6 @@ describe('Provide a personalized `Gathering Function`', () => {
 
   afterAll(async () => {
     console.log(`Killing PID: ${app.emberServe.pid}`);
-    await app.emberServe.kill('SIGTERM', {
-      forceKillAfterTimeout: 200,
-    });
+    await app.emberServe.shutdown();
   }, APP_TIMEOUT);
 });

lib/index.js

@@ -1,4 +1,5 @@
 const gatherTelemetryForUrl = require('./gather/gather-telemetry');
+const gatherSingleTelemetryForUrl = require('./gather/gather-single-telemetry.js');
 const { getModulePathFor } = require('./utils/get-module-path-for');
 const { getTelemetry, setTelemetry, getTelemetryFor } = require('./utils/telemetry');
 const analyzeEmberObject = require('./gather/analyze-ember-object');
@@ -7,6 +8,7 @@ module.exports = {
   getTelemetry,
   setTelemetry,
   gatherTelemetryForUrl,
+  gatherSingleTelemetryForUrl,
   getTelemetryFor,
   getModulePathFor,
   analyzeEmberObject,

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 };

test/helpers/start-app.js

@@ -3,14 +3,18 @@ const path = require('path');
 
 module.exports = async function startApp(appPath) {
   const classicAppDir = path.resolve(appPath);
-  const execOpts = { cwd: classicAppDir, stderr: 'inherit' };
+  const execOpts = { cwd: classicAppDir, stderr: 'inherit', preferLocal: true };
   console.log('installing deps');
 
   await execa('rm', ['-rf', 'node_modules'], execOpts);
   await execa('yarn', ['install'], execOpts);
 
   console.log('starting serve');
-  const emberServe = execa('yarn', ['start'], execOpts);
+
+  // `yarn` has a bug where even if the process gets killed, it leaves the child process (ember in this case) orphaned.
+  // Hence we are using `ember` directly here to overcome the above shortcoming and ensure that the ember process is always killed
+  // cleanly.
+  const emberServe = execa('ember', ['serve'], execOpts);
   emberServe.stdout.pipe(process.stdout);
 
   await new Promise(resolve => {
@@ -22,5 +26,14 @@ module.exports = async function startApp(appPath) {
     });
   });
 
+  emberServe.shutdown = async function() {
+    this.kill();
+    try {
+      await this;
+    } catch (e) {
+      // Process is allowed to exit with a non zero exit status code.
+    }
+  };
+
   return { emberServe };
 };