build: Switch @sentry/node to using eslint

Author: AbhiPrasad

.eslintrc.js

@@ -94,7 +94,7 @@ module.exports = {
       files: ['src/**/*'],
       rules: {
         // We want to prevent async await usage in our files to prevent uncessary bundle size.
-        'sentry-sdk/no-async-await': 'error',
+        'sentry-sdks/no-async-await': 'error',
 
         // JSDOC comments are required for classes and methods. As we have a public facing codebase, documentation,
         // even if it may seems excessive at times, is important to emphasize. Turned off in tests.

packages/node/.eslintrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
+  extends: ['../../.eslintrc.js'],
+  ignorePatterns: ['build/**/*', 'dist/**/*', 'esm/**/*', 'examples/**/*', 'scripts/**/*', 'test/manual/**/*'],
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx', '*.d.ts'],
+      parserOptions: {
+        project: './tsconfig.json',
+      },
+    },
+    {
+      files: ['test/**/*'],
+      rules: {
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-non-null-assertion': 'off',
+      },
+    },
+    {
+      files: ['test/**/*.js'],
+      rules: {
+        'import/order': 'off',
+      },
+    },
+  ],
+  rules: {
+    'prefer-rest-params': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    'sentry-sdks/no-async-await': 'off',
+  },
+};

packages/node/package.json

@@ -49,13 +49,12 @@
     "build:watch:esm": "tsc -p tsconfig.esm.json -w --preserveWatchOutput",
     "clean": "rimraf dist coverage",
     "link:yarn": "yarn link",
-    "lint": "run-s lint:prettier lint:tslint",
+    "lint": "run-s lint:prettier lint:eslint",
     "lint:prettier": "prettier-check \"{src,test}/**/*.ts\"",
-    "lint:tslint": "tslint -t stylish -p .",
-    "lint:tslint:json": "tslint --format json -p . | tee lint-results.json",
-    "fix": "run-s fix:tslint fix:prettier",
+    "lint:eslint": "eslint . --cache --cache-location '../../eslintcache/' --format stylish",
+    "fix": "run-s fix:eslint fix:prettier",
     "fix:prettier": "prettier --write \"{src,test}/**/*.ts\"",
-    "fix:tslint": "tslint --fix -t stylish -p .",
+    "fix:eslint": "eslint . --format stylish --fix",
     "test": "run-s test:jest test:express test:webpack",
     "test:jest": "jest",
     "test:watch": "jest --watch",

packages/node/src/backend.ts

@@ -19,9 +19,6 @@ import { HTTPSTransport, HTTPTransport } from './transports';
  * @see NodeClient for more information.
  */
 export interface NodeOptions extends Options {
-  /** Callback that is executed when a fatal global error occurs. */
-  onFatalError?(error: Error): void;
-
   /** Sets an optional server name (device name) */
   serverName?: string;
 
@@ -39,6 +36,9 @@ export interface NodeOptions extends Options {
 
   /** Sets the number of context lines for each frame when loading a file. */
   frameContextLines?: number;
+
+  /** Callback that is executed when a fatal global error occurs. */
+  onFatalError?(error: Error): void;
 }
 
 /**
@@ -49,35 +49,9 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
   /**
    * @inheritDoc
    */
-  protected _setupTransport(): Transport {
-    if (!this._options.dsn) {
-      // We return the noop transport here in case there is no Dsn.
-      return super._setupTransport();
-    }
-
-    const dsn = new Dsn(this._options.dsn);
-
-    const transportOptions: TransportOptions = {
-      ...this._options.transportOptions,
-      ...(this._options.httpProxy && { httpProxy: this._options.httpProxy }),
-      ...(this._options.httpsProxy && { httpsProxy: this._options.httpsProxy }),
-      ...(this._options.caCerts && { caCerts: this._options.caCerts }),
-      dsn: this._options.dsn,
-    };
-
-    if (this._options.transport) {
-      return new this._options.transport(transportOptions);
-    }
-    if (dsn.protocol === 'http') {
-      return new HTTPTransport(transportOptions);
-    }
-    return new HTTPSTransport(transportOptions);
-  }
-
-  /**
-   * @inheritDoc
-   */
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
   public eventFromException(exception: any, hint?: EventHint): PromiseLike<Event> {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     let ex: any = exception;
     const mechanism: Mechanism = {
       handled: true,
@@ -91,7 +65,7 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
         const message = `Non-Error exception captured with keys: ${extractExceptionKeysForMessage(exception)}`;
 
         getCurrentHub().configureScope(scope => {
-          scope.setExtra('__serialized__', normalizeToSize(exception as {}));
+          scope.setExtra('__serialized__', normalizeToSize(exception as Record<string, unknown>));
         });
 
         ex = (hint && hint.syntheticException) || new Error(message);
@@ -147,4 +121,32 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
       }
     });
   }
