feat: handle big response

Author: SamYSF

console/atest-ui/src/views/TestCase.vue

@@ -98,8 +98,11 @@ const handleTestResult = (e) => {
   if (!isHistoryTestCase.value) {
     handleTestResultError(e)
   }
+  const isFilePath = e.body.startsWith("isFilePath-")
 
-  if (e.body !== '') {
+  if(isFilePath){
+    isResponseFile.value = true
+  } else if(e.body !== ''){
     testResult.value.bodyObject = JSON.parse(e.body);
     testResult.value.originBodyObject = JSON.parse(e.body);
   }
@@ -312,6 +315,33 @@ function determineBodyType(e) {
   });
 }
 
+const isResponseFile = ref(false)
+function downloadResponseFile(){
+  API.DownloadResponseFile({
+      body: testResult.value.body
+    }, (e) => {
+    if (e && e.data) {
+      try {
+      const bytes = atob(e.data);
+      const blob = new Blob([bytes], { type: 'mimeType' });
+      const link = document.createElement('a');
+      link.href = window.URL.createObjectURL(blob);
+      link.download = e.filename.substring("isFilePath-".length);
+
+      document.body.appendChild(link);
+      link.click();
+
+      window.URL.revokeObjectURL(link.href);
+      document.body.removeChild(link);
+      } catch (error) {
+        console.error('Error during file download:', error);
+      }
+    } else {
+      console.error('No data to download.');
+    }
+    })
+}
+
 function setDefaultValues(e) {
   if (e.request.method === '') {
     e.request.method = 'GET'
@@ -1157,10 +1187,20 @@ Magic.Keys(() => {
           <div v-if="testResult.bodyObject">
             <el-input :prefix-icon="Search" @change="responseBodyFilter" v-model="responseBodyFilterText"
               clearable placeholder="$.key" />
-            <JsonViewer :value="testResult.bodyObject" :expand-depth="2" copyable boxed sort />
+            <JsonViewer :value="testResult.bodyObject" :expand-depth="5" copyable boxed sort />
           </div>
           <div v-else>
-            <Codemirror v-model="testResult.bodyText"/>
+            <Codemirror v-if="!isResponseFile" v-model="testResult.bodyText"/>
+            <div v-if="isResponseFile" style="padding-top: 10px;">
+            <el-row>
+              <el-col :span="8">
+                <div>Response body is too large, please download to view.</div>
+              </el-col>
+              <el-col :span="4">
+                <el-button type="primary" @click="downloadResponseFile">Download</el-button>
+              </el-col>
+            </el-row>
+          </div>
           </div>
         </el-tab-pane>
         <el-tab-pane name="response-header">

console/atest-ui/src/views/net.ts

@@ -622,12 +622,50 @@ function DeleteAllHistoryTestCase(suiteName: string, caseName: string,
         .then(callback).catch(errHandle)
 }
 
+function GetTestCaseAllHistory(req: TestCase,
+  callback: (d: any) => void, errHandle?: (e: any) => void | null) {
+  const requestOptions = {
+    method: 'POST',
+    headers: {
+      'X-Store-Name': Cache.GetCurrentStore().name,
+      'X-Auth': getToken()
+    },
+    body: JSON.stringify({
+      suiteName: req.suiteName,
+      name: req.name
+    })
+  }
+  fetch(`/api/v1/suites/${req.suiteName}/cases/${req.name}`, requestOptions)
+    .then(DefaultResponseProcess)
+    .then(callback).catch(errHandle)
+}
+
+function DownloadResponseFile(testcase,
+    callback: (d: any) => void, errHandle?: (e: any) => void | null) {
+    const requestOptions = {
+        method: 'POST',
+        headers: {
+            'X-Store-Name': Cache.GetCurrentStore().name,
+            'X-Auth': getToken()
+        },
+        body: JSON.stringify({
+            response: {
+                body: testcase.body,
+            }
+        })
+    }
+    fetch(`/api/v1/downloadFile/${testcase.body}`, requestOptions)
+        .then(DefaultResponseProcess)
+        .then(callback).catch(errHandle)
+}
+
+
 export const API = {
   DefaultResponseProcess,
   GetVersion,
   CreateTestSuite, UpdateTestSuite, ImportTestSuite, GetTestSuite, DeleteTestSuite, ConvertTestSuite,GetTestSuiteYaml,
   CreateTestCase, UpdateTestCase, GetTestCase, ListTestCase, DeleteTestCase, RunTestCase,
-  GetHistoryTestCaseWithResult, DeleteHistoryTestCase, GetHistoryTestCase, GetTestCaseAllHistory, DeleteAllHistoryTestCase,
+  GetHistoryTestCaseWithResult, DeleteHistoryTestCase,GetHistoryTestCase, GetTestCaseAllHistory, DeleteAllHistoryTestCase, DownloadResponseFile,
   GenerateCode, ListCodeGenerator,
   PopularHeaders,
   CreateOrUpdateStore, GetStores, DeleteStore, VerifyStore,

pkg/server/remote_server.go

@@ -22,8 +22,10 @@ import (
 	"errors"
 	"fmt"
 	"io"
+	"mime"
 	"net/http"
 	"os"
+	"path/filepath"
 	reflect "reflect"
 	"regexp"
 	"strings"
@@ -252,6 +254,7 @@ func (s *server) Run(ctx context.Context, task *TestTask) (reply *TestResult, er
 		output, testErr := suiteRunner.RunTestCase(&testCase, dataContext, ctx)
 		if getter, ok := suiteRunner.(runner.ResponseRecord); ok {
 			resp := getter.GetResponseRecord()
+			resp, err = handleLargeResponseBody(resp, suite.Name, testCase.Name)
 			reply.TestCaseResult = append(reply.TestCaseResult, &TestCaseResult{
 				StatusCode: int32(resp.StatusCode),
 				Body:       resp.Body,
@@ -291,6 +294,65 @@ func (s *server) Run(ctx context.Context, task *TestTask) (reply *TestResult, er
 	return
 }
 
+func handleLargeResponseBody(resp runner.SimpleResponse, suite string, caseName string) (reply runner.SimpleResponse, err error) {
+	const maxSize = 1024
+	prefix := "isFilePath-" + strings.Join([]string{suite, caseName}, "-")
+
+	if len(resp.Body) > maxSize {
+		tmpFile, err := os.CreateTemp("", prefix+"-")
+		defer tmpFile.Close()
+		if err != nil {
+			return resp, fmt.Errorf("failed to create file: %w", err)
+		}
+
+		if _, err = tmpFile.Write([]byte(resp.Body)); err != nil {
+			return resp, fmt.Errorf("failed to write response body to file: %w", err)
+		}
+		absFilePath, err := filepath.Abs(tmpFile.Name())
+		if err != nil {
+			return resp, fmt.Errorf("failed to get absolute file path: %w", err)
+		}
+		resp.Body = filepath.Base(absFilePath)
+		return resp, nil
+	}
+	return resp, nil
+}
+
+func (s *server) DownloadResponseFile(ctx context.Context, in *TestCase) (reply *FileData, err error) {
+	if in.Response != nil {
+		tempFileName := in.Response.Body
+		if tempFileName == "" {
+			return nil, errors.New("file name is empty")
+		}
+
+		tempDir := os.TempDir()
+		filePath := filepath.Join(tempDir, tempFileName)
+		if filepath.Clean(filePath) != filepath.Join(tempDir, filepath.Base(tempFileName)) {
+			return nil, errors.New("invalid file path")
+		}
+
+		fileContent, err := os.ReadFile(filePath)
+		if err != nil {
+			return nil, fmt.Errorf("failed to read file: %s", filePath)
+		}
+
+		mimeType := mime.TypeByExtension(filepath.Ext(filePath))
+		if mimeType == "" {
+			mimeType = "application/octet-stream"
+		}
+
+		reply = &FileData{
+			Data:        fileContent,
+			ContentType: mimeType,
+			Filename:    filepath.Base(filePath),
+		}
+
+		return reply, nil
+	} else {
+		return reply, errors.New("response is empty")
+	}
+}
+
 func (s *server) RunTestSuite(srv Runner_RunTestSuiteServer) (err error) {
 	ctx := srv.Context()
 	for {