Merge pull request #4411 from RedisInsight/ric/1.0.x

Ric/1.0.x

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,8 @@ 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 { convertAnyStringToPositiveInteger } from 'src/utils';
 import {
   AnalyticsService,
   Telemetry,
@@ -49,7 +50,7 @@ describe('AnalyticsService', () => {
         },
         {
           provide: ConstantsProvider,
-          useFactory: mockConstantsProvider,
+          useClass: LocalConstantsProvider,
         },
       ],
     }).compile();
@@ -178,7 +179,7 @@ describe('AnalyticsService', () => {
 
       expect(service.getSessionId()).toEqual(-1);
       expect(service.getSessionId(mockSessionMetadata))
-        .toEqual(Number(BigInt(`0x${Buffer.from(mockSessionMetadata.sessionId).toString('hex')}`)));
+        .toEqual(convertAnyStringToPositiveInteger(mockSessionMetadata.sessionId));
     });
   });
 

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

@@ -9,6 +9,7 @@ import { SettingsService } from 'src/modules/settings/settings.service';
 import { ConstantsProvider } from 'src/modules/constants/providers/constants.provider';
 import { ServerService } from 'src/modules/server/server.service';
 import { SessionMetadata } from 'src/common/models';
+import { convertAnyStringToPositiveInteger } from 'src/utils';
 
 export const NON_TRACKING_ANONYMOUS_ID = '00000000-0000-0000-0000-000000000001';
 
@@ -70,7 +71,7 @@ export class AnalyticsService {
    * @param sessionMetadata
    */
   public getAnonymousId(sessionMetadata?: SessionMetadata): string {
-    return this.anonymousId ?? sessionMetadata?.userId ?? 'unknown';
+    return this.anonymousId ?? this.constantsProvider.getAnonymousId(sessionMetadata);
   }
 
   /**
@@ -87,16 +88,15 @@ export class AnalyticsService {
     }
 
     if (sessionMetadata?.sessionId) {
-      // convert string to number
-      return Number(BigInt(`0x${Buffer.from(sessionMetadata?.sessionId).toString('hex')}`));
+      return convertAnyStringToPositiveInteger(sessionMetadata?.sessionId);
     }
 
     return -1;
   }
 
   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';
+  }
 }

redisinsight/api/src/utils/converter.spec.ts

@@ -1,6 +1,7 @@
 import {
   convertIntToSemanticVersion,
   convertStringToNumber,
+  convertAnyStringToPositiveInteger,
 } from './converter';
 
 const convertIntToSemanticVersionTests: Record<string, any>[] = [
@@ -49,3 +50,24 @@ describe('convertStringToNumber', () => {
     });
   });
 });
+
+const convertAnyStringToPositiveIntegerTests = [
+  [undefined, -1],
+  [null, -1],
+  [123123, -1],
+  [[], -1],
+  [{}, -1],
+  [{ length: 12 }, -1],
+  ['', -1],
+  ['1', 49],
+  ['4f5daa5e-6139-4e95-8e7c-3283287f4218', 1347108680],
+  [
+    (new Array(1000).fill('4f5daa5e-6139-4e95-8e7c-3283287f4218')).join(),
+    229890988,
+  ],
+] as [string, number][];
+describe('convertAnyStringToPositiveInteger', () => {
+  it.each(convertAnyStringToPositiveIntegerTests)('for input: %s, should return: %s', (input, result) => {
+    expect(convertAnyStringToPositiveInteger(input)).toEqual(result);
+  });
+});

redisinsight/api/src/utils/converter.ts

@@ -36,3 +36,19 @@ export const convertStringToNumber = (value: any, defaultValue?: number): number
 
   return num;
 };
+
+export const convertAnyStringToPositiveInteger = (str: string) => {
+  if (!isString(str) || !str.length) {
+    return -1;
+  }
+
+  let hash = 0;
+  for (let i = 0; i < str.length; i += 1) {
+    const char = str.charCodeAt(i);
+    // eslint-disable-next-line no-bitwise
+    hash = (hash << 5) - hash + char;
+    // eslint-disable-next-line no-bitwise
+    hash |= 0;
+  }
+  return Math.abs(hash);
+};