Upgrade typescript-eslint (#528)

Upgrade to the current version of `typescript-eslint`.

Part 1 of #489.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **Chores**
- Updated developer dependencies and linting configurations to improve
code quality.
- **Refactor**
- Streamlined asynchronous operations by eliminating redundant promise
wrapping for clearer execution.
- **Style**
- Refined inline guidance and error-handling patterns for consistent
development practices.
- **Tests**
	- Adjusted test directives to align with updated standards.

These internal improvements enhance maintainability and performance
without altering visible features for end-users.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

Co-authored-by: Alexey Romanov <[email protected]>

Author: alexeyr-ci2

.eslintrc

@@ -68,7 +68,7 @@ overrides:
       "@typescript-eslint/restrict-template-expressions": off
       "@typescript-eslint/no-unused-vars":
         - error
-        - { argsIgnorePattern: "^_" }
+        - { argsIgnorePattern: "^_", caughtErrorsIgnorePattern: "^_" }
       "@typescript-eslint/no-floating-promises":
         - error
         - allowForKnownSafePromises:

package.json

@@ -85,7 +85,7 @@
     "sentry-testkit": "^5.0.6",
     "touch": "^3.1.0",
     "typescript": "^5.4.3",
-    "typescript-eslint": "^7.4.0",
+    "typescript-eslint": "^8.29.1",
     "yalc": "^1.0.0-pre.53"
   },
   "peerDependencies": {

packages/node-renderer/src/ReactOnRailsProNodeRenderer.ts

@@ -26,13 +26,13 @@ and for "@fastify/..." dependencies in your package.json. Consider removing them
     );
   }
 
-  /* eslint-disable global-require,@typescript-eslint/no-var-requires --
+  /* eslint-disable global-require,@typescript-eslint/no-require-imports --
    * Using normal `import` fails before the check above.
    */
   if (cluster.isPrimary) {
     (require('./master') as typeof import('./master'))(config);
   } else {
     await (require('./worker') as typeof import('./worker')).default(config).ready();
   }
-  /* eslint-enable global-require,@typescript-eslint/no-var-requires */
+  /* eslint-enable global-require,@typescript-eslint/no-require-imports */
 }

packages/node-renderer/src/integrations/sentry6.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-deprecated */
 import { captureException, captureMessage, startTransaction } from '@sentry/node';
 import { CaptureContext, TransactionContext } from '@sentry/types';
 import { addErrorNotifier, addMessageNotifier, message, setupTracing } from './api';
@@ -23,9 +24,9 @@ export function init({ tracing = false } = {}) {
 
   if (tracing) {
     try {
-      // eslint-disable-next-line global-require,import/no-unresolved -- Intentionally absent in our devDependencies
+      // eslint-disable-next-line global-require,import/no-unresolved,@typescript-eslint/no-require-imports -- Intentionally absent in our devDependencies
       require('@sentry/tracing');
-    } catch (e) {
+    } catch (_e) {
       message("Failed to load '@sentry/tracing'. Tracing is disabled.");
       return;
     }

packages/node-renderer/src/shared/log.ts

@@ -5,10 +5,10 @@ let pretty = false;
 
 if (process.env.NODE_ENV === 'development' || process.env.NODE_ENV === 'test') {
   try {
-    // eslint-disable-next-line global-require
+    // eslint-disable-next-line global-require,@typescript-eslint/no-require-imports
     require('pino-pretty');
     pretty = true;
-  } catch (e) {
+  } catch (_e) {
     console.log('pino-pretty not found in development, using the default pino log settings');
   }
 }

packages/node-renderer/src/shared/tracing.ts

@@ -1,5 +1,6 @@
 import { message } from './errorReporter';
 
+/* eslint-disable @typescript-eslint/no-empty-object-type -- empty interfaces are used as targets for augmentation */
 /**
  * This contains the options necessary to start a unit of work (transaction/span/etc.).
  * Integrations should augment it using their name as the property.
@@ -21,6 +22,7 @@ export interface UnitOfWorkOptions {}
  * {@link import('@sentry/types').CaptureContext} parameter, and so it adds `{ sentry6: CaptureContext }`.
  */
 export interface TracingContext {}
+/* eslint-enable @typescript-eslint/no-empty-object-type */
 
 let setupRun = false;
 

packages/node-renderer/src/worker/handleRenderRequest.ts

@@ -42,29 +42,29 @@ async function prepareResult(
     }
 
     if (exceptionMessage) {
-      return Promise.resolve(errorResponseResult(exceptionMessage));
+      return errorResponseResult(exceptionMessage);
     }
 
     if (isReadableStream(result)) {
       const newStreamAfterHandlingError = handleStreamError(result, (error) => {
         const msg = formatExceptionMessage(renderingRequest, error, 'Error in a rendering stream');
         errorReporter.message(msg);
       });
-      return Promise.resolve({
+      return {
         headers: { 'Cache-Control': 'public, max-age=31536000' },
         status: 200,
         stream: newStreamAfterHandlingError,
-      });
+      };
     }
 
-    return Promise.resolve({
+    return {
       headers: { 'Cache-Control': 'public, max-age=31536000' },
       status: 200,
       data: result,
-    });
+    };
   } catch (err) {
     const exceptionMessage = formatExceptionMessage(renderingRequest, err, 'Unknown error calling runInVM');
-    return Promise.resolve(errorResponseResult(exceptionMessage));
+    return errorResponseResult(exceptionMessage);
   }
 }
 
