RI-2722-fix filtered events (#539)

* RI-2722-fix filtered events

Author: AmirAllayarovSofteq

package.json

@@ -142,6 +142,7 @@
     "@types/express": "^4.17.3",
     "@types/html-entities": "^1.3.4",
     "@types/ioredis": "^4.26.0",
+    "@types/is-glob": "^4.0.2",
     "@types/jest": "^26.0.15",
     "@types/lodash": "^4.14.171",
     "@types/node": "14.14.10",

redisinsight/ui/src/slices/hash.ts

@@ -3,7 +3,7 @@ import { cloneDeep, remove, isNull } from 'lodash'
 import { apiService } from 'uiSrc/services'
 import { ApiEndpoints, KeyTypes } from 'uiSrc/constants'
 import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils'
-import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
+import { getBasedOnViewTypeEvent, getMatchType, sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
 import { SCAN_COUNT_DEFAULT } from 'uiSrc/constants/api'
 import successMessages from 'uiSrc/components/notifications/success-messages'
 import {
@@ -209,6 +209,7 @@ export function fetchHashFields(
       )
 
       if (isStatusSuccessful(status)) {
+        const matchValue = getMatchType(match)
         sendEventTelemetry({
           event: getBasedOnViewTypeEvent(
             state.browser.keys?.viewType,
@@ -218,10 +219,11 @@ export function fetchHashFields(
           eventData: {
             databaseId: state.connections.instances?.connectedInstance?.id,
             keyType: KeyTypes.Hash,
-            match: 'EXACT_VALUE_NAME',
+            match: matchValue,
             length: data.total,
           }
         })
+
         dispatch(loadHashFieldsSuccess(data))
         dispatch(updateSelectedKeyRefreshTime(Date.now()))
       }

redisinsight/ui/src/slices/keys.ts

@@ -12,7 +12,7 @@ import {
   isStatusSuccessful,
 } from 'uiSrc/utils'
 import { DEFAULT_SEARCH_MATCH, SCAN_COUNT_DEFAULT } from 'uiSrc/constants/api'
-import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent, getAdditionalAddedEventData } from 'uiSrc/telemetry'
+import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent, getAdditionalAddedEventData, getMatchType } from 'uiSrc/telemetry'
 import successMessages from 'uiSrc/components/notifications/success-messages'
 import {
   CreateListWithExpireDto,
@@ -390,6 +390,10 @@ export function fetchKeys(cursor: string, count: number, onSuccess?: () => void,
           })
         )
         if (!!type || !!match) {
+          let matchValue = '*'
+          if (match !== '*' && !!match) {
+            matchValue = getMatchType(match)
+          }
           sendEventTelemetry({
             event: getBasedOnViewTypeEvent(
               state.browser.keys?.viewType,
@@ -399,7 +403,7 @@ export function fetchKeys(cursor: string, count: number, onSuccess?: () => void,
             eventData: {
               databaseId: state.connections.instances?.connectedInstance?.id,
               keyType: type,
-              match: 'EXACT KEY NAME',
+              match: matchValue,
               databaseSize: data[0].total,
               numberOfKeysScanned: data[0].scanned,
               scanCount: count,

redisinsight/ui/src/slices/set.ts

@@ -4,7 +4,7 @@ import { remove } from 'lodash'
 import { apiService } from 'uiSrc/services'
 import { ApiEndpoints, KeyTypes } from 'uiSrc/constants'
 import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils'
-import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
+import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent, getMatchType } from 'uiSrc/telemetry'
 import {
   AddMembersToSetDto,
   GetSetMembersResponse,
@@ -170,6 +170,7 @@ export function fetchSetMembers(
       )
 
       if (isStatusSuccessful(status)) {
+        const matchValue = getMatchType(match)
         sendEventTelemetry({
           event: getBasedOnViewTypeEvent(
             state.browser.keys?.viewType,
@@ -179,7 +180,7 @@ export function fetchSetMembers(
           eventData: {
             databaseId: state.connections.instances?.connectedInstance?.id,
             keyType: KeyTypes.Set,
-            match: 'EXACT_VALUE_NAME',
+            match: matchValue,
             length: data.total,
           }
         })

redisinsight/ui/src/slices/zset.ts

@@ -4,7 +4,7 @@ import { createSlice } from '@reduxjs/toolkit'
 import { apiService } from 'uiSrc/services'
 import { ApiEndpoints, SortOrder, KeyTypes } from 'uiSrc/constants'
 import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils'
-import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
+import { getBasedOnViewTypeEvent, sendEventTelemetry, TelemetryEvent, getMatchType } from 'uiSrc/telemetry'
 import { StateZset } from 'uiSrc/slices/interfaces/zset'
 import successMessages from 'uiSrc/components/notifications/success-messages'
 import {
@@ -447,6 +447,7 @@ export function fetchSearchZSetMembers(
       )
 
       if (isStatusSuccessful(status)) {
+        const matchValue = getMatchType(match)
         sendEventTelemetry({
           event: getBasedOnViewTypeEvent(
             state.browser.keys?.viewType,
@@ -456,7 +457,7 @@ export function fetchSearchZSetMembers(
           eventData: {
             databaseId: state.connections.instances?.connectedInstance?.id,
             keyType: KeyTypes.ZSet,
-            match: 'EXACT_VALUE_NAME',
+            match: matchValue,
             length: data.total,
           }
         })

redisinsight/ui/src/telemetry/interfaces.ts

@@ -29,3 +29,8 @@ export interface ITelemetryEvent {
   event: TelemetryEvent;
   properties?: object;
 }
+
+export enum MatchType {
+  EXACT_VALUE_NAME = 'EXACT_VALUE_NAME',
+  PATTERN = 'PATTERN'
+}

redisinsight/ui/src/telemetry/telemetryUtils.ts

@@ -3,13 +3,14 @@
  * This module abstracts the exact service/framework used for tracking usage.
  */
 import { get } from 'lodash'
+import isGlob from 'is-glob'
 import * as jsonpath from 'jsonpath'
 import { Nullable } from 'uiSrc/utils'
 import store from 'uiSrc/slices/store'
 import { localStorageService } from 'uiSrc/services'
 import { ApiEndpoints, BrowserStorageItem, KeyTypes } from 'uiSrc/constants'
 import { KeyViewType } from 'uiSrc/slices/interfaces/keys'
-import { ITelemetrySendEvent, ITelemetrySendPageView, ITelemetryService } from './interfaces'
+import { ITelemetrySendEvent, ITelemetrySendPageView, ITelemetryService, MatchType } from './interfaces'
 import { TelemetryEvent } from './events'
 import { NON_TRACKING_ANONYMOUS_ID, SegmentTelemetryService } from './segment'
 
@@ -156,12 +157,19 @@ const getAdditionalAddedEventData = (endpoint: ApiEndpoints, data: any) => {
   }
 }
 
+const getMatchType = (match: string): MatchType => (
+  !isGlob(match, { strict: false })
+    ? MatchType.EXACT_VALUE_NAME
+    : MatchType.PATTERN
+)
+
 export {
   getTelemetryService,
   sendEventTelemetry,
   sendPageViewTelemetry,
   checkIsAnalyticsGranted,
   getBasedOnViewTypeEvent,
   getJsonPathLevel,
-  getAdditionalAddedEventData
+  getAdditionalAddedEventData,
+  getMatchType
 }

yarn.lock

@@ -2161,6 +2161,11 @@
   dependencies:
     "@types/node" "*"
 
+"@types/is-glob@^4.0.2":
+  version "4.0.2"
+  resolved "https://registry.yarnpkg.com/@types/is-glob/-/is-glob-4.0.2.tgz#c243dd0d09eac2992130142419ff2308ffd988bf"
+  integrity sha512-4j5G9Y5jljDSICQ1R2f/Rcyoj6DZmYGneny+p/cDkjep0rkqNg0W73Ty0bVjMUTZgLXHf8oiMjg1XC3CDwCz+g==
+
 "@types/istanbul-lib-coverage@*", "@types/istanbul-lib-coverage@^2.0.0", "@types/istanbul-lib-coverage@^2.0.1":
   version "2.0.3"
   resolved "https://registry.yarnpkg.com/@types/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.3.tgz#4ba8ddb720221f432e443bd5f9117fd22cfd4762"