Implement NO_TELEMETRY behavior

gitKrystan · gitKrystan · commit cc78719c169c · 2024-02-23T14:52:26.000-08:00
diff --git a/transforms/ember-object/__testfixtures__/-mock-telemetry.json b/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"],
diff --git a/transforms/ember-object/__testfixtures__/decorators-invalid-2.options.json b/transforms/ember-object/__testfixtures__/decorators-invalid-2.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}
diff --git a/transforms/ember-object/__testfixtures__/decorators-invalid-4.options.json b/transforms/ember-object/__testfixtures__/decorators-invalid-4.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}
diff --git a/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-1.options.json b/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-1.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}
diff --git a/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-2.options.json b/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-2.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}
diff --git a/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-3.options.json b/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-3.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}
diff --git a/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-4.options.json b/transforms/ember-object/__testfixtures__/object-literal-with-decorators-invalid-4.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": false
+}
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-1.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-1.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-10.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-10.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-11.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-11.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-12.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-12.options.json
@@ -1,4 +1,5 @@
 {
   "decorators": false,
-  "inObjectLiterals": ["macro"]
+  "inObjectLiterals": ["macro"],
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-13.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-13.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-2.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-2.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-3.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-3.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-4.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-4.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-5.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-5.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-6.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-6.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-7.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-7.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-8.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-8.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/options/decorators-disabled-9.options.json b/transforms/ember-object/__testfixtures__/options/decorators-disabled-9.options.json
@@ -1,3 +1,4 @@
 {
-  "decorators": false
+  "decorators": false,
+  "noTelemetry": false
 }
diff --git a/transforms/ember-object/__testfixtures__/runtime.input.js b/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,
 
diff --git a/transforms/ember-object/__testfixtures__/runtime.options.json b/transforms/ember-object/__testfixtures__/runtime.options.json
@@ -0,0 +1,3 @@
+{
+  "noTelemetry": "false"
+}
diff --git a/transforms/ember-object/__testfixtures__/runtime.output.js b/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;
 
diff --git a/transforms/ember-object/test.ts b/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,
diff --git a/transforms/helpers/eo-prop/private/computed/abstract.ts b/transforms/helpers/eo-prop/private/computed/abstract.ts
@@ -3,10 +3,10 @@ import type * as AST from '../../../ast';
 import type { DecoratorImportInfo } from '../../../decorator-info';
 import logger from '../../../log-helper';
 import type { Options } from '../../../options';
+import { COMPUTED_DECORATOR_NAME } from '../../../util/index';
 import { defined } from '../../../util/types';
 import AbstractEOProp from '../abstract';
 import type { CallExpressionModifier } from './modifier-helper';
-import { COMPUTED_DECORATOR_NAME } from '../../../util/index';
 
 /**
  * Ember Object Call Expression Property
diff --git a/transforms/helpers/eo-prop/private/computed/index.ts b/transforms/helpers/eo-prop/private/computed/index.ts
@@ -99,7 +99,10 @@ function getDecorators(
   const decoratorImportInfo = existingDecoratorImportInfos.get(calleeName);
   if (decoratorImportInfo) {
     decorators.push(decoratorImportInfo);
-  } else if (options.runtimeData?.computedProperties.includes(raw.key.name)) {
+  } else if (
+    options.noTelemetry ||
+    options.runtimeData?.computedProperties.includes(raw.key.name)
+  ) {
     decorators.push({ name: calleeName });
   }
   return decorators;
diff --git a/transforms/helpers/import-helper.ts b/transforms/helpers/import-helper.ts
@@ -156,7 +156,9 @@ function getDecoratorPathSpecifiers(
         decoratorsToImport
       );
 
-      const existingSpecifiers = decoratorImport.value.specifiers ?? [];
+      // The type for value seems to be wrong
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
+      const existingSpecifiers = decoratorImport.value?.specifiers ?? [];
 
       // Iterate over existing specifiers for the current path. This is needed
       // to pick the only required specifiers from the existing imports
diff --git a/transforms/helpers/runtime-data.ts b/transforms/helpers/runtime-data.ts
@@ -2,6 +2,7 @@ import { getTelemetryFor } from 'ember-codemods-telemetry-helpers';
 import path from 'path';
 import { z } from 'zod';
 import logger from './log-helper';
+import { isRecord } from './util/types';
 
 const RuntimeDataSchema = z.object({
   type: z.string().optional(),
@@ -21,7 +22,7 @@ export type RuntimeData = z.infer<typeof RuntimeDataSchema>;
  */
 export function getRuntimeData(filePath: string): RuntimeData | null {
   const rawTelemetry = getTelemetryFor(path.resolve(filePath));
-  if (!rawTelemetry) {
+  if (!isRecord(rawTelemetry) || !('type' in rawTelemetry)) {
     // Do not re-throw. The most likely reason this happened was because
     // the user's app threw an error. We still want the codemod to work if so.
     logger.error({

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "noTelemetry": "false"`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
`1`	`1`	`{`
`2`		`- "decorators": false`
	`2`	`+ "decorators": false,`
	`3`	`+ "noTelemetry": false`
`3`	`4`	`}`