more changes

Author: AbhiPrasad

.eslintrc.js

@@ -4,38 +4,101 @@ module.exports = {
     node: true,
   },
   extends: ['prettier', 'eslint:recommended'],
-  plugins: ['sentry-sdk'],
+  plugins: ['sentry-sdk', 'jsdoc'],
+  ignorePatterns: ['eslint-plugin-sentry-sdk'],
   overrides: [
     {
+      // Configuration for JavaScript files
       files: ['*.js'],
       rules: {
         'no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
       },
     },
     {
-      files: ['*.ts'],
+      // Configuration for typescript files
+      files: ['*.ts', '*.tsx'],
       extends: ['plugin:@typescript-eslint/recommended', 'prettier/@typescript-eslint'],
       plugins: ['@typescript-eslint'],
       parser: '@typescript-eslint/parser',
       rules: {
+        // We want to prevent async await usage in our files to prevent uncessary bundle size.
         'sentry-sdk/no-async-await': 'error',
+
         // Make sure variables marked with _ are ignored (ex. _varName)
         '@typescript-eslint/no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+
+        // Make sure that all ts-ignore comments are given a description
+        '@typescript-eslint/ban-ts-comment': [
+          'warn',
+          {
+            'ts-ignore': 'allow-with-description',
+          },
+        ],
+
+        // Types usage should be explicit as possible, so we prevent usage of inferrable types.
+        // This is especially important because we have a public API, so usage needs to be as
+        // easy to understand as possible
+        '@typescript-eslint/no-inferrable-types': 'off',
+
+        // Enforce type annotations to maintain consistency. This is especially important as
+        // we have a public API, so we want changes to be very explicit.
+        '@typescript-eslint/typedef': ['error', { arrowParameter: false }],
+        '@typescript-eslint/explicit-function-return-type': 'error',
+
+        // Consistent ordering of fields, methods and constructors for classes should be enforced
+        '@typescript-eslint/member-ordering': 'error',
+
+        // Private and protected members of a class should be prefixed with a leading underscore
+        '@typescript-eslint/naming-convention': [
+          'error',
+          {
+            selector: 'memberLike',
+            modifiers: ['private'],
+            format: ['camelCase'],
+            leadingUnderscore: 'require',
+          },
+          {
+            selector: 'memberLike',
+            modifiers: ['protected'],
+            format: ['camelCase'],
+            leadingUnderscore: 'require',
+          },
+        ],
+
+        // JSDOC comments are required for classes and methods
+        'jsdoc/require-jsdoc': [
+          'error',
+          { require: { ClassDeclaration: true, MethodDefinition: true }, checkConstructors: false },
+        ],
       },
     },
     {
+      // Configuration for test files
       env: {
         jest: true,
       },
-      files: ['*.test.ts'],
+      files: ['*.test.ts', '*.test.tsx', '*.test.js', '*.test.jsx'],
+      rules: {
+        'sentry-sdk/no-async-await': 'off',
+        'jsdoc/require-jsdoc': 'off',
+      },
     },
     {
+      // Configuration for config files like webpack/rollback
       files: ['*.config.js'],
       parserOptions: {
         sourceType: 'module',
         ecmaVersion: 2018,
       },
     },
   ],
-  rules: {},
+
+  rules: {
+    // We want to prevent usage of unary operators outside of for loops
+    'no-plusplus': ['error', { allowForLoopAfterthoughts: true }],
+
+    // disallow usage of console and alert
+    'no-console': 'error',
+    'no-alert': 'error',
+  },
 };

eslint-plugin-sentry-sdk/index.js

@@ -29,6 +29,16 @@ const noAsyncAwait = {
           });
         }
       },
+
+      ArrowFunctionExpression(node) {
+        if (node.async) {
+          context.report({
+            node,
+            message:
+              'Using async-await can add a lot to bundle size. Please do not use it outside of tests, use Promises instead',
+          });
+        }
+      },
     };
   },
 };

package.json

