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

Author: Luca Forstner

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 {

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);
   }
 }

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

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

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;
   }
 

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;
+      },
+    );
   });
 }
 

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();

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();

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',
       },
     },
     {

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');