@sap-ux/telemetry 0.2.0

package/dist/tooling-telemetry/telemetry-settings.js

@@ -0,0 +1,180 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTelemetrySetting = exports.setEnableTelemetry = exports.initTelemetrySettings = void 0;
+const reporting_1 = require("../base/utils/reporting");
+const store_1 = require("@sap-ux/store");
+const btp_utils_1 = require("@sap-ux/btp-utils");
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const fs_1 = __importDefault(require("fs"));
+const data_processor_1 = require("./data-processor");
+const config_state_1 = require("../base/config-state");
+const config_state_2 = require("./config-state");
+const deprecatedSettingPaths = {
+    win32: '\\AppData\\Roaming\\Code\\User\\settings.json',
+    darwin: '/Library/Application Support/Code/User/settings.json',
+    linux: '/.config/Code/User/settings.json',
+    theia: '/.theia/settings.json'
+};
+const deprecatedExtensionPropKeys = [
+    'sap.ux.annotation.lsp.enableTelemetry',
+    'sap.ux.applicationModeler.enableTelemetry',
+    'sap.ux.help.enableTelemetry',
+    'sap.ux.serviceModeler.enableTelemetry'
+];
+const definePath = (paths) => {
+    const platform = process.platform;
+    let settingsPath = paths[platform];
+    if ((0, btp_utils_1.isAppStudio)()) {
+        settingsPath = paths.theia;
+    }
+    if (!settingsPath) {
+        // no path for unknown platform settings path
+        return null;
+    }
+    const homedir = os_1.default.homedir();
+    return path_1.default.join(homedir, settingsPath);
+};
+/**
+ * Read telemetry settings from file store.
+ *
+ * @param storeService Store service that is used for read/write telemetry settings
+ */
+function readEnableTelemetry(storeService) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let setting;
+        try {
+            setting = yield storeService.read(new store_1.TelemetrySettingKey());
+        }
+        catch (_a) {
+            // ignore read failure, assume file doens't exist and thus setting is undefined
+        }
+        if (!setting) {
+            // If no telemetry setting found in .fioritools folder,
+            // check telemetry setting in vscode settings for extensions
+            const deprecatedSettingPath = definePath(deprecatedSettingPaths);
+            if (!deprecatedSettingPath) {
+                // If no vscode setting found, default central telemetry setting to true
+                yield setEnableTelemetry(true);
+            }
+            else {
+                // If deprecated vscode setting exists, set central telemetry setting to false if any of vscode setting was false
+                let content;
+                try {
+                    content = yield fs_1.default.promises.readFile(deprecatedSettingPath, 'utf-8');
+                    const deprecatedSetting = JSON.parse(content);
+                    const propValues = deprecatedExtensionPropKeys.map((propKey) => { var _a; return ((_a = deprecatedSetting[propKey]) !== null && _a !== void 0 ? _a : true); });
+                    const deprecatedEnableTelemetrySetting = propValues.reduce((prevValue, currentValue) => prevValue && currentValue);
+                    yield setEnableTelemetry(deprecatedEnableTelemetrySetting);
+                }
+                catch (_b) {
+                    // ignore read failure and content is undefined
+                    yield setEnableTelemetry(true);
+                }
+            }
+        }
+        else {
+            config_state_1.TelemetrySettings.telemetryEnabled = setting.enableTelemetry;
+        }
+    });
+}
+/**
+ * Watch changes to telemetry setting in the store and update runtime settings accordingly.
+ *
+ * @param storeService Store service that is used for read/write telemetry settings
+ */
+function watchTelemetrySettingStore(storeService) {
+    (0, store_1.getFilesystemWatcherFor)(store_1.Entity.TelemetrySetting, () => {
+        storeService
+            .read(new store_1.TelemetrySettingKey())
+            .then((watchedSetting) => {
+            if (watchedSetting) {
+                config_state_1.TelemetrySettings.telemetryEnabled = watchedSetting.enableTelemetry;
+            }
+        })
+            .catch(() => {
+            // Failed to read file changes, nothing can be done here.
+        });
+    });
+}
+/**
+ * Telemetry API function to init settings.
+ *
+ * @param options Settings pass from the consumer module.
+ */
+const initTelemetrySettings = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    var _a;
+    try {
+        config_state_1.TelemetrySettings.azureInstrumentationKey = options.resourceId;
+        config_state_1.TelemetrySettings.consumerModuleName = options.consumerModule.name;
+        config_state_1.TelemetrySettings.consumerModuleVersion = options.consumerModule.version;
+        config_state_2.ToolingTelemetrySettings.internalFeature = (_a = options.internalFeature) !== null && _a !== void 0 ? _a : false;
+        const storeService = yield (0, store_1.getService)({
+            entityName: 'telemetrySetting'
+        });
+        yield readEnableTelemetry(storeService);
+        watchTelemetrySettingStore(storeService);
+    }
+    catch (err) {
+        (0, reporting_1.reportRuntimeError)(err);
+    }
+});
+exports.initTelemetrySettings = initTelemetrySettings;
+/**
+ * Toggle on/off enable telemetry setting. This will update telemetry settings file
+ * and the runtime setting.
+ *
+ * @param enableTelemetry Telemetry is enabled or not
+ */
+function setEnableTelemetry(enableTelemetry) {
+    return __awaiter(this, void 0, void 0, function* () {
+        try {
+            const storeService = yield (0, store_1.getService)({
+                entityName: 'telemetrySetting'
+            });
+            const setting = new store_1.TelemetrySetting({ enableTelemetry });
+            yield storeService.write(setting);
+            config_state_1.TelemetrySettings.telemetryEnabled = enableTelemetry;
+        }
+        catch (_a) {
+            // Telemetry settings could not be written
+        }
+        const commonProperties = yield (0, data_processor_1.getCommonProperties)();
+        (0, reporting_1.reportEnableTelemetryOnOff)(enableTelemetry, commonProperties);
+    });
+}
+exports.setEnableTelemetry = setEnableTelemetry;
+/**
+ * Get telemetry settings.
+ *
+ * @returns Telemetry settings of context module that consumes telemetry library
+ */
+function getTelemetrySetting() {
+    return __awaiter(this, void 0, void 0, function* () {
+        let setting;
+        try {
+            const storeService = yield (0, store_1.getService)({
+                entityName: 'telemetrySetting'
+            });
+            setting = yield storeService.read(new store_1.TelemetrySettingKey());
+        }
+        catch (_a) {
+            // ignore if settings could not be read, return undefined
+        }
+        return setting;
+    });
+}
+exports.getTelemetrySetting = getTelemetrySetting;
+//# sourceMappingURL=telemetry-settings.js.map

