@salesforce/telemetry 4.0.16 → 4.1.0

package/lib/enabledCheck.d.ts

@@ -0,0 +1,9 @@
+import { ConfigAggregator } from '@salesforce/core/lib/config/configAggregator';
+/**
+ *
+ * Check ConfigAggregator once for telemetry opt-out.  Returns true unless config/env has opt-out
+ * If you don't pass in a ConfigAggregator, one will be constructed for you
+ * memoized: only runs once
+ *
+ * */
+export declare const isEnabled: (configAggregator?: ConfigAggregator) => Promise<boolean>;

package/lib/enabledCheck.js

@@ -0,0 +1,30 @@
+"use strict";
+/*
+ * Copyright (c) 2023, 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEnabled = void 0;
+// deep imports to avoid requiring the ENTIRE package (which will also pull in jsforce) until we get ESM done
+const configAggregator_1 = require("@salesforce/core/lib/config/configAggregator");
+const config_1 = require("@salesforce/core/lib/config/config");
+// store the result to reduce checks
+let enabled;
+/**
+ *
+ * Check ConfigAggregator once for telemetry opt-out.  Returns true unless config/env has opt-out
+ * If you don't pass in a ConfigAggregator, one will be constructed for you
+ * memoized: only runs once
+ *
+ * */
+const isEnabled = async (configAggregator) => {
+    if (enabled === undefined) {
+        const agg = configAggregator ?? (await configAggregator_1.ConfigAggregator.create({}));
+        enabled = agg.getPropertyValue(config_1.SfConfigProperties.DISABLE_TELEMETRY) !== 'true';
+    }
+    return enabled;
+};
+exports.isEnabled = isEnabled;
+//# sourceMappingURL=enabledCheck.js.map

package/lib/exported.d.ts

@@ -1,3 +1,4 @@
 import { TelemetryReporter } from './telemetryReporter';
 export * from './telemetryReporter';
+export { isEnabled } from './enabledCheck';
 export default TelemetryReporter;

package/lib/exported.js

@@ -20,7 +20,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEnabled = void 0;
 const telemetryReporter_1 = require("./telemetryReporter");
 __exportStar(require("./telemetryReporter"), exports);
+var enabledCheck_1 = require("./enabledCheck");
+Object.defineProperty(exports, "isEnabled", { enumerable: true, get: function () { return enabledCheck_1.isEnabled; } });
 exports.default = telemetryReporter_1.TelemetryReporter;
 //# sourceMappingURL=exported.js.map

package/lib/telemetryReporter.d.ts

@@ -1,18 +1,18 @@
 import { AsyncCreatable } from '@salesforce/kit';
-import { Attributes, Properties, TelemetryOptions } from './appInsights';
+import { type Attributes, type Properties, type TelemetryOptions } from './appInsights';
 import { TelemetryClient } from './exported';
 export { TelemetryOptions, Attributes, Properties, TelemetryClient } from './appInsights';
 /**
  * Reports telemetry events to app insights. We do not send if the config 'disableTelemetry' is set.
  */
 export declare class TelemetryReporter extends AsyncCreatable<TelemetryOptions> {
-    private static config;
+    private enabled;
     private options;
     private logger;
-    private config;
     private reporter;
     constructor(options: TelemetryOptions);
     /**
+     * @deprecated Use the standalone function isEnabled() instead.
      * Determine if the telemetry event should be logged.
      * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
      */

package/lib/telemetryReporter.js

@@ -39,6 +39,7 @@ const kit_1 = require("@salesforce/kit");
 const got_1 = __importDefault(require("got"));
 const proxy_agent_1 = require("proxy-agent");
 const appInsights_1 = require("./appInsights");
+const enabledCheck_1 = require("./enabledCheck");
 var appInsights_2 = require("./appInsights");
 Object.defineProperty(exports, "TelemetryClient", { enumerable: true, get: function () { return appInsights_2.TelemetryClient; } });
 /**
@@ -47,27 +48,20 @@ Object.defineProperty(exports, "TelemetryClient", { enumerable: true, get: funct
 class TelemetryReporter extends kit_1.AsyncCreatable {
     constructor(options) {
         super(options);
+        this.enabled = false;
         this.options = options;
     }
     /**
+     * @deprecated Use the standalone function isEnabled() instead.
      * Determine if the telemetry event should be logged.
      * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
      */
     static async determineSfdxTelemetryEnabled() {
-        if (!TelemetryReporter.config) {
-            TelemetryReporter.config = await core_1.ConfigAggregator.create({});
-        }
-        const configValue = TelemetryReporter.config.getPropertyValue(core_1.SfConfigProperties.DISABLE_TELEMETRY);
-        // SF_DISABLE_TELEMETRY is the proper name for this env that will be cheked by config.getPropertyValue. SFDX_DISABLE_INSIGHTS is present for backwards compatibility
-        const sfdxDisableInsights = configValue === 'true' || kit_1.env.getBoolean('SFDX_DISABLE_INSIGHTS');
-        return !sfdxDisableInsights;
+        return (0, enabledCheck_1.isEnabled)();
     }
     async init() {
+        this.enabled = await (0, enabledCheck_1.isEnabled)();
         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);
@@ -173,14 +167,10 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
      * Setting the disableTelemetry config var to true will disable insights for errors and diagnostics.
      */
     isSfdxTelemetryEnabled() {
-        const configValue = this.config.getPropertyValue(core_1.SfConfigProperties.DISABLE_TELEMETRY);
-        const sfdxDisableInsights = configValue === 'true' || kit_1.env.getBoolean('SFDX_DISABLE_INSIGHTS');
-        // isEnabled = !sfdxDisableInsights
-        return !sfdxDisableInsights;
+        return this.enabled;
     }
     logTelemetryStatus() {
-        const isEnabled = this.isSfdxTelemetryEnabled();
-        if (isEnabled) {
+        if (this.enabled) {
             this.logger.warn(`Telemetry is enabled. This can be disabled by running sfdx force:config:set ${core_1.SfConfigProperties.DISABLE_TELEMETRY}=true`);
         }
         else {

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "4.0.16",
+  "version": "4.1.0",
   "description": "Library for application insights",
   "main": "lib/exported",
+  "exports": {
+    "./enabledCheck": "./lib/enabledCheck.js",
+    ".": "./lib/exported.js"
+  },
   "repository": "forcedotcom/telemetry",
   "author": "Salesforce",
   "license": "BSD-3-Clause",
@@ -43,14 +47,14 @@
   },
   "devDependencies": {
     "@salesforce/dev-config": "^4.0.1",
-    "@salesforce/dev-scripts": "^5.4.3",
+    "@salesforce/dev-scripts": "^5.7.0",
     "@salesforce/prettier-config": "^0.0.3",
-    "@salesforce/ts-sinon": "^1.4.12",
+    "@salesforce/ts-sinon": "^1.4.14",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "chai": "^4.3.7",
-    "eslint": "^8.46.0",
-    "eslint-config-prettier": "^8.9.0",
+    "eslint": "^8.47.0",
+    "eslint-config-prettier": "^8.10.0",
     "eslint-config-salesforce": "^2.0.2",
     "eslint-config-salesforce-license": "^0.2.0",
     "eslint-config-salesforce-typescript": "^1.1.2",