@@ -100,7 +100,7 @@ async function handleNewBundleProvided(
         errorMessage,
         `Failed to acquire lock ${lockfileName}. Worker: ${workerIdLabel()}.`,
       );
-      return Promise.resolve(errorResponseResult(msg));
+      return errorResponseResult(msg);
     }
 
     try {
@@ -123,7 +123,7 @@ async function handleNewBundleProvided(
 to ${bundleFilePathPerTimestamp})`,
         );
         log.error(msg);
-        return Promise.resolve(errorResponseResult(msg));
+        return errorResponseResult(msg);
       }
       log.info(
         'File exists when trying to overwrite bundle %s. Assuming bundle written by other thread',
@@ -136,14 +136,14 @@ to ${bundleFilePathPerTimestamp})`,
       // file must be fully written
       log.info('buildVM, bundleFilePathPerTimestamp', bundleFilePathPerTimestamp);
       await buildVM(bundleFilePathPerTimestamp);
-      return prepareResult(renderingRequest, bundleFilePathPerTimestamp);
+      return await prepareResult(renderingRequest, bundleFilePathPerTimestamp);
     } catch (error) {
       const msg = formatExceptionMessage(
         renderingRequest,
         error,
         `Unexpected error when building the VM ${bundleFilePathPerTimestamp}`,
       );
-      return Promise.resolve(errorResponseResult(msg));
+      return errorResponseResult(msg);
     }
   } finally {
     if (lockAcquired) {
@@ -185,12 +185,12 @@ export = async function handleRenderRequest({
 
     // If the current VM has the correct bundle and is ready
     if (hasVMContextForBundle(bundleFilePathPerTimestamp)) {
-      return prepareResult(renderingRequest, bundleFilePathPerTimestamp);
+      return await prepareResult(renderingRequest, bundleFilePathPerTimestamp);
     }
 
     // If gem has posted updated bundle:
     if (providedNewBundle) {
-      return handleNewBundleProvided(
+      return await handleNewBundleProvided(
         bundleFilePathPerTimestamp,
         providedNewBundle,
         renderingRequest,
@@ -202,19 +202,19 @@ export = async function handleRenderRequest({
     const fileExists = await fileExistsAsync(bundleFilePathPerTimestamp);
     if (!fileExists) {
       log.info(`No saved bundle ${bundleFilePathPerTimestamp}. Requesting a new bundle.`);
-      return Promise.resolve({
+      return {
         headers: { 'Cache-Control': 'no-cache, no-store, max-age=0, must-revalidate' },
         status: 410,
         data: 'No bundle uploaded',
-      });
+      };
     }
 
     // The bundle exists, but the VM has not yet been created.
     // Another worker must have written it or it was saved during deployment.
     log.info('Bundle %s exists. Building VM for worker %s.', bundleFilePathPerTimestamp, workerIdLabel());
     await buildVM(bundleFilePathPerTimestamp);
 
-    return prepareResult(renderingRequest, bundleFilePathPerTimestamp);
+    return await prepareResult(renderingRequest, bundleFilePathPerTimestamp);
   } catch (error) {
     const msg = formatExceptionMessage(
       renderingRequest,

packages/node-renderer/src/worker/vm.ts

@@ -319,7 +319,7 @@ ${smartTrim(result)}`);
       await writeFileAsync(debugOutputPathResult, result);
     }
 
-    return Promise.resolve(result);
+    return result;
   } catch (exception) {
     const exceptionMessage = formatExceptionMessage(renderingRequest, exception);
     log.debug('Caught exception in rendering request', exceptionMessage);

packages/node-renderer/tests/shared/tracing.test.ts

@@ -34,6 +34,7 @@ test('should run function and finish span', async () => {
     await fn();
   }, testTransactionContext);
   expect(savedSpan).toBeDefined();
+  // eslint-disable-next-line @typescript-eslint/no-deprecated -- the suggested replacement doesn't work
   expect(savedSpan?.name).toBe(spanName);
   expect(Sentry.getActiveSpan()).not.toBe(savedSpan);
   expect(fn.mock.calls).toHaveLength(1);