+
+  /**
+   * @inheritDoc
+   */
+  protected _setupTransport(): Transport {
+    if (!this._options.dsn) {
+      // We return the noop transport here in case there is no Dsn.
+      return super._setupTransport();
+    }
+
+    const dsn = new Dsn(this._options.dsn);
+
+    const transportOptions: TransportOptions = {
+      ...this._options.transportOptions,
+      ...(this._options.httpProxy && { httpProxy: this._options.httpProxy }),
+      ...(this._options.httpsProxy && { httpsProxy: this._options.httpsProxy }),
+      ...(this._options.caCerts && { caCerts: this._options.caCerts }),
+      dsn: this._options.dsn,
+    };
+
+    if (this._options.transport) {
+      return new this._options.transport(transportOptions);
+    }
+    if (dsn.protocol === 'http') {
+      return new HTTPTransport(transportOptions);
+    }
+    return new HTTPSTransport(transportOptions);
+  }
 }

packages/node/src/handlers.ts

@@ -1,3 +1,5 @@
+/* eslint-disable max-lines */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Span } from '@sentry/apm';
 import { captureException, getCurrentHub, startTransaction, withScope } from '@sentry/core';
 import { Event } from '@sentry/types';
@@ -253,7 +255,7 @@ export function parseRequest(
   },
   options?: ParseRequestOptions,
 ): Event {
-  // tslint:disable-next-line:no-parameter-reassignment
+  // eslint-disable-next-line no-param-reassign
   options = {
     ip: false,
     request: true,
@@ -334,7 +336,7 @@ export function requestHandler(
     next: (error?: any) => void,
   ): void {
     if (options && options.flushTimeout && options.flushTimeout > 0) {
-      // tslint:disable-next-line: no-unbound-method
+      // eslint-disable-next-line @typescript-eslint/unbound-method
       const _end = res.end;
       res.end = function(chunk?: any | (() => void), encoding?: string | (() => void), cb?: () => void): void {
         flush(options.flushTimeout)
@@ -403,6 +405,7 @@ export function errorHandler(options?: {
     res: http.ServerResponse,
     next: (error: MiddlewareError) => void,
   ): void {
+    // eslint-disable-next-line @typescript-eslint/unbound-method
     const shouldHandleError = (options && options.shouldHandleError) || defaultShouldHandleError;
 
     if (shouldHandleError(error)) {
@@ -428,6 +431,7 @@ export function errorHandler(options?: {
  * @hidden
  */
 export function logAndExitProcess(error: Error): void {
+  // eslint-disable-next-line no-console
   console.error(error && error.stack ? error.stack : error);
 
   const client = getCurrentHub().getClient<NodeClient>();

packages/node/src/index.ts

@@ -63,7 +63,7 @@ const carrier = getMainCarrier();
 if (carrier.__SENTRY__) {
   carrier.__SENTRY__.extensions = carrier.__SENTRY__.extensions || {};
   if (!carrier.__SENTRY__.extensions.domain) {
-    // @ts-ignore
+    // @ts-ignore domain is missing from extensions Type
     carrier.__SENTRY__.extensions.domain = domain;
   }
 }

packages/node/src/integrations/console.ts

@@ -8,11 +8,12 @@ export class Console implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Console.id;
+  public static id: string = 'Console';
+
   /**
    * @inheritDoc
    */
-  public static id: string = 'Console';
+  public name: string = Console.id;
 
   /**
    * @inheritDoc

packages/node/src/integrations/http.ts

@@ -11,11 +11,12 @@ export class Http implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Http.id;
+  public static id: string = 'Http';
+
   /**
    * @inheritDoc
    */
-  public static id: string = 'Http';
+  public name: string = Http.id;
 
   /**
    * @inheritDoc

packages/node/src/integrations/linkederrors.ts

@@ -12,12 +12,12 @@ export class LinkedErrors implements Integration {
   /**
    * @inheritDoc
    */
-  public readonly name: string = LinkedErrors.id;
+  public static id: string = 'LinkedErrors';
 
   /**
    * @inheritDoc
    */
-  public static id: string = 'LinkedErrors';
+  public readonly name: string = LinkedErrors.id;
 
   /**
    * @inheritDoc

packages/node/src/integrations/modules.ts

@@ -9,7 +9,7 @@ function collectModules(): {
   [name: string]: string;
 } {
   const mainPaths = (require.main && require.main.paths) || [];
-  const paths = require.cache ? Object.keys(require.cache as {}) : [];
+  const paths = require.cache ? Object.keys(require.cache as Record<string, unknown>) : [];
   const infos: {
     [name: string]: string;
   } = {};
@@ -61,11 +61,12 @@ export class Modules implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Modules.id;
+  public static id: string = 'Modules';
+
   /**
    * @inheritDoc
    */
-  public static id: string = 'Modules';
+  public name: string = Modules.id;
 
   /**
    * @inheritDoc