@@ -51,6 +51,7 @@
     "danger-plugin-tslint": "^2.0.0",
     "eslint": "^7.5.0",
     "eslint-config-prettier": "^6.11.0",
+    "eslint-plugin-jsdoc": "^30.0.3",
     "eslint-plugin-sentry-sdk": "file:./eslint-plugin-sentry-sdk",
     "jest": "^24.7.1",
     "karma-browserstack-launcher": "^1.5.1",

packages/browser/.eslintrc.js

@@ -4,9 +4,19 @@ module.exports = {
     es6: true,
     browser: true,
   },
+  parserOptions: {
+    ecmaVersion: 2018,
+  },
   extends: ['../../.eslintrc.js'],
   ignorePatterns: ['build/**/*', 'dist/**/*', 'esm/**/*', 'examples/**/*', 'scripts/**/*', 'src/loader.js'],
   overrides: [
+    {
+      files: ['test/**/*'],
+      rules: {
+        'jsdoc/require-jsdoc': 'off',
+        'no-console': 'off',
+      },
+    },
     {
       files: ['test/integration/**/*'],
       env: {
@@ -17,7 +27,7 @@ module.exports = {
       },
     },
     {
-      files: ['test/integration/common/**/*'],
+      files: ['test/integration/common/**/*', 'test/integration/suites/**/*'],
       rules: {
         'no-unused-vars': 'off',
       },

packages/browser/package.json

@@ -63,7 +63,7 @@
     "build:watch": "run-p build:dist:watch build:esm:watch build:bundle:watch",
     "clean": "rimraf dist coverage .rpt2_cache build esm",
     "link:yarn": "yarn link",
-    "lint": "run-s lint:eslint lint:tslint",
+    "lint": "run-s lint:prettier lint:eslint",
     "lint:prettier": "prettier-check \"{src,test}/**/*.ts\"",
     "lint:eslint": "eslint . --format stylish",
     "lint:eslint:json": "eslint . --format json | tee lint-results.json",

packages/browser/src/backend.ts

@@ -36,6 +36,19 @@ export interface BrowserOptions extends Options {
  * @hidden
  */
 export class BrowserBackend extends BaseBackend<BrowserOptions> {
+  /**
+   * @inheritDoc
+   */
+  public eventFromException(exception: unknown, hint?: EventHint): PromiseLike<Event> {
+    return eventFromException(this._options, exception, hint);
+  }
+  /**
+   * @inheritDoc
+   */
+  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
+    return eventFromMessage(this._options, message, level, hint);
+  }
+
   /**
    * @inheritDoc
    */
@@ -58,17 +71,4 @@ export class BrowserBackend extends BaseBackend<BrowserOptions> {
     }
     return new XHRTransport(transportOptions);
   }
-
-  /**
-   * @inheritDoc
-   */
-  public eventFromException(exception: unknown, hint?: EventHint): PromiseLike<Event> {
-    return eventFromException(this._options, exception, hint);
-  }
-  /**
-   * @inheritDoc
-   */
-  public eventFromMessage(message: string, level: Severity = Severity.Info, hint?: EventHint): PromiseLike<Event> {
-    return eventFromMessage(this._options, message, level, hint);
-  }
 }

packages/browser/src/client.ts

@@ -23,6 +23,29 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
     super(BrowserBackend, options);
   }
 
+  /**
+   * Show a report dialog to the user to send feedback to a specific event.
+   *
+   * @param options Set individual options for the dialog
+   */
+  public showReportDialog(options: ReportDialogOptions = {}): void {
+    // doesn't work without a document (React Native)
+    const document = getGlobalObject<Window>().document;
+    if (!document) {
+      return;
+    }
+
+    if (!this._isEnabled()) {
+      logger.error('Trying to call showReportDialog with Sentry Client disabled');
+      return;
+    }
+
+    injectReportDialog({
+      ...options,
+      dsn: options.dsn || this.getDsn(),
+    });
+  }
+
   /**
    * @inheritDoc
    */
@@ -54,27 +77,4 @@ export class BrowserClient extends BaseClient<BrowserBackend, BrowserOptions> {
     }
     super._sendEvent(event);
   }
