rollbar 3.0.0-beta.5 → 3.0.0

package/eslint.config.js

@@ -0,0 +1,151 @@
+import babelParser from '@babel/eslint-parser';
+import js from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import chaiFriendly from 'eslint-plugin-chai-friendly';
+import importPlugin from 'eslint-plugin-import';
+import prettierRecommended from 'eslint-plugin-prettier/recommended';
+import unusedImports from 'eslint-plugin-unused-imports';
+import globals from 'globals';
+import ts from 'typescript-eslint';
+
+const noUnusedVarsRule = [
+  'error',
+  {
+    argsIgnorePattern: '^_',
+    varsIgnorePattern: '^_',
+    caughtErrorsIgnorePattern: '^_',
+  },
+];
+
+export default defineConfig(
+  js.configs.recommended,
+  ts.configs.recommended,
+  ts.configs.stylistic,
+  prettierRecommended,
+  chaiFriendly.configs.recommendedFlat,
+
+  // all files
+  {
+    languageOptions: {
+      ecmaVersion: 2021,
+      sourceType: 'module',
+    },
+    plugins: {
+      import: importPlugin,
+      'unused-imports': unusedImports,
+      'chai-friendly': chaiFriendly,
+    },
+    rules: {
+      complexity: ['error', { max: 35 }],
+      eqeqeq: ['error', 'smart'],
+      'no-console': 'error',
+      'no-implicit-coercion': 'error',
+      'unused-imports/no-unused-imports': 'error',
+      'import/order': [
+        'warn',
+        {
+          alphabetize: {
+            order: 'asc',
+            caseInsensitive: true,
+          },
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            'sibling',
+            'index',
+          ],
+          'newlines-between': 'always',
+        },
+      ],
+      'no-unused-vars': noUnusedVarsRule,
+      '@typescript-eslint/no-unused-vars': noUnusedVarsRule,
+      '@typescript-eslint/no-empty-function': [
+        'error',
+        { allow: ['arrowFunctions'] },
+      ],
+      '@typescript-eslint/no-this-alias': [
+        'error',
+        { allowDestructuring: true },
+      ],
+      'chai-friendly/no-unused-expressions': [
+        'error',
+        { allowShortCircuit: true },
+      ],
+
+      // disabled for now
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/ban-ts-comment': ['error', { 'ts-nocheck': false }],
+    },
+  },
+
+  // globals
+  {
+    files: ['test/**/*.[tj]s'],
+    languageOptions: { globals: { ...globals.mocha } },
+  },
+  {
+    files: ['src/**/*.[tj]s', 'test/**/*.[tj]s'],
+    languageOptions: { globals: { ...globals.browser } },
+  },
+  {
+    files: [
+      'src/server/**/*.[tj]s',
+      'src/react-native/**/*.[tj]s',
+      'test/**/server.*.[tj]s',
+      'scripts/**/*.[tj]s',
+    ],
+    languageOptions: { globals: { ...globals.node } },
+  },
+
+  // js
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      sourceType: 'module',
+      parser: babelParser,
+      parserOptions: {
+        ecmaVersion: 2021,
+      },
+    },
+    rules: {
+      strict: ['error', 'safe'],
+      '@typescript-eslint/no-unused-vars': 'off',
+    },
+  },
+
+  // ts
+  {
+    files: ['**/*.ts'],
+    rules: {
+      'no-unused-vars': 'off',
+    },
+  },
+
+  // cjs
+  {
+    files: ['**/*.cjs'],
+    languageOptions: { sourceType: 'commonjs' },
+    rules: {
+      strict: 'off',
+      '@typescript-eslint/no-require-imports': 'off',
+    },
+  },
+
+  // tests
+  {
+    files: ['test/**/*.[tj]s'],
+    rules: { '@typescript-eslint/no-empty-function': 'off' },
+  },
+
+  // scripts
+  {
+    files: ['scripts/**/*.{js,cjs}'],
+    rules: { 'no-console': 'off' },
+  },
+
+  {
+    ignores: ['dist', 'examples', 'node_modules', 'vendor', 'coverage'],
+  },
+);

package/index.d.ts

@@ -3,8 +3,8 @@
 
 export default Rollbar;
 