package/dist/tooling-telemetry/types.d.ts

@@ -0,0 +1,92 @@
+import type { ProjectInfo } from '../base/types';
+import type { AppType } from '@sap-ux/project-access/dist/types';
+export type TelemetryHelperProperties = {
+    appPath: string;
+};
+/**
+ * Type exposed via telemetry API. The following paramters can be provided by developer who
+ * calls telemetry API.
+ *
+ * - resourceId: Id of cloud telemetry resource (e.g. Azure application insights resource is supported)
+ * - consumerModule: name and version of module that uses telemetry library
+ * - internalFeature: if UX tooling InternalFeature is enabled
+ *
+ */
+export type ToolsSuiteTelemetryInitSettings = {
+    resourceId: string;
+    consumerModule: ProjectInfo;
+    internalFeature: boolean;
+};
+export declare enum ToolsId {
+    UNKNOWN = "UNKNOWN",
+    NO_TOOLS_ID = "NO_TOOLS_ID"
+}
+export declare enum ODataSource {
+    CAPJava = "CAPJava",
+    CAPNode = "CAPNode",
+    ABAP = "ABAP",
+    UNKNOWN = "UNKNOWN"
+}
+export declare enum DeployTarget {
+    CF = "CF",
+    ABAP = "ABAP",
+    UNKNOWN_DEPLOY_CONFIG = "UNKNOWN_DEPLOY_CONFIG",
+    NO_DEPLOY_CONFIG = "NO_DEPLOY_CONFIG"
+}
+export declare enum CommonProperties {
+    DevSpace = "cmn.devspace",
+    AppStudio = "cmn.appstudio",
+    AppStudioBackwardCompatible = "appstudio",
+    InternlVsExternal = "cmn.internalFeatures",
+    InternlVsExternalBackwardCompatible = "internalVsExternal",
+    TemplateType = "cmn.template",
+    DeployTargetType = "cmn.deployTarget",
+    ODataSourceType = "cmn.odataSource",
+    AppToolsId = "cmn.toolsId",
+    NodeVersion = "cmn.nodeVersion",
+    AppProgrammingLanguage = "cmn.appLanguage",
+    TemplateId = "cmn.templateId",
+    TemplateVersion = "cmn.templateVersion",
+    ApplicationType = "cmn.applicationType"
+}
+export type InternalFeature = 'internal' | 'external';
+export interface CommonTelemetryProperties extends TelemetryProperties {
+    v: string;
+    datetime: string;
+}
+export interface CommonFioriProjectProperties extends TelemetryProperties {
+    [CommonProperties.DevSpace]: string;
+    [CommonProperties.AppStudio]: boolean;
+    [CommonProperties.AppStudioBackwardCompatible]: boolean;
+    [CommonProperties.InternlVsExternal]: InternalFeature;
+    [CommonProperties.InternlVsExternalBackwardCompatible]: InternalFeature;
+    [CommonProperties.TemplateType]: string;
+    [CommonProperties.DeployTargetType]: DeployTarget;
+    [CommonProperties.ODataSourceType]: ODataSource;
+    [CommonProperties.AppToolsId]: string;
+    [CommonProperties.NodeVersion]: string;
+    [CommonProperties.AppProgrammingLanguage]: string;
+    [CommonProperties.TemplateId]: string;
+    [CommonProperties.TemplateVersion]: string;
+    [CommonProperties.ApplicationType]: AppType;
+}
+export interface TelemetryProperties {
+    [key: string]: string | boolean;
+}
+export interface TelemetryMeasurements {
+    [key: string]: number;
+}
+export type TelemetryEvent = {
+    eventName: string;
+    properties: TelemetryProperties;
+    measurements: TelemetryMeasurements;
+};
+/**
+ * sourceTemplate information in Fiori app manifest.json file.
+ */
+export interface SourceTemplate {
+    id?: string;
+    version?: string;
+    toolsId?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/tooling-telemetry/types.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommonProperties = exports.DeployTarget = exports.ODataSource = exports.ToolsId = void 0;
+var ToolsId;
+(function (ToolsId) {
+    ToolsId["UNKNOWN"] = "UNKNOWN";
+    ToolsId["NO_TOOLS_ID"] = "NO_TOOLS_ID";
+})(ToolsId = exports.ToolsId || (exports.ToolsId = {}));
+var ODataSource;
+(function (ODataSource) {
+    ODataSource["CAPJava"] = "CAPJava";
+    ODataSource["CAPNode"] = "CAPNode";
+    ODataSource["ABAP"] = "ABAP";
+    ODataSource["UNKNOWN"] = "UNKNOWN";
+})(ODataSource = exports.ODataSource || (exports.ODataSource = {}));
+var DeployTarget;
+(function (DeployTarget) {
+    DeployTarget["CF"] = "CF";
+    DeployTarget["ABAP"] = "ABAP";
+    DeployTarget["UNKNOWN_DEPLOY_CONFIG"] = "UNKNOWN_DEPLOY_CONFIG";
+    DeployTarget["NO_DEPLOY_CONFIG"] = "NO_DEPLOY_CONFIG";
+})(DeployTarget = exports.DeployTarget || (exports.DeployTarget = {}));
+var CommonProperties;
+(function (CommonProperties) {
+    CommonProperties["DevSpace"] = "cmn.devspace";
+    CommonProperties["AppStudio"] = "cmn.appstudio";
+    CommonProperties["AppStudioBackwardCompatible"] = "appstudio";
+    CommonProperties["InternlVsExternal"] = "cmn.internalFeatures";
+    CommonProperties["InternlVsExternalBackwardCompatible"] = "internalVsExternal";
+    CommonProperties["TemplateType"] = "cmn.template";
+    CommonProperties["DeployTargetType"] = "cmn.deployTarget";
+    CommonProperties["ODataSourceType"] = "cmn.odataSource";
+    CommonProperties["AppToolsId"] = "cmn.toolsId";
+    CommonProperties["NodeVersion"] = "cmn.nodeVersion";
+    CommonProperties["AppProgrammingLanguage"] = "cmn.appLanguage";
+    CommonProperties["TemplateId"] = "cmn.templateId";
+    CommonProperties["TemplateVersion"] = "cmn.templateVersion";
+    CommonProperties["ApplicationType"] = "cmn.applicationType";
+})(CommonProperties = exports.CommonProperties || (exports.CommonProperties = {}));
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@sap-ux/telemetry",
+  "version": "0.2.0",
+  "description": "Library for sending usage telemetry data",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/telemetry"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Atelemetry"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "dist/index.js",
+  "dependencies": {
+    "@sap/ux-specification": "1.108.18",
+    "applicationinsights": "2.9.0",
+    "axios": "1.6.0",
+    "performance-now": "2.1.0",
+    "yaml": "2.3.3",
+    "@sap-ux/store": "0.4.0",
+    "@sap-ux/project-access": "1.16.2",
+    "@sap-ux/btp-utils": "0.12.1",
+    "@sap-ux/ui5-config": "0.21.0",
+    "@sap-ux/logger": "0.4.0"
+  },
+  "devDependencies": {
+    "jest-extended": "3.2.4",
+    "memfs": "3.4.13",
+    "ts-jest": "29.1.1",
+    "ts-node": "8.5.2",
+    "typescript": "4.9.5",
+    "unionfs": "4.4.0",
+    "dotenv": "16.3.1"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "engines": {
+    "pnpm": ">=6.26.1 < 7.0.0 || >=7.1.0",
+    "node": ">=18.x"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "watch": "tsc --watch",
+    "clean": "rimraf --glob dist coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "test-u": "jest --ci --forceExit --detectOpenHandles --colors -u",
+    "link": "pnpm link --global",
+    "unlink": "pnpm unlink --global",
+    "example": "ts-node example/index.ts"
+  }
+}