diff --git a/MIGRATION.md b/MIGRATION.md index cda6cb2836db..9c2663c05b46 100644 --- a/MIGRATION.md +++ b/MIGRATION.md @@ -218,8 +218,6 @@ Sentry.init({ ... }) - - // Before: class MyCustomTransport extends BaseTransport { constructor(options: TransportOptions) { @@ -252,6 +250,30 @@ object with your custom logic, will also take care of rate limiting and flushing For a complete v7 transport implementation, take a look at our [browser fetch transport](https://github.com/getsentry/sentry-javascript/blob/ebc938a03d6efe7d0c4bbcb47714e84c9a566a9c/packages/browser/src/transports/fetch.ts#L1-L34). +### Node Transport Changes + +To clean up the options interface, we now require users to pass down transport related options under the `transportOptions` key. The options that +were changed were `caCerts`, `httpProxy`, and `httpsProxy`. In addition, `httpProxy` and `httpsProxy` were unified to a single option under +the `transportOptions` key, `proxy`. + +```ts +// New in v7: +Sentry.init({ + dsn: '...', + transportOptions: { + caCerts: getMyCaCert(), + proxy: 'http://example.com', + }, +}); + +// Before: +Sentry.init({ + dsn: '...', + caCerts: getMyCaCert(), + httpsProxy: 'http://example.com', +}) +``` + ## Enum Changes Given that enums have a high bundle-size impact, our long term goal is to eventually remove all enums from the SDK in diff --git a/packages/node/src/types.ts b/packages/node/src/types.ts index a2311a4698f9..57b19dcd1820 100644 --- a/packages/node/src/types.ts +++ b/packages/node/src/types.ts @@ -1,18 +1,11 @@ import { ClientOptions, Options } from '@sentry/types'; +import { NodeTransportOptions } from './transports'; + export interface BaseNodeOptions { /** Sets an optional server name (device name) */ serverName?: string; - /** Set a HTTP proxy that should be used for outbound requests. */ - httpProxy?: string; - - /** Set a HTTPS proxy that should be used for outbound requests. */ - httpsProxy?: string; - - /** HTTPS proxy certificates path */ - caCerts?: string; - /** Callback that is executed when a fatal global error occurs. */ onFatalError?(error: Error): void; } @@ -21,10 +14,10 @@ export interface BaseNodeOptions { * Configuration options for the Sentry Node SDK * @see @sentry/types Options for more information. */ -export interface NodeOptions extends Options, BaseNodeOptions {} +export interface NodeOptions extends Options, BaseNodeOptions {} /** * Configuration options for the Sentry Node SDK Client class * @see NodeClient for more information. */ -export interface NodeClientOptions extends ClientOptions, BaseNodeOptions {} +export interface NodeClientOptions extends ClientOptions, BaseNodeOptions {}