Merge pull request #2885 from RedisInsight/feature/RI-5257-add-telemetry-usser-property

Feature/ri 5257 add telemetry usser property

Author: mariasergeenko

redisinsight/api/config/features-config.json

@@ -1,5 +1,5 @@
 {
-  "version": 2.3402,
+  "version": 2.3403,
   "features": {
     "insightsRecommendations": {
       "flag": true,
@@ -47,6 +47,22 @@
         }
       }
     },
+    "cloudSsoRecommendedSettings": {
+      "flag": true,
+      "perc": [[0, 50]],
+      "filters": [
+        {
+          "name": "config.server.buildType",
+          "value": "ELECTRON",
+          "cond": "eq"
+        },
+        {
+          "name": "agreements.analytics",
+          "value": true,
+          "cond": "eq"
+        }
+      ]
+    },
     "redisModuleFilter": {
       "flag": true,
       "perc": [[0, 100]],

redisinsight/api/src/__mocks__/feature.ts

@@ -182,12 +182,12 @@ export const mockFeatureSso = Object.assign(new Feature(), {
         redisStackPreview: [
           {
             provider: 'AWS',
-            regions: ['us-east-2', 'ap-southeast-1', 'sa-east-1']
+            regions: ['us-east-2', 'ap-southeast-1', 'sa-east-1'],
           },
           {
             provider: 'GCP',
-            regions: ['asia-northeast1', 'europe-west1', 'us-central1']
-          }
+            regions: ['asia-northeast1', 'europe-west1', 'us-central1'],
+          },
         ],
       },
     },

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

