first gather func test

Author: tylerturdenpants

.gitignore

@@ -59,3 +59,5 @@ typings/
 
 # next.js build output
 .next
+
+test/fixtures/classic-app/dist/

.npmignore

@@ -0,0 +1,2 @@
+*.test.js
+**/test/**

.travis.yml

@@ -18,4 +18,4 @@ install:
 
 script:
   - yarn lint:js
-  - yarn test
+  - yarn test --forceExit

lib/gather/local-gather.js lib/gather/analyze-ember-object.jslib/gather/local-gather.js renamed to lib/gather/analyze-ember-object.js

@@ -1,6 +1,17 @@
-module.exports = function parseMeta(meta = {}) {
+module.exports = function analyzeEmberObject(possibleEmberObject) {
+  if (typeof possibleEmberObject !== 'object' || possibleEmberObject === null) {
+    return undefined;
+  }
+  if (possibleEmberObject.default && typeof possibleEmberObject.default.proto !== 'function') {
+    return undefined;
+  }
+  let proto = possibleEmberObject.default.proto();
+
+  // Ember here is assumed to be global when ran within the context of the browser
+  /* globals Ember */
+  let meta = Ember.meta(proto);
+
   // eslint-disable-next-line no-undef
-  meta = Ember.meta(meta);
   if (!meta || !meta.source) {
     return {};
   }

lib/gather/gather-telemetry.js

@@ -15,38 +15,41 @@ module.exports = async function gatherTelemetry(url, gatherFn, puppeteerArgs = {
     console.error(message); // eslint-disable-line no-console
   });
 
-  await page.exposeFunction('gatherFn', gatherFn);
-
-  const telemetry = await page.evaluate(() => {
-    const SKIPPED_MODULES = ['fetch/ajax'];
-
-    /* globals window,*/
-    let telemetry = {};
-
-    const modules = Object.keys(window.require.entries);
+  const telemetry = await bridgeEvaluate(
+    page,
+    async gFn => {
+      const SKIPPED_MODULES = ['fetch/ajax'];
+      /* globals window,*/
+      let telemetry = {};
+      const modules = Object.keys(window.require.entries);
+
+      for (let modulePath of modules) {
+        if (SKIPPED_MODULES.includes(modulePath)) {
+          continue;
+        }
 
-    for (let modulePath of modules) {
-      if (SKIPPED_MODULES.includes(modulePath)) {
-        continue;
-      }
-      if (window.gatherFn && typeof window.gatherFn === 'function') {
         try {
           let module = require(modulePath);
-
-          if (module && module.default && module.default.proto) {
-            let defaultProto = module.default.proto();
-
-            telemetry[modulePath] = window.gatherFn(defaultProto);
-          }
+          telemetry[modulePath] = await gFn(module);
         } catch (error) {
           // log the error, but continue
           window.logErrorInNodeProcess(`error evaluating \`${modulePath}\`: ${error.message}`);
         }
       }
-    }
-    return telemetry;
-  });
+      return telemetry;
+    },
+    gatherFn
+  );
 
   setTelemetry(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-telemetry.test.js

@@ -0,0 +1,49 @@
+const startApp = require('../../test/helpers/start-app');
+const gatherTelemetry = require('./gather-telemetry');
+const { getTelemetry } = require('../utils/telemetry');
+const analyzeEmberObject = require('../gather/analyze-ember-object');
+const APP_TIMEOUT = 100000;
+
+function helper(possibleEmberObject) {
+  if (
+    possibleEmberObject &&
+    possibleEmberObject.default &&
+    possibleEmberObject.default.isHelperFactory
+  ) {
+    return true;
+  }
+}
+
+describe('Provide a personalized `Gathering Function`', () => {
+  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 helpers with simple a function', async () => {
+    await gatherTelemetry('http://localhost:4200', helper);
+    let telemetry = getTelemetry();
+    expect(telemetry).toEqual({
+      'ember-inflector/lib/helpers/pluralize': true,
+      'ember-inflector/lib/helpers/singularize': true,
+      'input/helpers/app-version': true,
+      'input/helpers/pluralize': true,
+      'input/helpers/singularize': true,
+    });
+  });
+
+  test('can determine components with a robust function', async () => {
+    await gatherTelemetry('http://localhost:4200', analyzeEmberObject);
+    let telemetry = getTelemetry();
+    expect(Object.keys(telemetry).filter(Boolean).length).toEqual(1);
+  });
+
+  afterAll(async () => {
+    console.log(`Killing PID: ${app.emberServe.pid}`);
+    await app.emberServe.kill('SIGTERM', {
+      forceKillAfterTimeout: 200,
+    });
+  }, APP_TIMEOUT);
+});

lib/index.js

@@ -1,13 +1,13 @@
 const gatherTelemetryForUrl = require('./gather/gather-telemetry');
 const { getModulePathFor } = require('./utils/get-module-path-for');
 const { getTelemetry, setTelemetry, getTelemetryFor } = require('./utils/telemetry');
-const parseMeta = require('../lib/gather/local-gather');
+const analyzeEmberObject = require('./gather/analyze-ember-object');
 
 module.exports = {
   getTelemetry,
   setTelemetry,
   gatherTelemetryForUrl,
   getTelemetryFor,
   getModulePathFor,
-  parseMeta,
+  analyzeEmberObject,
 };

package.json

@@ -5,34 +5,40 @@
   "main": "lib/index.js",
   "repository": "https://github.com/ember-codemods/ember-codemods-telemetry-helpers",
   "author": "",
+  "contributors": [
+    "Ryan Mark <[email protected]>"
+  ],
   "license": "MIT",
   "private": false,
   "scripts": {
     "lint:js": "eslint .",
     "test": "jest .",
     "release": "release-it"
   },
-  "devDependencies": {
-    "eslint": "^6.1.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-plugin-node": "^9.1.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "execa": "^2.0.3",
-    "jest": "^24.8.0",
-    "prettier": "^1.18.2",
-    "release-it": "^12.3.4",
-    "release-it-lerna-changelog": "^1.0.3"
-  },
   "dependencies": {
     "fs-extra": "^8.1.0",
     "git-repo-info": "^2.1.0",
-    "puppeteer": "^1.19.0",
+    "puppeteer": "^1.20.0",
     "sync-disk-cache": "^1.3.3",
     "walk-sync": "^2.0.2"
   },
+  "devDependencies": {
+    "eslint": "^6.5.1",
+    "eslint-config-prettier": "^6.4.0",
+    "eslint-plugin-node": "^10.0.0",
+    "eslint-plugin-prettier": "^3.1.1",
+    "execa": "^2.1.0",
+    "jest": "^24.9.0",
+    "prettier": "^1.18.2",
+    "release-it": "^12.4.3",
+    "release-it-lerna-changelog": "^1.0.3"
+  },
   "engines": {
     "node": "8.* || 10.* || >= 12.*"
   },
+  "jest": {
+    "testEnvironment": "node"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },

test/helpers/start-app.js

@@ -0,0 +1,26 @@
+const execa = require('execa');
+const path = require('path');
+
+module.exports = async function startApp(appPath) {
+  const classicAppDir = path.resolve(appPath);
+  const execOpts = { cwd: classicAppDir, stderr: 'inherit' };
+  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);
+  emberServe.stdout.pipe(process.stdout);
+
+  await new Promise(resolve => {
+    emberServe.stdout.on('data', data => {
+      let dataAsStr = data.toString();
+      if (dataAsStr.includes('Build successful')) {
+        resolve();
+      }
+    });
+  });
+
+  return { emberServe };
+};