RI-5335 Add free DB identifier in telemetry events (#4267)

- INSIGHTS_PANEL_OPENED
- INSIGHTS_PANEL_CLOSED
- EXPLORE_PANEL_TUTORIAL_OPENED
- EXPLORE_PANEL_COMMAND_COPIED
- EXPLORE_PANEL_COMMAND_RUN_CLICKED
- EXPLORE_PANEL_LINK_CLICKED
- TelemetryPageView.BROWSER_PAGE

Author: pawelangelow

redisinsight/ui/src/pages/browser/BrowserPage.test.tsx

@@ -6,6 +6,8 @@ import { render, screen, fireEvent, mockedStore, cleanup, act, waitForEuiToolTip
 import { KeyTypes } from 'uiSrc/constants'
 import { RootState } from 'uiSrc/slices/store'
 import { setSelectedKeyRefreshDisabled, toggleBrowserFullScreen } from 'uiSrc/slices/browser/keys'
+import { sendPageViewTelemetry, TelemetryPageView } from 'uiSrc/telemetry'
+import { connectedInstanceSelector } from 'uiSrc/slices/instances/instances'
 import BrowserPage from './BrowserPage'
 import KeyList, { Props as KeyListProps } from './components/key-list/KeyList'
 
@@ -77,12 +79,55 @@ const selectKey = (state: any, selectedKey: any, data?: any = {}) => {
   }))
 }
 
+jest.mock('uiSrc/telemetry', () => ({
+  ...jest.requireActual('uiSrc/telemetry'),
+  sendPageViewTelemetry: jest.fn(),
+}))
+
+jest.mock('uiSrc/slices/instances/instances', () => ({
+  ...jest.requireActual('uiSrc/slices/instances/instances'),
+  connectedInstanceSelector: jest.fn(),
+}))
 /**
  * BrowserPage tests
  *
  * @group component
  */
 
