Merge pull request #550 from ember-codemods/no-telemetry

.gitignore

@@ -1,3 +1,5 @@
 node_modules
 *.log
 .eslintcache
+transforms/**/*.js
+!transforms/ember-object/__testfixtures__/**/*.js

README.md

@@ -50,6 +50,14 @@ If you have any _lazily loaded_ modules, such as modules from Ember Engines,
 you'll need to make sure that the URL you provide loads these modules as well.
 Otherwise, the codemod will not be able to detect them or analyze them.
 
+To disable this feature, run with `NO_TELEMETRY=true` and omit the path to your local server:
+
+```shell
+NO_TELEMETRY=true npx ember-native-class-codemod [OPTIONS] path/of/files/ or/some**/*glob.js
+```
+
+DANGER: Disabling the telemetry may result in incorrect behavior. Carefully vet the results.
+
 ### Types
 
 The `type` option can be used to further narrow down transforms to a particular type of

bin/cli.js

@@ -4,11 +4,11 @@
 const { gatherTelemetryForUrl, analyzeEmberObject } = require('ember-codemods-telemetry-helpers');
 
 (async () => {
-  await gatherTelemetryForUrl(process.argv[2], analyzeEmberObject);
+  let args = process.argv.slice(1);
+  if (process.env['NO_TELEMETRY'] !== 'true') {
+    await gatherTelemetryForUrl(process.argv[2], analyzeEmberObject);
+    args = process.argv.slice(2);
+  }
 
-  require('codemod-cli').runTransform(
-    __dirname,
-    'ember-object',
-    process.argv.slice(2) /* paths or globs */
-  );
+  require('codemod-cli').runTransform(__dirname, 'ember-object', args);
 })();

transforms/ember-object/__testfixtures__/-mock-telemetry.json

@@ -1,8 +1,8 @@
 {
   "runtime": {
     "computedProperties": ["computedMacro", "anotherMacro", "numPlusOne", "numPlusPlus", "error", "errorService"],
-    "observedProperties": [],
-    "observerProperties": {},
+    "observedProperties": ["prop"],
+    "observerProperties": { "observerProp": ["prop"] },
     "offProperties": { "offProp": ["prop1", "prop2"] },
     "overriddenActions": ["overriddenActionMethod"],
     "overriddenProperties": ["overriddenMethod"],

transforms/ember-object/__testfixtures__/decorators-invalid-2.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}

transforms/ember-object/__testfixtures__/decorators-invalid-4.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}

transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-1.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}

transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-2.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}

transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-3.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}

transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-4.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}

transforms/ember-object/__testfixtures__/options/decorators-disabled-1.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-10.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-11.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-12.options.json

@@ -1,4 +1,5 @@
 {
   "decorators": false,
-  "inObjectLiterals": ["macro"]
+  "inObjectLiterals": ["macro"],
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-13.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-2.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-3.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-4.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-5.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-6.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-7.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-8.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/options/decorators-disabled-9.options.json

@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }

transforms/ember-object/__testfixtures__/runtime.input.js

@@ -1,7 +1,8 @@
-import Runtime from 'common/runtime';
+import { computed, observer } from '@ember/object';
 import { alias } from '@ember/object/computed';
-import { computed } from '@ember/object';
 import { service } from '@ember/service';
