Merge pull request #2294 from RedisInsight/feature/RI-4608_redisgraph_commands

#RI-4608 - remove GRAPH commands from command helper

Author: vlad-dargel

redisinsight/ui/src/components/command-helper/CommandHelperWrapper.spec.tsx

@@ -193,4 +193,21 @@ describe('CliBodyWrapper', () => {
       unmount()
     })
   })
+
+  it('should render default message when matched command is deprecated', () => {
+    const sinceId = 'cli-helper-since'
+    const cliHelperDefaultId = 'cli-helper-default'
+
+    cliSettingsSelector.mockImplementation(() => ({
+      matchedCommand: 'GRAPH.CONFIG SET',
+      isEnteringCommand: true,
+    }))
+
+    const { unmount, queryByTestId } = render(<CommandHelperWrapper />)
+
+    expect(queryByTestId(cliHelperDefaultId)).toBeInTheDocument()
+    expect(queryByTestId(sinceId)).not.toBeInTheDocument()
+
+    unmount()
+  })
 })

redisinsight/ui/src/components/command-helper/CommandHelperWrapper.tsx

@@ -1,5 +1,5 @@
 import { EuiBadge, EuiFlexGroup, EuiFlexItem, EuiText } from '@elastic/eui'
-import React, { ReactElement, useEffect } from 'react'
+import React, { ReactElement, useEffect, useMemo } from 'react'
 import { useSelector } from 'react-redux'
 import { useParams } from 'react-router-dom'
 
