Add telemetry option

gitKrystan · gitKrystan · commit 8144d5329833 · 2023-05-30T11:25:10.000-07:00
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,34 +1,29 @@
 module.exports = {
-    root: true,
-    parserOptions: {
-      ecmaVersion: 2017
+  root: true,
+  parserOptions: {
+    ecmaVersion: 2017,
+  },
+  env: {
+    node: true,
+    es6: true,
+  },
+  extends: ['eslint:recommended', 'prettier'],
+  plugins: ['prettier'],
+  rules: {
+    'prettier/prettier': 'error',
+  },
+  overrides: [
+    {
+      files: ['**/*.ts'],
+      parser: '@typescript-eslint/parser',
+      plugins: ['prettier', '@typescript-eslint'],
+      extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended', 'prettier'],
     },
-    env: {
-      node: true,
-      es6: true
-    },
-    extends: ["eslint:recommended", "prettier"],
-    plugins: ["prettier"],
-    rules: {
-      "prettier/prettier": "error"
-    },
-    overrides: [
-      {
-        files: ['**/*.ts'],
-        parser: '@typescript-eslint/parser',
-        plugins: ['prettier', '@typescript-eslint'],
-        extends: [
-          'eslint:recommended',
-          'plugin:@typescript-eslint/recommended',
-          'prettier',
-          'prettier/@typescript-eslint',
-        ],
+    {
+      files: ['**/*.test.js'],
+      env: {
+        jest: true,
       },
-      {
-        files: ['**/*.test.js'],
-        env: {
-          jest: true
-        }
-      }
-    ]
+    },
+  ],
 };
diff --git a/TODO.md b/TODO.md
@@ -0,0 +1,69 @@
+```ts
+  const { Webpack } = require('@embroider/webpack');
+  return require('@embroider/compat').compatBuild(app, Webpack, {
+    // staticComponents: true,
+    // staticModifiers: true,
+    // staticHelpers: true,
+    skipBabel: [
+      {
+        package: 'qunit',
+      },
+    ],
+  });
+```
+
+1. Find '@embroider/webpack' entry point
+2. Look at second arg to `compatBuild`
+3. ...?
+
+
+# TODO
+
+- [ ] Make telemetry pluggable
+- [ ] Maybe Discourse can make their own Telemetry plugin
+- [ ] Embroider telemetry plugin[1]
+
+## Problems
+
+[1] Embroider compat tries to link up your modules by emitting the implicit imports.
+
+## Questions for tomorrow
+
+1. How does the angle bracket codemod work?
+
+## Questions for EF4
+
+1. Is this even possible?!?
+
+```ts
+{{ambiguous}} ->
+  1. <Ambiguous>
+  2. {{(ambiguous)}}
+  3. {{this.ambiguous}}
+  4. {{ambiguous}} //modifier
+
+  1. leave it alone
+  2. change to {{this.ambiguous}}
+  (3. error?)
+
+enum DisambiguateResult {
+    LeaveIt,
+    ChangeIt,
+    CantDoIt,
+}
+
+enum Namespace {
+    Helper,
+    Component,
+    ComponentOrHelper,
+    Modifier,
+}
+
+function disambiguate(headName: string, namespace: Namespace, ...?): DisambiguateResult {
+    // ...
+    // SOMETHING SOMETHING PLUG IN EMBROIDER
+}
+
+
+
+```
diff --git a/helpers/types.ts b/helpers/types.ts
@@ -1,6 +1,4 @@
 /** Type predicate. Checks if the given value is a `Record<string, unknown>`. */
-export function isRecord<R extends Record<string, unknown>>(
-  value: unknown
-): value is R {
+export function isRecord<R extends Record<string, unknown>>(value: unknown): value is R {
   return value !== null && typeof value === 'object';
-}
+}
diff --git a/package.json b/package.json
@@ -64,12 +64,12 @@
     "chalk": "^4.1.1",
     "common-tags": "^1.8.0",
     "coveralls": "^3.1.0",
-    "eslint": "^6.8.0",
-    "eslint-config-prettier": "^6.15.0",
+    "eslint": "^8.41.0",
+    "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-prettier": "^3.4.0",
     "execa": "^3.4.0",
     "jest": "^29.1.0",
-    "prettier": "^1.19.1",
+    "prettier": "^2.8.8",
     "release-it": "^14.6.2",
     "release-it-lerna-changelog": "^3.1.0",
     "ts-jest": "^29.1.0",
diff --git a/test/fixtures/3.13/input/app/templates/application.hbs b/test/fixtures/3.13/input/app/templates/application.hbs
@@ -1,7 +1,7 @@
 {{not false}}
 
-{{#if (not foo)}}
-  {{foo}}
+{{#if (not this.foo)}}
+  {{this.foo}}
 {{/if}}
 
 {{outlet}}
diff --git a/test/helpers/test-runner.ts b/test/helpers/test-runner.ts
@@ -43,8 +43,8 @@ export class TestRunner {
       emberServe.stderr?.pipe(process.stderr);
     }
 
-    const serverWaiter = new Promise<void>(resolve => {
-      emberServe.stdout?.on('data', data => {
+    const serverWaiter = new Promise<void>((resolve) => {
+      emberServe.stdout?.on('data', (data) => {
         if (data.toString().includes('Build successful')) {
           resolve();
         }
@@ -75,7 +75,7 @@ export class TestRunner {
 
       await execa('diff', ['-rq', actual, expectedApp], { cwd: this.inputDir, stdio: 'inherit' });
     } catch (e) {
-      console.log(isRecord(e) ? e['stdout']: 'codemod did not run successfully');
+      console.log(isRecord(e) ? e['stdout'] : 'codemod did not run successfully');
 
       throw new Error('codemod did not run successfully');
     }
diff --git a/test/helpers/utils.ts b/test/helpers/utils.ts
@@ -33,10 +33,10 @@ export async function kill(subprocess: execa.ExecaChildProcess): Promise<void> {
   } catch (e) {
     console.log(`PID ${subprocess.pid} has stopped.`);
     console.log(`\tKilled: ${subprocess.killed}`);
-    console.log(`\tCancelled: ${isRecord(e) ? e['isCanceled']: 'unknown'}`);
+    console.log(`\tCancelled: ${isRecord(e) ? e['isCanceled'] : 'unknown'}`);
   }
 
-  return new Promise(resolve => {
+  return new Promise((resolve) => {
     setTimeout(() => resolve(), 3000);
   });
 }
diff --git a/test/run-test.ts b/test/run-test.ts
@@ -44,7 +44,7 @@ const allVersions = ['3.10', '3.13'];
   }
 
   process.exit(didSucceed ? 0 : 1);
-})().catch(e => {
+})().catch((e) => {
   console.error(e);
   process.exit(1);
 });
diff --git a/transforms/no-implicit-this/__testfixtures__/-mock-telemetry.d.json.ts b/transforms/no-implicit-this/__testfixtures__/-mock-telemetry.d.json.ts
@@ -2,4 +2,4 @@ export type Telemetry = Record<string, Record<string, unknown>>;
 
 declare const telemetry: Telemetry;
 
-export default telemetry;
+export default telemetry;
diff --git a/transforms/no-implicit-this/helpers/options.ts b/transforms/no-implicit-this/helpers/options.ts
@@ -2,15 +2,19 @@ import { getOptions as getCLIOptions } from 'codemod-cli';
 import fs from 'node:fs';
 import path from 'node:path';
 import { ZodError, ZodType, z } from 'zod';
-import { Telemetry, getTelemetry } from './telemetry';
+import Resolver, { RuntimeResolver } from './resolver';
 
 export interface Options {
-  customHelpers: string[],
-  telemetry: Telemetry
+  customHelpers: string[];
+  resolver: Resolver;
 }
 
 const CLIOptions = z.object({
   config: z.string().optional(),
+  // FIXME: Defaulting to 'runtime' isn't quite correct
+  telemetry: z.union([z.literal('runtime'), z.literal('embroider')]).default('runtime'),
+  // FIXME: Optionally allow angle-bracket conversion for components
+  // FIXME: Optionally add parens for helpers
 });
 
 type CLIOptions = z.infer<typeof CLIOptions>;
@@ -29,7 +33,8 @@ export function getOptions(): Options {
   const cliOptions = parse(getCLIOptions(), CLIOptions);
   return {
     customHelpers: getCustomHelpersFromConfig(cliOptions.config),
-    telemetry: getTelemetry(),
+    resolver:
+      cliOptions.telemetry === 'runtime' ? RuntimeResolver.build() : (null as unknown as Resolver),
   };
 }
 
diff --git a/transforms/no-implicit-this/helpers/plugin.ts b/transforms/no-implicit-this/helpers/plugin.ts
@@ -1,8 +1,7 @@
 import Debug from 'debug';
-import { builders as b, AST, traverse } from 'ember-template-recast';
+import { AST, builders as b, traverse } from 'ember-template-recast';
 import KNOWN_HELPERS from './known-helpers';
 import { Options } from './options';
-import { Telemetry } from './telemetry';
 
 const debug = Debug('ember-no-implicit-this-codemod:plugin');
 
@@ -13,10 +12,8 @@ const debug = Debug('ember-no-implicit-this-codemod:plugin');
 /**
  * plugin entrypoint
  */
-export default function transform(root: AST.Node, { telemetry, customHelpers }: Options) {
-
+export default function transform(root: AST.Node, { customHelpers, resolver }: Options) {
   const scopedParams: string[] = [];
-  const [components, helpers] = populateInvokeables(telemetry);
 
   const paramTracker = {
     enter(node: { blockParams: any[] }) {
@@ -78,6 +75,9 @@ export default function transform(root: AST.Node, { telemetry, customHelpers }:
     Object.assign(node, b.path(`this.${node.original}`));
   }
 
+  // app/components/foo.js
+  // <div class={{foo}} />
+
   function isHelper(name: string) {
     if (KNOWN_HELPERS.includes(name)) {
       debug(`Skipping \`%s\` because it is a known helper`, name);
@@ -89,21 +89,19 @@ export default function transform(root: AST.Node, { telemetry, customHelpers }:
       return true;
     }
 
-    const helper = helpers.find(path => path.endsWith(`/${name}`));
-    if (helper) {
+    if (resolver.has('helper', name)) {
       const message = `Skipping \`%s\` because it appears to be a helper from the telemetry data: %s`;
-      debug(message, name, helper);
+      debug(message, name);
       return true;
     }
 
     return false;
   }
 
   function isComponent(name: string) {
-    const component = components.find(path => path.endsWith(`/${name}`));
-    if (component) {
+    if (resolver.has('component', name)) {
       const message = `Skipping \`%s\` because it appears to be a component from the telemetry data: %s`;
-      debug(message, name, component);
+      debug(message, name);
       return true;
     }
 
@@ -188,21 +186,3 @@ export default function transform(root: AST.Node, { telemetry, customHelpers }:
     },
   });
 }
-
-function populateInvokeables(telemetry: Telemetry): [components: string[], helpers: string[]] {
-  const components = [];
-  const helpers = [];
-
-  for (const [name, datum] of Object.entries(telemetry)) {
-    switch (datum.type) {
-      case 'Component':
-        components.push(name);
-        break;
-      case 'Helper':
-        helpers.push(name);
-        break;
-    }
-  }
-
-  return [components, helpers];
-}
diff --git a/transforms/no-implicit-this/helpers/resolver.ts b/transforms/no-implicit-this/helpers/resolver.ts
@@ -0,0 +1,59 @@
+import { Telemetry, getTelemetry } from './telemetry';
+
+export default abstract class Resolver {
+  has(type: 'component' | 'helper' | 'ambiguous', name: string): boolean {
+    switch (type) {
+      case 'component':
+        return this.hasComponent(name);
+      case 'helper':
+        return this.hasHelper(name);
+      case 'ambiguous':
+        return this.hasAmbiguous(name);
+    }
+  }
+
+  abstract hasComponent(name: string): boolean;
+  abstract hasHelper(name: string): boolean;
+
+  hasAmbiguous(name: string): boolean {
+    return this.hasComponent(name) || this.hasHelper(name);
+  }
+}
+
+export class RuntimeResolver extends Resolver {
+  static build(): RuntimeResolver {
+    const telemetry = getTelemetry();
+    const [components, helpers] = populateInvokeables(telemetry);
+    return new RuntimeResolver(components, helpers);
+  }
+
+  constructor(private components: string[], private helpers: string[]) {
+    super();
+  }
+
+  hasComponent(name: string): boolean {
+    return !!this.components.find((path) => path.endsWith(`/${name}`));
+  }
+
+  hasHelper(name: string): boolean {
+    return !!this.helpers.find((path) => path.endsWith(`/${name}`));
+  }
+}
+
+function populateInvokeables(telemetry: Telemetry): [components: string[], helpers: string[]] {
+  const components = [];
+  const helpers = [];
+
+  for (const [name, datum] of Object.entries(telemetry)) {
+    switch (datum.type) {
+      case 'Component':
+        components.push(name);
+        break;
+      case 'Helper':
+        helpers.push(name);
+        break;
+    }
+  }
+
+  return [components, helpers];
+}
diff --git a/transforms/no-implicit-this/helpers/tagged-templates.ts b/transforms/no-implicit-this/helpers/tagged-templates.ts
diff --git a/transforms/no-implicit-this/helpers/telemetry.ts b/transforms/no-implicit-this/helpers/telemetry.ts
diff --git a/transforms/no-implicit-this/index.ts b/transforms/no-implicit-this/index.ts
diff --git a/transforms/no-implicit-this/test-helpers.ts b/transforms/no-implicit-this/test-helpers.ts
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,8 @@ export class TestRunner {`
`43`	`43`	`emberServe.stderr?.pipe(process.stderr);`
`44`	`44`	`}`
`45`	`45`
`46`		`- const serverWaiter = new Promise<void>(resolve => {`
`47`		`- emberServe.stdout?.on('data', data => {`
	`46`	`+ const serverWaiter = new Promise<void>((resolve) => {`
	`47`	`+ emberServe.stdout?.on('data', (data) => {`
`48`	`48`	`if (data.toString().includes('Build successful')) {`
`49`	`49`	`resolve();`
`50`	`50`	`}`
`@@ -75,7 +75,7 @@ export class TestRunner {`
`75`	`75`
`76`	`76`	`await execa('diff', ['-rq', actual, expectedApp], { cwd: this.inputDir, stdio: 'inherit' });`
`77`	`77`	`} catch (e) {`
`78`		`- console.log(isRecord(e) ? e['stdout']: 'codemod did not run successfully');`
	`78`	`+ console.log(isRecord(e) ? e['stdout'] : 'codemod did not run successfully');`
`79`	`79`
`80`	`80`	`throw new Error('codemod did not run successfully');`
`81`	`81`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,10 +33,10 @@ export async function kill(subprocess: execa.ExecaChildProcess): Promise<void> {`
`33`	`33`	`} catch (e) {`
`34`	`34`	console.log(`PID ${subprocess.pid} has stopped.`);
`35`	`35`	console.log(`\tKilled: ${subprocess.killed}`);
`36`		- console.log(`\tCancelled: ${isRecord(e) ? e['isCanceled']: 'unknown'}`);
	`36`	+ console.log(`\tCancelled: ${isRecord(e) ? e['isCanceled'] : 'unknown'}`);
`37`	`37`	`}`
`38`	`38`
`39`		`- return new Promise(resolve => {`
	`39`	`+ return new Promise((resolve) => {`
`40`	`40`	`setTimeout(() => resolve(), 3000);`
`41`	`41`	`});`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ const allVersions = ['3.10', '3.13'];`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`process.exit(didSucceed ? 0 : 1);`
`47`		`-})().catch(e => {`
	`47`	`+})().catch((e) => {`
`48`	`48`	`console.error(e);`
`49`	`49`	`process.exit(1);`
`50`	`50`	`});`
Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,4 @@ export type Telemetry = Record<string, Record<string, unknown>>;`
`2`	`2`
`3`	`3`	`declare const telemetry: Telemetry;`
`4`	`4`
`5`		`-export default telemetry;`
	`5`	`+export default telemetry;`