feat(core): Introduce seperate client options

Author: AbhiPrasad

packages/core/src/options.ts

@@ -0,0 +1,28 @@
+import { ClientOptions, Options } from '@sentry/types';
+import { makeDsn, stackParserFromOptions } from '@sentry/utils';
+
+import { getIntegrationsToSetup } from './integration';
+import { NoopTransport } from './transports/noop';
+
+export const DEFAULT_MAX_BREADCRUMBS = 100;
+export const DEFAULT_MAX_VALUE_LENGTH = 250;
+export const DEFAULT_NORMALIZE_DEPTH = 3;
+export const DEFAULT_NORMALIZE_MAX_BREADTH = 1000;
+export const DEFAULT_SHUTDOWN_TIMEOUT = 2000;
+
+/** JSDoc */
+export function optionsToClientOptions(options: Options): ClientOptions {
+  return {
+    ...options,
+    integrations: getIntegrationsToSetup(options),
+    transport: options.transport || NoopTransport,
+    dsn: options.dsn === undefined ? undefined : makeDsn(options.dsn),
+    stackParser: stackParserFromOptions(options),
+    maxBreadcrumbs: options.maxBreadcrumbs || DEFAULT_MAX_BREADCRUMBS,
+    sampleRate: typeof options.sampleRate === 'number' ? options.sampleRate : 1,
+    maxValueLength: options.maxValueLength || DEFAULT_MAX_VALUE_LENGTH,
+    normalizeDepth: options.normalizeDepth || DEFAULT_NORMALIZE_DEPTH,
+    normalizeMaxBreadth: options.normalizeMaxBreadth || DEFAULT_NORMALIZE_MAX_BREADTH,
+    shutdownTimeout: options.shutdownTimeout || DEFAULT_SHUTDOWN_TIMEOUT,
+  };
+}

packages/types/src/index.ts

@@ -27,7 +27,7 @@ export { Hub } from './hub';
 export { Integration, IntegrationClass } from './integration';
 export { Mechanism } from './mechanism';
 export { ExtractedNodeRequestData, Primitive, WorkerLocation } from './misc';
-export { Options } from './options';
+export { ClientOptions, Options } from './options';
 export { Package } from './package';
 export { QueryParams, Request, SentryRequest, SentryRequestType } from './request';
 export { Response } from './response';

packages/types/src/options.ts

@@ -1,4 +1,5 @@
 import { Breadcrumb, BreadcrumbHint } from './breadcrumb';
+import { DsnComponents } from './dsn';
 import { Event, EventHint } from './event';
 import { Integration } from './integration';
 import { CaptureContext } from './scope';
@@ -7,8 +8,7 @@ import { StackLineParser, StackParser } from './stacktrace';
 import { SamplingContext } from './transaction';
 import { Transport, TransportClass, TransportOptions } from './transport';
 
