Merge pull request #116 from RedisInsight/fix/RI-2156_cluster-redirection

Fix/ CLI Redirection message

Author: ArtyomPSofteq

redisinsight/api/src/modules/cli/dto/cli.dto.ts

@@ -27,6 +27,15 @@ export enum ClusterNodeRole {
   Slave = 'SLAVE',
 }
 
+class ClusterNode extends EndpointDto {
+  @ApiPropertyOptional({
+    description: 'Cluster node slot.',
+    type: Number,
+    example: 0,
+  })
+  slot?: number;
+}
+
 export class CreateCliClientDto {
   @ApiPropertyOptional({
     type: String,
@@ -123,10 +132,10 @@ export class SendClusterCommandResponse {
   response: any;
 
   @ApiPropertyOptional({
-    type: () => EndpointDto,
+    type: () => ClusterNode,
     description: 'Redis Cluster Node info',
   })
-  node?: EndpointDto;
+  node?: ClusterNode;
 
   @ApiProperty({
     description: 'Redis CLI command execution status',

redisinsight/api/src/modules/cli/services/cli-business/cli-business.service.spec.ts

@@ -555,7 +555,7 @@ describe('CliBusinessService', () => {
       const command = 'set foo bar';
       const mockResult: SendClusterCommandResponse = {
         response: 'OK',
-        node: { ...mockNode, port: 7002 },
+        node: { ...mockNode, port: 7002, slot: 7008 },
         status: CommandExecutionStatus.Success,
       };
       cliTool.execCommandForNode
@@ -586,7 +586,7 @@ describe('CliBusinessService', () => {
       const command = 'set foo bar';
       const mockResult: SendClusterCommandResponse = {
         response: '-> Redirected to slot [7008] located at 127.0.0.1:7002\nOK',
-        node: { ...mockNode, port: 7002 },
+        node: { ...mockNode, port: 7002, slot: 7008 },
         status: CommandExecutionStatus.Success,
       };
       cliTool.execCommandForNode

redisinsight/api/src/modules/cli/services/cli-business/cli-business.service.ts

@@ -306,6 +306,7 @@ export class CliBusinessService {
           replyEncoding,
         );
         result.response = formatter.format(result.response, { slot, address });
+        result.slot = parseInt(slot, 10);
       } else {
         result.response = formatter.format(result.response);
       }
@@ -316,9 +317,9 @@ export class CliBusinessService {
         { command, outputFormat },
       );
       const {
-        host, port, error, ...rest
+        host, port, error, slot, ...rest
       } = result;
-      return { ...rest, node: { host, port } };
+      return { ...rest, node: { host, port, slot } };
     } catch (error) {
       this.logger.error('Failed to execute redis.cluster CLI command.', error);
 

redisinsight/api/src/modules/cli/services/cli-tool/cli-tool.service.ts

@@ -25,6 +25,7 @@ export interface ICliExecResultFromNode {
   port: number;
   response: any;
   status: CommandExecutionStatus;
+  slot?: number;
   error?: any,
 }
 

redisinsight/api/test/api/cli/POST-instance-id-cli-uuid-send_cluster_command.test.ts

@@ -37,6 +37,7 @@ const responseSchema = Joi.array().items(Joi.object().keys({
   node: Joi.object().keys({
     host: Joi.string().required(),
     port: Joi.number().integer().required(),
+    slot: Joi.number().integer(),
   })
 }).required());
 
@@ -46,6 +47,7 @@ const responseRawSchema = Joi.array().items(Joi.object().keys({
   node: Joi.object().keys({
     host: Joi.string().required(),
     port: Joi.number().integer().required(),
+    slot: Joi.number().integer(),
   })
 }).required());
 

redisinsight/ui/src/slices/cli/cli-output.ts

@@ -3,13 +3,13 @@ import { createSlice } from '@reduxjs/toolkit'
 import { CliOutputFormatterType, cliTexts } from 'uiSrc/constants/cliOutput'
 import { apiService, localStorageService } from 'uiSrc/services'
 import { ApiEndpoints, BrowserStorageItem } from 'uiSrc/constants'
-import { cliCommandOutput, cliParseTextResponseWithOffset } from 'uiSrc/utils/cliHelper'
-import { getUrl, getApiErrorMessage, isStatusSuccessful } from 'uiSrc/utils'
 import {
-  SendClusterCommandDto,
-  SendClusterCommandResponse,
-  SendCommandResponse,
-} from 'apiSrc/modules/cli/dto/cli.dto'
+  cliCommandOutput,
+  cliParseTextResponseWithOffset,
+  cliParseTextResponseWithRedirect,
+} from 'uiSrc/utils/cliHelper'
+import { getApiErrorMessage, getUrl, isStatusSuccessful } from 'uiSrc/utils'
+import { SendClusterCommandDto, SendClusterCommandResponse, SendCommandResponse, } from 'apiSrc/modules/cli/dto/cli.dto'
 
 import { AppDispatch, RootState } from '../store'
 import { CommandExecutionStatus, StateCliOutput } from '../interfaces/cli'
@@ -124,6 +124,7 @@ export function sendCliClusterCommandAction(
 ) {
   return async (dispatch: AppDispatch, stateInit: () => RootState) => {
     try {
+      const outputFormat = CliOutputFormatterType.Raw
       const state = stateInit()
       const { id = '' } = state.connections.instances?.connectedInstance
 
@@ -137,7 +138,7 @@ export function sendCliClusterCommandAction(
 
       const {
         data: [
-          { response, status: dataStatus }
+          { response, status: dataStatus, node: nodeOptionsResponse }
         ] = [],
         status
       } = await apiService.post<SendClusterCommandResponse[]>(
@@ -147,15 +148,23 @@ export function sendCliClusterCommandAction(
           state.cli.settings?.cliClientUuid,
           ApiEndpoints.SEND_CLUSTER_COMMAND
         ),
-        { ...options, command, outputFormat: CliOutputFormatterType.Raw }
+        { ...options, command, outputFormat }
       )
 
       if (isStatusSuccessful(status)) {
+        let isRedirected = false
+        if (options.nodeOptions && nodeOptionsResponse) {
+          const requestNodeAddress = `${options.nodeOptions.host}:${options.nodeOptions.port}`
+          const responseNodeAddress = `${nodeOptionsResponse.host}:${nodeOptionsResponse.port}`
+          isRedirected = requestNodeAddress !== responseNodeAddress
+        }
         onSuccessAction?.()
         dispatch(sendCliCommandSuccess())
-        dispatch(
-          concatToOutput(cliParseTextResponseWithOffset(response, command, dataStatus))
-        )
+        const result = outputFormat === CliOutputFormatterType.Raw && isRedirected
+          ? cliParseTextResponseWithRedirect(response, command, dataStatus, nodeOptionsResponse)
+          : cliParseTextResponseWithOffset(response, command, dataStatus)
+
+        dispatch(concatToOutput(result))
       }
     } catch (error) {
       const errorMessage = getApiErrorMessage(error)

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

@@ -193,6 +193,7 @@ export interface ClusterNode {
   host: string;
   port: number;
   role?: 'slave' | 'master';
+  slot?: number;
 }
 
 export enum RedisCloudSubscriptionStatus {

redisinsight/ui/src/slices/tests/cli/cli-output.spec.ts

@@ -11,7 +11,11 @@ import {
 import { ClusterNodeRole, CommandExecutionStatus } from 'uiSrc/slices/interfaces/cli'
 import { apiService } from 'uiSrc/services'
 import { cliTexts } from 'uiSrc/constants/cliOutput'
-import { cliCommandOutput, cliParseTextResponseWithOffset } from 'uiSrc/utils/cliHelper'
+import {
+  cliCommandOutput,
+  cliParseTextResponseWithOffset,
+  cliParseTextResponseWithRedirect
+} from 'uiSrc/utils/cliHelper'
 import reducer, {
   initialState,
   concatToOutput,
@@ -282,9 +286,9 @@ describe('cliOutput slice', () => {
         const command = 'keys *'
         const data: SendClusterCommandResponse[] = [
           {
-            response: '-> Redirected to slot [6918] located at 127.0.0.1:7002\n(nil)',
+            response: '(nil)',
             status: 'success',
-            node: { host: '127.0.0.1', port: 7002 },
+            node: { host: '127.0.0.1', port: 7002, slot: 6918 },
           },
         ]
         const responsePayload = { data, status: 200 }
@@ -300,7 +304,9 @@ describe('cliOutput slice', () => {
           sendCliCommand(),
           sendCliCommandSuccess(),
           concatToOutput(
-            cliParseTextResponseWithOffset(first(data)?.response, command, first(data)?.status)
+            cliParseTextResponseWithRedirect(
+              first(data)?.response, command, first(data)?.status, first(data)?.node
+            )
           ),
         ]
         expect(clearStoreActions(store.getActions())).toEqual(clearStoreActions(expectedActions))
@@ -311,9 +317,9 @@ describe('cliOutput slice', () => {
         const command = 'keys *'
         const data: SendClusterCommandResponse[] = [
           {
-            response: '-> Redirected to slot [6918] located at 127.0.0.1:7002\n(nil)',
+            response: null,
             status: 'success',
-            node: { host: '127.0.0.1', port: 7002 },
+            node: { host: '127.0.0.1', port: 7002, slot: 6918 },
           },
         ]
         const responsePayload = { data, status: 200 }
@@ -329,7 +335,9 @@ describe('cliOutput slice', () => {
           sendCliCommand(),
           sendCliCommandSuccess(),
           concatToOutput(
-            cliParseTextResponseWithOffset(first(data)?.response, command, first(data)?.status)
+            cliParseTextResponseWithRedirect(
+              first(data)?.response, command, first(data)?.status, first(data)?.node
+            )
           ),
         ]
         expect(clearStoreActions(store.getActions())).toEqual(clearStoreActions(expectedActions))

redisinsight/ui/src/utils/cliHelper.tsx

@@ -6,7 +6,7 @@ import { CommandExecutionStatus } from 'uiSrc/slices/interfaces/cli'
 import { resetOutput, updateCliCommandHistory } from 'uiSrc/slices/cli/cli-output'
 import { BrowserStorageItem } from 'uiSrc/constants'
 import { ModuleCommandPrefix } from 'uiSrc/pages/workbench/constants'
-import { RedisDefaultModules } from 'uiSrc/slices/interfaces'
+import { ClusterNode, RedisDefaultModules } from 'uiSrc/slices/interfaces'
 
 import { RedisModuleDto } from 'apiSrc/modules/instances/dto/database-instance.dto'
 import { Nullable } from './types'
@@ -17,6 +17,20 @@ export enum CliPrefix {
   QueryCard = 'query-card',
 }
 
+const cliParseTextResponseWithRedirect = (
+  text: string = '',
+  command: string = '',
+  status: CommandExecutionStatus = CommandExecutionStatus.Success,
+  redirectTo: ClusterNode | undefined,
+) => {
+  let redirectMessage = ''
+  if (redirectTo) {
+    const { host, port, slot } = redirectTo
+    redirectMessage = `-> Redirected to slot [${slot}] located at ${host}:${port}`
+  }
+  return [redirectMessage, '\n', cliParseTextResponse(text, command, status), '\n\n']
+}
+
 const cliParseTextResponseWithOffset = (
   text: string = '',
   command: string = '',
@@ -110,6 +124,7 @@ const checkUnsupportedModuleCommand = (loadedModules: RedisModuleDto[], commandL
 export {
   cliParseTextResponse,
   cliParseTextResponseWithOffset,
+  cliParseTextResponseWithRedirect,
   cliCommandOutput,
   bashTextValue,
   cliCommandWrapper,

redisinsight/ui/src/utils/cliTextFormatter.ts

@@ -3,7 +3,7 @@ import {
 } from 'lodash'
 import { bulkReplyCommands } from 'uiSrc/constants'
 
-const formatToText = (reply: any, command: string = '', redirectedTo: any = false): string => {
+const formatToText = (reply: any, command: string = ''): string => {
   let result
   if (isNull(reply)) {
     result = '(nil)'
@@ -19,10 +19,6 @@ const formatToText = (reply: any, command: string = '', redirectedTo: any = fals
     result = reply
   }
 
-  if (redirectedTo) {
-    const { slot, address } = redirectedTo
-    result = `-> Redirected to slot [${slot}] located at ${address}\n${result}`
-  }
   return result
 }