Merge pull request #4197 from RedisInsight/feature/RI-6323-wb-big-responses

mariasergeenko · web-flow · commit 0015ce45e3e7 · 2024-12-30T15:08:17.000+01:00
show original placeholder without applying visualization for big resp…
diff --git a/redisinsight/api/src/__mocks__/workbench.ts b/redisinsight/api/src/__mocks__/workbench.ts
@@ -28,6 +28,7 @@ export const mockCommandExecutionSuccessResult = Object.assign(new CommandExecut
 export const mockCommendExecutionHugeResultPlaceholder = Object.assign(new CommandExecutionResult(), {
   status: CommandExecutionStatus.Success,
   response: 'Results have been deleted since they exceed 1 MB. Re-run the command to see new results.',
+  sizeLimitExceeded: true,
 });
 
 export const mockCommendExecutionHugeResultPlaceholderEncrypted = 'huge_result_placeholder_encrypted';
diff --git a/redisinsight/api/src/modules/workbench/models/command-execution-result.ts b/redisinsight/api/src/modules/workbench/models/command-execution-result.ts
@@ -17,4 +17,11 @@ export class CommandExecutionResult {
   })
   @Expose()
   response: any;
+
+  @ApiProperty({
+    type: Boolean,
+    description: 'Flag showing if response was replaced with message notification about response size limit threshold',
+  })
+  @Expose()
+  sizeLimitExceeded?: boolean;
 }
diff --git a/redisinsight/api/src/modules/workbench/repositories/local-command-execution.repository.ts b/redisinsight/api/src/modules/workbench/repositories/local-command-execution.repository.ts
@@ -51,6 +51,7 @@ export class LocalCommandExecutionRepository extends CommandExecutionRepository
           {
             status: CommandExecutionStatus.Success,
             response: ERROR_MESSAGES.WORKBENCH_RESPONSE_TOO_BIG(),
+            sizeLimitExceeded: true,
           },
         ]);
         // Hack, do not store isNotStored. Send once to show warning
@@ -61,7 +62,10 @@ export class LocalCommandExecutionRepository extends CommandExecutionRepository
         ...(await this.commandExecutionRepository.save(await this.modelEncryptor.encryptEntity(entity))),
         command: commandExecutions[idx].command, // avoid decryption
         mode: commandExecutions[idx].mode,
-        result: commandExecutions[idx].result, // avoid decryption + show original response when it was huge
+        // avoid decryption + show original response when it was huge
+        // also will return original response even if it wasn't stored
+        // so flag sizeLimitExceeded will be undefined
+        result: commandExecutions[idx].result,
         summary: commandExecutions[idx].summary,
         executionTime: commandExecutions[idx].executionTime,
         isNotStored,
diff --git a/redisinsight/api/test/api/workbench/POST-databases-id-workbench-command_executions.test.ts b/redisinsight/api/test/api/workbench/POST-databases-id-workbench-command_executions.test.ts
@@ -160,6 +160,7 @@ describe('POST /databases/:instanceId/workbench/command-executions', () => {
             expect(localDb.encryptData(JSON.stringify([{
               status: 'success',
               response: 'Results have been deleted since they exceed 1 MB. Re-run the command to see new results.',
+              sizeLimitExceeded: true,
             }]))).to.eql(entity.result);
           }
         },
diff --git a/redisinsight/ui/src/components/query/query-card/QueryCard.spec.tsx b/redisinsight/ui/src/components/query/query-card/QueryCard.spec.tsx
@@ -4,6 +4,7 @@ import { instance, mock } from 'ts-mockito'
 import { toggleOpenWBResult } from 'uiSrc/slices/workbench/wb-results'
 import { ResultsMode } from 'uiSrc/slices/interfaces/workbench'
 import { cleanup, clearStoreActions, fireEvent, mockedStore, render } from 'uiSrc/utils/test-utils'
+import { CommandExecutionStatus } from 'uiSrc/slices/interfaces/cli'
 import QueryCard, { Props, getSummaryText } from './QueryCard'
 
 const mockedProps = mock<Props>()
@@ -137,4 +138,41 @@ describe('QueryCard', () => {
     expect(queryCommonResultEl).toBeInTheDocument()
     expect(queryCliResultEl).not.toBeInTheDocument()
   })
+
+  it('should render QueryCardCliResult when result reached response size threshold', () => {
+    const { queryByTestId } = render(
+      <QueryCard
+        {...instance(mockedProps)}
+        resultsMode={ResultsMode.GroupMode}
+        result={[{
+          status: CommandExecutionStatus.Success,
+          response: 'Any message about size limit threshold exceeded',
+          sizeLimitExceeded: true
+        }]}
+        isOpen
+        command={null}
+      />
+    )
+    const queryCliResultEl = queryByTestId('query-cli-result')
+
+    expect(queryCliResultEl).toBeInTheDocument()
+  })
+
+  it('should render QueryCardCliResult when result reached response size threshold even w/o flag', () => {
+    const { queryByTestId } = render(
+      <QueryCard
+        {...instance(mockedProps)}
+        resultsMode={ResultsMode.GroupMode}
+        result={[{
+          status: CommandExecutionStatus.Success,
+          response: 'Results have been deleted since they exceed 1 MB. Re-run the command to see new results.',
+        }]}
+        isOpen
+        command={null}
+      />
+    )
+    const queryCliResultEl = queryByTestId('query-cli-result')
+
+    expect(queryCliResultEl).toBeInTheDocument()
+  })
 })
