Don't use JSON.stringify for logging purposes (#236)

anchore · Apr 5, 2022 · f6c3d0f · f6c3d0f
1 parent ced7eec
commit f6c3d0f
Show file tree

Hide file tree

Showing 6 changed files with 61 additions and 38 deletions.
diff --git a/dist/attachReleaseAssets/index.js b/dist/attachReleaseAssets/index.js
diff --git a/dist/downloadSyft/index.js b/dist/downloadSyft/index.js
diff --git a/dist/runSyftAction/index.js b/dist/runSyftAction/index.js
diff --git a/src/github/GithubClient.ts b/src/github/GithubClient.ts
@@ -96,8 +96,7 @@ export function dashWrap(str: string): string {
 }
 
 /**
- * Logs all objects passed in debug outputting strings directly and
- * calling JSON.stringify on other elements in a group with the given label
+ * Attempts to intelligently log all objects passed in when debug is enabled
  */
 export function debugLog(label: string, ...args: unknown[]): void {
   if (core.isDebug()) {
@@ -107,9 +106,9 @@ export function debugLog(label: string, ...args: unknown[]): void {
           core.debug(arg);
         } else if (arg instanceof Error) {
           core.debug(arg.message);
-          core.debug(JSON.stringify(arg.stack));
+          console.log(arg.stack);
         } else {
-          core.debug(JSON.stringify(arg));
+          console.log(arg);
         }
       }
     });
@@ -432,16 +431,14 @@ export class GithubClient {
       );
 
       if (response.status >= 400) {
-        core.warning(
-          `Dependency snapshot upload failed: ${JSON.stringify(response)}`
-        );
+        core.warning(`Dependency snapshot upload failed:`);
+        console.log(response);
       } else {
         debugLog(`Dependency snapshot upload successful:`, response);
       }
     } catch (e) {
-      core.warning(
-        `Error uploading depdendency snapshot: ${JSON.stringify(e)}`
-      );
+      core.warning(`Error uploading depdendency snapshot:`);
+      console.log(e);
     }
   }
 }

diff --git a/src/github/SyftGithubAction.ts b/src/github/SyftGithubAction.ts
@@ -348,7 +348,7 @@ export async function runSyftAction(): Promise<void> {
       core.exportVariable(PRIOR_ARTIFACT_ENV_VAR, getArtifactName());
     }
   } else {
-    throw new Error(`No Syft output: ${JSON.stringify(output)}`);
+    throw new Error(`No Syft output`);
   }
 }
 
@@ -517,7 +517,12 @@ export async function runAndFailBuildOnException<T>(
     if (e instanceof Error) {
       core.setFailed(e.message);
     } else if (e instanceof Object) {
-      core.setFailed(JSON.stringify(e));
+      try {
+        core.setFailed(JSON.stringify(e));
+      } catch (e) {
+        core.setFailed("Action failed");
+        console.error(e);
+      }
     } else {
       core.setFailed(`An unknown error occurred: ${e}`);
     }

diff --git a/tests/GithubClient.test.ts b/tests/GithubClient.test.ts
@@ -214,10 +214,10 @@ describe("Github Client", () => {
       }
     });
 
-    debugLog("the_label", { the: "obj" });
+    debugLog("the_label", "string");
 
     expect(data.debug.log.length).toBe(1);
-    expect(data.debug.log[0]).toBe("{\"the\":\"obj\"}");
+    expect(data.debug.log[0]).toBe("string");
   });
 
   it("finds a draft release", async () => {