+const originalUseSelector = jest.requireActual('react-redux').useSelector
+
+describe('BrowserPage', () => {
+  const commonOptions = {
+    id: 'instanceId',
+    name: 'test',
+    connectionType: 'CLUSTER',
+    provider: 'RE_CLOUD',
+  }
+
+  beforeAll(() => {
+    (useSelector as jest.Mock).mockImplementation(originalUseSelector)
+  })
+
+  it.each([true, false])('should call proper sendPageViewTelemetry when isFreeDb is %s', (isFreeDb) => {
+    const sendPageViewTelemetryMock = jest.fn();
+    (sendPageViewTelemetry as jest.Mock).mockImplementation(() => sendPageViewTelemetryMock);
+    (connectedInstanceSelector as jest.Mock).mockImplementation(() => ({
+      ...commonOptions,
+      isFreeDb,
+    }))
+
+    render(<BrowserPage />)
+
+    expect(sendPageViewTelemetry).toBeCalledWith({
+      name: TelemetryPageView.BROWSER_PAGE,
+      eventData: {
+        databaseId: 'instanceId',
+        isFree: isFreeDb,
+      },
+    })
+  })
+})
+
 describe('KeyDetailsHeader', () => {
   beforeAll(() => {
     KeyList.mockImplementation(mockKeyList)

redisinsight/ui/src/pages/browser/BrowserPage.tsx

@@ -61,7 +61,7 @@ const isOneSideMode = (isInsightsOpen: boolean) =>
 const BrowserPage = () => {
   const { instanceId } = useParams<{ instanceId: string }>()
 
-  const { name: connectedInstanceName, db = 0 } = useSelector(connectedInstanceSelector)
+  const { name: connectedInstanceName, db = 0, isFreeDb } = useSelector(connectedInstanceSelector)
   const {
     panelSizes,
     keyList: { selectedKey: selectedKeyContext },
@@ -154,7 +154,8 @@ const BrowserPage = () => {
     sendPageViewTelemetry({
       name: TelemetryPageView.BROWSER_PAGE,
       eventData: {
-        databaseId: instanceId
+        databaseId: instanceId,
+        isFree: isFreeDb,
       }
     })
     setIsPageViewSent(true)

redisinsight/ui/src/telemetry/telemetryUtils.ts

@@ -35,6 +35,27 @@ export const getProviderData = (dbId: string): {
   return { provider, serverName }
 }
 
+const FREE_DB_IDENTIFIER_TELEMETRY_EVENTS = [
+  TelemetryEvent.INSIGHTS_PANEL_OPENED,
+  TelemetryEvent.INSIGHTS_PANEL_CLOSED,
+  TelemetryEvent.EXPLORE_PANEL_TUTORIAL_OPENED,
+  TelemetryEvent.EXPLORE_PANEL_COMMAND_COPIED,
+  TelemetryEvent.EXPLORE_PANEL_COMMAND_RUN_CLICKED,
+  TelemetryEvent.EXPLORE_PANEL_LINK_CLICKED,
+]
+
+const getFreeDbFlag = (
+  event: TelemetryEvent,
+  freeDbEvents: TelemetryEvent[] = FREE_DB_IDENTIFIER_TELEMETRY_EVENTS
+): { isFree?: boolean } => {
+  if (freeDbEvents.includes(event)) {
+    const state = get(store.getState(), 'connections.instances.connectedInstance')
+    return state ? { isFree: state.isFreeDb } : {}
+  }
+
+  return {}
+}
+
 const TELEMETRY_EMPTY_VALUE = 'none'
 
 const sendEventTelemetry = async ({ event, eventData = {}, traits = {} }: ITelemetrySendEvent) => {
@@ -48,8 +69,11 @@ const sendEventTelemetry = async ({ event, eventData = {}, traits = {} }: ITelem
     if (eventData.databaseId) {
       providerData = getProviderData(eventData.databaseId)
     }
+
+    const freeDbIdentifier = getFreeDbFlag(event)
+
     await apiService.post(`${ApiEndpoints.ANALYTICS_SEND_EVENT}`,
-      { event, eventData: { ...providerData, ...eventData }, traits })
+      { event, eventData: { ...providerData, ...eventData, ...freeDbIdentifier }, traits })
   } catch (e) {
     // continue regardless of error
   }
@@ -224,4 +248,5 @@ export {
   getAdditionalAddedEventData,
   getMatchType,
   getRedisModulesSummary,
+  getFreeDbFlag,
 }

redisinsight/ui/src/telemetry/tests/telemetryUtils.spec.ts

@@ -1,4 +1,6 @@
-import { getRedisModulesSummary } from '../telemetryUtils'
+import { RootState, store } from 'uiSrc/slices/store'
+import { TelemetryEvent } from '../events'
+import { getRedisModulesSummary, getFreeDbFlag } from '../telemetryUtils'
 
 const DEFAULT_SUMMARY = Object.freeze(
   {
@@ -72,3 +74,57 @@ describe('getRedisModulesSummary', () => {
     expect(result).toEqual(expected)
   })
 })
+
+describe('determineFreeDbFlag', () => {
+  describe.each`
+  isFreeDb
+  ${true}
+  ${false}
+`('when isFreeDb=$isFreeDb', ({ isFreeDb }) => {
+    beforeEach(() => {
+      jest.spyOn(store, 'getState').mockImplementation(() => ({
+        connections: {
+          instances: {
+            connectedInstance: {
+              isFreeDb,
+            },
+          },
+        },
+      } as RootState))
+    })
+
+    it(`returns { isFree: ${isFreeDb} } for an event in the freeDbEvents list`, () => {
+      const freeDbEvents = [TelemetryEvent.INSIGHTS_PANEL_OPENED, TelemetryEvent.INSIGHTS_PANEL_CLOSED]
+      const event = TelemetryEvent.INSIGHTS_PANEL_OPENED
+
+      const result = getFreeDbFlag(event, freeDbEvents)
+
+      expect(result).toEqual({ isFree: isFreeDb })
+    })
+
+    it('returns {} for an event NOT in the freeDbEvents list', () => {
+      const freeDbEvents = [TelemetryEvent.INSIGHTS_PANEL_OPENED, TelemetryEvent.INSIGHTS_PANEL_CLOSED]
+      const event = TelemetryEvent.AI_CHAT_BOT_COMMAND_RUN_CLICKED
+
+      const result = getFreeDbFlag(event, freeDbEvents)
+
+      expect(result).toEqual({})
+    })
+  })
+
+  it('returns {} if there is no connected instance', () => {
+    jest.spyOn(store, 'getState').mockImplementation(() =>
+      ({
+        connections: {
+          instances: {},
+        },
+      } as RootState))
+
+    const freeDbEvents = [TelemetryEvent.INSIGHTS_PANEL_OPENED, TelemetryEvent.INSIGHTS_PANEL_CLOSED]
+    const event = TelemetryEvent.INSIGHTS_PANEL_OPENED
+
+    const result = getFreeDbFlag(event, freeDbEvents)
+
+    expect(result).toEqual({})
+  })
+})