add cloudRecommendedSettings user property

Author: Artem

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/ui/src/components/oauth/oauth-social/OAuthSocial.tsx

@@ -40,18 +40,25 @@ const OAuthSocial = ({ type = OAuthSocialType.Modal, hideTitle = false }: Props)
   const isAutodiscovery = type === OAuthSocialType.Autodiscovery
   const getAction = () => (isAutodiscovery ? 'import' : 'create')
 
-  const sendTelemetry = (accountOption: string) => sendEventTelemetry({
-    event: TelemetryEvent.CLOUD_SIGN_IN_SOCIAL_ACCOUNT_SELECTED,
-    eventData: {
-      accountOption,
-      action: getAction(),
-      recommendedSettings: isAutodiscovery
-        ? undefined
-        : (!isRecommendedFeatureEnabled?.flag
-          ? 'not displayed'
-          : (isRecommended ? 'enabled' : 'disabled'))
-    }
-  })
+  const sendTelemetry = (accountOption: string) => {
+    const cloudRecommendedSettings = isAutodiscovery
+      ? undefined
+      : (!isRecommendedFeatureEnabled?.flag
+        ? 'not displayed'
+        : (isRecommended ? 'enabled' : 'disabled'))
+
+    return sendEventTelemetry({
+      event: TelemetryEvent.CLOUD_SIGN_IN_SOCIAL_ACCOUNT_SELECTED,
+      eventData: {
+        accountOption,
+        action: getAction(),
+        cloudRecommendedSettings
+      },
+      traits: {
+        cloudRecommendedSettings
+      }
+    })
+  }
 
   const handleClickSso = () => {
     dispatch(signIn())

redisinsight/ui/src/telemetry/interfaces.ts

@@ -10,6 +10,7 @@ export interface ITelemetrySendEvent {
   event: TelemetryEvent
   eventData?: Object
   nonTracking?: boolean
+  traits?: Object
 }
 
 export interface ITelemetrySendPageView {

redisinsight/ui/src/telemetry/telemetryUtils.ts

@@ -19,13 +19,13 @@ import {
 import { TelemetryEvent } from './events'
 import { checkIsAnalyticsGranted } from './checkAnalytics'
 
-const sendEventTelemetry = async ({ event, eventData = {} }: ITelemetrySendEvent) => {
+const sendEventTelemetry = async ({ event, eventData = {}, traits = {} }: ITelemetrySendEvent) => {
   try {
     const isAnalyticsGranted = checkIsAnalyticsGranted()
     if (!isAnalyticsGranted) {
       return
     }
-    await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_EVENT}`, { event, eventData })
+    await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_EVENT}`, { event, eventData, traits })
   } catch (e) {
     // continue regardless of error
   }