@salesforce/telemetry 2.0.1 → 2.0.5

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 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)
+
+**Note:** Version bump only for package @salesforce/telemetry
+
+
+
+
+
+## [2.0.4](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.3...@salesforce/telemetry@2.0.4) (2020-11-13)
+
+**Note:** Version bump only for package @salesforce/telemetry
+
+
+
+
+
+## [2.0.3](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.2...@salesforce/telemetry@2.0.3) (2020-11-11)
+
+**Note:** Version bump only for package @salesforce/telemetry
+
+
+
+
+
+## [2.0.2](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.1...@salesforce/telemetry@2.0.2) (2020-03-02)
+
+
+### Bug Fixes
+
+* check connection to app insights ([d4d5748](https://github.com/forcedotcom/cli-packages/commit/d4d5748))
+
+
+
+
+
 ## [2.0.1](https://github.com/forcedotcom/cli-packages/compare/@salesforce/telemetry@2.0.0...@salesforce/telemetry@2.0.1) (2020-01-31)
 
 

package/lib/appInsights.d.ts

@@ -20,7 +20,14 @@ export interface TelemetryOptions {
     gdprSensitiveKeys?: string[];
     userId?: string;
     sessionId?: string;
+    waitForConnection?: boolean;
 }
+export declare function getPlatformVersion(): string;
+export declare function getCpus(): string;
+export declare function buildPropertiesAndMeasurements(attributes: Attributes): {
+    properties: Properties;
+    measurements: Measurements;
+};
 /**
  * This is a wrapper around appinsights sdk for convenience.
  *
@@ -29,6 +36,7 @@ export interface TelemetryOptions {
  */
 export declare class AppInsights extends AsyncCreatable<TelemetryOptions> {
     static GDPR_HIDDEN: string;
+    static APP_INSIGHTS_SERVER: string;
     private static ASIMOV_ENDPOINT;
     appInsightsClient: appInsights.TelemetryClient;
     private options;
@@ -39,24 +47,28 @@ export declare class AppInsights extends AsyncCreatable<TelemetryOptions> {
     init(): Promise<void>;
     /**
      * Publishes event to app insights dashboard
+     *
      * @param eventName {string} - name of the event you want published. Will be concatenated with this.options.project
      * @param attributes {Attributes} - map of properties to publish alongside the event.
      */
     sendTelemetryEvent(eventName: string, attributes?: Attributes): void;
     /**
      * Publishes exception to app insights dashboard
+     *
      * @param exception {Error} - exception you want published.
      * @param attributes {Attributes} - map of measurements to publish alongside the exception.
      */
     sendTelemetryException(exception: Error, attributes?: Attributes): void;
     /**
      * Publishes diagnostic information to app insights dashboard
+     *
      * @param message {string} - trace message to sen to app insights.
      * @param properties {Properties} - map of properties to publish alongside the event.
      */
     sendTelemetryTrace(traceMessage: string, properties?: Properties): void;
     /**
      * Publishes metric to app insights dashboard
+     *
      * @param name {string} - name of the metric you want published
      * @param value {number} - value of the metric
      * @param properties {Properties} - map of properties to publish alongside the event.
@@ -70,19 +82,15 @@ export declare class AppInsights extends AsyncCreatable<TelemetryOptions> {
     private createAppInsightsClient;
     /**
      * Builds the properties to send with every event
+     *
      * @return {Properties} map of base properites and properties provided when class was created
      */
     private buildCommonProperties;
     /**
      * Builds the context tags for appInsightsClient
+     *
      * @return {Properties} map of tags to add to this.appInsightsClient.context.tags
      */
     private buildContextTags;
     private hideGDPRdata;
 }
-export declare function buildPropertiesAndMeasurements(attributes: Attributes): {
-    properties: Properties;
-    measurements: Measurements;
-};
-export declare function getPlatformVersion(): string;
-export declare function getCpus(): string;

package/lib/appInsights.js

@@ -1,13 +1,58 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppInsights = exports.buildPropertiesAndMeasurements = exports.getCpus = exports.getPlatformVersion = void 0;
+/*
+ * Copyright (c) 2020, 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
+ */
+const os = require("os");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const appInsights = require("applicationinsights");
-const os = require("os");
 var applicationinsights_1 = require("applicationinsights");
-exports.TelemetryClient = applicationinsights_1.TelemetryClient;
+Object.defineProperty(exports, "TelemetryClient", { enumerable: true, get: function () { return applicationinsights_1.TelemetryClient; } });
 core_1.Messages.importMessagesDirectory(__dirname);
+function getPlatformVersion() {
+    return (os.release() || '').replace(/^(\d+)(\.\d+)?(\.\d+)?(.*)/, '$1$2$3');
+}
+exports.getPlatformVersion = getPlatformVersion;
+function getCpus() {
+    const cpus = os.cpus();
+    if (cpus && cpus.length > 0) {
+        return `${cpus[0].model}(${cpus.length} x ${cpus[0].speed})`;
+    }
+    else {
+        return '';
+    }
+}
+exports.getCpus = getCpus;
+function getSystemMemory() {
+    return `${(os.totalmem() / (1024 * 1024 * 1024)).toFixed(2)} GB`;
+}
+function isAsimovKey(key) {
+    return !!(key && key.startsWith('AIF-'));
+}
+function buildPropertiesAndMeasurements(attributes) {
+    const properties = {};
+    const measurements = {};
+    Object.keys(attributes).forEach((key) => {
+        const value = attributes[key];
+        if (ts_types_1.isString(value)) {
+            properties[key] = value;
+        }
+        else if (ts_types_1.isNumber(value)) {
+            measurements[key] = value;
+        }
+        else if (ts_types_1.isBoolean(value)) {
+            properties[key] = value.toString();
+        }
+    });
+    return { properties, measurements };
+}
+exports.buildPropertiesAndMeasurements = buildPropertiesAndMeasurements;
 /**
  * This is a wrapper around appinsights sdk for convenience.
  *
@@ -35,6 +80,7 @@ class AppInsights extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes event to app insights dashboard
+     *
      * @param eventName {string} - name of the event you want published. Will be concatenated with this.options.project
      * @param attributes {Attributes} - map of properties to publish alongside the event.
      */
@@ -46,6 +92,7 @@ class AppInsights extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes exception to app insights dashboard
+     *
      * @param exception {Error} - exception you want published.
      * @param attributes {Attributes} - map of measurements to publish alongside the exception.
      */
@@ -56,6 +103,7 @@ class AppInsights extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes diagnostic information to app insights dashboard
+     *
      * @param message {string} - trace message to sen to app insights.
      * @param properties {Properties} - map of properties to publish alongside the event.
      */
@@ -65,6 +113,7 @@ class AppInsights extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes metric to app insights dashboard
+     *
      * @param name {string} - name of the metric you want published
      * @param value {number} - value of the metric
      * @param properties {Properties} - map of properties to publish alongside the event.
@@ -102,6 +151,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
      */
     buildCommonProperties() {
@@ -110,12 +160,13 @@ class AppInsights extends kit_1.AsyncCreatable {
             'common.os': os.platform(),
             'common.platformversion': getPlatformVersion(),
             'common.systemmemory': getSystemMemory(),
-            'common.usertype': this.env.getString('SFDX_USER_TYPE') || 'normal'
+            'common.usertype': this.env.getString('SFDX_USER_TYPE') || 'normal',
         };
         return Object.assign(baseProperties, this.options.commonProperties);
     }
     /**
      * Builds the context tags for appInsightsClient
+     *
      * @return {Properties} map of tags to add to this.appInsightsClient.context.tags
      */
     buildContextTags() {
@@ -125,51 +176,14 @@ class AppInsights extends kit_1.AsyncCreatable {
     }
     // filters out non-GDPR compliant tags
     hideGDPRdata(tags) {
-        this.gdprSensitiveKeys.forEach(key => {
+        this.gdprSensitiveKeys.forEach((key) => {
             tags[key] = AppInsights.GDPR_HIDDEN;
         });
         return tags;
     }
 }
+exports.AppInsights = AppInsights;
 AppInsights.GDPR_HIDDEN = '<GDPR_HIDDEN>';
+AppInsights.APP_INSIGHTS_SERVER = 'https://dc.services.visualstudio.com';
 AppInsights.ASIMOV_ENDPOINT = 'https://vortex.data.microsoft.com/collect/v1';
-exports.AppInsights = AppInsights;
-function buildPropertiesAndMeasurements(attributes) {
-    const properties = {};
-    const measurements = {};
-    Object.keys(attributes).forEach(key => {
-        const value = attributes[key];
-        if (ts_types_1.isString(value)) {
-            properties[key] = value;
-        }
-        else if (ts_types_1.isNumber(value)) {
-            measurements[key] = value;
-        }
-        else if (ts_types_1.isBoolean(value)) {
-            properties[key] = value.toString();
-        }
-    });
-    return { properties, measurements };
-}
-exports.buildPropertiesAndMeasurements = buildPropertiesAndMeasurements;
-function getPlatformVersion() {
-    return (os.release() || '').replace(/^(\d+)(\.\d+)?(\.\d+)?(.*)/, '$1$2$3');
-}
-exports.getPlatformVersion = getPlatformVersion;
-function getCpus() {
-    const cpus = os.cpus();
-    if (cpus && cpus.length > 0) {
-        return `${cpus[0].model}(${cpus.length} x ${cpus[0].speed})`;
-    }
-    else {
-        return '';
-    }
-}
-exports.getCpus = getCpus;
-function getSystemMemory() {
-    return `${(os.totalmem() / (1024 * 1024 * 1024)).toFixed(2)} GB`;
-}
-function isAsimovKey(key) {
-    return !!(key && key.indexOf('AIF-') === 0);
-}
 //# sourceMappingURL=appInsights.js.map

package/lib/exported.js

@@ -1,9 +1,22 @@
+/*
+ * Copyright (c) 2020, 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
+ */
 'use strict';
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const telemetryReporter_1 = require("./telemetryReporter");
-__export(require("./telemetryReporter"));
+__exportStar(require("./telemetryReporter"), exports);
 exports.default = telemetryReporter_1.TelemetryReporter;
 //# sourceMappingURL=exported.js.map

package/lib/telemetryReporter.d.ts

@@ -6,17 +6,17 @@ export { TelemetryOptions, Attributes, Properties, TelemetryClient } from './app
  * Reports telemetry events to app insights. We do not send if the config 'disableTelemetry' is set.
  */
 export declare class TelemetryReporter extends AsyncCreatable<TelemetryOptions> {
-    /**
-     * Determine if the telemetry event should be logged.
-     * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
-     */
-    static determineSfdxTelemetryEnabled(): Promise<boolean>;
     private static config;
     private options;
     private logger;
     private config;
     private reporter;
     constructor(options: TelemetryOptions);
+    /**
+     * Determine if the telemetry event should be logged.
+     * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
+     */
+    static determineSfdxTelemetryEnabled(): Promise<boolean>;
     init(): Promise<void>;
     /**
      * Starts data collection services. This is for long running processes. Short lived
@@ -28,26 +28,32 @@ export declare class TelemetryReporter extends AsyncCreatable<TelemetryOptions>
      * not counting timeouts.
      */
     stop(): void;
+    waitForConnection(): Promise<void>;
+    testConnection(): Promise<boolean>;
     /**
      * Sends message to child process.
+     *
      * @param eventName {string} - name of the event you want published.
      * @param attributes {Attributes} - map of properties to publish alongside the event.
      */
     sendTelemetryEvent(eventName: string, attributes?: Attributes): void;
     /**
      * Sends exception to child process.
+     *
      * @param exception {Error} - exception you want published.
      * @param measurements {Measurements} - map of measurements to publish alongside the event.
      */
     sendTelemetryException(exception: Error, attributes?: Attributes): void;
     /**
      * Publishes diagnostic information to app insights dashboard
+     *
      * @param message {string} - trace message to sen to app insights.
      * @param properties {Properties} - map of properties to publish alongside the event.
      */
     sendTelemetryTrace(traceMessage: string, properties?: Properties): void;
     /**
      * Publishes metric to app insights dashboard
+     *
      * @param name {string} - name of the metric you want published
      * @param value {number} - value of the metric
      * @param properties {Properties} - map of properties to publish alongside the event.

package/lib/telemetryReporter.js

@@ -1,16 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelemetryReporter = void 0;
+/*
+ * Copyright (c) 2020, 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
+ */
+const os = require("os");
 const core_1 = require("@salesforce/core");
 const kit_1 = require("@salesforce/kit");
-const os = require("os");
+const axios_1 = require("axios");
 const appInsights_1 = require("./appInsights");
 const DISABLE_TELEMETRY = 'disableTelemetry';
 var appInsights_2 = require("./appInsights");
-exports.TelemetryClient = appInsights_2.TelemetryClient;
+Object.defineProperty(exports, "TelemetryClient", { enumerable: true, get: function () { return appInsights_2.TelemetryClient; } });
 /**
  * Reports telemetry events to app insights. We do not send if the config 'disableTelemetry' is set.
  */
 class TelemetryReporter extends kit_1.AsyncCreatable {
+    constructor(options) {
+        super(options);
+        this.options = options;
+    }
     /**
      * Determine if the telemetry event should be logged.
      * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
@@ -24,16 +36,14 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
         const isEnabled = !sfdxDisableInsights;
         return isEnabled;
     }
-    constructor(options) {
-        super(options);
-        this.options = options;
-    }
     async init() {
         this.logger = await core_1.Logger.child('TelemetryReporter');
         if (!TelemetryReporter.config) {
             TelemetryReporter.config = await core_1.ConfigAggregator.create({});
         }
         this.config = TelemetryReporter.config;
+        if (this.options.waitForConnection)
+            await this.waitForConnection();
         this.reporter = await appInsights_1.AppInsights.create(this.options);
     }
     /**
@@ -50,8 +60,45 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
     stop() {
         this.reporter.stop();
     }
+    async waitForConnection() {
+        const canConnect = await this.testConnection();
+        if (!canConnect) {
+            throw new Error('Unable to connect to app insights.');
+        }
+    }
+    async testConnection() {
+        const timeout = parseInt(kit_1.env.getString('SFDX_TELEMETRY_TIMEOUT', '1000'), 10);
+        this.logger.debug(`Testing connection to ${appInsights_1.AppInsights.APP_INSIGHTS_SERVER} with timeout of ${timeout} ms`);
+        // set up a CancelToken to handle connection timeouts because
+        // the built in timeout functionality only handles response timeouts
+        // see here: https://github.com/axios/axios/issues/647#issuecomment-322209906
+        const cancelRequest = axios_1.default.CancelToken.source();
+        setTimeout(() => cancelRequest.cancel('connection timeout'), timeout);
+        let canConnect;
+        try {
+            const options = {
+                timeout,
+                cancelToken: cancelRequest.token,
+                // We want any status less than 500 to be resolved (not rejected)
+                validateStatus: (status) => status < 500,
+            };
+            await axios_1.default.get(appInsights_1.AppInsights.APP_INSIGHTS_SERVER, options);
+            canConnect = true;
+        }
+        catch (err) {
+            canConnect = false;
+        }
+        if (canConnect) {
+            this.logger.debug(`Successfully made a connection to ${appInsights_1.AppInsights.APP_INSIGHTS_SERVER}`);
+        }
+        else {
+            this.logger.warn(`Connection to ${appInsights_1.AppInsights.APP_INSIGHTS_SERVER} timed out after ${timeout} ms`);
+        }
+        return canConnect;
+    }
     /**
      * Sends message to child process.
+     *
      * @param eventName {string} - name of the event you want published.
      * @param attributes {Attributes} - map of properties to publish alongside the event.
      */
@@ -62,6 +109,7 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
     }
     /**
      * Sends exception to child process.
+     *
      * @param exception {Error} - exception you want published.
      * @param measurements {Measurements} - map of measurements to publish alongside the event.
      */
@@ -75,6 +123,7 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes diagnostic information to app insights dashboard
+     *
      * @param message {string} - trace message to sen to app insights.
      * @param properties {Properties} - map of properties to publish alongside the event.
      */
@@ -85,6 +134,7 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
     }
     /**
      * Publishes metric to app insights dashboard
+     *
      * @param name {string} - name of the metric you want published
      * @param value {number} - value of the metric
      * @param properties {Properties} - map of properties to publish alongside the event.

package/package.json

@@ -1,23 +1,24 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "2.0.1",
+  "version": "2.0.5",
   "description": "Library for application insights",
   "main": "lib/exported",
   "repository": "https://github.com/forcedotcom/cli-packages",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
   "scripts": {
-    "build": "yarn sfdx-build",
-    "clean": "yarn sfdx-clean",
-    "clean-all": "yarn sfdx-clean all",
-    "compile": "yarn sfdx-compile",
-    "docs": "yarn sfdx-docs",
-    "format": "yarn sfdx-format",
-    "lint": "yarn sfdx-lint",
+    "build": "sf-build",
+    "clean": "sf-clean",
+    "clean-all": "sf-clean all",
+    "compile": "sf-compile",
+    "docs": "sf-docs",
+    "format": "sf-format",
+    "lint": "sf-lint",
     "lint-fix": "yarn sfdx-lint --fix",
-    "prepack": "yarn sfdx-build",
+    "prepack": "sf-build",
     "prepare": "npm run build",
-    "test": "yarn sfdx-test"
+    "pretest": "sf-compile-test",
+    "test": "sf-test"
   },
   "keywords": [
     "force",
@@ -32,17 +33,38 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@salesforce/core": "^2.1.6",
+    "@salesforce/core": "^2.15.2",
     "@salesforce/ts-types": "^1.2.1",
-    "applicationinsights": "^1.4.0"
+    "applicationinsights": "^1.4.0",
+    "axios": "^0.21.1"
   },
   "devDependencies": {
-    "@salesforce/dev-scripts": "^0.3.14",
-    "@salesforce/ts-sinon": "^1.1.0"
+    "@salesforce/dev-config": "^2.0.0",
+    "@salesforce/dev-scripts": "^0.6.2",
+    "@salesforce/prettier-config": "^0.0.1",
+    "@salesforce/ts-sinon": "^1.1.0",
+    "@typescript-eslint/eslint-plugin": "^2.30.0",
+    "@typescript-eslint/parser": "^2.30.0",
+    "chai": "^4.2.0",
+    "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.11.0",
+    "eslint-config-salesforce": "^0.1.0",
+    "eslint-config-salesforce-license": "^0.1.0",
+    "eslint-config-salesforce-typescript": "^0.1.0",
+    "eslint-plugin-header": "^3.0.0",
+    "eslint-plugin-import": "^2.20.2",
+    "eslint-plugin-jsdoc": "^27.0.3",
+    "eslint-plugin-prettier": "^3.1.3",
+    "mocha": "^7.2.0",
+    "nyc": "^15.1.0",
+    "prettier": "^2.0.5",
+    "sinon": "^9.0.2",
+    "ts-node": "^8.10.2",
+    "typescript": "^3.9.3"
   },
   "types": "lib/exported.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8ad448ef70c9cac25544e588cfbfc4e3cb8c3fe0"
+  "gitHead": "b089ff3508131aa35774ee088376b7a98dcb3167"
 }