Merge pull request #2471 from RedisInsight/feature/RI-4842_add_appVersion_to_all_telemetry_events

#RI-4842 - Add application version to all telemetry events

Author: mariasergeenko

redisinsight/api/src/__mocks__/feature.ts

@@ -17,6 +17,7 @@ export const mockFeaturesConfigId = '1';
 export const mockFeaturesConfigVersion = defaultConfig.version + 0.111;
 export const mockControlNumber = 7.68;
 export const mockControlGroup = '7';
+export const mockAppVersion = '2.1.0';
 
 export const mockFeaturesConfigJson = {
   version: mockFeaturesConfigVersion,

redisinsight/api/src/modules/analytics/analytics.service.spec.ts

@@ -1,7 +1,7 @@
 import { Test, TestingModule } from '@nestjs/testing';
 import {
   mockAppSettings,
-  mockAppSettingsWithoutPermissions, mockControlGroup, mockControlNumber,
+  mockAppSettingsWithoutPermissions, mockAppVersion, mockControlGroup, mockControlNumber,
   mockSettingsService,
   MockType,
 } from 'src/__mocks__';
@@ -59,6 +59,7 @@ describe('AnalyticsService', () => {
         appType: AppType.Electron,
         controlNumber: mockControlNumber,
         controlGroup: mockControlGroup,
+        appVersion: mockAppVersion,
       });
 
       const anonymousId = service.getAnonymousId();
@@ -76,6 +77,7 @@ describe('AnalyticsService', () => {
         appType: AppType.Electron,
         controlNumber: mockControlNumber,
         controlGroup: mockControlGroup,
+        appVersion: mockAppVersion,
       });
     });
     it('should send event with anonymousId if permission are granted', async () => {
@@ -95,6 +97,7 @@ describe('AnalyticsService', () => {
           buildType: AppType.Electron,
           controlNumber: mockControlNumber,
           controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
         },
       });
     });
@@ -126,6 +129,7 @@ describe('AnalyticsService', () => {
           buildType: AppType.Electron,
           controlNumber: mockControlNumber,
           controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
         },
       });
     });

redisinsight/api/src/modules/analytics/analytics.service.ts

@@ -21,6 +21,7 @@ export interface ITelemetryInitEvent {
   appType: string;
   controlNumber: number;
   controlGroup: string;
+  appVersion: string;
 }
 
 @Injectable()
@@ -35,6 +36,8 @@ export class AnalyticsService {
 
   private controlGroup: string = '-1';
 
+  private appVersion: string = '2.0.0';
+
   private analytics;
 
   constructor(
@@ -48,12 +51,13 @@ export class AnalyticsService {
   @OnEvent(AppAnalyticsEvents.Initialize)
   public initialize(payload: ITelemetryInitEvent) {
     const {
-      anonymousId, sessionId, appType, controlNumber, controlGroup,
+      anonymousId, sessionId, appType, controlNumber, controlGroup, appVersion,
     } = payload;
     this.sessionId = sessionId;
     this.anonymousId = anonymousId;
     this.appType = appType;
     this.controlGroup = controlGroup;
+    this.appVersion = appVersion;
     this.controlNumber = controlNumber;
     this.analytics = new Analytics(ANALYTICS_CONFIG.writeKey, {
       flushInterval: ANALYTICS_CONFIG.flushInterval,
@@ -87,6 +91,7 @@ export class AnalyticsService {
             buildType: this.appType,
             controlNumber: this.controlNumber,
             controlGroup: this.controlGroup,
+            appVersion: this.appVersion,
           },
         });
       }

redisinsight/api/src/modules/server/server.service.spec.ts

@@ -90,6 +90,7 @@ describe('ServerService', () => {
           anonymousId: mockServer.id,
           sessionId,
           appType: SERVER_CONFIG.buildType,
+          appVersion: SERVER_CONFIG.appVersion,
           controlNumber: mockControlNumber,
           controlGroup: mockControlGroup,
         },

redisinsight/api/src/modules/server/server.service.ts

@@ -52,6 +52,7 @@ export class ServerService implements OnApplicationBootstrap {
       anonymousId: server.id,
       sessionId: this.sessionId,
       appType: ServerService.getAppType(SERVER_CONFIG.buildType),
+      appVersion: SERVER_CONFIG.appVersion,
       ...(await this.featuresConfigService.getControlInfo()),
     });
 

redisinsight/ui/src/telemetry/interfaces.ts

@@ -14,6 +14,7 @@ export interface ITelemetryService {
       buildType?: string
       controlNumber?: number
       controlGroup?: string
+      appVersion?: string
       databaseId?: string
     }
   ): Promise<void>

redisinsight/ui/src/telemetry/telemetryUtils.ts

@@ -61,7 +61,7 @@ const sendEventTelemetry = (payload: ITelemetrySendEvent) => {
   const isAnalyticsGranted = checkIsAnalyticsGranted()
   setAnonymousId(isAnalyticsGranted)
 
-  const { appType: buildType, controlNumber, controlGroup } = getInfoServer() as Record<string, any>
+  const { appType: buildType, controlNumber, controlGroup, appVersion } = getInfoServer() as Record<string, any>
 
   if (isAnalyticsGranted || nonTracking) {
     return telemetryService?.event({
@@ -70,6 +70,7 @@ const sendEventTelemetry = (payload: ITelemetrySendEvent) => {
         buildType,
         controlNumber,
         controlGroup,
+        appVersion,
         ...eventData,
       },
     })
@@ -90,7 +91,7 @@ const sendPageViewTelemetry = (payload: ITelemetrySendPageView) => {
   const isAnalyticsGranted = checkIsAnalyticsGranted()
   setAnonymousId(isAnalyticsGranted)
 
-  const { appType: buildType, controlNumber, controlGroup } = getInfoServer() as Record<string, any>
+  const { appType: buildType, controlNumber, controlGroup, appVersion } = getInfoServer() as Record<string, any>
 
   if (isAnalyticsGranted || nonTracking) {
     telemetryService?.pageView(
@@ -99,7 +100,8 @@ const sendPageViewTelemetry = (payload: ITelemetrySendPageView) => {
         buildType,
         controlNumber,
         controlGroup,
-        databaseId
+        appVersion,
+        databaseId,
       }
     )
   }