GDPR: Added includePrivateInformation flags.

Author: niemyjski

src/configuration/Configuration.ts

@@ -115,6 +115,14 @@ export class Configuration implements IConfigurationSettings {
    */
   private _dataExclusions: string[] = [];
 
+  private _includePrivateInformation: boolean;
+  private _includeUserName: boolean;
+  private _includeMachineName: boolean;
+  private _includeIpAddress: boolean;
+  private _includeCookies: boolean;
+  private _includePostData: boolean;
+  private _includeQueryString: boolean;
+
   /**
    * A list of user agent patterns.
    * @type {Array}
@@ -148,6 +156,7 @@ export class Configuration implements IConfigurationSettings {
     this.serverUrl = configSettings.serverUrl;
     this.heartbeatServerUrl = configSettings.heartbeatServerUrl;
     this.updateSettingsWhenIdleInterval = configSettings.updateSettingsWhenIdleInterval;
+    this.includePrivateInformation = configSettings.includePrivateInformation;
 
     this.environmentInfoCollector = inject(configSettings.environmentInfoCollector);
     this.errorParser = inject(configSettings.errorParser);
@@ -286,6 +295,138 @@ export class Configuration implements IConfigurationSettings {
     this._dataExclusions = Utils.addRange<string>(this._dataExclusions, ...exclusions);
   }
 
+  /**
+   * Gets a value indicating whether to include private information about the local machine.
+   * @returns {boolean}
+   */
+  public get includePrivateInformation(): boolean {
+    return this._includePrivateInformation;
+  }
+
+  /**
+   * Sets a value indicating whether to include private information about the local machine
+   * @param value
+   */
+  public set includePrivateInformation(value: boolean) {
+    const val = value || false;
+    this._includePrivateInformation = val;
+    this.includeUserName = val;
+    this._includeMachineName = val;
+    this.includeIpAddress = val;
+    this.includeCookies = val;
+    this.includePostData = val;
+    this.includeQueryString = val;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include User Name.
+   * @returns {boolean}
+   */
+  public get includeUserName(): boolean {
+    return this._includeUserName;
+  }
+
+  /**
+   * Sets a value indicating whether to include User Name.
+   * @param value
+   */
+  public set includeUserName(value: boolean) {
+    this._includeUserName = value || false;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include MachineName in MachineInfo.
+   * @returns {boolean}
+   */
+  public get includeMachineName(): boolean {
+    return this._includeMachineName;
+  }
+
+  /**
+   * Sets a value indicating whether to include MachineName in MachineInfo.
+   * @param value
+   */
+  public set includeMachineName(value: boolean) {
+    this._includeMachineName = value || false;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include Ip Addresses in MachineInfo and RequestInfo.
+   * @returns {boolean}
+   */
+  public get includeIpAddress(): boolean {
+    return this._includeIpAddress;
+  }
+
+  /**
+   * Sets a value indicating whether to include Ip Addresses in MachineInfo and RequestInfo.
+   * @param value
+   */
+  public set includeIpAddress(value: boolean) {
+    this._includeIpAddress = value || false;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include Cookies.
+   * NOTE: DataExclusions are applied to all Cookie keys when enabled.
+   * @returns {boolean}
+   */
+  public get includeCookies(): boolean {
+    return this._includeCookies;
+  }
+
+  /**
+   * Sets a value indicating whether to include Cookies.
+   * NOTE: DataExclusions are applied to all Cookie keys when enabled.
+   * @param value
+   */
+  public set includeCookies(value: boolean) {
+    this._includeCookies = value || false;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include Form/POST Data.
+   * NOTE: DataExclusions are only applied to Form data keys when enabled.
+   * @returns {boolean}
+   */
+  public get includePostData(): boolean {
+    return this._includePostData;
+  }
+
+  /**
+   * Sets a value indicating whether to include Form/POST Data.
+   * NOTE: DataExclusions are only applied to Form data keys when enabled.
+   * @param value
+   */
+  public set includePostData(value: boolean) {
+    this._includePostData = value || false;
+    this.changed();
+  }
+
+  /**
+   * Gets a value indicating whether to include query string information.
+   * NOTE: DataExclusions are applied to all Query String keys when enabled.
+   * @returns {boolean}
+   */
+  public get includeQueryString(): boolean {
+    return this._includeQueryString;
+  }
+
+  /**
+   * Sets a value indicating whether to include query string information.
+   * NOTE: DataExclusions are applied to all Query String keys when enabled.
+   * @param value
+   */
+  public set includeQueryString(value: boolean) {
+    this._includeQueryString = value || false;
+    this.changed();
+  }
+
   /**
    * A list of user agent patterns that will cause any event with a matching user agent to not be submitted.
    *
@@ -468,7 +609,7 @@ export class Configuration implements IConfigurationSettings {
    */
   public static get defaults() {
     if (Configuration._defaultSettings === null) {
-      Configuration._defaultSettings = {};
+      Configuration._defaultSettings = { includePrivateInformation: true };
     }
 
     return Configuration._defaultSettings;

src/configuration/IConfigurationSettings.ts

@@ -14,6 +14,7 @@ export interface IConfigurationSettings {
   serverUrl?: string;
   heartbeatServerUrl?: string;
   updateSettingsWhenIdleInterval?: number;
+  includePrivateInformation?: boolean;
   environmentInfoCollector?: IEnvironmentInfoCollector;
   errorParser?: IErrorParser;
   lastReferenceIdManager?: ILastReferenceIdManager;

src/exceptionless.ts

@@ -64,9 +64,18 @@ import { Utils } from './Utils';
 
   const defaults = Configuration.defaults;
   const settings = getDefaultsSettingsFromScriptTag();
-  if (settings && (settings.apiKey || settings.serverUrl)) {
-    defaults.apiKey = settings.apiKey;
-    defaults.serverUrl = settings.serverUrl;
+  if (settings) {
+    if (settings.apiKey) {
+      defaults.apiKey = settings.apiKey;
+    }
+
+    if (settings.serverUrl) {
+      defaults.serverUrl = settings.serverUrl;
+    }
+
+    if (settings.includePrivateInformation) {
+      defaults.includePrivateInformation = settings.includePrivateInformation;
+    }
   }
 
   defaults.errorParser = new DefaultErrorParser();

src/services/DefaultRequestInfoCollector.ts

@@ -9,18 +9,25 @@ export class DefaultRequestInfoCollector implements IRequestInfoCollector {
       return null;
     }
 
-    const exclusions = context.client.config.dataExclusions;
+    const config = context.client.config;
+    const exclusions = config.dataExclusions;
     const requestInfo: IRequestInfo = {
       user_agent: navigator.userAgent,
       is_secure: location.protocol === 'https:',
       host: location.hostname,
       port: location.port && location.port !== '' ? parseInt(location.port, 10) : 80,
-      path: location.pathname,
-      // client_ip_address: 'TODO',
-      cookies: Utils.getCookies(document.cookie, exclusions),
-      query_string: Utils.parseQueryString(location.search.substring(1), exclusions)
+      path: location.pathname
+      // client_ip_address: 'TODO'
     };
 
+    if (config.includeCookies) {
+      requestInfo.cookies = Utils.getCookies(document.cookie, exclusions);
+    }
+
+    if (config.includeQueryString) {
+      requestInfo.query_string = Utils.parseQueryString(location.search.substring(1), exclusions);
+    }
+
     if (document.referrer && document.referrer !== '') {
       requestInfo.referrer = document.referrer;
     }

src/services/NodeEnvironmentInfoCollector.ts

@@ -36,8 +36,6 @@ export class NodeEnvironmentInfoCollector implements IEnvironmentInfoCollector {
       architecture: os.arch(),
       o_s_name: os.type(),
       o_s_version: os.release(),
-      ip_address: getIpAddresses(),
-      machine_name: os.hostname(),
       // install_id: '',
       runtime_version: process.version,
       data: {
@@ -48,6 +46,15 @@ export class NodeEnvironmentInfoCollector implements IEnvironmentInfoCollector {
       }
     };
 
+    const config = context.client.config;
+    if (config.includeMachineName) {
+      environmentInfo.machine_name = os.hostname();
+    }
+
+    if (config.includeIpAddress) {
+      environmentInfo.ip_address = getIpAddresses();
+    }
+
     if ((os as any).endianness) {
       environmentInfo.data.endianness = (os as any).endianness();
     }

src/services/NodeRequestInfoCollector.ts

@@ -10,20 +10,17 @@ export class NodeRequestInfoCollector implements IRequestInfoCollector {
       return null;
     }
 
-    const exclusions = context.client.config.dataExclusions;
+    const config = context.client.config;
+    const exclusions = config.dataExclusions;
 
     // TODO: include referrer
     const request = context.contextData[REQUEST_KEY];
     const requestInfo: IRequestInfo = {
-      client_ip_address: request.ip,
       user_agent: request.headers['user-agent'],
       is_secure: request.secure,
       http_method: request.method,
       host: request.hostname || request.host,
-      path: request.path,
-      post_data: JSON.parse(Utils.stringify(request.body || {}, exclusions)),
-      cookies: Utils.getCookies(request.headers.cookie, exclusions),
-      query_string: JSON.parse(Utils.stringify(request.params || {}, exclusions))
+      path: request.path
     };
 
     const host = request.headers.host;
@@ -32,6 +29,22 @@ export class NodeRequestInfoCollector implements IRequestInfoCollector {
       requestInfo.port = port;
     }
 
+    if (config.includeIpAddress) {
+      requestInfo.client_ip_address = request.ip;
+    }
+
+    if (config.includeCookies) {
+      requestInfo.cookies = Utils.getCookies(request.headers.cookie, exclusions);
+    }
+
+    if (config.includeQueryString) {
+      requestInfo.query_string = JSON.parse(Utils.stringify(request.params || {}, exclusions));
+    }
+
+    if (config.includePostData) {
+      requestInfo.post_data = JSON.parse(Utils.stringify(request.body || {}, exclusions));
+    }
+
     return requestInfo;
   }
 }