Merge pull request #4409 from RedisInsight/feature/RI-6928-enhance-analytics

RI-6928 enhance analytics anonymous id generation

Author: ArtemHoruzhenko

redisinsight/api/src/__mocks__/constants.ts

@@ -2,4 +2,5 @@ import { mockSessionMetadata } from 'src/__mocks__/common';
 
 export const mockConstantsProvider = jest.fn(() => ({
   getSystemSessionMetadata: jest.fn().mockReturnValue(mockSessionMetadata),
+  getAnonymousId: jest.fn().mockReturnValue(mockSessionMetadata.userId),
 }));

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

@@ -3,7 +3,6 @@ import {
   mockAppSettings,
   mockAppSettingsWithoutPermissions,
   mockAppVersion,
-  mockConstantsProvider,
   mockControlGroup,
   mockControlNumber,
   mockSessionMetadata,
@@ -14,6 +13,7 @@ import { TelemetryEvents } from 'src/constants';
 import { AppType } from 'src/modules/server/models/server';
 import { SettingsService } from 'src/modules/settings/settings.service';
 import { ConstantsProvider } from 'src/modules/constants/providers/constants.provider';
+import { LocalConstantsProvider } from 'src/modules/constants/providers/local.constants.provider';
 import {
   AnalyticsService,
   Telemetry,
@@ -49,7 +49,7 @@ describe('AnalyticsService', () => {
         },
         {
           provide: ConstantsProvider,
-          useFactory: mockConstantsProvider,
+          useClass: LocalConstantsProvider,
         },
       ],
     }).compile();

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

@@ -70,7 +70,7 @@ export class AnalyticsService {
    * @param sessionMetadata
    */
   public getAnonymousId(sessionMetadata?: SessionMetadata): string {
-    return this.anonymousId ?? sessionMetadata?.userId ?? 'unknown';
+    return this.anonymousId ?? this.constantsProvider.getAnonymousId(sessionMetadata);
   }
 
   /**
@@ -96,7 +96,7 @@ export class AnalyticsService {
 
   public async init(initConfig: ITelemetryInitEvent) {
     const {
-      anonymousId, sessionId, appType, controlNumber, controlGroup, appVersion, firstStart, sessionMetadata
+      anonymousId, sessionId, appType, controlNumber, controlGroup, appVersion, firstStart, sessionMetadata,
     } = initConfig;
     this.sessionId = sessionId;
     this.anonymousId = anonymousId;

redisinsight/api/src/modules/constants/providers/constants.provider.ts

@@ -8,4 +8,10 @@ export abstract class ConstantsProvider {
    * For example onModuleInit step or in some automatic actions generated by system
    */
   abstract getSystemSessionMetadata(): SessionMetadata;
+
+  /**
+   * Should return generated anonymous id based on sessionMetadata or default value
+   * @param sessionMetadata
+   */
+  abstract getAnonymousId(sessionMetadata?: SessionMetadata): string;
 }

redisinsight/api/src/modules/constants/providers/local.constants.provider.ts

@@ -11,4 +11,11 @@ export class LocalConstantsProvider extends ConstantsProvider {
       sessionId: '1',
     };
   }
+
+  /**
+   * @inheritDoc
+   */
+  getAnonymousId(sessionMetadata?: SessionMetadata): string {
+    return sessionMetadata?.userId ?? 'unknown';
+  }
 }