feat: HTTP(S) Proxy support for Node

Author: kamilogorek

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- [node] HTTP(S) Proxy support
+
 ## 4.3.4
 
 - [utils] fix: Broken tslib import - Fixes #1757

packages/node/package.json

@@ -21,6 +21,7 @@
     "@sentry/utils": "4.3.4",
     "@types/stack-trace": "0.0.29",
     "cookie": "0.3.1",
+    "https-proxy-agent": "^2.2.1",
     "lsmod": "1.0.0",
     "stack-trace": "0.0.10",
     "tslib": "^1.9.3"

packages/node/src/backend.ts

@@ -11,6 +11,8 @@ import { HTTPSTransport, HTTPTransport } from './transports';
  * @see NodeClient for more information.
  */
 export interface NodeOptions extends Options {
+  [key: string]: any;
+
   /** Callback that is executed when a fatal global error occurs. */
   onFatalError?(error: Error): void;
 
@@ -19,6 +21,15 @@ export interface NodeOptions extends Options {
 
   /** Maximum time to wait to drain the request queue, before the process is allowed to exit. */
   shutdownTimeout?: number;
+
+  /** 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;
 }
 
 /** The Sentry Node SDK Backend. */
@@ -101,6 +112,14 @@ export class NodeBackend extends BaseBackend<NodeOptions> {
 
     if (!this.transport) {
       const transportOptions = this.options.transportOptions ? this.options.transportOptions : { dsn };
+      const clientOptions = ['httpProxy', 'httpsProxy', 'caCerts'];
+
+      for (const option of clientOptions) {
+        if (this.options[option]) {
+          transportOptions[option] = transportOptions[option] || this.options[option];
+        }
+      }
+
       this.transport = this.options.transport
         ? new this.options.transport({ dsn })
         : dsn.protocol === 'http'

packages/node/src/declarations.d.ts

@@ -1 +1,9 @@
 declare module 'lsmod';
+
+declare module 'https-proxy-agent' {
+  /** JSDoc */
+  // tslint:disable-next-line:no-unnecessary-class
+  export default class HttpsProxyAgent {
+    public constructor(proxy: string);
+  }
+}

packages/node/src/transports/base.ts

@@ -1,6 +1,7 @@
 import { API, SentryError } from '@sentry/core';
 import { SentryEvent, SentryResponse, Status, Transport, TransportOptions } from '@sentry/types';
 import { serialize } from '@sentry/utils/object';
+import * as fs from 'fs';
 import * as http from 'http';
 import * as https from 'https';
 import * as url from 'url';
@@ -33,9 +34,11 @@ export abstract class BaseTransport implements Transport {
       ...this.api.getRequestHeaders(SDK_NAME, SDK_VERSION),
       ...this.options.headers,
     };
-
     const dsn = this.api.getDsn();
-    return {
+
+    const options: {
+      [key: string]: any;
+    } = {
       agent: this.client,
       headers,
       hostname: dsn.host,
@@ -44,6 +47,12 @@ export abstract class BaseTransport implements Transport {
       port: dsn.port,
       protocol: `${dsn.protocol}:`,
     };
+
+    if (this.options.caCerts) {
+      options.ca = fs.readFileSync(this.options.caCerts);
+    }
+
+    return options;
   }
 
   /** JSDoc */

packages/node/src/transports/http.ts

@@ -1,13 +1,17 @@
 import { SentryEvent, SentryResponse, TransportOptions } from '@sentry/types';
 import * as http from 'http';
+import HttpsProxyAgent from 'https-proxy-agent';
 import { BaseTransport } from './base';
 
-/** /** Node http module transport */
+/** Node http module transport */
 export class HTTPTransport extends BaseTransport {
   /** Create a new instance and set this.agent */
   public constructor(public options: TransportOptions) {
     super(options);
-    this.client = new http.Agent({ keepAlive: true, maxSockets: 100 });
+    const proxy = options.httpProxy || process.env.http_proxy;
+    this.client = proxy
+      ? (new HttpsProxyAgent(proxy) as http.Agent)
+      : new http.Agent({ keepAlive: true, maxSockets: 100 });
   }
 
   /**

packages/node/src/transports/https.ts

@@ -1,13 +1,17 @@
 import { SentryEvent, SentryResponse, TransportOptions } from '@sentry/types';
 import * as https from 'https';
+import HttpsProxyAgent from 'https-proxy-agent';
 import { BaseTransport } from './base';
 
 /** Node https module transport */
 export class HTTPSTransport extends BaseTransport {
   /** Create a new instance and set this.agent */
   public constructor(public options: TransportOptions) {
     super(options);
-    this.client = new https.Agent({ keepAlive: true, maxSockets: 100 });
+    const proxy = options.httpsProxy || options.httpProxy || process.env.https_proxy || process.env.http_proxy;
+    this.client = proxy
+      ? (new HttpsProxyAgent(proxy) as https.Agent)
+      : new https.Agent({ keepAlive: true, maxSockets: 100 });
   }
 
   /**

packages/types/src/index.ts

@@ -225,9 +225,17 @@ export interface SentryResponse {
 
 /** JSDoc */
 export interface TransportOptions {
+  [key: string]: any;
+  /** Sentry DSN */
   dsn: DsnLike;
   /** Define custom headers */
   headers?: object;
+  /** 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;
 }
 
 /** JSDoc */