Wrap reading and writing SARIF files

github · Mar 27, 2023 · 1e7a388 · 1e7a388
1 parent fb32c3f
commit 1e7a388
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 19 deletions.
diff --git a/lib/codeql.js b/lib/codeql.js
diff --git a/lib/codeql.js.map b/lib/codeql.js.map
diff --git a/lib/util.js b/lib/util.js
diff --git a/lib/util.js.map b/lib/util.js.map
diff --git a/src/codeql.ts b/src/codeql.ts
@@ -923,11 +923,7 @@ export async function getCodeQLForCmd(
       );
 
       if (shouldExportDiagnostics) {
-        let sarif = JSON.parse(
-          fs.readFileSync(codeqlOutputFile, "utf8")
-        ) as util.SarifFile;
-        sarif = util.fixInvalidNotifications(sarif, logger);
-        fs.writeFileSync(sarifFile, JSON.stringify(sarif));
+        util.fixInvalidNotificationsInFile(codeqlOutputFile, sarifFile, logger);
       }
 
       return returnState.stdout;
@@ -1050,11 +1046,11 @@ export async function getCodeQLForCmd(
       await new toolrunner.ToolRunner(cmd, args).exec();
 
       // Fix invalid notifications in the SARIF file output by CodeQL.
-      let sarif = JSON.parse(
-        fs.readFileSync(intermediateSarifFile, "utf8")
-      ) as util.SarifFile;
-      sarif = util.fixInvalidNotifications(sarif, logger);
-      fs.writeFileSync(sarifFile, JSON.stringify(sarif));
+      util.fixInvalidNotificationsInFile(
+        intermediateSarifFile,
+        sarifFile,
+        logger
+      );
     },
     async diagnosticsExport(
       sarifFile: string,

diff --git a/src/util.ts b/src/util.ts
@@ -878,3 +878,13 @@ export function fixInvalidNotifications(
   }
   return newSarif;
 }
+
+export function fixInvalidNotificationsInFile(
+  inputPath: string,
+  outputPath: string,
+  logger: Logger
+): void {
+  let sarif = JSON.parse(fs.readFileSync(inputPath, "utf8")) as SarifFile;
+  sarif = fixInvalidNotifications(sarif, logger);
+  fs.writeFileSync(outputPath, JSON.stringify(sarif));
+}