tbi(telemetry): update init settings, bump azure applicationinsights and stablise tests

.changeset/four-kids-bathe.md

@@ -0,0 +1,5 @@
+---
+'@sap-ux/telemetry': minor
+---
+
+update init settings, bump azure applicationinsights and stablise tests

packages/telemetry/package.json

@@ -33,7 +33,7 @@
         "@sap/ux-specification": "1.108.18",
         "@sap-ux/ui5-config": "workspace:*",
         "@sap-ux/logger": "workspace:*",
-        "applicationinsights": "2.9.0",
+        "applicationinsights": "2.9.2",
         "axios": "1.6.0",
         "performance-now": "2.1.0",
         "yaml": "2.3.3"

packages/telemetry/src/tooling-telemetry/telemetry-settings.ts

@@ -120,7 +120,10 @@ export const initTelemetrySettings = async (options: ToolsSuiteTelemetryInitSett
         });
 
         await readEnableTelemetry(storeService);
-        watchTelemetrySettingStore(storeService);
+
+        if (options.watchTelemetrySettingStore) {
+            watchTelemetrySettingStore(storeService);
+        }
     } catch (err) {
         reportRuntimeError(err);
     }

packages/telemetry/src/tooling-telemetry/types.ts

@@ -11,12 +11,14 @@ export type TelemetryHelperProperties = {
  *
  * - consumerModule: name and version of module that uses telemetry library
  * - internalFeature: if UX tooling InternalFeature is enabled
+ * - watchTelemetrySettingStore: watch changes to telemetry setting in the store and update runtime settings accordingly (recommended for extensions)
  * - resourceId: Id of cloud telemetry resource (e.g. Azure application insights resource is supported).
  *
  */
 export type ToolsSuiteTelemetryInitSettings = {
     consumerModule: ProjectInfo;
     internalFeature: boolean;
+    watchTelemetrySettingStore: boolean;
     resourceId?: string;
 };
 

packages/telemetry/test/telemetrySettings/init-settings.test.ts

@@ -56,6 +56,7 @@ describe('toolsSuiteTelemetrySettings', () => {
      * Has existing central telemetry setting
      */
     it('Telemetry setting exists in store, enabled: true', async () => {
+        const getFilesystemWatcherForSpy = jest.spyOn(storeMock, 'getFilesystemWatcherFor');
         jest.spyOn(storeMock, 'getService').mockImplementation(() =>
             Promise.resolve({
                 read: () => Promise.resolve({ enableTelemetry: true })
@@ -65,10 +66,12 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: true
         });
 
         expect(readFileMock).toBeCalledTimes(0);
+        expect(getFilesystemWatcherForSpy).toBeCalledTimes(1);
         expect(TelemetrySettings.consumerModuleName).toBe('testProject');
         expect(TelemetrySettings.consumerModuleVersion).toBe('0.0.1');
         expect(TelemetrySettings.telemetryEnabled).toBe(true);
@@ -84,7 +87,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: undefined,
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
 
         expect(readFileMock).toBeCalledTimes(0);
@@ -99,6 +103,7 @@ describe('toolsSuiteTelemetrySettings', () => {
      * Set enableTelemetry to fase if any of the vscode extension setting is false.
      */
     it('Telemetry setting does not exist in store, at least one of legacy telemetry setting is disabled', async () => {
+        const getFilesystemWatcherForSpy = jest.spyOn(storeMock, 'getFilesystemWatcherFor');
         mockSettingFileContent['sap.ux.help.enableTelemetry'] = false;
         jest.spyOn(storeMock, 'getService').mockImplementation(() =>
             Promise.resolve({
@@ -111,11 +116,13 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: 'abc-123',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
 
         expect(readFileMock).toBeCalledTimes(1);
         expect(readFileMock).toBeCalledWith(expect.stringContaining('settings.json'), 'utf-8');
+        expect(getFilesystemWatcherForSpy).toBeCalledTimes(0);
         expect(TelemetrySettings.telemetryEnabled).toBe(false);
         expect(TelemetrySettings.consumerModuleName).toBe('testProject');
         expect(TelemetrySettings.consumerModuleVersion).toBe('0.0.1');
@@ -138,7 +145,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
 
         expect(readFileMock).toBeCalledTimes(1);
@@ -163,7 +171,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
         expect(readFileMock).toBeCalledTimes(1);
         expect(readFileMock).toBeCalledWith(expect.stringContaining('settings.json'), 'utf-8');
@@ -188,7 +197,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
         expect(readFileMock).toBeCalledTimes(1);
         expect(readFileMock).toBeCalledWith(expect.stringContaining('settings.json'), 'utf-8');
@@ -212,7 +222,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
         expect(readFileMock).toBeCalledTimes(1);
         expect(readFileMock).toBeCalledWith(expect.stringContaining('settings.json'), 'utf-8');
@@ -242,7 +253,8 @@ describe('toolsSuiteTelemetrySettings', () => {
         await initTelemetrySettings({
             resourceId: '',
             consumerModule: packageJson,
-            internalFeature: false
+            internalFeature: false,
+            watchTelemetrySettingStore: false
         });
         expect(readFileMock).toBeCalledTimes(0);
         expect(TelemetrySettings.telemetryEnabled).toBe(true);

packages/telemetry/test/tools-suite-telemetry/index.test.ts

@@ -3,6 +3,7 @@ import * as memfs from 'memfs';
 import { processToolsSuiteTelemetry } from '../../src/tooling-telemetry';
 import { ToolingTelemetrySettings } from '../../src/tooling-telemetry/config-state';
 import fs from 'fs';
+import { join } from 'path';
 
 jest.mock('fs', () => {
     const fs1 = jest.requireActual('fs');
@@ -30,6 +31,8 @@ jest.mock('axios', () => {
 });
 
 describe('Tools Suite Telemetry Tests', () => {
+    jest.setTimeout(10000);
+
     beforeEach(() => {
         memfs.vol.reset();
     });
@@ -136,15 +139,15 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['/project1/README.md']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/README_LROPv4.md',
+                    join(__dirname, 'fixtures/fiori_elements/README_LROPv4.md'),
                     'utf-8'
                 ),
                 ['/project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/package.json',
+                    join(__dirname, 'fixtures/fiori_elements/package.json'),
                     'utf-8'
                 ),
                 ['/project1/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/manifest.json',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -177,15 +180,15 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['/project1/README.md']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/README_Form.md',
+                    join(__dirname, '/fixtures/fiori_elements/README_Form.md'),
                     'utf-8'
                 ),
                 ['/project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/package.json',
+                    join(__dirname, 'fixtures/fiori_elements/package.json'),
                     'utf-8'
                 ),
                 ['/project1/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/manifest.json',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -218,23 +221,23 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['/project1/ui5-deploy.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/ui5-deploy.cf.yaml',
+                    join(__dirname, 'fixtures/fiori_elements/ui5-deploy.cf.yaml'),
                     'utf-8'
                 ),
                 ['/project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/package.json',
+                    join(__dirname, 'fixtures/fiori_elements/package.json'),
                     'utf-8'
                 ),
                 ['/project1/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/manifest.json',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/manifest.json'),
                     'utf-8'
                 ),
                 ['/project1/webapp/Component.ts']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/Component.ts',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/Component.ts'),
                     'utf-8'
                 ),
                 ['/project1/tsconfig.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/tsconfig.json',
+                    join(__dirname, 'fixtures/fiori_elements/tsconfig.json'),
                     'utf-8'
                 )
             },
@@ -267,19 +270,19 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['./project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/package.json',
+                    join(__dirname, 'fixtures/fiori_elements/package.json'),
                     'utf-8'
                 ),
                 ['./project1/webapp/Component.js']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/Component.js',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/Component.js'),
                     'utf-8'
                 ),
                 ['./project1/ui5-deploy.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/ui5-deploy.abap.yaml',
+                    join(__dirname, 'fixtures/fiori_elements/ui5-deploy.abap.yaml'),
                     'utf-8'
                 ),
                 ['/project1/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/fiori_elements/webapp/manifest.json',
+                    join(__dirname, 'fixtures/fiori_elements/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -312,19 +315,19 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['./project1/srv/src/main/resources/application.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/srv/src/main/resources/application.yaml',
+                    join(__dirname, 'fixtures/cap-java-freestyle/srv/src/main/resources/application.yaml'),
                     'utf-8'
                 ),
                 ['./project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/package.json',
+                    join(__dirname, 'fixtures/cap-java-freestyle/package.json'),
                     'utf-8'
                 ),
                 ['./project1/app/freestyle/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/app/freestyle/package.json',
+                    join(__dirname, 'fixtures/cap-java-freestyle/app/freestyle/package.json'),
                     'utf-8'
                 ),
                 ['./project1/app/freestyle/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/app/freestyle/webapp/manifest.json',
+                    join(__dirname, 'fixtures/cap-java-freestyle/app/freestyle/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -357,15 +360,15 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['./project1/srv/src/main/resources/application.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/srv/src/main/resources/application.yaml',
+                    join(__dirname, 'fixtures/cap-java-freestyle/srv/src/main/resources/application.yaml'),
                     'utf-8'
                 ),
                 ['./project1/app/freestyle/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/app/freestyle/package.json',
+                    join(__dirname, 'fixtures/cap-java-freestyle/app/freestyle/package.json'),
                     'utf-8'
                 ),
                 ['./project1/app/freestyle/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-java-freestyle/app/freestyle/webapp/manifest.json',
+                    join(__dirname, 'fixtures/cap-java-freestyle/app/freestyle/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -398,19 +401,19 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['/project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-node-freestyle/package.json',
+                    join(__dirname, 'fixtures/cap-node-freestyle/package.json'),
                     'utf-8'
                 ),
                 ['/project1/srv/keep']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-node-freestyle/srv/keep',
+                    join(__dirname, 'fixtures/cap-node-freestyle/srv/keep'),
                     'utf-8'
                 ),
                 ['/project1/app/freestyle/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-node-freestyle/app/freestyle/package.json',
+                    join(__dirname, 'fixtures/cap-node-freestyle/app/freestyle/package.json'),
                     'utf-8'
                 ),
                 ['/project1/app/freestyle/webapp/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/cap-node-freestyle/app/freestyle/webapp/manifest.json',
+                    join(__dirname, 'fixtures/cap-node-freestyle/app/freestyle/webapp/manifest.json'),
                     'utf-8'
                 )
             },
@@ -442,20 +445,17 @@ describe('Tools Suite Telemetry Tests', () => {
     it('common telemetry property: reuse library', async () => {
         memfs.vol.fromNestedJSON(
             {
-                ['./project1/ui5.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-library/ui5.yaml',
-                    'utf-8'
-                ),
+                ['./project1/ui5.yaml']: fs.readFileSync(join(__dirname, 'fixtures/valid-library/ui5.yaml'), 'utf-8'),
                 ['./project1/src/manifest.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-library/src/manifest.json',
+                    join(__dirname, 'fixtures/valid-library/src/manifest.json'),
                     'utf-8'
                 ),
                 ['./project1/ui5-deploy.yaml']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-library/ui5-deploy.yaml',
+                    join(__dirname, 'fixtures/valid-library/ui5-deploy.yaml'),
                     'utf-8'
                 ),
                 ['./project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-library/package.json',
+                    join(__dirname, 'fixtures/valid-library/package.json'),
                     'utf-8'
                 )
             },
@@ -488,15 +488,15 @@ describe('Tools Suite Telemetry Tests', () => {
         memfs.vol.fromNestedJSON(
             {
                 ['/project1/.adp/config.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-adaptation/.adp/config.json',
+                    join(__dirname, 'fixtures/valid-adaptation/.adp/config.json'),
                     'utf-8'
                 ),
                 ['/project1/webapp/manifest.appdescr_variant']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-adaptation/webapp/manifest.appdescr_variant',
+                    join(__dirname, 'fixtures/valid-adaptation/webapp/manifest.appdescr_variant'),
                     'utf-8'
                 ),
                 ['/project1/package.json']: fs.readFileSync(
-                    './test/tools-suite-telemetry/fixtures/valid-adaptation/package.json',
+                    join(__dirname, 'fixtures/valid-adaptation/package.json'),
                     'utf-8'
                 )
             },