feat(ga): extends startup interface

SAP · Sep 18, 2023 · 986c24f · 986c24f
1 parent e688881
commit 986c24f
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 3 deletions.
diff --git a/packages/ide-extension/src/panel/guidedAnswersPanel.ts b/packages/ide-extension/src/panel/guidedAnswersPanel.ts
@@ -94,7 +94,8 @@ export class GuidedAnswersPanel {
             name: 'STARTUP',
             properties: {
                 treeId: typeof this.startOptions?.treeId === 'number' ? this.startOptions?.treeId.toString() : '',
-                nodeIdPath: (this.startOptions?.nodeIdPath ?? []).join(':')
+                nodeIdPath: (this.startOptions?.nodeIdPath ?? []).join(':'),
+                trigger: this.startOptions?.trigger ?? ''
             }
         }).catch((error) => logger.logError(`Error tracking event 'STARTUP'`, error));
         /**

diff --git a/packages/ide-extension/src/types/index.ts b/packages/ide-extension/src/types/index.ts
@@ -18,4 +18,5 @@ export interface StartOptions {
     treeId: GuidedAnswerTreeId;
     nodeIdPath?: GuidedAnswerNodeId[];
     openToSide?: boolean;
+    trigger?: string;
 }
diff --git a/packages/ide-extension/src/types/telemetry.ts b/packages/ide-extension/src/types/telemetry.ts
@@ -35,6 +35,7 @@ export interface TelemetryStartupEvent extends TelemetryBaseEvent {
     properties: {
         treeId: string;
         nodeIdPath: string;
+        trigger: string;
     };
 }
 

diff --git a/packages/ide-extension/test/telemetry/telemetry.test.ts b/packages/ide-extension/test/telemetry/telemetry.test.ts
@@ -75,7 +75,10 @@ describe('Telemetry trackEvent() tests', () => {
     test('set common properties and track event, telemetry enabled', () => {
         // Test execution
         setCommonProperties({ ide: 'SBAS', devSpace: 'DevSpace', apiHost: 'any:host', apiVersion: 'v1' });
-        trackEvent({ name: 'STARTUP', properties: { treeId: 1, nodeIdPath: '2:3:4' } } as unknown as TelemetryEvent);
+        trackEvent({
+            name: 'STARTUP',
+            properties: { treeId: 1, nodeIdPath: '2:3:4', trigger: 'vsc-extension-mock' }
+        } as unknown as TelemetryEvent);
 
         // Result check
         expect(reporter.client.trackEvent).toBeCalledWith({
@@ -91,7 +94,8 @@ describe('Telemetry trackEvent() tests', () => {
                 'common.extname': packageJson.name,
                 'common.extversion': packageJson.version,
                 nodeIdPath: '2:3:4',
-                treeId: '1'
+                treeId: '1',
+                trigger: 'vsc-extension-mock'
             }
         });
     });