Fix provider is not added to some telemetry events

Author: kchepikava

redisinsight/ui/src/constants/telemetry.ts

@@ -1,4 +1,18 @@
+import { TelemetryEvent, TelemetryPageView } from 'uiSrc/telemetry'
+
 export enum ReleaseNotesSource {
   helpCenter = 'Help Center',
   updateNotification = 'Update notification'
 }
+
+export const eventsWithExcludedProvider: string[] = [
+  TelemetryPageView.DATABASES_LIST_PAGE,
+  TelemetryPageView.SETTINGS_PAGE,
+  TelemetryEvent.NOTIFICATIONS_HISTORY_OPENED,
+  TelemetryEvent.CONFIG_DATABASES_DATABASE_LIST_SEARCHED,
+  TelemetryEvent.INSIGHTS_PANEL_OPENED,
+  TelemetryEvent.INSIGHTS_PANEL_CLOSED,
+  TelemetryEvent.INSIGHTS_PANEL_TAB_CHANGED,
+  TelemetryEvent.CONFIG_DATABASES_REDIS_IMPORT_CLICKED,
+  TelemetryEvent.CONFIG_DATABASES_CLICKED
+]

redisinsight/ui/src/pages/browser/modules/key-details/KeyDetails.tsx

@@ -45,7 +45,7 @@ const KeyDetails = (props: Props) => {
   const { viewType } = useSelector(keysSelector)
   const { loading, error = '', data } = useSelector(selectedKeySelector)
   const isKeySelected = !isNull(useSelector(selectedKeyDataSelector))
-  const { type: keyType, name: keyName, length: keyLength } = useSelector(selectedKeyDataSelector) ?? {
+  const { type: keyType, length: keyLength } = useSelector(selectedKeyDataSelector) ?? {
     type: KeyTypes.String,
   }
 
@@ -55,14 +55,7 @@ const KeyDetails = (props: Props) => {
     if (keyProp === null) {
       return
     }
-    // Restore key details from context in future
-    // (selectedKey.data?.name !== keyProp)
-    dispatch(fetchKeyInfo(keyProp))
-    dispatch(setSelectedKeyRefreshDisabled(false))
-  }, [keyProp])
-
-  useEffect(() => {
-    if (!isUndefined(keyName)) {
+    if (keyProp?.data) {
       sendEventTelemetry({
         event: getBasedOnViewTypeEvent(
           viewType,
@@ -76,7 +69,11 @@ const KeyDetails = (props: Props) => {
         }
       })
     }
-  }, [keyName])
+    // Restore key details from context in future
+    // (selectedKey.data?.name !== keyProp)
+    dispatch(fetchKeyInfo(keyProp))
+    dispatch(setSelectedKeyRefreshDisabled(false))
+  }, [keyProp])
 
   const onCloseAddItemPanel = () => {
     sendEventTelemetry({

redisinsight/ui/src/pages/home/components/database-list-component/DatabasesListWrapper.tsx

@@ -145,14 +145,15 @@ const DatabasesListWrapper = ({ width, onEditInstance, editedInstance, onDeleteI
         ...modulesSummary,
       }
     })
-    dispatch(checkConnectToInstanceAction(id, connectToInstance))
+    dispatch(checkConnectToInstanceAction(id, connectToInstance, undefined, contextInstanceId !== id))
   }
 
-  const handleClickDeleteInstance = (id: string) => {
+  const handleClickDeleteInstance = ({ id, provider }: Instance) => {
     sendEventTelemetry({
       event: TelemetryEvent.CONFIG_DATABASES_SINGLE_DATABASE_DELETE_CLICKED,
       eventData: {
-        databaseId: id
+        databaseId: id,
+        provider
       }
     })
     showPopover(id)
@@ -162,7 +163,8 @@ const DatabasesListWrapper = ({ width, onEditInstance, editedInstance, onDeleteI
     sendEventTelemetry({
       event: TelemetryEvent.CONFIG_DATABASES_DATABASE_EDIT_CLICKED,
       eventData: {
-        databaseId: instance.id
+        databaseId: instance.id,
+        provider: instance.provider,
       }
     })
     onEditInstance(instance)
@@ -394,7 +396,7 @@ const DatabasesListWrapper = ({ width, onEditInstance, editedInstance, onDeleteI
               updateLoading={false}
               showPopover={showPopover}
               handleDeleteItem={() => handleDeleteInstance(instance)}
-              handleButtonClick={() => handleClickDeleteInstance(instance.id)}
+              handleButtonClick={() => handleClickDeleteInstance(instance)}
               testid={`delete-instance-${instance.id}`}
             />
           </>

redisinsight/ui/src/telemetry/interfaces.ts

@@ -6,16 +6,21 @@ export interface ITelemetryIdentify {
   sessionId: number
 }
 
+export type EventData = {
+  [key: string]: any
+  provider?: string
+}
+
 export interface ITelemetrySendEvent {
   event: TelemetryEvent
-  eventData?: Object
+  eventData?: EventData
   nonTracking?: boolean
   traits?: Object
 }
 
 export interface ITelemetrySendPageView {
   name: string
-  eventData?: Object
+  eventData?: EventData
   databaseId?: string
   nonTracking?: boolean
 }

redisinsight/ui/src/telemetry/telemetryUtils.ts

@@ -11,6 +11,7 @@ import { KeyViewType } from 'uiSrc/slices/interfaces/keys'
 import { IModuleSummary, ITelemetrySendEvent, ITelemetrySendPageView, RedisModulesKeyType } from 'uiSrc/telemetry/interfaces'
 import { apiService } from 'uiSrc/services'
 import { store } from 'uiSrc/slices/store'
+import { eventsWithExcludedProvider } from 'uiSrc/constants/telemetry'
 import { AdditionalRedisModule } from 'apiSrc/modules/database/models/additional.redis.module'
 import {
   IRedisModulesSummary,
@@ -30,22 +31,27 @@ const sendEventTelemetry = async ({ event, eventData = {}, traits = {} }: ITelem
     if (!isAnalyticsGranted) {
       return
     }
-    const provider = getProvider()
+
+    if (!eventData.provider && !eventsWithExcludedProvider.includes(event)) {
+      eventData.provider = getProvider()
+    }
     await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_EVENT}`,
-      { event, eventData: { ...eventData, provider }, traits })
+      { event, eventData, traits })
   } catch (e) {
     // continue regardless of error
   }
 }
 
-const sendPageViewTelemetry = async ({ name, eventData }: ITelemetrySendPageView) => {
+const sendPageViewTelemetry = async ({ name, eventData = {} }: ITelemetrySendPageView) => {
   try {
     const isAnalyticsGranted = checkIsAnalyticsGranted()
     if (!isAnalyticsGranted) {
       return
     }
-    const provider = getProvider()
-    await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_PAGE}`, { event: name, eventData: { ...eventData, provider } })
+    if (!eventData.provider && !eventsWithExcludedProvider.includes(name)) {
+      eventData.provider = getProvider()
+    }
+    await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_PAGE}`, { event: name, eventData })
   } catch (e) {
     // continue regardless of error
   }