feat: consolidate json streaming

snyk · Jun 5, 2024 · 7d4e354 · 7d4e354
1 parent 58d4fc9
commit 7d4e354
Show file tree

Hide file tree

Showing 14 changed files with 104 additions and 201 deletions.
diff --git a/src/cli/commands/test/iac/output.ts b/src/cli/commands/test/iac/output.ts
@@ -101,23 +101,21 @@ export function buildOutput({
   const mappedResults = results.map(mapIacTestResult);
 
   const {
-    stdout: dataToSend,
-    stringifiedData,
-    stringifiedJsonData,
-    stringifiedSarifData,
+    dataToSend,
+    jsonData,
+    sarifData,
   } = extractDataToSendFromResults(results, mappedResults, options);
 
   if (options.json || options.sarif) {
     // if all results are ok (.ok == true)
     if (mappedResults.every((res) => res.ok)) {
       return TestCommandResult.createJsonTestCommandResult(
-        stringifiedData,
-        stringifiedJsonData,
-        stringifiedSarifData,
+        jsonData,
+        sarifData,
       );
     }
 
-    const err = new Error(stringifiedData) as any;
+    const err = new Error() as any;
 
     if (foundVulnerabilities) {
       err.code = 'VULNS';
@@ -134,9 +132,8 @@ export function buildOutput({
       // the first error.
       err.code = errorResults[0].code;
     }
-    err.json = stringifiedData;
-    err.jsonStringifiedResults = stringifiedJsonData;
-    err.sarifStringifiedResults = stringifiedSarifData;
+    err.jsonData = jsonData;
+    err.sarifData = sarifData;
     throw err;
   }
 
@@ -228,15 +225,15 @@ export function buildOutput({
     // first one
     error.code = vulnerableResults[0].code || 'VULNS';
     error.userMessage = vulnerableResults[0].userMessage;
-    error.jsonStringifiedResults = stringifiedJsonData;
-    error.sarifStringifiedResults = stringifiedSarifData;
+    error.jsonData = jsonData;
+    error.sarifData = sarifData;
     throw error;
   }
 
   return TestCommandResult.createHumanReadableTestCommandResult(
     response,
-    stringifiedJsonData,
-    stringifiedSarifData,
+    jsonData,
+    sarifData,
   );
 }
 

diff --git a/src/cli/commands/test/index.ts b/src/cli/commands/test/index.ts
@@ -202,37 +202,28 @@ export default async function test(
   const mappedResults = createErrorMappedResultsForJsonOutput(results);
 
   const {
-    stdout: dataToSend,
-    stringifiedData,
-    stringifiedJsonData,
-    stringifiedSarifData,
+    dataToSend,
+    jsonData,
+    sarifData,
   } = extractDataToSendFromResults(results, mappedResults, options);
 
-  const jsonPayload = stringifiedJsonData.length === 0 ? dataToSend : null;
-
   if (options.json || options.sarif) {
     // if all results are ok (.ok == true)
     if (mappedResults.every((res) => res.ok)) {
       return TestCommandResult.createJsonTestCommandResult(
-        stringifiedData,
-        stringifiedJsonData,
-        stringifiedSarifData,
-        jsonPayload,
+        jsonData, sarifData,
       );
     }
 
-    const err = new Error(stringifiedData) as any;
+    const err = new Error() as any;
 
     if (foundVulnerabilities) {
       if (options.failOn) {
         const fail = shouldFail(vulnerableResults, options.failOn);
         if (!fail) {
           // return here to prevent failure
           return TestCommandResult.createJsonTestCommandResult(
-            stringifiedData,
-            stringifiedJsonData,
-            stringifiedSarifData,
-            jsonPayload,
+            jsonData, sarifData,
           );
         }
       }
@@ -249,13 +240,8 @@ export default async function test(
       // the first error.
       err.code = errorResults[0].code;
     }
-    err.json = stringifiedData;
-    err.jsonStringifiedResults = stringifiedJsonData;
-    err.sarifStringifiedResults = stringifiedSarifData;
-    // set jsonPayload if we failed to stringify it
-    if (jsonPayload) {
-      err.jsonPayload = jsonPayload;
-    }
+    err.jsonData = jsonData;
+    err.sarifData = sarifData;
     throw err;
   }
 
@@ -315,10 +301,7 @@ export default async function test(
         );
 
         return TestCommandResult.createHumanReadableTestCommandResult(
-          response,
-          stringifiedJsonData,
-          stringifiedSarifData,
-          jsonPayload,
+          response, jsonData, sarifData,
         );
       }
     }
@@ -339,12 +322,8 @@ export default async function test(
     // first one
     error.code = vulnerableResults[0].code || 'VULNS';
     error.userMessage = vulnerableResults[0].userMessage;
-    error.jsonStringifiedResults = stringifiedJsonData;
-    error.sarifStringifiedResults = stringifiedSarifData;
-    // conditionally set jsonPayload for now, to determine whether to stream data to destination
-    if (stringifiedJsonData.length === 0) {
-      error.jsonPayload = dataToSend;
-    }
+    error.jsonData
+    error.sarifData
     throw error;
   }
 
@@ -356,9 +335,8 @@ export default async function test(
 
   return TestCommandResult.createHumanReadableTestCommandResult(
     response,
-    stringifiedJsonData,
-    stringifiedSarifData,
-    jsonPayload,
+    jsonData,
+    sarifData,
   );
 }
 

diff --git a/src/cli/commands/types.ts b/src/cli/commands/types.ts
@@ -15,113 +15,65 @@ export class CommandResult {
   }
 }
 
-export abstract class TestCommandResult extends CommandResult {
-  protected jsonResult = '';
-  protected sarifResult = '';
-  protected jsonData = {};
+export type JsonDocument = Record<string, undefined> | Array<JsonDocument>;
 
-  public getJsonResult(): string {
-    return this.jsonResult;
-  }
+export abstract class TestCommandResult extends CommandResult {
+  protected jsonData?: JsonDocument;
+  protected sarifData?: JsonDocument;
 
-  public getSarifResult(): string {
-    return this.sarifResult;
+  public getJsonData(): JsonDocument | undefined {
+    return this.jsonData;
   }
 
-  public getJsonData(): Record<string, unknown> {
-    return this.jsonData;
+  public getSarifData(): JsonDocument | undefined {
+    return this.sarifData;
   }
 
   public static createHumanReadableTestCommandResult(
     humanReadableResult: string,
-    jsonResult: string,
-    sarifResult?: string,
-    jsonData?: Record<string, unknown>,
+    jsonData?: JsonDocument,
+    sarifData?: JsonDocument,
   ): HumanReadableTestCommandResult {
     return new HumanReadableTestCommandResult(
       humanReadableResult,
-      jsonResult,
-      sarifResult,
       jsonData,
+      sarifData,
     );
   }
 
   public static createJsonTestCommandResult(
-    stdout: string,
-    jsonResult?: string,
-    sarifResult?: string,
-    jsonPayload?: Record<string, unknown>,
+    jsonData?: JsonDocument,
+    sarifData?: JsonDocument,
   ): JsonTestCommandResult {
     return new JsonTestCommandResult(
-      stdout,
-      jsonResult,
-      sarifResult,
-      jsonPayload,
+      '',
+      jsonData,
+      sarifData,
     );
   }
 }
 
 class HumanReadableTestCommandResult extends TestCommandResult {
-  protected jsonResult = '';
-  protected sarifResult = '';
-  protected jsonData = {};
-
   constructor(
     humanReadableResult: string,
-    jsonResult: string,
-    sarifResult?: string,
-    jsonData?: Record<string, unknown>,
+    jsonData?: JsonDocument,
+    sarifData?: JsonDocument,
   ) {
     super(humanReadableResult);
-    this.jsonResult = jsonResult;
-    if (sarifResult) {
-      this.sarifResult = sarifResult;
-    }
-    if (jsonData) {
-      this.jsonData = jsonData;
-    }
-  }
-
-  public getJsonResult(): string {
-    return this.jsonResult;
-  }
-
-  public getSarifResult(): string {
-    return this.sarifResult;
-  }
-
-  public getJsonData(): Record<string, unknown> {
-    return this.jsonData;
+    this.jsonData = jsonData;
+    this.sarifData = sarifData;
   }
 }
 
 class JsonTestCommandResult extends TestCommandResult {
   constructor(
     stdout: string,
-    jsonResult?: string,
-    sarifResult?: string,
-    jsonData?: Record<string, unknown>,
+    jsonData?: JsonDocument,
+    sarifData?: JsonDocument,
   ) {
     super(stdout);
-    if (jsonResult) {
-      this.jsonResult = jsonResult;
-    }
-    if (sarifResult) {
-      this.sarifResult = sarifResult;
-    } else {
-      this.jsonResult = stdout;
-    }
-    if (jsonData) {
-      this.jsonData = jsonData;
-    }
-  }
-
-  public getJsonResult(): string {
-    return this.jsonResult;
-  }
-
-  public getSarifResult(): string {
-    return this.sarifResult;
+    this.jsonData = jsonData;
+    this.sarifData = sarifData;
   }
 }