@@ -196,6 +196,10 @@ describe('AnalyticsService', () => {
         event: TelemetryEvents.ApplicationStarted,
         eventData: {},
         nonTracking: false,
+        traits: {
+          telemetry: 'will be overwritten',
+          custom: 'trait',
+        },
       });
 
       expect(mockAnalyticsPage).toHaveBeenCalledWith({
@@ -205,6 +209,7 @@ describe('AnalyticsService', () => {
         context: {
           traits: {
             telemetry: Telemetry.Enabled,
+            custom: 'trait',
           },
         },
         properties: {

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

@@ -13,6 +13,7 @@ export interface ITelemetryEvent {
   event: string;
   eventData: Object;
   nonTracking: boolean;
+  traits?: Object;
 }
 
 export interface ITelemetryInitEvent {
@@ -43,7 +44,7 @@ export class AnalyticsService {
 
   private appVersion: string = '2.0.0';
 
-  private analytics;
+  private analytics: Analytics;
 
   constructor(
     private settingsService: SettingsService,
@@ -80,7 +81,9 @@ export class AnalyticsService {
       // for analytics is granted or not.
       // If permissions not granted
       // anonymousId will includes "00000000-0000-0000-0000-000000000001" value without any user identifiers.
-      const { event, eventData, nonTracking } = payload;
+      const {
+        event, eventData, nonTracking, traits = {},
+      } = payload;
       const isAnalyticsGranted = await this.checkIsAnalyticsGranted();
 
       if (isAnalyticsGranted || nonTracking) {
@@ -90,8 +93,9 @@ export class AnalyticsService {
           event,
           context: {
             traits: {
+              ...traits,
               telemetry: isAnalyticsGranted ? Telemetry.Enabled : Telemetry.Disabled,
-            }
+            },
           },
           properties: {
             ...eventData,
@@ -118,7 +122,9 @@ export class AnalyticsService {
       // 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.
-      const { event, eventData, nonTracking } = payload;
+      const {
+        event, eventData, nonTracking, traits = {},
+      } = payload;
       const isAnalyticsGranted = await this.checkIsAnalyticsGranted();
 
       if (isAnalyticsGranted || nonTracking) {
@@ -128,8 +134,9 @@ export class AnalyticsService {
           integrations: { Amplitude: { session_id: this.sessionId } },
           context: {
             traits: {
+              ...traits,
               telemetry: isAnalyticsGranted ? Telemetry.Enabled : Telemetry.Disabled,
-            }
+            },
           },
           properties: {
             ...eventData,

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

@@ -36,4 +36,13 @@ export class SendEventDto {
   @IsOptional()
   @IsBoolean()
   nonTracking: boolean = false;
+
+  @ApiPropertyOptional({
+    description: 'User data.',
+    type: Object,
+    example: { telemetry: true },
+  })
+  @IsOptional()
+  @ValidateNested()
+  traits: Object = {};
 }

redisinsight/api/src/modules/cloud/job/cloud-job.factory.ts

@@ -2,7 +2,7 @@ import { Injectable } from '@nestjs/common';
 import {
   CloudJob,
   CreateFreeSubscriptionAndDatabaseCloudJob,
-  ImportFreeDatabaseCloudJob
+  ImportFreeDatabaseCloudJob,
 } from 'src/modules/cloud/job/jobs';
 import { CloudJobName } from 'src/modules/cloud/job/constants';
 import { CreateFreeDatabaseCloudJob } from 'src/modules/cloud/job/jobs/create-free-database.cloud-job';
@@ -16,6 +16,7 @@ import { DatabaseService } from 'src/modules/database/database.service';
 import { CloudDatabaseAnalytics } from 'src/modules/cloud/database/cloud-database.analytics';
 import { CloudRequestUtm } from 'src/modules/cloud/common/models';
 import { CloudCapiKeyService } from 'src/modules/cloud/capi-key/cloud-capi-key.service';
+import { CloudSubscriptionApiService } from 'src/modules/cloud/subscription/cloud-subscription.api.service';
 
 @Injectable()
 export class CloudJobFactory {
@@ -26,6 +27,7 @@ export class CloudJobFactory {
     private readonly cloudDatabaseAnalytics: CloudDatabaseAnalytics,
     private readonly databaseService: DatabaseService,
     private readonly cloudCapiKeyService: CloudCapiKeyService,
+    private readonly cloudSubscriptionApiService: CloudSubscriptionApiService,
   ) {}
 
   async create(
@@ -53,6 +55,7 @@ export class CloudJobFactory {
             cloudDatabaseAnalytics: this.cloudDatabaseAnalytics,
             databaseService: this.databaseService,
             cloudCapiKeyService: this.cloudCapiKeyService,
+            cloudSubscriptionApiService: this.cloudSubscriptionApiService,
           },
         );
       case CloudJobName.CreateFreeDatabase:

redisinsight/api/src/modules/cloud/job/dto/create-subscription-and-database.cloud-job.data.dto.ts

@@ -1,12 +1,21 @@
-import { ApiProperty } from '@nestjs/swagger';
-import { IsNotEmpty, IsNumber } from 'class-validator';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsBoolean, IsNotEmpty, IsNumber, IsOptional, ValidateIf } from 'class-validator';
 
 export class CreateSubscriptionAndDatabaseCloudJobDataDto {
   @ApiProperty({
     description: 'Plan id for create a subscription.',
     type: Number,
   })
+  @ValidateIf((object) => !object.isRecommendedSettings)
   @IsNumber()
   @IsNotEmpty()
   planId: number;
+
+  @ApiPropertyOptional({
+    description: 'Use recommended settings',
+    type: Boolean,
+  })
+  @IsBoolean()
+  @IsOptional()
+  isRecommendedSettings?: boolean;
 }

redisinsight/api/src/modules/cloud/job/jobs/create-free-subscription-and-database.cloud-job.ts

@@ -1,3 +1,4 @@
+import { sortBy } from 'lodash';
 import { CloudJob, CloudJobOptions, CreateFreeDatabaseCloudJob } from 'src/modules/cloud/job/jobs';
 import { CloudTaskCapiService } from 'src/modules/cloud/task/cloud-task.capi.service';
 import { CloudSubscriptionCapiService } from 'src/modules/cloud/subscription/cloud-subscription.capi.service';
@@ -10,15 +11,18 @@ import { Database } from 'src/modules/database/models/database';
 import { CloudDatabaseAnalytics } from 'src/modules/cloud/database/cloud-database.analytics';
 import { CloudCapiKeyService } from 'src/modules/cloud/capi-key/cloud-capi-key.service';
 import { CloudSubscription } from 'src/modules/cloud/subscription/models';
+import { CloudSubscriptionApiService } from '../../subscription/cloud-subscription.api.service';
+import { CloudSubscriptionPlanResponse } from '../../subscription/dto';
 
 export class CreateFreeSubscriptionAndDatabaseCloudJob extends CloudJob {
   protected name = CloudJobName.CreateFreeSubscriptionAndDatabase;
 
   constructor(
     readonly options: CloudJobOptions,
 
-    private readonly data: {
-      planId: number,
+    private data: {
+      planId?: number,
+      isRecommendedSettings?: boolean,
     },
 
     protected readonly dependencies: {
@@ -28,12 +32,15 @@ export class CreateFreeSubscriptionAndDatabaseCloudJob extends CloudJob {
       cloudDatabaseAnalytics: CloudDatabaseAnalytics,
       databaseService: DatabaseService,
       cloudCapiKeyService: CloudCapiKeyService,
+      cloudSubscriptionApiService: CloudSubscriptionApiService,
     },
   ) {
     super(options);
   }
 
   async iteration(): Promise<Database> {
+    let planId = this.data?.planId;
+
     this.logger.log('Create free subscription and database');
 
     this.checkSignal();
@@ -42,9 +49,15 @@ export class CreateFreeSubscriptionAndDatabaseCloudJob extends CloudJob {
 
     this.logger.debug('Get or create free subscription');
 
+    if (this.data?.isRecommendedSettings) {
+      const plans = await this.dependencies.cloudSubscriptionApiService.getSubscriptionPlans(this.options.sessionMetadata);
+
+      planId = this.getRecommendedPlanId(plans);
+    }
+
     const freeSubscription: CloudSubscription = await this.runChildJob(
       CreateFreeSubscriptionCloudJob,
-      this.data,
+      { planId },
       this.options,
     );
 
@@ -72,4 +85,9 @@ export class CreateFreeSubscriptionAndDatabaseCloudJob extends CloudJob {
 
     return database;
   }
+
+  private getRecommendedPlanId(plans: CloudSubscriptionPlanResponse[]) {
+    const defaultPlan = sortBy(plans, ['details.displayOrder']);
+    return defaultPlan[0]?.id;
+  }
 }

redisinsight/api/src/modules/cloud/subscription/cloud-subscription.module.ts

@@ -25,6 +25,7 @@ import { CloudSubscriptionCapiProvider } from './providers/cloud-subscription.ca
   ],
   exports: [
     CloudSubscriptionCapiService,
+    CloudSubscriptionApiService,
   ],
 })
 export class CloudSubscriptionModule {}

redisinsight/api/src/modules/feature/constants/index.ts

@@ -22,6 +22,7 @@ export enum FeatureConfigConfigDestination {
 export enum KnownFeatures {
   InsightsRecommendations = 'insightsRecommendations',
   CloudSso = 'cloudSso',
+  CloudSsoRecommendedSettings = 'cloudSsoRecommendedSettings',
   RedisModuleFilter = 'redisModuleFilter',
 }