feat(eslint): Add no-return-await rule to eslint config (#8388)

Add https://eslint.org/docs/latest/rules/no-return-await to eslint
config to remove usage of uneeded async/await calls. This helps reduce
microtasks being generated, which can help reduce memory pressure caused
by the SDK.

The downside of removing `return await` is that stacktraces get slightly
worse for async errors that use these methods, as we no longer pause
execution on return for the engine to grab context on, but instead just
pass through the promise, but I think it's worth it for this to be the
default, and for us to opt-in to the better stacktraces if need be.

Author: AbhiPrasad

packages/browser-integration-tests/utils/helpers.ts

@@ -268,7 +268,7 @@ async function injectScriptAndGetEvents(page: Page, url: string, scriptPath: str
   await page.goto(url);
   await runScriptInSandbox(page, scriptPath);
 
-  return await getSentryEvents(page);
+  return getSentryEvents(page);
 }
 
 export {

packages/browser-integration-tests/utils/replayHelpers.ts

@@ -132,14 +132,14 @@ export async function waitForReplayRunning(page: Page): Promise<void> {
  * Note that due to how this works with playwright, this is a POJO copy of replay.
  * This means that we cannot access any methods on it, and also not mutate it in any way.
  */
-export async function getReplaySnapshot(page: Page): Promise<{
+export function getReplaySnapshot(page: Page): Promise<{
   _isPaused: boolean;
   _isEnabled: boolean;
   _context: InternalEventContext;
   session: Session | undefined;
   recordingMode: ReplayRecordingMode;
 }> {
-  return await page.evaluate(() => {
+  return page.evaluate(() => {
     const replayIntegration = (window as unknown as Window & { Replay: { _replay: ReplayContainer } }).Replay;
     const replay = replayIntegration._replay;
 

packages/e2e-tests/test-utils/event-proxy-server.ts

@@ -243,7 +243,7 @@ async function registerCallbackServerPort(serverName: string, port: string): Pro
   await writeFile(tmpFilePath, port, { encoding: 'utf8' });
 }
 
-async function retrieveCallbackServerPort(serverName: string): Promise<string> {
+function retrieveCallbackServerPort(serverName: string): Promise<string> {
   const tmpFilePath = path.join(os.tmpdir(), `${TEMP_FILE_PREFIX}${serverName}`);
-  return await readFile(tmpFilePath, 'utf8');
+  return readFile(tmpFilePath, 'utf8');
 }

packages/eslint-config-sdk/src/index.js

@@ -261,5 +261,8 @@ module.exports = {
     'array-callback-return': ['error', { allowImplicit: true }],
 
     quotes: ['error', 'single', { avoidEscape: true }],
+
+    // Remove uncessary usages of async await to prevent extra micro-tasks
+    'no-return-await': 'error',
   },
 };

packages/nextjs/src/client/wrapAppGetInitialPropsWithSentry.ts

@@ -8,8 +8,8 @@ type AppGetInitialProps = (typeof App)['getInitialProps'];
  */
 export function wrapAppGetInitialPropsWithSentry(origAppGetInitialProps: AppGetInitialProps): AppGetInitialProps {
   return new Proxy(origAppGetInitialProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<AppGetInitialProps>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<AppGetInitialProps>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }

packages/nextjs/src/client/wrapDocumentGetInitialPropsWithSentry.ts

@@ -10,8 +10,8 @@ export function wrapDocumentGetInitialPropsWithSentry(
   origDocumentGetInitialProps: DocumentGetInitialProps,
 ): DocumentGetInitialProps {
   return new Proxy(origDocumentGetInitialProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<DocumentGetInitialProps>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<DocumentGetInitialProps>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }

packages/nextjs/src/client/wrapErrorGetInitialPropsWithSentry.ts

@@ -11,8 +11,8 @@ export function wrapErrorGetInitialPropsWithSentry(
   origErrorGetInitialProps: ErrorGetInitialProps,
 ): ErrorGetInitialProps {
   return new Proxy(origErrorGetInitialProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<ErrorGetInitialProps>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<ErrorGetInitialProps>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }

packages/nextjs/src/client/wrapGetInitialPropsWithSentry.ts

@@ -8,8 +8,8 @@ type GetInitialProps = Required<NextPage>['getInitialProps'];
  */
 export function wrapGetInitialPropsWithSentry(origGetInitialProps: GetInitialProps): GetInitialProps {
   return new Proxy(origGetInitialProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<GetInitialProps>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<GetInitialProps>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }

packages/nextjs/src/client/wrapGetServerSidePropsWithSentry.ts

@@ -6,8 +6,8 @@ import type { GetServerSideProps } from 'next';
  */
 export function wrapGetServerSidePropsWithSentry(origGetServerSideProps: GetServerSideProps): GetServerSideProps {
   return new Proxy(origGetServerSideProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<GetServerSideProps>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<GetServerSideProps>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }

packages/nextjs/src/client/wrapGetStaticPropsWithSentry.ts

@@ -8,8 +8,8 @@ type Props = { [key: string]: unknown };
  */
 export function wrapGetStaticPropsWithSentry(origGetStaticProps: GetStaticProps<Props>): GetStaticProps<Props> {
   return new Proxy(origGetStaticProps, {
-    apply: async (wrappingTarget, thisArg, args: Parameters<GetStaticProps<Props>>) => {
-      return await wrappingTarget.apply(thisArg, args);
+    apply: (wrappingTarget, thisArg, args: Parameters<GetStaticProps<Props>>) => {
+      return wrappingTarget.apply(thisArg, args);
     },
   });
 }