+import Runtime from 'common/runtime';
+import { customMacro, customMacroWithInput } from 'my-app/lib';
 
 /**
  * Program comments
@@ -19,6 +20,8 @@ export default Runtime.extend(MyMixin, {
   error: service(),
   errorService: service('error'),
 
+  observerProp: observer('prop', function() { return this.prop; }),
+
   unobservedProp: null,
   offProp: null,
 

transforms/ember-object/__testfixtures__/runtime.options.json

@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}

transforms/ember-object/__testfixtures__/runtime.output.js

@@ -1,9 +1,10 @@
 import classic from 'ember-classic-decorator';
-import { off, unobserves } from '@ember-decorators/object';
+import { off, unobserves, observes } from '@ember-decorators/object';
 import { action, computed } from '@ember/object';
 import { service } from '@ember/service';
 import { alias } from '@ember/object/computed';
 import Runtime from 'common/runtime';
+import { customMacro, customMacroWithInput } from 'my-app/lib';
 
 /**
  * Program comments
@@ -26,6 +27,9 @@ export default class _Runtime extends Runtime.extend(MyMixin) {
   @service('error')
   errorService;
 
+  @observes('prop')
+  observerProp() { return this.prop; }
+
   @unobserves('prop3', 'prop4')
   unobservedProp;
 

transforms/ember-object/test.ts

@@ -11,6 +11,9 @@ import mockTelemetryData from './__testfixtures__/-mock-telemetry.json';
 const fixtureDir = 'transforms/ember-object/__testfixtures__/';
 const testFiles = new GlobSync(`${fixtureDir}**/*.input.js`).found;
 
+const OUTPUT_PARSER =
+  /^(?:\/\*\nExpect error:\n(?<expectedError>[\S\s]*)\n\*\/)?(?<content>[\S\s]*)$/;
+
 const mockTelemetry: Record<string, unknown> = {};
 for (const testFile of testFiles) {
   const moduleName = testFile
@@ -31,7 +34,9 @@ interface TestCase {
   testPath: string;
   input: string;
   output: string;
+  outputWithNoTelemetry: string;
   expectedError: string | undefined;
+  expectedErrorWithNoTelemetry: string | undefined;
   skipped: boolean;
   options: string;
 }
@@ -44,18 +49,27 @@ const testCases = testFiles.map((inputPath): TestCase => {
   const testPath = path.join(fixtureDir, `${testName}${extension}`);
   const input = readFileSync(inputPath, 'utf8');
   const outputPath = path.join(fixtureDir, `${testName}.output${extension}`);
+  const outputWithNoTelemetryPath = path.join(
+    fixtureDir,
+    `${testName}.output-no-telemetry${extension}`
+  );
 
-  const fullOutput = readFileSync(outputPath, 'utf8');
-  const parsedOutput =
-    /^(?:\/\*\nExpect error:\n(?<expectedError>[\S\s]*)\n\*\/)?(?<content>[\S\s]*)$/.exec(
-      fullOutput
-    );
-  const output = parsedOutput?.groups?.['content'];
-  assert(output, `Expected to find file content in ${outputPath}`);
-  const expectedError = parsedOutput.groups?.['expectedError'];
+  const { fullOutput, output, expectedError } = parseOutput(outputPath);
 
   const skipped = fullOutput.startsWith('/* Expect skipped */');
 
+  let outputWithNoTelemetry;
+  let expectedErrorWithNoTelemetry;
+  if (existsSync(outputWithNoTelemetryPath)) {
+    ({
+      output: outputWithNoTelemetry,
+      expectedError: expectedErrorWithNoTelemetry,
+    } = parseOutput(outputWithNoTelemetryPath));
+  } else {
+    outputWithNoTelemetry = output;
+    expectedErrorWithNoTelemetry = expectedError;
+  }
+
   const optionsPath = path.join(fixtureDir, `${testName}.options.json`);
   const options = existsSync(optionsPath)
     ? readFileSync(optionsPath, 'utf8')
@@ -65,7 +79,9 @@ const testCases = testFiles.map((inputPath): TestCase => {
     testPath,
     input,
     output,
+    outputWithNoTelemetry,
     expectedError,
+    expectedErrorWithNoTelemetry,
     skipped,
     options,
   };
@@ -74,7 +90,20 @@ const testCases = testFiles.map((inputPath): TestCase => {
 describe('ember-object', () => {
   describe.each(testCases)(
     '$testName',
-    ({ testPath, input, output, expectedError, skipped, options }) => {
+    ({
+      testPath,
+      input,
+      output,
+      outputWithNoTelemetry,
+      expectedError,
+      expectedErrorWithNoTelemetry,
+      skipped,
+      options,
+    }) => {
+      const parsedOptions = options
+        ? (JSON.parse(options) as Record<string, unknown>)
+        : {};
+
       beforeEach(function () {
         process.env['CODEMOD_CLI_ARGS'] = options;
       });
@@ -90,10 +119,48 @@ describe('ember-object', () => {
       test('is idempotent', function () {
         runTest(testPath, output, output, expectedError, skipped);
       });
+
+      // NOTE: To skip testing an input file in no telemetry file, make an
+      // options file with `{ "noTelemetry": "false" }`
+      if (parsedOptions['noTelemetry'] === undefined) {
+        describe('NO_TELEMETRY', function () {
+          beforeEach(function () {
+            process.env['CODEMOD_CLI_ARGS'] = JSON.stringify({
+              noTelemetry: true,
+              ...parsedOptions,
+            });
+          });
+
+          test('transforms correctly', function () {
+            runTest(
+              testPath,
+              input,
+              outputWithNoTelemetry,
+              expectedErrorWithNoTelemetry,
+              skipped
+            );
+          });
+
+          // FIXME: is idempotent
+        });
+      }
     }
   );
 });
 
+function parseOutput(outputPath: string): {
+  fullOutput: string;
+  output: string;
+  expectedError: string | undefined;
+} {
+  const fullOutput = readFileSync(outputPath, 'utf8');
+  const parsedOutput = OUTPUT_PARSER.exec(fullOutput);
+  const output = parsedOutput?.groups?.['content'];
+  assert(output, `Expected to find file content in ${outputPath}`);
+  const expectedError = parsedOutput.groups?.['expectedError'];
+  return { fullOutput, output, expectedError };
+}
+
 function runTest(
   testPath: string,
   input: string,

transforms/helpers/config.ts

@@ -22,6 +22,9 @@ export default function getConfig(dir = process.cwd()): UserOptions {
     getFileConfig(dir),
     getCliConfig()
   );
+  if (process.env['NO_TELEMETRY'] === 'true') {
+    config.noTelemetry = true;
+  }
   return UserOptionsSchema.parse(config);
 }
 

transforms/helpers/decorator-info.ts

@@ -1,6 +1,6 @@
-import { assert } from './util/types';
-import { COMPUTED_DECORATOR_NAME, METHOD_DECORATORS } from './util/index';
 import type * as AST from '../helpers/ast';
+import { COMPUTED_DECORATOR_NAME, METHOD_DECORATORS } from './util/index';
+import { assert } from './util/types';
 
 export interface DecoratorImportInfo {
   name: string;

transforms/helpers/eo-extend-expression.ts

@@ -31,8 +31,13 @@ export default class EOExtendExpression {
   ) {
     const raw = path.value;
 
-    this.className = getClassName(path, filePath, options.runtimeData.type);
     this.superClassName = raw.callee.object.name;
+    this.className = getClassName(
+      path,
+      filePath,
+      this.superClassName,
+      options.runtimeData?.type
+    );
 
     const mixins: AST.EOMixin[] = [];
     for (const arg of raw.arguments) {
@@ -92,6 +97,7 @@ export default class EOExtendExpression {
       templateLayout: false,
       off: false,
       tagName: false,
+      observes: false,
       unobserves: false,
     };
     const { properties } = this;
@@ -110,6 +116,7 @@ export default class EOExtendExpression {
           specs.templateLayout || prop.decoratorImportSpecs.templateLayout,
         off: specs.off || prop.decoratorImportSpecs.off,
         tagName: specs.tagName || prop.decoratorImportSpecs.tagName,
+        observes: specs.observes || prop.decoratorImportSpecs.observes,
         unobserves: specs.unobserves || prop.decoratorImportSpecs.unobserves,
       };
     }