-/** Base configuration options for every SDK. */
-export interface Options {
+export interface ClientOptions {
   /**
    * Enable debug functionality in the SDK itself
    */
@@ -20,76 +20,88 @@ export interface Options {
    */
   enabled?: boolean;
 
+  /** Attaches stacktraces to pure capture message / log integrations */
+  attachStacktrace?: boolean;
+
+  /**
+   * A flag enabling Sessions Tracking feature.
+   * By default, Sessions Tracking is enabled.
+   */
+  autoSessionTracking?: boolean;
+
+  /**
+   * Send SDK Client Reports.
+   * By default, Client Reports are enabled.
+   */
+  sendClientReports?: boolean;
+
   /**
    * The Dsn used to connect to Sentry and identify the project. If omitted, the
    * SDK will not send any data to Sentry.
    */
-  dsn?: string;
+  dsn?: DsnComponents;
 
   /**
-   * If this is set to false, default integrations will not be added, otherwise this will internally be set to the
-   * recommended default integrations.
-   * TODO: We should consider changing this to `boolean | Integration[]`
+   * The release identifier used when uploading respective source maps. Specify
+   * this value to allow Sentry to resolve the correct source maps when
+   * processing events.
    */
-  defaultIntegrations?: false | Integration[];
+  release?: string;
+
+  /** The current environment of your application (e.g. "production"). */
+  environment?: string;
+
+  /** Sets the distribution for all events */
+  dist?: string;
 
   /**
    * List of integrations that should be installed after SDK was initialized.
-   * Accepts either a list of integrations or a function that receives
-   * default integrations and returns a new, updated list.
    */
-  integrations?: Integration[] | ((integrations: Integration[]) => Integration[]);
+  integrations: Integration[];
 
   /**
-   * A pattern for error messages which should not be sent to Sentry.
-   * By default, all errors will be sent.
+   * Transport object that should be used to send events to Sentry
    */
-  ignoreErrors?: Array<string | RegExp>;
+  transport: TransportClass<Transport>;
 
   /**
-   * Transport object that should be used to send events to Sentry
+   * A stack parser implementation
+   * By default, a stack parser is supplied for all supported platforms
    */
-  transport?: TransportClass<Transport>;
+  stackParser: StackParser;
 
   /**
    * Options for the default transport that the SDK uses.
    */
   transportOptions?: TransportOptions;
 
   /**
-   * A URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint
-   * that accepts Sentry envelopes for forwarding. This can be used to force data
-   * through a custom server independent of the type of data.
+   * Sample rate to determine trace sampling.
+   *
+   * 0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send
+   * all traces)
+   *
+   * Tracing is enabled if either this or `tracesSampler` is defined. If both are defined, `tracesSampleRate` is
+   * ignored.
    */
-  tunnel?: string;
+  tracesSampleRate?: number;
 
   /**
-   * The release identifier used when uploading respective source maps. Specify
-   * this value to allow Sentry to resolve the correct source maps when
-   * processing events.
+   * Initial data to populate scope.
    */
-  release?: string;
-
-  /** The current environment of your application (e.g. "production"). */
-  environment?: string;
-
-  /** Sets the distribution for all events */
-  dist?: string;
+  initialScope?: CaptureContext;
 
   /**
    * The maximum number of breadcrumbs sent with events. Defaults to 100.
    * Values over 100 will be ignored and 100 used instead.
    */
-  maxBreadcrumbs?: number;
+  maxBreadcrumbs: number;
 
   /** A global sample rate to apply to all events (0 - 1). */
-  sampleRate?: number;
-
-  /** Attaches stacktraces to pure capture message / log integrations */
-  attachStacktrace?: boolean;
+  sampleRate: number;
 
   /** Maximum number of chars a single value can have before it will be truncated. */
-  maxValueLength?: number;
+  maxValueLength: number;
 
   /**
    * Maximum number of levels that normalization algorithm will traverse in objects and arrays.
@@ -100,7 +112,7 @@ export interface Options {
    * - `extra`
    * Defaults to `3`. Set to `0` to disable.
    */
-  normalizeDepth?: number;
+  normalizeDepth: number;
 
   /**
    * Maximum number of properties or elements that the normalization algorithm will output in any single array or object included in the normalized event.
@@ -111,7 +123,7 @@ export interface Options {
    * - `extra`
    * Defaults to `1000`
    */
-  normalizeMaxBreadth?: number;
+  normalizeMaxBreadth: number;
 
   /**
    * Controls how many milliseconds to wait before shutting down. The default is
@@ -120,41 +132,20 @@ export interface Options {
    * high can cause the application to block for users with network connectivity
    * problems.
    */
-  shutdownTimeout?: number;
+  shutdownTimeout: number;
 
   /**
-   * Sample rate to determine trace sampling.
-   *
-   * 0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send
-   * all traces)
-   *
-   * Tracing is enabled if either this or `tracesSampler` is defined. If both are defined, `tracesSampleRate` is
-   * ignored.
-   */
-  tracesSampleRate?: number;
-
-  /**
-   * A flag enabling Sessions Tracking feature.
-   * By default, Sessions Tracking is enabled.
-   */
-  autoSessionTracking?: boolean;
-
-  /**
-   * Send SDK Client Reports.
-   * By default, Client Reports are enabled.
-   */
-  sendClientReports?: boolean;
-
-  /**
-   * Initial data to populate scope.
+   * A pattern for error messages which should not be sent to Sentry.
+   * By default, all errors will be sent.
    */
-  initialScope?: CaptureContext;
+  ignoreErrors?: Array<string | RegExp>;
 
   /**
-   * A stack parser implementation or an array of stack line parsers
-   * By default, a stack parser is supplied for all supported browsers
+   * A URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint
+   * that accepts Sentry envelopes for forwarding. This can be used to force data
+   * through a custom server independent of the type of data.
    */
-  stackParser?: StackParser | StackLineParser[];
+  tunnel?: string;
 
   /**
    * Set of metadata about the SDK that can be internally used to enhance envelopes and events,
@@ -210,3 +201,37 @@ export interface Options {
    */
   beforeBreadcrumb?: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => Breadcrumb | null;
 }
+
+/** Base configuration options for every SDK. */
+export interface Options extends Omit<Partial<ClientOptions>, 'dsn' | 'integrations' | 'transport' | 'stackParser'> {
+  /**
+   * The Dsn used to connect to Sentry and identify the project. If omitted, the
+   * SDK will not send any data to Sentry.
+   */
+  dsn?: string;
+
+  /**
+   * If this is set to false, default integrations will not be added, otherwise this will internally be set to the
+   * recommended default integrations.
+   * TODO: We should consider changing this to `boolean | Integration[]`
+   */
+  defaultIntegrations?: false | Integration[];
+
+  /**
+   * List of integrations that should be installed after SDK was initialized.
+   * Accepts either a list of integrations or a function that receives
+   * default integrations and returns a new, updated list.
+   */
+  integrations?: Integration[] | ((integrations: Integration[]) => Integration[]);
+
+  /**
+   * Transport object that should be used to send events to Sentry
+   */
+  transport?: TransportClass<Transport>;
+
+  /**
+   * A stack parser implementation or an array of stack line parsers
+   * By default, a stack parser is supplied for all supported browsers
+   */
+  stackParser?: StackParser | StackLineParser[];
+}

packages/utils/src/dsn.ts

@@ -98,8 +98,6 @@ function validateDsn(dsn: DsnComponents): boolean | void {
 /** The Sentry Dsn, identifying a Sentry instance and project. */
 export function makeDsn(from: DsnLike): DsnComponents {
   const components = typeof from === 'string' ? dsnFromString(from) : dsnFromComponents(from);
-
   validateDsn(components);
-
   return components;
 }