#RI-4384, #RI-4385 add backward compatibility so new helper will work for "main" commands only

Author: Artem

redisinsight/api/src/modules/commands/commands.service.ts

@@ -1,4 +1,4 @@
-import { assign } from 'lodash';
+import { assign, forEach } from 'lodash';
 import { Injectable, OnModuleInit } from '@nestjs/common';
 import { CommandsJsonProvider } from 'src/modules/commands/commands-json.provider';
 
@@ -31,10 +31,15 @@ export class CommandsService implements OnModuleInit {
    * Get all commands merged into single object
    */
   async getAll(): Promise<any> {
-    return assign(
-      {},
-      ...Object.values(await this.getCommandsGroups()),
-    );
+    const commands = {};
+
+    Object.entries(await this.getCommandsGroups()).forEach(([provider, groupCommands]) => {
+      return forEach(groupCommands as {}, (value: {}, command) => {
+        commands[command] = { ...value, provider };
+      });
+    });
+
+    return commands;
   }
 
   async getCommandsGroups(): Promise<any> {

redisinsight/ui/src/components/cli/components/cli-input/CliAutocomplete/CliAutocomplete.spec.tsx

@@ -79,8 +79,42 @@ describe('CliAutocomplete', () => {
     expect(store.getActions().slice(-2)).toEqual(expectedActions)
   })
 
-  it('Autocomplete should be only with optional args for "scan" command with filled in required args ', () => {
+  it('Autocomplete should be only with optional args for "scan" command with filled in required args (new realization)', () => {
     const autocompleteOptionalText = '[MATCH pattern] [COUNT count] [TYPE type]'
+    const { queryByTestId } = render(
+      <CliAutocomplete
+        {...instance(mockedProps)}
+        provider="main"
+        commandName={scanCommand}
+        arguments={scanArgs}
+        wordsTyped={2}
+      />
+    )
+
+    const autocompleteComponent = queryByTestId(CliAutocompleteTestId)
+
+    expect(autocompleteOptionalText).toEqual(autocompleteComponent?.textContent)
+  })
+
+  it('Autocomplete should be only with optional args for "scan" command with filled in required args (old realization)', () => {
+    const autocompleteOptionalText = '[pattern] [count] [type]'
+    const { queryByTestId } = render(
+      <CliAutocomplete
+        {...instance(mockedProps)}
+        provider="someprovider"
+        commandName={scanCommand}
+        arguments={scanArgs}
+        wordsTyped={2}
+      />
+    )
+
+    const autocompleteComponent = queryByTestId(CliAutocompleteTestId)
+
+    expect(autocompleteOptionalText).toEqual(autocompleteComponent?.textContent)
+  })
+
+  it('Autocomplete should be only with optional args for "scan" command with filled in required args (old realization)', () => {
+    const autocompleteOptionalText = '[pattern] [count] [type]'
     const { queryByTestId } = render(
       <CliAutocomplete
         {...instance(mockedProps)}
@@ -100,6 +134,7 @@ describe('CliAutocomplete', () => {
     const { queryByTestId } = render(
       <CliAutocomplete
         {...instance(mockedProps)}
+        provider="main"
         commandName={scanCommand}
         arguments={scanArgs}
         wordsTyped={10}

redisinsight/ui/src/components/cli/components/cli-input/CliAutocomplete/CliAutocomplete.tsx

@@ -9,13 +9,14 @@ import { setMatchedCommand, clearSearchingCommand } from 'uiSrc/slices/cli/cli-s
 import styles from './styles.module.scss'
 
 export interface Props {
+  provider: string;
   commandName: string;
   wordsTyped: number;
   arguments?: ICommandArg[];
 }
 
 const CliAutocomplete = (props: Props) => {
-  const { commandName = '', arguments: args = [], wordsTyped } = props
+  const { commandName = '', provider = '', arguments: args = [], wordsTyped } = props
 
   const dispatch = useDispatch()
 
@@ -47,7 +48,7 @@ const CliAutocomplete = (props: Props) => {
   }
 
   if (args.length) {
-    argsList = generateArgsNames(args)
+    argsList = generateArgsNames(provider, args)
 
     untypedArgs = argsList.slice(getUntypedArgs()).join(' ')
     argsList = argsList.join(' ')

redisinsight/ui/src/components/cli/components/cli-input/CliInputWrapper.tsx

@@ -27,6 +27,7 @@ const CliInputWrapper = (props: Props) => {
   const secondCommandMatch = `${firstCommandMatch} ${secondCommand ? secondCommand.toUpperCase() : null}`
 
   const matchedCmd = ALL_REDIS_COMMANDS[secondCommandMatch] || ALL_REDIS_COMMANDS[firstCommandMatch]
+  const provider = matchedCmd?.provider || 'unknown'
   const commandName = !isUndefined(ALL_REDIS_COMMANDS[secondCommandMatch])
     ? `${firstCommand} ${secondCommand}`
     : firstCommand
@@ -42,6 +43,7 @@ const CliInputWrapper = (props: Props) => {
       />
       {matchedCmd && (
         <CliAutocomplete
+          provider={provider}
           commandName={commandName}
           wordsTyped={repeatCommand === 1 ? wordsTyped : wordsTyped - 1}
           {...matchedCmd}

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

@@ -49,6 +49,7 @@ const CommandHelperWrapper = () => {
     group = CommandGroup.Generic,
     complexity = '',
     since = '',
+    provider,
   }: ICommand = ALL_REDIS_COMMANDS[lastMatchedCommand.toUpperCase()] ?? {}
 
   if (isSearching) {
@@ -61,9 +62,9 @@ const CommandHelperWrapper = () => {
       })
   }
 
-  const generatedArgs = generateArgs(args)
+  const generatedArgs = generateArgs(provider, args)
   const complexityShort = getComplexityShortNotation(complexity)
-  const argString = [lastMatchedCommand.toUpperCase(), ...generateArgsNames(args)].join(' ')
+  const argString = [lastMatchedCommand.toUpperCase(), ...generateArgsNames(provider, args)].join(' ')
 
   const generateArgData = (arg: ICommandArgGenerated, i: number): ReactElement => {
     const type = arg.multiple ? 'Multiple' : arg.optional ? 'Optional' : 'Required'

redisinsight/ui/src/components/command-helper/components/command-helper-search-output/CHSearchOutput.tsx

@@ -35,7 +35,7 @@ const CHSearchOutput = ({ searchedCommands }: Props) => {
   const renderDescription = (command: string) => {
     const args = ALL_REDIS_COMMANDS[command].arguments || []
     if (args.length) {
-      const argString = generateArgsNames(args).join(' ')
+      const argString = generateArgsNames(ALL_REDIS_COMMANDS[command]?.provider, args).join(' ')
       return (
         <EuiText
           size="s"

redisinsight/ui/src/constants/commands.ts

@@ -9,6 +9,7 @@ export interface ICommand {
   arguments?: ICommandArg[];
   since: string;
   group: CommandGroup | string;
+  provider?: string;
 }
 
 export interface ICommandArg {