add eslint rules for promises

.eslintrc.yml

@@ -9,6 +9,7 @@ plugins:
   - node
   - import
   - simple-import-sort
+  - promise
 settings:
   node:
     tryExtensions: ['.js', '.ts', '.jsx', '.json', '.node', '.d.ts']
@@ -177,6 +178,27 @@ rules:
         - ["^\\./"]
   simple-import-sort/exports: off # TODO
 
+  ##############################################################################
+  # `eslint-plugin-promise` rule list based on `v6.1.x`
+  # https://github.com/eslint-community/eslint-plugin-promise/blob/main/README.md
+  ##############################################################################
+
+  promise/always-return: error
+  promise/avoid-new: off
+  promise/catch-or-return: error
+  promise/no-callback-in-promise: error
+  promise/no-multiple-resolved: error
+  promise/no-native: off
+  promise/no-nesting: error
+  promise/no-new-statics: error
+  promise/no-promise-in-callback: off
+  promise/no-return-in-finally: error
+  promise/no-return-wrap: error
+  promise/param-names: error
+  promise/prefer-await-to-callbacks: off
+  promise/prefer-await-to-then: error
+  promise/valid-params: error
+
   ##############################################################################
   # ESLint builtin rules list based on `v8.27.x`
   ##############################################################################
@@ -629,7 +651,7 @@ overrides:
         ]
       '@typescript-eslint/no-useless-constructor': error
       '@typescript-eslint/require-await': error
-      '@typescript-eslint/return-await': error
+      '@typescript-eslint/return-await': [error, 'always']
 
       # Disable for JS and TS
       '@typescript-eslint/init-declarations': off

package.json

@@ -77,6 +77,7 @@
     "eslint-plugin-import": "2.26.0",
     "eslint-plugin-internal-rules": "file:./resources/eslint-internal-rules",
     "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.1.1",
     "eslint-plugin-react": "7.31.10",
     "eslint-plugin-react-hooks": "4.6.0",
     "eslint-plugin-simple-import-sort": "8.0.0",

resources/gen-changelog.ts

@@ -294,7 +294,7 @@ async function getPRsInfo(
   let prNumbers = await splitBatches(commits, batchCommitToPR);
   prNumbers = Array.from(new Set(prNumbers)); // Remove duplicates
 
-  return splitBatches(prNumbers, batchPRInfo);
+  return await splitBatches(prNumbers, batchPRInfo);
 }
 
 // Split commits into batches of 50 to prevent timeouts

src/__testUtils__/__tests__/resolveOnNextTick-test.ts

@@ -7,12 +7,13 @@ describe('resolveOnNextTick', () => {
   it('resolves promise on the next tick', async () => {
     const output = [];
 
-    const promise1 = resolveOnNextTick().then(() => {
-      output.push('second');
-    });
-    const promise2 = resolveOnNextTick().then(() => {
-      output.push('third');
-    });
+    async function outputOnNextTick(message: string) {
+      await resolveOnNextTick();
+      output.push(message);
+    }
+
+    const promise1 = outputOnNextTick('second');
+    const promise2 = outputOnNextTick('third');
     output.push('first');
 
     await Promise.all([promise1, promise2]);

src/__testUtils__/expectEqualPromisesOrValues.ts

@@ -5,13 +5,18 @@ import type { PromiseOrValue } from '../jsutils/PromiseOrValue.js';
 
 import { expectMatchingValues } from './expectMatchingValues.js';
 
+async function expectMatchingPromises<T>(items: Promise<ReadonlyArray<T>>) {
+  const values = await items;
+  return expectMatchingValues(values);
+}
+
 export function expectEqualPromisesOrValues<T>(
   items: ReadonlyArray<PromiseOrValue<T>>,
 ): PromiseOrValue<T> {
   const [firstItem, ...remainingItems] = items;
   if (isPromise(firstItem)) {
     if (remainingItems.every(isPromise)) {
-      return Promise.all(items).then(expectMatchingValues);
+      return expectMatchingPromises(Promise.all(items));
     }
   } else if (remainingItems.every((item) => !isPromise(item))) {
     return expectMatchingValues(items);

src/execution/__tests__/executor-test.ts

@@ -419,7 +419,7 @@ describe('Execute: Handles basic execution tasks', () => {
         return new Promise((resolve) => resolve('async'));
       },
       asyncReject() {
-        return new Promise((_, reject) =>
+        return new Promise((_resolve, reject) =>
           reject(new Error('Error getting asyncReject')),
         );
       },

src/execution/__tests__/simplePubSub-test.ts

@@ -22,9 +22,13 @@ describe('SimplePubSub', () => {
       value: 'Banana',
     });
 
+    async function getNextItem(i: AsyncIterator<unknown>) {
+      return await i.next();
+    }
+
     // Read ahead
-    const i3 = iterator.next().then((x) => x);
-    const i4 = iterator.next().then((x) => x);
+    const i3 = getNextItem(iterator);
+    const i4 = getNextItem(iterator);
 
     // Publish
     expect(pubsub.emit('Coconut')).to.equal(true);
@@ -35,7 +39,7 @@ describe('SimplePubSub', () => {
     expect(await i3).to.deep.equal({ done: false, value: 'Coconut' });
 
     // Read ahead
-    const i5 = iterator.next().then((x) => x);
+    const i5 = getNextItem(iterator);
 
     // Terminate queue
     await iterator.return();

src/execution/__tests__/stream-test.ts

@@ -126,7 +126,7 @@ async function completeAsync(
   for (let i = 0; i < numCalls; i++) {
     promises.push(iterator.next());
   }
-  return Promise.all(promises);
+  return await Promise.all(promises);
 }
 
 function createResolvablePromise<T>(): [Promise<T>, (value?: T) => void] {
@@ -531,11 +531,6 @@ describe('Execute: stream directive', () => {
               },
             ],
           },
-        ],
-        hasNext: true,
-      },
-      {
-        incremental: [
           {
             items: [{ name: 'Leia', id: '3' }],
             path: ['friendList', 2],
@@ -984,11 +979,6 @@ describe('Execute: stream directive', () => {
               },
             ],
           },
-        ],
-        hasNext: true,
-      },
-      {
-        incremental: [
           {
             items: [{ nonNullName: 'Han' }],
             path: ['friendList', 2],