@salesforce/telemetry 2.0.5 → 3.0.1

package/CHANGELOG.md

@@ -1,7 +1,31 @@
-# Change Log
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [3.0.1](https://github.com/forcedotcom/telemetry/compare/v3.0.0...v3.0.1) (2021-11-17)
+
+
+### Bug Fixes
+
+* release 3.0.1 ([050953a](https://github.com/forcedotcom/telemetry/commit/050953a117a4f3c6c5a2100d2a47e80719e64976))
+* replace homedir ([2bcb2ed](https://github.com/forcedotcom/telemetry/commit/2bcb2ede66dc7ef3c14cb40d530fb34530b84147))
+* sanitizing exception strings ([b12c52c](https://github.com/forcedotcom/telemetry/commit/b12c52cad97b736bcb0e5968c8427ae89f0d8397))
+* sinon types match sinon ([4cbefbf](https://github.com/forcedotcom/telemetry/commit/4cbefbf4ded50b4fdd1f451e27aba449c886b481))
+
+## 3.0.0 (2021-07-08)
+
+
+### Features
+
+* publish ([9336302](https://github.com/forcedotcom/telemetry/commit/9336302f15b43bd824ec70fe604e05a6bb2f5ba2))
+
+## [2.0.6](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.5...@salesforce/telemetry@2.0.6) (2021-05-11)
+
+**Note:** Version bump only for package @salesforce/telemetry
+
+
+
 
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
 ## [2.0.5](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.4...@salesforce/telemetry@2.0.5) (2021-01-22)
 

package/lib/appInsights.d.ts

@@ -83,7 +83,7 @@ export declare class AppInsights extends AsyncCreatable<TelemetryOptions> {
     /**
      * Builds the properties to send with every event
      *
-     * @return {Properties} map of base properites and properties provided when class was created
+     * @return {Properties} map of base properties and properties provided when class was created
      */
     private buildCommonProperties;
     /**

package/lib/appInsights.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AppInsights = exports.buildPropertiesAndMeasurements = exports.getCpus = exports.getPlatformVersion = void 0;
 /*
- * Copyright (c) 2020, salesforce.com, inc.
+ * Copyright (c) 2021, salesforce.com, inc.
  * All rights reserved.
  * Licensed under the BSD 3-Clause license.
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
@@ -29,6 +29,20 @@ function getCpus() {
     }
 }
 exports.getCpus = getCpus;
+const homeDir = os.homedir();
+const sanitizeError = (err) => {
+    if (err.name) {
+        err.name = err.name.replace(homeDir, '~');
+    }
+    if (err.message) {
+        err.message = err.message.replace(homeDir, '~');
+    }
+    if (err.stack) {
+        // there might be lots of this one
+        err.stack = err.stack.replace(new RegExp(`\\b${homeDir}\\b`, 'gi'), '~');
+    }
+    return err;
+};
 function getSystemMemory() {
     return `${(os.totalmem() / (1024 * 1024 * 1024)).toFixed(2)} GB`;
 }
@@ -41,7 +55,7 @@ function buildPropertiesAndMeasurements(attributes) {
     Object.keys(attributes).forEach((key) => {
         const value = attributes[key];
         if (ts_types_1.isString(value)) {
-            properties[key] = value;
+            properties[key] = value.replace(homeDir, '~');
         }
         else if (ts_types_1.isNumber(value)) {
             measurements[key] = value;
@@ -97,9 +111,10 @@ class AppInsights extends kit_1.AsyncCreatable {
      * @param attributes {Attributes} - map of measurements to publish alongside the exception.
      */
     sendTelemetryException(exception, attributes = {}) {
-        this.logger.debug(`Sending telemetry exception: ${exception.message}`);
+        const cleanException = sanitizeError(exception);
+        this.logger.debug(`Sending telemetry exception: ${cleanException.message}`);
         const { properties, measurements } = buildPropertiesAndMeasurements(attributes);
-        this.appInsightsClient.trackException({ exception, properties, measurements });
+        this.appInsightsClient.trackException({ exception: cleanException, properties, measurements });
     }
     /**
      * Publishes diagnostic information to app insights dashboard
@@ -152,7 +167,7 @@ class AppInsights extends kit_1.AsyncCreatable {
     /**
      * Builds the properties to send with every event
      *
-     * @return {Properties} map of base properites and properties provided when class was created
+     * @return {Properties} map of base properties and properties provided when class was created
      */
     buildCommonProperties() {
         const baseProperties = {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "2.0.5",
+  "version": "3.0.1",
   "description": "Library for application insights",
   "main": "lib/exported",
-  "repository": "https://github.com/forcedotcom/cli-packages",
+  "repository": "forcedotcom/telemetry",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "scripts": {
@@ -65,6 +65,5 @@
   "types": "lib/exported.d.ts",
   "publishConfig": {
     "access": "public"
-  },
-  "gitHead": "b089ff3508131aa35774ee088376b7a98dcb3167"
+  }
 }