meta(eslint-config): Don't allow voiding Promises (#9814)

getsentry · Dec 20, 2023 · 7ace093 · 7ace093
1 parent bf32ea4
commit 7ace093
Show file tree

Hide file tree

Showing 40 changed files with 179 additions and 82 deletions.
diff --git a/packages/browser-integration-tests/utils/replayHelpers.ts b/packages/browser-integration-tests/utils/replayHelpers.ts
@@ -105,40 +105,35 @@ export function waitForReplayRequest(
  * Wait until a callback returns true, collecting all replay responses along the way.
  * This can be useful when you don't know if stuff will be in one or multiple replay requests.
  */
-export function waitForReplayRequests(
+export async function waitForReplayRequests(
   page: Page,
   callback: (event: ReplayEvent, res: Response) => boolean,
   timeout?: number,
 ): Promise<Response[]> {
   const responses: Response[] = [];
 
-  return new Promise<Response[]>(resolve => {
-    void page.waitForResponse(
-      res => {
-        const req = res.request();
+  await page.waitForResponse(
+    res => {
+      const req = res.request();
 
-        const event = getReplayEventFromRequest(req);
+      const event = getReplayEventFromRequest(req);
 
-        if (!event) {
-          return false;
-        }
+      if (!event) {
+        return false;
+      }
 
-        responses.push(res);
+      responses.push(res);
 
-        try {
-          if (callback(event, res)) {
-            resolve(responses);
-            return true;
-          }
+      try {
+        return callback(event, res);
+      } catch {
+        return false;
+      }
+    },
+    timeout ? { timeout } : undefined,
+  );
 
-          return false;
-        } catch {
-          return false;
-        }
-      },
-      timeout ? { timeout } : undefined,
-    );
-  });
+  return responses;
 }
 
 export function isReplayEvent(event: Event): event is ReplayEvent {

diff --git a/packages/browser/src/client.ts b/packages/browser/src/client.ts
@@ -106,7 +106,10 @@ export class BrowserClient extends BaseClient<BrowserClientOptions> {
       dsn: this.getDsn(),
       tunnel: this.getOptions().tunnel,
     });
-    void this._sendEnvelope(envelope);
+
+    // _sendEnvelope should not throw
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this._sendEnvelope(envelope);
   }
 
   /**
@@ -137,6 +140,9 @@ export class BrowserClient extends BaseClient<BrowserClientOptions> {
     DEBUG_BUILD && logger.log('Sending outcomes:', outcomes);
 
     const envelope = createClientReportEnvelope(outcomes, this._options.tunnel && dsnToString(this._dsn));
-    void this._sendEnvelope(envelope);
+
+    // _sendEnvelope should not throw
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this._sendEnvelope(envelope);
   }
 }
diff --git a/packages/browser/src/profiling/hubextensions.ts b/packages/browser/src/profiling/hubextensions.ts
@@ -139,7 +139,8 @@ export function startProfileForTransaction(transaction: Transaction): Transactio
       );
     }
     // If the timeout exceeds, we want to stop profiling, but not finish the transaction
-    void onProfileHandler();
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    onProfileHandler();
   }, MAX_PROFILE_DURATION_MS);
 
   // We need to reference the original finish call to avoid creating an infinite loop

diff --git a/packages/core/src/baseclient.ts b/packages/core/src/baseclient.ts
@@ -375,7 +375,10 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
    */
   public sendSession(session: Session | SessionAggregates): void {
     const env = createSessionEnvelope(session, this._dsn, this._options._metadata, this._options.tunnel);
-    void this._sendEnvelope(env);
+
+    // _sendEnvelope should not throw
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this._sendEnvelope(env);
   }
 
   /**
@@ -409,7 +412,10 @@ export abstract class BaseClient<O extends ClientOptions> implements Client<O> {
       this._options._metadata,
       this._options.tunnel,
     );
-    void this._sendEnvelope(metricsEnvelope);
+
+    // _sendEnvelope should not throw
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this._sendEnvelope(metricsEnvelope);
   }
 
   // Keep on() & emit() signatures in sync with types' client.ts interface

diff --git a/packages/core/src/server-runtime-client.ts b/packages/core/src/server-runtime-client.ts
@@ -193,7 +193,11 @@ export class ServerRuntimeClient<
     );
 
     DEBUG_BUILD && logger.info('Sending checkin:', checkIn.monitorSlug, checkIn.status);
-    void this._sendEnvelope(envelope);
+
+    // _sendEnvelope should not throw
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    this._sendEnvelope(envelope);
+
     return id;
   }
 

diff --git a/packages/deno/src/integrations/globalhandlers.ts b/packages/deno/src/integrations/globalhandlers.ts
@@ -79,10 +79,16 @@ function installGlobalErrorHandler(client: Client): void {
     data.preventDefault();
     isExiting = true;
 
-    void flush().then(() => {
-      // rethrow to replicate Deno default behavior
-      throw error;
-    });
+    flush().then(
+      () => {
+        // rethrow to replicate Deno default behavior
+        throw error;
+      },
+      () => {
+        // rethrow to replicate Deno default behavior
+        throw error;
+      },
+    );
   });
 }
 
@@ -122,10 +128,16 @@ function installGlobalUnhandledRejectionHandler(client: Client): void {
     e.preventDefault();
     isExiting = true;
 
-    void flush().then(() => {
-      // rethrow to replicate Deno default behavior
-      throw error;
-    });
+    flush().then(
+      () => {
+        // rethrow to replicate Deno default behavior
+        throw error;
+      },
+      () => {
+        // rethrow to replicate Deno default behavior
+        throw error;
+      },
+    );
   });
 }
 

diff --git a/packages/e2e-tests/prepare.ts b/packages/e2e-tests/prepare.ts
@@ -21,4 +21,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/e2e-tests/run.ts b/packages/e2e-tests/run.ts
@@ -80,4 +80,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/eslint-config-sdk/src/base.js b/packages/eslint-config-sdk/src/base.js
@@ -84,7 +84,7 @@ module.exports = {
         '@typescript-eslint/no-unused-expressions': ['error', { allowShortCircuit: true }],
 
         // Make sure Promises are handled appropriately
-        '@typescript-eslint/no-floating-promises': 'error',
+        '@typescript-eslint/no-floating-promises': ['error', { ignoreVoid: false }],
 
         // Disallow delete operator. We should make this operation opt in (by disabling this rule).
         '@typescript-eslint/no-dynamic-delete': 'error',
@@ -158,7 +158,17 @@ module.exports = {
       env: {
         jest: true,
       },
-      files: ['test.ts', '*.test.ts', '*.test.tsx', '*.test.js', '*.test.jsx', 'test/**/*.ts', 'test/**/*.js'],
+      files: [
+        'test.ts',
+        '*.test.ts',
+        '*.test.tsx',
+        '*.test.js',
+        '*.test.jsx',
+        'test/**/*.ts',
+        'test/**/*.js',
+        'tests/**/*.ts',
+        'tests/**/*.js',
+      ],
       rules: {
         'max-lines': 'off',
         '@typescript-eslint/explicit-function-return-type': 'off',
@@ -171,6 +181,7 @@ module.exports = {
         '@typescript-eslint/no-empty-function': 'off',
         '@sentry-internal/sdk/no-optional-chaining': 'off',
         '@sentry-internal/sdk/no-nullish-coalescing': 'off',
+        '@typescript-eslint/no-floating-promises': 'off',
       },
     },
     {

diff --git a/packages/integrations/scripts/buildBundles.ts b/packages/integrations/scripts/buildBundles.ts
@@ -47,7 +47,8 @@ if (runParallel) {
       process.exit(1);
     });
 } else {
-  void (async () => {
+  // eslint-disable-next-line @typescript-eslint/no-floating-promises
+  (async () => {
     for (const integration of getIntegrations()) {
       await buildBundle(integration, 'es5');
       await buildBundle(integration, 'es6');

diff --git a/packages/nextjs/src/common/utils/responseEnd.ts b/packages/nextjs/src/common/utils/responseEnd.ts
@@ -26,7 +26,7 @@ import type { ResponseEndMethod, WrappedResponseEndMethod } from '../types';
 export function autoEndTransactionOnResponseEnd(transaction: Transaction, res: ServerResponse): void {
   const wrapEndMethod = (origEnd: ResponseEndMethod): WrappedResponseEndMethod => {
     return function sentryWrappedEnd(this: ServerResponse, ...args: unknown[]) {
-      void finishTransaction(transaction, this);
+      finishTransaction(transaction, this);
       return origEnd.call(this, ...args);
     };
   };
@@ -39,7 +39,7 @@ export function autoEndTransactionOnResponseEnd(transaction: Transaction, res: S
 }
 
 /** Finish the given response's transaction and set HTTP status data */
-export async function finishTransaction(transaction: Transaction | undefined, res: ServerResponse): Promise<void> {
+export function finishTransaction(transaction: Transaction | undefined, res: ServerResponse): void {
   if (transaction) {
     transaction.setHttpStatus(res.statusCode);
     transaction.finish();

diff --git a/packages/nextjs/src/common/withServerActionInstrumentation.ts b/packages/nextjs/src/common/withServerActionInstrumentation.ts
@@ -129,7 +129,9 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
       }
 
       if (process.env.NEXT_RUNTIME === 'edge') {
-        void flushQueue();
+        // flushQueue should not throw
+        // eslint-disable-next-line @typescript-eslint/no-floating-promises
+        flushQueue();
       }
     }
 

diff --git a/packages/nextjs/src/common/wrapApiHandlerWithSentry.ts b/packages/nextjs/src/common/wrapApiHandlerWithSentry.ts
@@ -153,7 +153,7 @@ export function withSentry(apiHandler: NextApiHandler, parameterizedRoute?: stri
               const origResEnd = res.end;
               res.end = async function (this: unknown, ...args: unknown[]) {
                 if (transaction) {
-                  await finishTransaction(transaction, res);
+                  finishTransaction(transaction, res);
                   await flushQueue();
                 }
 
@@ -207,15 +207,14 @@ export function withSentry(apiHandler: NextApiHandler, parameterizedRoute?: stri
             res.statusCode = 500;
             res.statusMessage = 'Internal Server Error';
 
+            finishTransaction(transaction, res);
+
             // Make sure we have a chance to finish the transaction and flush events to Sentry before the handler errors
             // out. (Apps which are deployed on Vercel run their API routes in lambdas, and those lambdas will shut down the
             // moment they detect an error, so it's important to get this done before rethrowing the error. Apps not
             // deployed serverlessly will run into this cleanup code again in `res.end(), but the transaction will already
             // be finished and the queue will already be empty, so effectively it'll just no-op.)
             if (platformSupportsStreaming() && !wrappingTarget.__sentry_test_doesnt_support_streaming__) {
-              void finishTransaction(transaction, res);
-            } else {
-              await finishTransaction(transaction, res);
               await flushQueue();
             }
 

diff --git a/packages/nextjs/src/common/wrapServerComponentWithSentry.ts b/packages/nextjs/src/common/wrapServerComponentWithSentry.ts
@@ -88,7 +88,9 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
             }
           },
           () => {
-            void flushQueue();
+            // flushQueue should not throw
+            // eslint-disable-next-line @typescript-eslint/no-floating-promises
+            flushQueue();
           },
         );
 

diff --git a/packages/node-integration-tests/suites/tracing-new/apollo-graphql/scenario.ts b/packages/node-integration-tests/suites/tracing-new/apollo-graphql/scenario.ts
@@ -31,7 +31,8 @@ const transaction = Sentry.startTransaction({ name: 'test_transaction', op: 'tra
 
 Sentry.getCurrentScope().setSpan(transaction);
 
-void (async () => {
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+(async () => {
   // Ref: https://www.apollographql.com/docs/apollo-server/testing/testing/#testing-using-executeoperation
   await server.executeOperation({
     query: '{hello}',

diff --git a/packages/node-integration-tests/suites/tracing-new/auto-instrument/mongodb/scenario.ts b/packages/node-integration-tests/suites/tracing-new/auto-instrument/mongodb/scenario.ts
@@ -41,4 +41,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/node-integration-tests/suites/tracing-new/prisma-orm/scenario.ts b/packages/node-integration-tests/suites/tracing-new/prisma-orm/scenario.ts
@@ -42,4 +42,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/node-integration-tests/suites/tracing/apollo-graphql/scenario.ts b/packages/node-integration-tests/suites/tracing/apollo-graphql/scenario.ts
@@ -33,7 +33,8 @@ const transaction = Sentry.startTransaction({ name: 'test_transaction', op: 'tra
 
 Sentry.getCurrentScope().setSpan(transaction);
 
-void (async () => {
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+(async () => {
   // Ref: https://www.apollographql.com/docs/apollo-server/testing/testing/#testing-using-executeoperation
   await server.executeOperation({
     query: '{hello}',

diff --git a/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/scenario.ts b/packages/node-integration-tests/suites/tracing/auto-instrument/mongodb/scenario.ts
@@ -42,4 +42,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/node-integration-tests/suites/tracing/prisma-orm/scenario.ts b/packages/node-integration-tests/suites/tracing/prisma-orm/scenario.ts
@@ -44,4 +44,5 @@ async function run(): Promise<void> {
   }
 }
 
-void run();
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+run();
diff --git a/packages/node-integration-tests/utils/index.ts b/packages/node-integration-tests/utils/index.ts
@@ -184,7 +184,8 @@ export class TestEnv {
       envelopeTypeArray,
     );
 
-    void makeRequest(options.method, options.url || this.url, this._axiosConfig);
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    makeRequest(options.method, options.url || this.url, this._axiosConfig);
     return resProm;
   }
 
@@ -305,7 +306,8 @@ export class TestEnv {
 
           nock.cleanAll();
 
-          void this._closeServer().then(() => {
+          // eslint-disable-next-line @typescript-eslint/no-floating-promises
+          this._closeServer().then(() => {
             resolve(reqCount);
           });
         },

diff --git a/packages/node-integration-tests/utils/run-tests.ts b/packages/node-integration-tests/utils/run-tests.ts
@@ -70,7 +70,8 @@ const workers = os.cpus().map(async (_, i) => {
   }
 });
 
-void Promise.all(workers).then(() => {
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
+Promise.all(workers).then(() => {
   console.log('-------------------');
   console.log(`Successfully ran ${numTests} tests.`);
   if (fails.length > 0) {

diff --git a/packages/node/src/integrations/anr/worker.ts b/packages/node/src/integrations/anr/worker.ts
@@ -152,7 +152,9 @@ if (options.captureStackTrace) {
           session.post('Debugger.disable');
 
           const context = trace_id?.length && span_id?.length ? { trace_id, span_id, parent_span_id } : undefined;
-          void sendAnrEvent(stackFrames, context);
+          sendAnrEvent(stackFrames, context).then(null, () => {
+            log('Sending ANR event failed.');
+          });
         },
       );
     } catch (e) {
@@ -196,7 +198,9 @@ function watchdogTimeout(): void {
     debuggerPause();
   } else {
     log('Capturing event without a stack trace');
-    void sendAnrEvent();
+    sendAnrEvent().then(null, () => {
+      log('Sending ANR event failed on watchdog timeout.');
+    });
   }
 }