-declare class Rollbar {
-  constructor(options?: Rollbar.Configuration);
+declare class Rollbar implements Rollbar.Components {
+  constructor(options?: Rollbar.Configuration, client?: Rollbar);
   static init(options: Rollbar.Configuration): Rollbar;
   static setComponents(components: Rollbar.Components): void;
 
@@ -34,12 +34,30 @@ declare class Rollbar {
 
   public errorHandler(): Rollbar.ExpressErrorHandler;
 
+  // Components
+
+  public telemeter?: TelemeterType;
+  public instrumenter?: InstrumenterType;
+  public wrapGlobals?: WrapGlobalsType;
+  public scrub?: ScrubType;
+  public truncation?: TruncationType;
+  public tracing?: TracingType;
+  /**
+   * Replay component for session recording.
+   * Only available when using replay bundles (rollbar.replay.*).
+   * Use `import Rollbar from 'rollbar/replay'` to access.
+   */
+  public replay?: ReplayType;
+
   // Used with rollbar-react for rollbar-react-native compatibility.
   public rollbar: Rollbar;
 
   // Exposed only for testing, should be changed via the configure method
   // DO NOT MODIFY DIRECTLY
   public options: Rollbar.Configuration;
+
+  // Exposed only for testing, tracks pending anonymous errors
+  anonymousErrorsPending: number;
 }
 
 declare namespace Rollbar {
@@ -48,11 +66,16 @@ declare namespace Rollbar {
     context: TContext,
     callback: Callback<TResult>,
   ) => void | Promise<TResult>;
-  export type MaybeError = Error | undefined | null;
   export type Level = 'debug' | 'info' | 'warning' | 'error' | 'critical';
-  export type Dictionary = { [key: string]: unknown };
+  export type Dictionary = Record<string, unknown>;
+  export type MaybeError = Error | undefined | null;
   export type StringAttributes = Record<string, string>;
 
+  export interface ErrorWithContext extends Error {
+    rollbarContext?: Record<string, any>;
+    nested?: Error | null;
+  }
+
   /**
    * {@link https://docs.rollbar.com/docs/rollbarjs-configuration-reference#reference}
    */
@@ -111,6 +134,7 @@ declare namespace Rollbar {
     ) => void;
     overwriteScrubFields?: boolean;
     payload?: Payload;
+    person?: PersonParams;
     replay?: ReplayOptions;
     reportLevel?: Level;
     resource?: StringAttributes;
@@ -162,7 +186,11 @@ declare namespace Rollbar {
     network?: boolean;
     networkResponseHeaders?: boolean | string[];
     networkResponseBody?: boolean;
+    networkRequestHeaders?: boolean;
     networkRequestBody?: boolean;
+    networkErrorOnHttp5xx?: boolean;
+    networkErrorOnHttp4xx?: boolean;
+    networkErrorOnHttp0?: boolean;
     log?: boolean;
     dom?: boolean;
     navigation?: boolean;
@@ -191,9 +219,7 @@ declare namespace Rollbar {
     response: any,
     next: ExpressNextFunction,
   ) => any;
-  export interface ExpressNextFunction {
-    (err?: any): void;
-  }
+  export type ExpressNextFunction = (err?: any) => void;
   class Locals {}
   export type LocalsType = typeof Locals;
   export type LocalsOptions = LocalsType | LocalsSettings;
@@ -304,9 +330,20 @@ declare namespace Rollbar {
     plugins?: any[];
   }
 
+  export interface TransformSpanParams {
+    span: any;
+  }
   export interface TracingOptions {
     enabled?: boolean;
     endpoint?: string;
+    transformSpan?: (params: TransformSpanParams) => void;
+  }
+
+  export interface PersonParams {
+    id: string | DeprecatedNumber | null;
+    username?: string;
+    email?: string;
+    [property: string]: any;
   }
 
   /**
@@ -318,12 +355,7 @@ declare namespace Rollbar {
    * {@link https://docs.rollbar.com/docs/rollbarjs-configuration-reference#payload-1}
    */
   export interface Payload {
-    person?: {
-      id: string | DeprecatedNumber | null;
-      username?: string;
-      email?: string;
-      [property: string]: any;
-    };
+    person?: PersonParams;
     context?: any;
     client?: {
       javascript?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rollbar",
-  "version": "3.0.0-beta.5",
+  "version": "3.0.0",
   "type": "module",
   "repository": {
     "type": "git",
@@ -94,6 +94,13 @@
     "@babel/core": "^7.26.10",
     "@babel/eslint-parser": "^7.27.0",
     "@babel/preset-env": "^7.26.9",
+    "@babel/preset-typescript": "^7.28.5",
+    "@types/chai": "^4.3.20",
+    "@types/mocha": "^10.0.10",
+    "@types/nise": "^1.4.5",
+    "@types/node": "^20.17.12",
+    "@types/sinon": "^21.0.0",
+    "@web/dev-server-esbuild": "^1.0.4",
     "@web/test-runner": "^0.20.2",
     "@web/test-runner-mocha": "^0.9.0",
     "@web/test-runner-playwright": "^0.11.1",
@@ -101,13 +108,23 @@
     "chai": "^5.3.3",
     "es-check": "^9.1.4",
     "eslint": "^9.24.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-chai-friendly": "^1.1.0",
+    "eslint-plugin-import": "^2.32.0",
+    "eslint-plugin-prettier": "^5.5.4",
+    "eslint-plugin-unused-imports": "^4.3.0",
     "express": "^4.21.2",
     "glob": "^5.0.14",
+    "globals": "^16.5.0",
     "mocha": "^11.1.0",
+    "nise": "^6.1.1",
     "nock": "^11.9.1",
-    "node-libs-browser": "^0.5.2",
+    "node-libs-browser": "^2.2.1",
     "prettier": "^3.6.2",
-    "sinon": "^8.1.1",
+    "sinon": "^21.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.46.4",
     "webpack": "^5.98.0",
     "webpack-cli": "^6.0.1",
     "webpack-node-externals": "^3.0.0"
@@ -118,14 +135,17 @@
     "build:dev": "webpack --mode development",
     "postbuild:dev": "npm run postbuild",
     "test": "npm run test:wtr && npm run test:server",
-    "test:server": "mocha 'test/server.*.test.js' --reporter spec",
+    "test:server": "node scripts/run-server-tests.js",
     "test:wtr": "web-test-runner",
     "test:wtr:watch": "web-test-runner --watch",
-    "lint": "./node_modules/.bin/eslint .",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "format": "prettier --write \"**/*.{js,cjs,mjs,md,json,yml,yaml}\"",
     "format:check": "prettier --check \"**/*.{js,cjs,mjs,md,json,yml,yaml}\"",
     "pack": "node scripts/pack.js",
-    "validate": "npm run validate:es5 && npm run validate:examples",
+    "typecheck": "tsc --noEmit",
+    "typecheck:tests": "tsc --noEmit -p tsconfig.test.json",
+    "validate": "npm run validate:es5 && npm run validate:examples && npm run typecheck && npm run typecheck:tests",
     "validate:es5": "es-check es5 './dist/**/*.js' --verbose",
     "validate:examples": "node scripts/validate-examples.js -p",
     "update:snippets:examples": "node scripts/update-snippets.js examples"

package/src/api.js

@@ -1,7 +1,7 @@
-import * as _ from './utility.js';
 import * as helpers from './apiUtility.js';
+import { stringify, merge } from './utility.js';
 
-var defaultOptions = {
+const defaultOptions = {
   hostname: 'api.rollbar.com',
   path: '/api/1/item/',
   search: null,
@@ -10,7 +10,7 @@ var defaultOptions = {
   port: 443,
 };
 
-var OTLPDefaultOptions = {
+const OTLPDefaultOptions = {
   hostname: 'api.rollbar.com',
   path: '/api/1/session/',
   search: null,
@@ -20,153 +20,147 @@ var OTLPDefaultOptions = {
 };
 
 /**
- * Api is an object that encapsulates methods of communicating with
- * the Rollbar API.  It is a standard interface with some parts implemented
- * differently for server or browser contexts.  It is an object that should
- * be instantiated when used so it can contain non-global options that may
- * be different for another instance of RollbarApi.
- *
- * @param options {
- *    accessToken: the accessToken to use for posting items to rollbar
- *    endpoint: an alternative endpoint to send errors to
- *        must be a valid, fully qualified URL.
- *        The default is: https://api.rollbar.com/api/1/item
- *    proxy: if you wish to proxy requests provide an object
- *        with the following keys:
- *          host or hostname (required): foo.example.com
- *          port (optional): 123
- *          protocol (optional): https
- * }
+ * Api encapsulates methods of communicating with the Rollbar API.  It is a
+ * standard interface with some parts implemented differently for server or
+ * browser contexts.  It is an object that should be instantiated when used so
+ * it can contain non-global options that may be different for another instance
+ * of RollbarApi.
  */
-function Api(options, transport, urllib, truncation) {
-  this.options = options;
-  this.transport = transport;
-  this.url = urllib;
-  this.truncation = truncation;
-  this.accessToken = options.accessToken;
-  this.transportOptions = _getTransport(options, urllib);
-  this.OTLPTransportOptions = _getOTLPTransport(options, urllib);
-}
+class Api {
+  /**
+   * @param {Object} options - Configuration supplied from the parent Rollbar instance.
+   * @param {string} options.accessToken - Token used to authenticate API calls.
+   * @param {string} [options.endpoint] - Optional fully qualified URL overriding
+   *   the default `https://api.rollbar.com/api/1/item`.
+   * @param {Object} [options.proxy] - Optional proxy descriptor containing:
+   *   `host`/`hostname` (required), `port`, and `protocol`.
+   * @param {Object} transport - Adapter implementing `post` and `postJsonPayload`.
+   * @param {Object} urllib - Minimal URL helper used for option normalization.
+   * @param {Object} truncation - Optional truncation helper for payload size enforcement.
+   */
+  constructor(options, transport, urllib, truncation) {
+    this.options = options;
+    this.transport = transport;
+    this.url = urllib;
+    this.truncation = truncation;
+    this.accessToken = options.accessToken;
+    this.transportOptions = _getTransport(options, urllib);
+    this.OTLPTransportOptions = _getOTLPTransport(options, urllib);
+  }
 
-/**
- * Wraps transport.post in a Promise to support async/await
- *
- * @param {Object} options - Options for the API request
- * @param {string} options.accessToken - The access token for authentication
- * @param {Object} options.transportOptions - Options for the transport
- * @param {Object} options.payload - The data payload to send
- * @returns {Promise} A promise that resolves with the response or rejects with an error
- * @private
- */
-Api.prototype._postPromise = function ({
-  accessToken,
-  options,
-  payload,
-  headers,
-}) {
-  const self = this;
-  return new Promise((resolve, reject) => {
-    self.transport.post({
-      accessToken,
-      options,
-      payload,
-      headers,
-      callback: (err, resp) => (err ? reject(err) : resolve(resp)),
+  /**
+   * Wraps transport.post in a Promise to support async/await
+   *
+   * @param {Object} options - Options for the API request
+   * @param {string} options.accessToken - The access token for authentication
+   * @param {Object} options.transportOptions - Options for the transport
+   * @param {Object} options.payload - The data payload to send
+   * @returns {Promise} A promise that resolves with the response or rejects with an error
+   * @private
+   */
+  _postPromise({ accessToken, options, payload, headers }) {
+    return new Promise((resolve, reject) => {
+      this.transport.post({
+        accessToken,
+        options,
+        payload,
+        headers,
+        callback: (err, resp) => (err ? reject(err) : resolve(resp)),
+      });
     });
-  });
-};
+  }
 
-/**
- *
- * @param data
- * @param callback
- */
-Api.prototype.postItem = function (data, callback) {
-  const options = helpers.transportOptions(this.transportOptions, 'POST');
-  const payload = helpers.buildPayload(data);
-  const self = this;
-
-  // ensure the network request is scheduled after the current tick.
-  setTimeout(function () {
-    self.transport.post({
-      accessToken: self.accessToken,
+  /**
+   *
+   * @param data
+   * @param callback
+   */
+  postItem(data, callback) {
+    const options = helpers.transportOptions(this.transportOptions, 'POST');
+    const payload = helpers.buildPayload(data);
+
+    // ensure the network request is scheduled after the current tick.
+    setTimeout(() => {
+      this.transport.post({
+        accessToken: this.accessToken,
+        options,
+        payload,
+        callback,
+      });
+    }, 0);
+  }
+
+  /**
+   * Posts spans to the Rollbar API using the session endpoint
+   *
+   * @param {Array} payload - The spans to send
+   * @returns {Promise<Object>} A promise that resolves with the API response
+   */
+  async postSpans(payload, headers = {}) {
+    const options = helpers.transportOptions(this.OTLPTransportOptions, 'POST');
+
+    return this._postPromise({
+      accessToken: this.accessToken,
       options,
       payload,
-      callback,
+      headers,
     });
-  }, 0);
-};
-
-/**
- * Posts spans to the Rollbar API using the session endpoint
- *
- * @param {Array} payload - The spans to send
- * @returns {Promise<Object>} A promise that resolves with the API response
- */
-Api.prototype.postSpans = async function (payload, headers = {}) {
-  const options = helpers.transportOptions(this.OTLPTransportOptions, 'POST');
-
-  return await this._postPromise({
-    accessToken: this.accessToken,
-    options,
-    payload,
-    headers,
-  });
-};
-
-/**
- *
- * @param data
- * @param callback
- */
-Api.prototype.buildJsonPayload = function (data, callback) {
-  var payload = helpers.buildPayload(data);
-
-  var stringifyResult;
-  if (this.truncation) {
-    stringifyResult = this.truncation.truncate(payload);
-  } else {
-    stringifyResult = _.stringify(payload);
   }
 
-  if (stringifyResult.error) {
-    if (callback) {
-      callback(stringifyResult.error);
+  /**
+   *
+   * @param data
+   * @param callback
+   */
+  buildJsonPayload(data, callback) {
+    const payload = helpers.buildPayload(data);
+
+    let stringifyResult;
+    if (this.truncation) {
+      stringifyResult = this.truncation.truncate(payload);
+    } else {
+      stringifyResult = stringify(payload);
     }
-    return null;
-  }
 
-  return stringifyResult.value;
-};
+    if (stringifyResult.error) {
+      if (callback) {
+        callback(stringifyResult.error);
+      }
+      return null;
+    }
 
-/**
- *
- * @param jsonPayload
- * @param callback
- */
-Api.prototype.postJsonPayload = function (jsonPayload, callback) {
-  var transportOptions = helpers.transportOptions(
-    this.transportOptions,
-    'POST',
-  );
-  this.transport.postJsonPayload(
-    this.accessToken,
-    transportOptions,
-    jsonPayload,
-    callback,
-  );
-};
+    return stringifyResult.value;
+  }
 
-Api.prototype.configure = function (options) {
-  var oldOptions = this.oldOptions;
-  this.options = _.merge(oldOptions, options);
-  this.transportOptions = _getTransport(this.options, this.url);
-  this.OTLPTransportOptions = _getOTLPTransport(this.options, this.url);
-  if (this.options.accessToken !== undefined) {
-    this.accessToken = this.options.accessToken;
+  /**
+   *
+   * @param jsonPayload
+   * @param callback
+   */
+  postJsonPayload(jsonPayload, callback) {
+    const transportOptions = helpers.transportOptions(
+      this.transportOptions,
+      'POST',
+    );
+    this.transport.postJsonPayload(
+      this.accessToken,
+      transportOptions,
+      jsonPayload,
+      callback,
+    );
   }
-  return this;
-};
+
+  configure(options) {
+    const oldOptions = this.options;
+    this.options = merge(oldOptions, options);
+    this.transportOptions = _getTransport(this.options, this.url);
+    this.OTLPTransportOptions = _getOTLPTransport(this.options, this.url);
+    if (this.options.accessToken !== undefined) {
+      this.accessToken = this.options.accessToken;
+    }
+    return this;
+  }
+}
 
 function _getTransport(options, url) {
   return helpers.getTransportFromOptions(options, defaultOptions, url);

package/src/apiUtility.js

@@ -49,8 +49,8 @@ function getTransportFromOptions(options, defaults, url) {
 
 function detectTransport(options) {
   var gWindow =
-    (typeof window != 'undefined' && window) ||
-    (typeof self != 'undefined' && self);
+    (typeof window !== 'undefined' && window) ||
+    (typeof self !== 'undefined' && self);
   var transport = options.defaultTransport || 'xhr';
   if (typeof gWindow.fetch === 'undefined') transport = 'xhr';
   if (typeof gWindow.XMLHttpRequest === 'undefined') transport = 'fetch';

package/src/browser/bundles/rollbar.snippet.js

@@ -2,6 +2,7 @@
 
 import * as Shim from '../shim.js';
 import snippetCallback from '../snippet_callback.js';
+
 import { defaultRollbarJsUrl } from './defaults.js';
 
 _rollbarConfig = _rollbarConfig || {};