diff --git a/redisinsight/ui/src/components/query/query-card/QueryCard.tsx b/redisinsight/ui/src/components/query/query-card/QueryCard.tsx
@@ -152,6 +152,12 @@ const QueryCard = (props: Props) => {
 
   const commonError = CommonErrorResponse(id, command, result)
 
+  const isSizeLimitExceededResponse = (result: Maybe<CommandExecutionResult[]>) => {
+    const resultObj = result?.[0]
+    // response.includes - to be backward compatible with responses which don't include sizeLimitExceeded flag
+    return resultObj?.sizeLimitExceeded === true || resultObj?.response?.includes('Results have been deleted')
+  }
+
   return (
     <div
       className={cx(styles.containerWrapper, {
@@ -196,50 +202,65 @@ const QueryCard = (props: Props) => {
               ? <QueryCardCommonResult loading={loading} result={commonError} />
               : (
                 <>
-                  {isGroupResults(resultsMode) && (
-                    <QueryCardCliResultWrapper
-                      loading={loading}
-                      query={command}
-                      db={db}
-                      resultsMode={resultsMode}
-                      result={result}
-                      isNotStored={isNotStored}
-                      isFullScreen={isFullScreen}
-                      data-testid="group-mode-card"
-                    />
-                  )}
-                  {(resultsMode === ResultsMode.Default || !resultsMode) && (
-                    <>
-                      {viewTypeSelected === WBQueryType.Plugin && (
-                        <>
-                          {!loading && result !== undefined ? (
-                            <QueryCardCliPlugin
-                              id={selectedViewValue}
-                              result={result}
-                              query={command}
-                              mode={mode}
-                              setMessage={setMessage}
-                              commandId={id}
-                            />
-                          ) : (
-                            <div className={styles.loading}>
-                              <EuiLoadingContent lines={5} data-testid="loading-content" />
-                            </div>
-                          )}
-                        </>
-                      )}
-                      {(viewTypeSelected === WBQueryType.Text) && (
-                        <QueryCardCliResultWrapper
-                          loading={loading}
-                          query={command}
-                          resultsMode={resultsMode}
-                          result={result}
-                          isNotStored={isNotStored}
-                          isFullScreen={isFullScreen}
-                        />
-                      )}
-                    </>
-                  )}
+                  {isSizeLimitExceededResponse(result)
+                    ? (
+                      <QueryCardCliResultWrapper
+                        loading={loading}
+                        query={command}
+                        resultsMode={resultsMode}
+                        result={result}
+                        isNotStored={isNotStored}
+                        isFullScreen={isFullScreen}
+                      />
+                    )
+                    : (
+                      <>
+                        {isGroupResults(resultsMode) && (
+                          <QueryCardCliResultWrapper
+                            loading={loading}
+                            query={command}
+                            db={db}
+                            resultsMode={resultsMode}
+                            result={result}
+                            isNotStored={isNotStored}
+                            isFullScreen={isFullScreen}
+                            data-testid="group-mode-card"
+                          />
+                        )}
+                        {(resultsMode === ResultsMode.Default || !resultsMode) && (
+                          <>
+                            {viewTypeSelected === WBQueryType.Plugin && (
+                              <>
+                                {!loading && result !== undefined ? (
+                                  <QueryCardCliPlugin
+                                    id={selectedViewValue}
+                                    result={result}
+                                    query={command}
+                                    mode={mode}
+                                    setMessage={setMessage}
+                                    commandId={id}
+                                  />
+                                ) : (
+                                  <div className={styles.loading}>
+                                    <EuiLoadingContent lines={5} data-testid="loading-content" />
+                                  </div>
+                                )}
+                              </>
+                            )}
+                            {(viewTypeSelected === WBQueryType.Text) && (
+                              <QueryCardCliResultWrapper
+                                loading={loading}
+                                query={command}
+                                resultsMode={resultsMode}
+                                result={result}
+                                isNotStored={isNotStored}
+                                isFullScreen={isFullScreen}
+                              />
+                            )}
+                          </>
+                        )}
+                      </>
+                    )}
                 </>
               )}
           </>

Original file line number	Diff line number	Diff line change
`@@ -160,6 +160,7 @@ describe('POST /databases/:instanceId/workbench/command-executions', () => {`
`160`	`160`	`expect(localDb.encryptData(JSON.stringify([{`
`161`	`161`	`status: 'success',`
`162`	`162`	`response: 'Results have been deleted since they exceed 1 MB. Re-run the command to see new results.',`
	`163`	`+ sizeLimitExceeded: true,`
`163`	`164`	`}]))).to.eql(entity.result);`
`164`	`165`	`}`
`165`	`166`	`},`