@@ -11,7 +11,13 @@ import {
 import { sendEventTelemetry, TelemetryEvent } from 'uiSrc/telemetry'
 import { cliSettingsSelector } from 'uiSrc/slices/cli/cli-settings'
 import { appRedisCommandsSelector } from 'uiSrc/slices/app/redis-commands'
-import { generateArgs, generateArgsNames, getComplexityShortNotation } from 'uiSrc/utils'
+import {
+  generateArgs,
+  generateArgsNames,
+  getComplexityShortNotation,
+  removeDeprecatedModuleCommands,
+  checkDeprecatedModuleCommand,
+} from 'uiSrc/utils'
 import CommandHelper from './CommandHelper'
 import CommandHelperHeader from './CommandHelperHeader'
 
@@ -26,9 +32,12 @@ const CommandHelperWrapper = () => {
     searchingCommand,
     searchingCommandFilter
   } = useSelector(cliSettingsSelector)
-  const { spec: ALL_REDIS_COMMANDS, commandsArray: KEYS_OF_COMMANDS } = useSelector(appRedisCommandsSelector)
+  const { spec: ALL_REDIS_COMMANDS, commandsArray } = useSelector(appRedisCommandsSelector)
   const { instanceId = '' } = useParams<{ instanceId: string }>()
-  const lastMatchedCommand = (isEnteringCommand && matchedCommand) ? matchedCommand : searchedCommand
+  const lastMatchedCommand = (isEnteringCommand && matchedCommand && !checkDeprecatedModuleCommand(matchedCommand))
+    ? matchedCommand
+    : searchedCommand
+  const KEYS_OF_COMMANDS = useMemo(() => removeDeprecatedModuleCommands(commandsArray), [commandsArray])
   let searchedCommands: string[] = []
 
   useEffect(() => {

redisinsight/ui/src/constants/keys.ts

@@ -27,7 +27,6 @@ export const GROUP_TYPES_DISPLAY = Object.freeze({
   [KeyTypes.ReJSON]: 'JSON',
   [KeyTypes.JSON]: 'JSON',
   [KeyTypes.Stream]: 'Stream',
-  [ModulesKeyTypes.Graph]: 'Graph',
   [ModulesKeyTypes.TimeSeries]: 'TS',
   [CommandGroup.Bitmap]: 'Bitmap',
   [CommandGroup.Cluster]: 'Cluster',

redisinsight/ui/src/constants/workbenchResults.ts

@@ -24,14 +24,6 @@ export const MODULE_NOT_LOADED_CONTENT: { [key in RedisDefaultModules]?: any } =
     additionalText: ['These features enable multi-field queries, aggregation, exact phrase matching, numeric filtering, ', 'geo filtering and vector similarity semantic search on top of text queries.'],
     link: 'https://redis.io/docs/stack/search/'
   },
-  [RedisDefaultModules.Graph]: {
-    text: ['RedisGraph adds a Property Graph data structure to Redis. ', 'With this capability you can:'],
-    improvements: [
-      'Create graphs',
-      'Query property graphs using the Cypher query language with proprietary extensions'
-    ],
-    link: 'https://redis.io/docs/stack/graph/'
-  },
   [RedisDefaultModules.ReJSON]: {
     text: ['RedisJSON adds the capability to:'],
     improvements: [
@@ -58,7 +50,6 @@ export const MODULE_NOT_LOADED_CONTENT: { [key in RedisDefaultModules]?: any } =
 
 export const MODULE_TEXT_VIEW: { [key in RedisDefaultModules]?: string } = {
   [RedisDefaultModules.Bloom]: 'RedisBloom',
-  [RedisDefaultModules.Graph]: 'RedisGraph',
   [RedisDefaultModules.ReJSON]: 'RedisJSON',
   [RedisDefaultModules.Search]: 'RediSearch',
   [RedisDefaultModules.TimeSeries]: 'RedisTimeSeries',

redisinsight/ui/src/slices/app/redis-commands.ts

@@ -2,7 +2,7 @@ import { createSlice } from '@reduxjs/toolkit'
 import { isString, uniqBy } from 'lodash'
 import { apiService } from 'uiSrc/services'
 import { ApiEndpoints, ICommand, ICommands } from 'uiSrc/constants'
-import { getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils'
+import { getApiErrorMessage, isStatusSuccessful, checkDeprecatedCommandGroup } from 'uiSrc/utils'
 import { GetServerInfoResponse } from 'apiSrc/modules/server/dto/server.dto'
 
 import { AppDispatch, RootState } from '../store'
@@ -31,6 +31,7 @@ const appRedisCommandsSlice = createSlice({
       state.commandGroups = uniqBy(Object.values(payload), 'group')
         .map((item: ICommand) => item.group)
         .filter((group: string) => isString(group))
+        .filter((group: string) => !checkDeprecatedCommandGroup(group))
     },
     getRedisCommandsFailure: (state, { payload }) => {
       state.loading = false

redisinsight/ui/src/slices/interfaces/instances.ts

@@ -183,7 +183,6 @@ export const COMMAND_MODULES = {
   [RedisDefaultModules.Search]: REDISEARCH_MODULES,
   [RedisDefaultModules.ReJSON]: [RedisDefaultModules.ReJSON],
   [RedisDefaultModules.TimeSeries]: [RedisDefaultModules.TimeSeries],
-  [RedisDefaultModules.Graph]: [RedisDefaultModules.Graph],
   [RedisDefaultModules.Bloom]: [RedisDefaultModules.Bloom],
 }
 

redisinsight/ui/src/utils/cliHelper.tsx

@@ -6,7 +6,7 @@ import { isUndefined } from 'lodash'
 import { localStorageService } from 'uiSrc/services'
 import { CommandExecutionStatus } from 'uiSrc/slices/interfaces/cli'
 import { resetOutput, updateCliCommandHistory } from 'uiSrc/slices/cli/cli-output'
-import { BrowserStorageItem, ICommands } from 'uiSrc/constants'
+import { BrowserStorageItem, ICommands, CommandGroup } from 'uiSrc/constants'
 import { ModuleCommandPrefix } from 'uiSrc/pages/workbench/constants'
 import { SelectCommand } from 'uiSrc/constants/cliOutput'
 import {
@@ -162,9 +162,6 @@ const checkCommandModule = (command: string) => {
     case command.startsWith(ModuleCommandPrefix.TimeSeries): {
       return RedisDefaultModules.TimeSeries
     }
-    case command.startsWith(ModuleCommandPrefix.Graph): {
-      return RedisDefaultModules.Graph
-    }
     case command.startsWith(ModuleCommandPrefix.BF):
     case command.startsWith(ModuleCommandPrefix.CF):
     case command.startsWith(ModuleCommandPrefix.CMS):
@@ -221,6 +218,23 @@ const getCommandNameFromQuery = (
   }
 }
 
+const DEPRECATED_MODULE_PREFIXES = [
+  ModuleCommandPrefix.Graph
+]
+
+const DEPRECATED_MODULE_GROUPS = [
+  CommandGroup.Graph
+]
+
+const checkDeprecatedModuleCommand = (command: string) =>
+  DEPRECATED_MODULE_PREFIXES.some((prefix) => command.startsWith(prefix))
+
+const checkDeprecatedCommandGroup = (item: string) =>
+  DEPRECATED_MODULE_GROUPS.some((group) => group === item)
+
+const removeDeprecatedModuleCommands = (commands: string[]) => commands
+  .filter((command) => !checkDeprecatedModuleCommand(command))
+
 export {
   cliParseTextResponse,
   cliParseTextResponseWithOffset,
@@ -239,4 +253,7 @@ export {
   getCommandNameFromQuery,
   wbSummaryCommand,
   replaceEmptyValue,
+  removeDeprecatedModuleCommands,
+  checkDeprecatedModuleCommand,
+  checkDeprecatedCommandGroup,
 }

redisinsight/ui/src/utils/tests/cliHelper.spec.ts

@@ -9,6 +9,9 @@ import {
   checkUnsupportedCommand,
   checkBlockingCommand,
   replaceEmptyValue,
+  removeDeprecatedModuleCommands,
+  checkDeprecatedModuleCommand,
+  checkDeprecatedCommandGroup,
 } from 'uiSrc/utils'
 import { MOCK_COMMANDS_SPEC } from 'uiSrc/constants'
 import { render, screen } from 'uiSrc/utils/test-utils'
@@ -89,7 +92,6 @@ const checkCommandModuleTests = [
   { input: 'FT.foo bar', expected: RedisDefaultModules.Search },
   { input: 'JSON.foo bar', expected: RedisDefaultModules.ReJSON },
   { input: 'TS.foo bar', expected: RedisDefaultModules.TimeSeries },
-  { input: 'GRAPH.foo bar', expected: RedisDefaultModules.Graph },
   { input: 'BF.foo bar', expected: RedisDefaultModules.Bloom },
   { input: 'CF.foo bar', expected: RedisDefaultModules.Bloom },
   { input: 'CMS.foo bar', expected: RedisDefaultModules.Bloom },
@@ -110,6 +112,48 @@ const checkBlockingCommandTests = [
   { input: [['foo', 'bar'], 'FT.foo bar'], expected: undefined },
 ]
 
+const checkDeprecatedModuleCommandTests = [
+  { input: 'FT.foo bar', expected: false },
+  { input: 'GRAPH foo bar', expected: false },
+  { input: 'GRAPH.foo bar', expected: true },
+  { input: 'FOO bar', expected: false },
+]
+
+const removeDeprecatedModuleCommandsTests = [
+  { input: ['FT.foo'], expected: ['FT.foo'] },
+  { input: ['GRAPH.foo', 'FT.foo'], expected: ['FT.foo'] },
+  { input: ['FOO', 'GRAPH.FOO', 'CF.FOO', 'GRAPH.BAR'], expected: ['FOO', 'CF.FOO'] },
+]
+
+const checkDeprecatedCommandGroupTests = [
+  { input: 'cluster', expected: false },
+  { input: 'connection', expected: false },
+  { input: 'geo', expected: false },
+  { input: 'bitmap', expected: false },
+  { input: 'generic', expected: false },
+  { input: 'pubsub', expected: false },
+  { input: 'scripting', expected: false },
+  { input: 'transactions', expected: false },
+  { input: 'server', expected: false },
+  { input: 'sorted-set', expected: false },
+  { input: 'hyperloglog', expected: false },
+  { input: 'hash', expected: false },
+  { input: 'set', expected: false },
+  { input: 'stream', expected: false },
+  { input: 'list', expected: false },
+  { input: 'string', expected: false },
+  { input: 'search', expected: false },
+  { input: 'json', expected: false },
+  { input: 'timeseries', expected: false },
+  { input: 'graph', expected: true },
+  { input: 'ai', expected: false },
+  { input: 'tdigest', expected: false },
+  { input: 'cms', expected: false },
+  { input: 'topk', expected: false },
+  { input: 'bf', expected: false },
+  { input: 'cf', expected: false },
+]
+
 describe('getCommandNameFromQuery', () => {
   test.each(getCommandNameFromQueryTests)('%j', ({ input, expected }) => {
     // @ts-ignore
@@ -185,3 +229,21 @@ describe('checkBlockingCommand', () => {
     expect(checkBlockingCommand(...input)).toEqual(expected)
   })
 })
+
+describe('checkDeprecatedModuleCommand', () => {
+  test.each(checkDeprecatedModuleCommandTests)('%j', ({ input, expected }) => {
+    expect(checkDeprecatedModuleCommand(input)).toEqual(expected)
+  })
+})
+
+describe('removeDeprecatedModuleCommands', () => {
+  test.each(removeDeprecatedModuleCommandsTests)('%j', ({ input, expected }) => {
+    expect(removeDeprecatedModuleCommands(input)).toEqual(expected)
+  })
+})
+
+describe('checkDeprecatedCommandGroup', () => {
+  test.each(checkDeprecatedCommandGroupTests)('%j', ({ input, expected }) => {
+    expect(checkDeprecatedCommandGroup(input)).toEqual(expected)
+  })
+})

tests/e2e/tests/critical-path/cli/cli-command-helper.e2e.ts

@@ -96,7 +96,8 @@ test
         // await browserPage.CommandHelper.checkURLCommand(timeSeriesCommands[0], `https://redis.io/commands/${timeSeriesCommands[0].toLowerCase()}/`);
         // await t.switchToParentWindow();
     });
-test
+// outdated after https://redislabs.atlassian.net/browse/RI-4608
+test.skip
     .meta({ env: env.web })('Verify that user can type GRAPH. in Command helper and see auto-suggestions from RedisGraph commands.json', async t => {
         const commandForSearch = 'GRAPH.';
         // const externalPageLink = 'https://redis.io/commands/graph.config-get/';