Merge pull request #53 from simplabs/no-native-promise-helpers

Implement `no-native-promise-helpers` rule

Author: Turbo87

rules/no-native-promise-helpers.js

@@ -0,0 +1,46 @@
+'use strict';
+
+const HELPERS = ['all', 'race', 'allSettled'];
+
+module.exports = {
+  create(context) {
+    let parentTask = null;
+
+    return {
+      FunctionExpression(node) {
+        if (parentTask) return;
+
+        let { generator, parent } = node;
+        if (!generator) return;
+        if (parent.type !== 'CallExpression' || parent.arguments[0] !== node) return;
+
+        let { callee } = parent;
+        if (callee.type !== 'Identifier' || callee.name !== 'task') return;
+
+        parentTask = node;
+      },
+
+      'FunctionExpression:exit'(node) {
+        if (node === parentTask) {
+          parentTask = null;
+        }
+      },
+
+      CallExpression(node) {
+        if (!parentTask) return;
+
+        let { callee } = node;
+        if (callee.type !== 'MemberExpression') return;
+
+        let { object, property } = callee;
+        if (object.type !== 'Identifier' || object.name !== 'Promise') return;
+        if (property.type !== 'Identifier' || !HELPERS.includes(property.name)) return;
+
+        context.report({
+          node,
+          message: `Use \`import { ${property.name} } from 'ember-concurrency';\` instead of \`Promise.${property.name}()\``,
+        });
+      },
+    };
+  },
+};

rules/no-native-promise-helpers.md

@@ -0,0 +1,38 @@
+# no-native-promise-helpers
+
+`Promise.all()` and `Promise.race()` do not cancel their child promises or
+tasks, because they are not aware of cancellation in the way that
+ember-concurrency has implemented it. ember-concurrency does provide
+alternative, cancellation-aware `all()` and `race()` implementations though,
+but they need to be explicitly imported.
+
+see <http://ember-concurrency.com/api/global.html>
+
+This rule warns about usage of `Promise.all()` and `Promise.race()` inside of
+ember-concurrency tasks.
+
+## Examples
+
+This rule **forbids** the following:
+
+```js
+submitTask: task(function*() {
+  yield Promise.all([
+    this.saveTask.perform(),
+    this.loadingSpinnerTask.perform(),
+  ]);
+})
+```
+
+This rule **allows** the following:
+
+```js
+import { all } from 'ember-concurrency';
+
+submitTask: task(function*() {
+  yield all([
+    this.saveTask.perform(),
+    this.loadingSpinnerTask.perform(),
+  ]);
+})
+```

rules/no-native-promise-helpers.test.js

@@ -0,0 +1,169 @@
+const { RuleTester } = require('eslint');
+
+const rule = require('./no-native-promise-helpers');
+
+let ruleTester = new RuleTester({
+  parser: require.resolve('babel-eslint'),
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+  },
+});
+
+ruleTester.run('no-native-promise-helpers', rule, {
+  valid: [
+    `
+      import { all } from 'ember-concurrency';
+  
+      export default Component.extend({
+        submitTask: task(function*() {
+          yield all([
+            this.saveTask.perform(),
+            this.loadingSpinnerTask.perform(),
+          ]);
+        })
+      });
+    `,
+    `
+      import { all } from 'ember-concurrency';
+  
+      export default class extends Component {
+        @task(function*() {
+          yield all([
+            this.saveTask.perform(),
+            this.loadingSpinnerTask.perform(),
+          ]);
+        })
+        submitTask;
+      }
+    `,
+    `
+      import { all } from 'ember-concurrency';
+  
+      export default Component.extend({
+        async submit() {
+          await Promise.all([foo(), bar()]);
+        },
+      });
+    `,
+    `
+      import { all } from 'ember-concurrency';
+  
+      export default class extends Component {
+        async submit() {
+          await Promise.all([foo(), bar()]);
+        }
+      }
+    `,
+    `
+      import { all } from 'ember-concurrency';
+  
+      export default class extends Component {
+        *submit() {
+          yield Promise.all([foo(), bar()]);
+        }
+      }
+    `,
+    `
+      export default Component.extend({
+        submitTask: foo(function*() {
+          yield Promise.all([
+            this.saveTask.perform(),
+            this.loadingSpinnerTask.perform(),
+          ]);
+        })
+      });
+    `,
+  ],
+
+  invalid: [
+    {
+      code: `
+        export default Component.extend({
+          submitTask: task(function*() {
+            yield Promise.all([
+              this.saveTask.perform(),
+              this.loadingSpinnerTask.perform(),
+            ]);
+          })
+        });
+      `,
+      errors: [
+        {
+          message: "Use `import { all } from 'ember-concurrency';` instead of `Promise.all()`",
+          line: 4,
+          column: 19,
+          endLine: 7,
+          endColumn: 15,
+        },
+      ],
+    },
+    {
+      code: `
+        export default class extends Component {
+          @task(function*() {
+            yield Promise.all([
+              this.saveTask.perform(),
+              this.loadingSpinnerTask.perform(),
+            ]);
+          })
+          submitTask;
+        }
+      `,
+      errors: [
+        {
+          message: "Use `import { all } from 'ember-concurrency';` instead of `Promise.all()`",
+          line: 4,
+          column: 19,
+          endLine: 7,
+          endColumn: 15,
+        },
+      ],
+    },
+    {
+      code: `
+        export default class extends Component {
+          @task(function*() {
+            yield Promise.race([
+              this.saveTask.perform(),
+              this.loadingSpinnerTask.perform(),
+            ]);
+          })
+          submitTask;
+        }
+      `,
+      errors: [
+        {
+          message: "Use `import { race } from 'ember-concurrency';` instead of `Promise.race()`",
+          line: 4,
+          column: 19,
+          endLine: 7,
+          endColumn: 15,
+        },
+      ],
+    },
+    {
+      code: `
+        export default class extends Component {
+          @task(function*() {
+            yield Promise.allSettled([
+              this.saveTask.perform(),
+              this.loadingSpinnerTask.perform(),
+            ]);
+          })
+          submitTask;
+        }
+      `,
+      errors: [
+        {
+          message:
+            "Use `import { allSettled } from 'ember-concurrency';` instead of `Promise.allSettled()`",
+          line: 4,
+          column: 19,
+          endLine: 7,
+          endColumn: 15,
+        },
+      ],
+    },
+  ],
+});