[FEAT] Add validation checks detecting action infinite loop (#94)

Author: ssutar

transforms/ember-object/__testfixtures__/action.invalid.input.js

@@ -0,0 +1,44 @@
+const Foo = EmberObject.extend({
+  actions: {
+    bar() {
+      this._super(...arguments);
+      this.get("bar")();
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    biz() {
+      this._super(...arguments);
+      get(this, "biz")();
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    baz() {
+      this._super(...arguments);
+      tryInvoke(this, "baz");
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    sendBaz() {
+      this._super(...arguments);
+      this.send("sendBaz");
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    thisBaz() {
+      this._super(...arguments);
+      this.thisBaz();
+    }
+  }
+});

transforms/ember-object/__testfixtures__/action.invalid.options.json

@@ -0,0 +1,3 @@
+{
+  "decorators": true
+}

transforms/ember-object/__testfixtures__/action.invalid.output.js

@@ -0,0 +1,44 @@
+const Foo = EmberObject.extend({
+  actions: {
+    bar() {
+      this._super(...arguments);
+      this.get("bar")();
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    biz() {
+      this._super(...arguments);
+      get(this, "biz")();
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    baz() {
+      this._super(...arguments);
+      tryInvoke(this, "baz");
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    sendBaz() {
+      this._super(...arguments);
+      this.send("sendBaz");
+    }
+  }
+});
+
+const Foo = EmberObject.extend({
+  actions: {
+    thisBaz() {
+      this._super(...arguments);
+      this.thisBaz();
+    }
+  }
+});

transforms/helpers/parse-helper.js

@@ -244,8 +244,6 @@ function parseEmberObjectCallExpression(eoCallExpression) {
  * @param {Object} options
  */
 function replaceEmberObjectExpressions(j, root, filePath, options = {}) {
-  logger.info(`[${filePath}]: BEGIN`);
-
   const runtimeConfigPath = options["runtime-config-path"];
 
   if (runtimeConfigPath) {
@@ -255,7 +253,7 @@ function replaceEmberObjectExpressions(j, root, filePath, options = {}) {
     );
     if (!options.runtimeData) {
       logger.warn(
-        `${filePath} SKIPPED Could not find runtime data NO_RUNTIME_DATA`
+        `[${filePath}]: SKIPPED Could not find runtime data NO_RUNTIME_DATA`
       );
       return;
     }
@@ -291,7 +289,7 @@ function replaceEmberObjectExpressions(j, root, filePath, options = {}) {
       options.runtimeData
     );
 
-    const errors = hasValidProps(eoProps, getOptions(options));
+    const errors = hasValidProps(j, eoProps, getOptions(options));
     if (errors.length) {
       logger.warn(
         `[${filePath}]: FAILURE \nValidation errors: \n\t${errors.join("\n\t")}`

transforms/helpers/validation-helper.js

@@ -49,6 +49,7 @@ function isFileOfType(file, type) {
  * @returns {Boolean}
  */
 function hasValidProps(
+  j,
   { instanceProps = [] } = {},
   { decorators = false, classFields = true } = {}
 ) {
@@ -72,6 +73,7 @@ function hasValidProps(
 
     if (instanceProp.isAction) {
       errors = errors.concat(getLifecycleHookErrors(instanceProp));
+      errors = errors.concat(getInfiniteLoopErrors(j, instanceProp));
     }
 
     if (
@@ -139,4 +141,44 @@ function isExtendsMixin(j, eoCallExpression) {
   return j(eoCallExpression).get("arguments").value.length > 1;
 }
 
+/**
+ * Validation against pattern mentioned https://github.com/scalvert/eslint-plugin-ember-es6-class/pull/2
+ *
+ * @param {Object} j - jscodeshift lib reference
+ * @param {EOProp} actionsProp
+ */
+function getInfiniteLoopErrors(j, actionsProp) {
+  const actionProps = get(actionsProp, "value.properties");
+  return actionProps.reduce((errors, actionProp) => {
+    const actionName = getPropName(actionProp);
+    if (actionName) {
+      const functExpr = j(actionProp.value);
+
+      // Occurences of this.actionName()
+      const actionCalls = functExpr.find(j.CallExpression, {
+        callee: {
+          type: "MemberExpression",
+          object: {
+            type: "ThisExpression"
+          },
+          property: {
+            type: "Identifier",
+            name: actionName
+          }
+        }
+      });
+
+      // Occurences of this.get('actionName')() or get(this, 'actionName')()
+      const actionLiterals = functExpr.find(j.Literal, { value: actionName });
+
+      if (actionLiterals.length || actionCalls.length) {
+        errors.push(
+          `[${actionName}]: Transform not supported - calling the passed action would cause an infinite loop. See https://github.com/scalvert/eslint-plugin-ember-es6-class/pull/2 for more details`
+        );
+      }
+    }
+    return errors;
+  }, []);
+}
+
 module.exports = { isFileOfType, hasValidProps, isExtendsMixin, isTestFile };