fix: Enabled @typescript-eslint/return-await rule and fixed offending…

… code (#2157) Enabled `@typescript-eslint/return-await` eslint rule and fixed offending code. fixes #2154 BREAKING CHANGE: Fix any try / catch blocks that return non-awaited Promises
deephaven · Jul 22, 2024 · 7875d03 · 7875d03
1 parent 8b20692
commit 7875d03
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/packages/eslint-config/index.js b/packages/eslint-config/index.js
@@ -96,6 +96,10 @@ module.exports = {
         '@typescript-eslint/default-param-last': ['error'],
         '@typescript-eslint/explicit-module-boundary-types': 'error',
         '@typescript-eslint/method-signature-style': 'error',
+        // `no-return-await` needs to be disabled when enabling `@typescript-eslint/return-await`
+        // to avoid incorrectly reporting errors
+        'no-return-await': 'off',
+        '@typescript-eslint/return-await': 'error',
       },
     },
     {

diff --git a/packages/iris-grid/src/IrisGridTableModelTemplate.ts b/packages/iris-grid/src/IrisGridTableModelTemplate.ts
@@ -1528,7 +1528,9 @@ class IrisGridTableModelTemplate<
       table = await this.table.copy();
       table.applyFilter([]);
       table.applySort([]);
-      return table.selectDistinct(Array.isArray(columns) ? columns : [columns]);
+      return await table.selectDistinct(
+        Array.isArray(columns) ? columns : [columns]
+      );
     } finally {
       if (table != null) {
         table.close();

diff --git a/packages/utils/src/ClipboardUtils.test.ts b/packages/utils/src/ClipboardUtils.test.ts
@@ -10,7 +10,7 @@ describe('Clipboard', () => {
       Object.assign(navigator, {
         clipboard: {
           // eslint-disable-next-line @typescript-eslint/no-empty-function
-          writeText: () => {},
+          writeText: async () => {},
         },
       });
       jest.spyOn(navigator.clipboard, 'writeText');
@@ -22,7 +22,7 @@ describe('Clipboard', () => {
     it('should call copyToClipboardExecCommand if writeText fails', async () => {
       Object.assign(navigator, {
         clipboard: {
-          writeText: () => {
+          writeText: async () => {
             throw new Error('Could not write text');
           },
         },

diff --git a/packages/utils/src/ClipboardUtils.ts b/packages/utils/src/ClipboardUtils.ts
@@ -7,9 +7,10 @@ export async function copyToClipboard(text: string): Promise<void> {
   const { clipboard } = navigator;
   if (clipboard !== undefined) {
     try {
-      return navigator.clipboard.writeText(text);
+      return await navigator.clipboard.writeText(text);
     } catch {
-      return copyToClipboardExecCommand(text);
+      // Ignore error. Fallback to `copyToClipboardExecCommand` below
+      // (same as when clipboard is not available).
     }
   }
   copyToClipboardExecCommand(text);