Merge pull request #2586 from RedisInsight/be/feature/RI-4830-Optimize-the-number-of-unique-users-in-telemetry

#RI-4830 Optimize the number of unique users in telemetry

Author: mariasergeenko

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

@@ -123,11 +123,34 @@ describe('AnalyticsService', () => {
         nonTracking: true,
       });
 
+      expect(mockAnalyticsTrack).toHaveBeenCalledWith({
+        anonymousId: NON_TRACKING_ANONYMOUS_ID,
+        integrations: { Amplitude: { session_id: sessionId } },
+        event: TelemetryEvents.ApplicationStarted,
+        properties: {
+          anonymousId: mockAnonymousId,
+          buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
+        },
+      });
+    });
+    it('should send event for non tracking with regular payload', async () => {
+      settingsService.getAppSettings.mockResolvedValue(mockAppSettings);
+
+      await service.sendEvent({
+        event: TelemetryEvents.ApplicationStarted,
+        eventData: {},
+        nonTracking: true,
+      });
+
       expect(mockAnalyticsTrack).toHaveBeenCalledWith({
         anonymousId: mockAnonymousId,
         integrations: { Amplitude: { session_id: sessionId } },
         event: TelemetryEvents.ApplicationStarted,
         properties: {
+          anonymousId: undefined,
           buildType: AppType.Electron,
           controlNumber: mockControlNumber,
           controlGroup: mockControlGroup,
@@ -190,11 +213,34 @@ describe('AnalyticsService', () => {
         nonTracking: true,
       });
 
+      expect(mockAnalyticsPage).toHaveBeenCalledWith({
+        anonymousId: NON_TRACKING_ANONYMOUS_ID,
+        integrations: { Amplitude: { session_id: sessionId } },
+        name: TelemetryEvents.ApplicationStarted,
+        properties: {
+          anonymousId: mockAnonymousId,
+          buildType: AppType.Electron,
+          controlNumber: mockControlNumber,
+          controlGroup: mockControlGroup,
+          appVersion: mockAppVersion,
+        },
+      });
+    });
+    it('should send page for non tracking events with regular payload', async () => {
+      settingsService.getAppSettings.mockResolvedValue(mockAppSettings);
+
+      await service.sendPage({
+        event: TelemetryEvents.ApplicationStarted,
+        eventData: {},
+        nonTracking: true,
+      });
+
       expect(mockAnalyticsPage).toHaveBeenCalledWith({
         anonymousId: mockAnonymousId,
         integrations: { Amplitude: { session_id: sessionId } },
         name: TelemetryEvents.ApplicationStarted,
         properties: {
+          anonymousId: undefined,
           buildType: AppType.Electron,
           controlNumber: mockControlNumber,
           controlGroup: mockControlGroup,

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

@@ -6,7 +6,7 @@ import { AppAnalyticsEvents } from 'src/constants';
 import config from 'src/utils/config';
 import { SettingsService } from 'src/modules/settings/settings.service';
 
-export const NON_TRACKING_ANONYMOUS_ID = 'UNSET';
+export const NON_TRACKING_ANONYMOUS_ID = '00000000-0000-0000-0000-000000000001';
 const ANALYTICS_CONFIG = config.get('analytics');
 
 export interface ITelemetryEvent {
@@ -73,17 +73,19 @@ export class AnalyticsService {
       // The `nonTracking` argument can be set to True to mark an event that doesn't track the specific
       // user in any way. When `nonTracking` is True, the event is sent regardless of whether the user's permission
       // for analytics is granted or not.
-      // If permissions not granted anonymousId includes "UNSET" value without any user identifiers.
+      // If permissions not granted
+      // anonymousId will includes "00000000-0000-0000-0000-000000000001" value without any user identifiers.
       const { event, eventData, nonTracking } = payload;
       const isAnalyticsGranted = await this.checkIsAnalyticsGranted();
 
       if (isAnalyticsGranted || nonTracking) {
         this.analytics.track({
-          anonymousId: this.anonymousId,
+          anonymousId: !isAnalyticsGranted && nonTracking ? NON_TRACKING_ANONYMOUS_ID : this.anonymousId,
           integrations: { Amplitude: { session_id: this.sessionId } },
           event,
           properties: {
             ...eventData,
+            anonymousId: !isAnalyticsGranted && nonTracking ? this.anonymousId : undefined,
             buildType: this.appType,
             controlNumber: this.controlNumber,
             controlGroup: this.controlGroup,
@@ -112,10 +114,11 @@ export class AnalyticsService {
       if (isAnalyticsGranted || nonTracking) {
         this.analytics.page({
           name: event,
-          anonymousId: this.anonymousId,
+          anonymousId: !isAnalyticsGranted && nonTracking ? NON_TRACKING_ANONYMOUS_ID : this.anonymousId,
           integrations: { Amplitude: { session_id: this.sessionId } },
           properties: {
             ...eventData,
+            anonymousId: !isAnalyticsGranted && nonTracking ? this.anonymousId : undefined,
             buildType: this.appType,
             controlNumber: this.controlNumber,
             controlGroup: this.controlGroup,