RI-6864: add reason to ANALYTICS_PERMISSION event. (#4403)

* add reason to `ANALYTICS_PERMISSION` event.

If the event is triggered by accepting consents, reason is `install`, if it is because of `sso\social login\oauth` reasons, appropriate strategy is sent `google | github | sso`.
One last place where analytics is being enabled is in OAuthAgreement.tsx, where reason is sent as `oauth-agreement`

* update some of the test, to ensure, that having or lacking the reason, does not change overall execution of the code

* update settings.service.spec.ts

* extract ToggleAnalyticsReason as an object

* remove references to API constants, because it breaks tests of the UI

* replace UI values

* remove unused import

Author: pd-redis

redisinsight/api/src/modules/settings/constants/settings.ts

@@ -0,0 +1,10 @@
+export type ToggleAnalyticsReasonType = 'none' | 'oauth-agreement' | 'google' | 'github' | 'sso' | 'user';
+
+export enum ToggleAnalyticsReason {
+  None = 'none',
+  OAuthAgreement = 'oauth-agreement',
+  Google = 'google',
+  Github = 'github',
+  Sso = 'sso',
+  User = 'user',
+}

redisinsight/api/src/modules/settings/dto/settings.dto.ts

@@ -1,6 +1,6 @@
 import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 import {
-  IsBoolean,
+  IsBoolean, IsEnum,
   IsInstance,
   IsInt,
   IsOptional,
@@ -14,6 +14,7 @@ import { pickDefinedAgreements } from 'src/dto/dto-transformer';
 import { Default } from 'src/common/decorators';
 import config from 'src/utils/config';
 import { IAgreementSpec } from 'src/modules/settings/models/agreements.interface';
+import { ToggleAnalyticsReason, ToggleAnalyticsReasonType } from 'src/modules/settings/constants/settings';
 
 const REDIS_SCAN_CONFIG = config.get('redis_scan');
 const WORKBENCH_CONFIG = config.get('workbench');
@@ -187,4 +188,14 @@ export class UpdateSettingsDto {
   @Transform(pickDefinedAgreements)
   @IsBoolean({ each: true })
   agreements?: Map<string, boolean>;
+
+  @ApiPropertyOptional({
+    description: 'Reason describing why analytics are enabled',
+    type: String,
+    example: 'install',
+  })
+  @IsOptional()
+  @IsString()
+  @IsEnum(ToggleAnalyticsReason)
+  analyticsReason?: ToggleAnalyticsReasonType;
 }

redisinsight/api/src/modules/settings/models/agreements.interface.ts

@@ -9,6 +9,7 @@ export interface IAgreement {
   title?: string;
   label?: string;
   description?: string;
+  requiredText?: string;
   options?: {
     [key: string]: IAgreement;
   }

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

@@ -45,6 +45,43 @@ describe('SettingsAnalytics', () => {
         },
       );
     });
+    it('should emit ANALYTICS_PERMISSION with state enabled and reason undefined', async () => {
+      service.sendAnalyticsAgreementChange(
+        mockSessionMetadata,
+        new Map([['analytics', true]]),
+        undefined,
+        undefined,
+      );
+
+      expect(eventEmitter.emit).toHaveBeenCalledWith(
+        AppAnalyticsEvents.Track,
+        mockSessionMetadata,
+        {
+          event: TelemetryEvents.AnalyticsPermission,
+          eventData: { reason: undefined, state: 'enabled' },
+          nonTracking: true,
+        },
+      );
+    });
+    it('should emit ANALYTICS_PERMISSION with state enabled and reason "test-reason"', async () => {
+      service.sendAnalyticsAgreementChange(
+        mockSessionMetadata,
+        new Map([['analytics', true]]),
+        undefined,
+        'test-reason',
+      );
+
+      expect(eventEmitter.emit).toHaveBeenCalledWith(
+        AppAnalyticsEvents.Track,
+        mockSessionMetadata,
+        {
+          event: TelemetryEvents.AnalyticsPermission,
+          eventData: { reason: 'test-reason', state: 'enabled' },
+          nonTracking: true,
+
+        },
+      );
+    });
     it('should emit ANALYTICS_PERMISSION with state disabled on first app launch', async () => {
       service.sendAnalyticsAgreementChange(
         mockSessionMetadata,
@@ -67,6 +104,7 @@ describe('SettingsAnalytics', () => {
         mockSessionMetadata,
         new Map([['analytics', false]]),
         new Map([['analytics', false]]),
+        'test-reason',
       );
 
       expect(eventEmitter.emit).not.toHaveBeenCalledWith(
@@ -83,14 +121,15 @@ describe('SettingsAnalytics', () => {
         mockSessionMetadata,
         new Map([['analytics', false]]),
         new Map([['analytics', true]]),
+        'test-reason',
       );
 
       expect(eventEmitter.emit).toHaveBeenCalledWith(
         AppAnalyticsEvents.Track,
         mockSessionMetadata,
         {
           event: TelemetryEvents.AnalyticsPermission,
-          eventData: { state: 'disabled' },
+          eventData: { state: 'disabled', reason: 'test-reason' },
           nonTracking: true,
         },
       );

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

@@ -1,12 +1,8 @@
 import { Injectable } from '@nestjs/common';
 import { EventEmitter2 } from '@nestjs/event-emitter';
-import {
-  differenceWith,
-  isEqual,
-  has,
-} from 'lodash';
-import { AppAnalyticsEvents, TelemetryEvents } from 'src/constants';
-import { getRangeForNumber, getIsPipelineEnable, SCAN_THRESHOLD_BREAKPOINTS } from 'src/utils';
+import { differenceWith, has, isEqual } from 'lodash';
+import { AppAnalyticsEvents, TelemetryEvents, ToggleAnalyticsReasonType } from 'src/constants';
+import { getIsPipelineEnable, getRangeForNumber, SCAN_THRESHOLD_BREAKPOINTS } from 'src/utils';
 import { TelemetryBaseService } from 'src/modules/analytics/telemetry.base.service';
 import { GetAppSettingsResponse } from 'src/modules/settings/dto/settings.dto';
 import { SessionMetadata } from 'src/common/models';
@@ -42,6 +38,7 @@ export class SettingsAnalytics extends TelemetryBaseService {
     sessionMetadata: SessionMetadata,
     newAgreements: Map<string, boolean>,
     oldAgreements: Map<string, boolean> = new Map(),
+    reason?: ToggleAnalyticsReasonType,
   ) {
     try {
       const newPermission = newAgreements.get('analytics');
@@ -54,6 +51,7 @@ export class SettingsAnalytics extends TelemetryBaseService {
             event: TelemetryEvents.AnalyticsPermission,
             eventData: {
               state: newPermission ? 'enabled' : 'disabled',
+              reason,
             },
             nonTracking: true,
           },

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

@@ -10,7 +10,7 @@ import {
 } from 'src/__mocks__';
 import { UpdateSettingsDto } from 'src/modules/settings/dto/settings.dto';
 import * as AGREEMENTS_SPEC from 'src/constants/agreements-spec.json';
-import { AgreementIsNotDefinedException } from 'src/constants';
+import { AgreementIsNotDefinedException, ToggleAnalyticsReason } from 'src/constants';
 import config from 'src/utils/config';
 import { KeytarEncryptionStrategy } from 'src/modules/encryption/strategies/keytar-encryption.strategy';
 import { SettingsAnalytics } from 'src/modules/settings/settings.analytics';
@@ -199,6 +199,7 @@ describe('SettingsService', () => {
         agreements: new Map(Object.entries({
           analytics: false,
         })),
+        analyticsReason: ToggleAnalyticsReason.GitHub,
       };
 
       const response = await service.updateAppSettings(mockSessionMetadata, dto);
@@ -220,6 +221,7 @@ describe('SettingsService', () => {
         new Map(Object.entries({
           ...mockAgreements.data,
         })),
+        'some reason',
       );
     });
     it('should update agreements and settings', async () => {

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

@@ -16,7 +16,7 @@ import { readFile } from 'fs-extra';
 import { join } from 'path';
 import * as AGREEMENTS_SPEC from 'src/constants/agreements-spec.json';
 import config, { Config } from 'src/utils/config';
-import { AgreementIsNotDefinedException } from 'src/constants';
+import { AgreementIsNotDefinedException, ToggleAnalyticsReasonType } from 'src/constants';
 import { KeytarEncryptionStrategy } from 'src/modules/encryption/strategies/keytar-encryption.strategy';
 import { KeyEncryptionStrategy } from 'src/modules/encryption/strategies/key-encryption.strategy';
 import { SettingsAnalytics } from 'src/modules/settings/settings.analytics';
@@ -80,7 +80,7 @@ export class SettingsService {
     dto: UpdateSettingsDto,
   ): Promise<GetAppSettingsResponse> {
     this.logger.debug('Updating application settings.', sessionMetadata);
-    const { agreements, ...settings } = dto;
+    const { agreements, analyticsReason, ...settings } = dto;
     try {
       const oldAppSettings = await this.getAppSettings(sessionMetadata);
       if (!isEmpty(settings)) {
@@ -96,7 +96,7 @@ export class SettingsService {
         await this.settingsRepository.update(sessionMetadata, toUpdate);
       }
       if (agreements) {
-        await this.updateAgreements(sessionMetadata, agreements);
+        await this.updateAgreements(sessionMetadata, agreements, analyticsReason);
       }
       this.logger.debug('Succeed to update application settings.', sessionMetadata);
       const results = await this.getAppSettings(sessionMetadata);
@@ -193,6 +193,7 @@ export class SettingsService {
   private async updateAgreements(
     sessionMetadata: SessionMetadata,
     dtoAgreements: Map<string, boolean> = new Map(),
+    analyticsReason?: ToggleAnalyticsReasonType,
   ): Promise<void> {
     this.logger.debug('Updating application agreements.', sessionMetadata);
     const oldAgreements = await this.agreementRepository.getOrCreate(sessionMetadata);
@@ -206,7 +207,6 @@ export class SettingsService {
         ...Object.fromEntries(dtoAgreements),
       },
     };
-
     // Detect which agreements should be defined according to the settings specification
     const diff = difference(
       Object.keys(agreementsSpec.agreements),
@@ -226,6 +226,7 @@ export class SettingsService {
         sessionMetadata,
         dtoAgreements,
         new Map(Object.entries(oldAgreements.data || {})),
+        analyticsReason,
       );
     }
   }

redisinsight/ui/src/components/consents-settings/ConsentsSettings.tsx

@@ -157,13 +157,15 @@ const ConsentsSettings = ({ onSubmitted }: Props) => {
         recommended = false
         return false
       }
+      return true
     })
 
     forEach(notificationConsents, (consent) => {
       if (!formik.values[consent?.agreementName] && !consent.disabled) {
         recommended = false
         return false
       }
+      return true
     })
 
     return recommended
@@ -185,7 +187,11 @@ const ConsentsSettings = ({ onSubmitted }: Props) => {
           : TelemetryEvent.SETTINGS_NOTIFICATION_MESSAGES_DISABLED,
       })
     }
-    dispatch(updateUserConfigSettingsAction({ agreements: values }, onSubmitted))
+    const settings: Record<string, any> = { agreements: values }
+    if (values.analytics) {
+      settings.analyticsReason = 'user'
+    }
+    dispatch(updateUserConfigSettingsAction(settings, onSubmitted))
   }
 
   return (

redisinsight/ui/src/components/oauth/shared/oauth-agreement/OAuthAgreement.tsx

@@ -22,7 +22,7 @@ const OAuthAgreement = (props: Props) => {
 
   const handleCheck = (e: ChangeEvent<HTMLInputElement>) => {
     if (e.target.checked) {
-      dispatch(enableUserAnalyticsAction())
+      dispatch(enableUserAnalyticsAction('oauth-agreement'))
     }
     dispatch(setAgreement(e.target.checked))
     localStorageService.set(BrowserStorageItem.OAuthAgreement, e.target.checked)

redisinsight/ui/src/components/oauth/shared/oauth-form/OAuthForm.tsx

@@ -35,7 +35,7 @@ const OAuthForm = ({
   const onSocialButtonClick = (authStrategy: OAuthStrategy) => {
     setDisabled(true)
     setTimeout(() => { setDisabled(false) }, 1000)
-    dispatch(enableUserAnalyticsAction())
+    dispatch(enableUserAnalyticsAction(authStrategy))
     setAuthStrategy(authStrategy)
     onClick?.(authStrategy)