-
-  /**
-   * Show a report dialog to the user to send feedback to a specific event.
-   *
-   * @param options Set individual options for the dialog
-   */
-  public showReportDialog(options: ReportDialogOptions = {}): void {
-    // doesn't work without a document (React Native)
-    const document = getGlobalObject<Window>().document;
-    if (!document) {
-      return;
-    }
-
-    if (!this._isEnabled()) {
-      logger.error('Trying to call showReportDialog with Sentry Client disabled');
-      return;
-    }
-
-    injectReportDialog({
-      ...options,
-      dsn: options.dsn || this.getDsn(),
-    });
-  }
 }

packages/browser/src/integrations/breadcrumbs.ts

@@ -40,12 +40,12 @@ export class Breadcrumbs implements Integration {
   /**
    * @inheritDoc
    */
-  public name: string = Breadcrumbs.id;
+  public static id: string = 'Breadcrumbs';
 
   /**
    * @inheritDoc
    */
-  public static id = 'Breadcrumbs';
+  public name: string = Breadcrumbs.id;
 
   /** JSDoc */
   private readonly _options: BreadcrumbsOptions;
@@ -85,6 +85,57 @@ export class Breadcrumbs implements Integration {
     );
   }
 
+  /**
+   * Instrument browser built-ins w/ breadcrumb capturing
+   *  - Console API
+   *  - DOM API (click/typing)
+   *  - XMLHttpRequest API
+   *  - Fetch API
+   *  - History API
+   */
+  public setupOnce(): void {
+    if (this._options.console) {
+      addInstrumentationHandler({
+        callback: (...args) => {
+          this._consoleBreadcrumb(...args);
+        },
+        type: 'console',
+      });
+    }
+    if (this._options.dom) {
+      addInstrumentationHandler({
+        callback: (...args) => {
+          this._domBreadcrumb(...args);
+        },
+        type: 'dom',
+      });
+    }
+    if (this._options.xhr) {
+      addInstrumentationHandler({
+        callback: (...args) => {
+          this._xhrBreadcrumb(...args);
+        },
+        type: 'xhr',
+      });
+    }
+    if (this._options.fetch) {
+      addInstrumentationHandler({
+        callback: (...args) => {
+          this._fetchBreadcrumb(...args);
+        },
+        type: 'fetch',
+      });
+    }
+    if (this._options.history) {
+      addInstrumentationHandler({
+        callback: (...args) => {
+          this._historyBreadcrumb(...args);
+        },
+        type: 'history',
+      });
+    }
+  }
+
   /**
    * Creates breadcrumbs from console API calls
    */
@@ -256,55 +307,4 @@ export class Breadcrumbs implements Integration {
       },
     });
   }
-
-  /**
-   * Instrument browser built-ins w/ breadcrumb capturing
-   *  - Console API
-   *  - DOM API (click/typing)
-   *  - XMLHttpRequest API
-   *  - Fetch API
-   *  - History API
-   */
-  public setupOnce(): void {
-    if (this._options.console) {
-      addInstrumentationHandler({
-        callback: (...args) => {
-          this._consoleBreadcrumb(...args);
-        },
-        type: 'console',
-      });
-    }
-    if (this._options.dom) {
-      addInstrumentationHandler({
-        callback: (...args) => {
-          this._domBreadcrumb(...args);
-        },
-        type: 'dom',
-      });
-    }
-    if (this._options.xhr) {
-      addInstrumentationHandler({
-        callback: (...args) => {
-          this._xhrBreadcrumb(...args);
-        },
-        type: 'xhr',
-      });
-    }
-    if (this._options.fetch) {
-      addInstrumentationHandler({
-        callback: (...args) => {
-          this._fetchBreadcrumb(...args);
-        },
-        type: 'fetch',
-      });
-    }
-    if (this._options.history) {
-      addInstrumentationHandler({
-        callback: (...args) => {
-          this._historyBreadcrumb(...args);
-        },
-        type: 'history',
-      });
-    }
-  }
 }