Merge pull request #1811 from github/henrymercer/print-summary-once

Only print the analysis summary once

CHANGELOG.md

@@ -5,6 +5,7 @@ See the [releases page](https://github.com/github/codeql-action/releases) for th
 ## [UNRELEASED]
 
 - Update default CodeQL bundle version to 2.14.1. [#1797](https://github.com/github/codeql-action/pull/1797)
+- Avoid duplicating the analysis summary within the logs. [#1811](https://github.com/github/codeql-action/pull/1811)
 
 ## 2.21.1 - 26 Jul 2023
 

lib/codeql.js

@@ -485,12 +485,15 @@ async function getCodeQLForCmd(cmd, checkVersion) {
             if (querySuitePaths) {
                 codeqlArgs.push(...querySuitePaths);
             }
-            // capture stdout, which contains analysis summaries
+            // Capture the stdout, which contains the analysis summary. Don't stream it to the Actions
-            const returnState = await runTool(cmd, codeqlArgs);
+            // logs to avoid printing it twice.
+            const analysisSummary = await runTool(cmd, codeqlArgs, {
+                noStreamStdout: true,
+            });
             if (shouldWorkaroundInvalidNotifications) {
                 util.fixInvalidNotificationsInFile(codeqlOutputFile, sarifFile, logger);
             }
-            return returnState;
+            return analysisSummary;
         },
         async databasePrintBaseline(databasePath) {
             const codeqlArgs = [
@@ -718,9 +721,13 @@ async function runTool(cmd, args = [], opts = {}) {
     let output = "";
     let error = "";
     const exitCode = await new toolrunner.ToolRunner(cmd, args, {
+        ignoreReturnCode: true,
         listeners: {
             stdout: (data) => {
                 output += data.toString("utf8");
+                if (!opts.noStreamStdout) {
+                    process.stdout.write(data);
+                }
             },
             stderr: (data) => {
                 let readStartIndex = 0;
@@ -730,9 +737,11 @@ async function runTool(cmd, args = [], opts = {}) {
                     readStartIndex = data.length - maxErrorSize + 1;
                 }
                 error += data.toString("utf8", readStartIndex);
+                // Mimic the standard behavior of the toolrunner by writing stderr to stdout
+                process.stdout.write(data);
             },
         },
-        ignoreReturnCode: true,
+        silent: true,
         ...(opts.stdin ? { input: Buffer.from(opts.stdin || "") } : {}),
     }).exec();
     if (exitCode !== 0) {

src/codeql.ts

@@ -843,14 +843,17 @@ export async function getCodeQLForCmd(
       if (querySuitePaths) {
         codeqlArgs.push(...querySuitePaths);
       }
-      // capture stdout, which contains analysis summaries
+      // Capture the stdout, which contains the analysis summary. Don't stream it to the Actions
-      const returnState = await runTool(cmd, codeqlArgs);
+      // logs to avoid printing it twice.
+      const analysisSummary = await runTool(cmd, codeqlArgs, {
+        noStreamStdout: true,
+      });
 
       if (shouldWorkaroundInvalidNotifications) {
         util.fixInvalidNotificationsInFile(codeqlOutputFile, sarifFile, logger);
       }
 
-      return returnState;
+      return analysisSummary;
     },
     async databasePrintBaseline(databasePath: string): Promise<string> {
       const codeqlArgs = [
@@ -1131,14 +1134,18 @@ const maxErrorSize = 20_000;
 async function runTool(
   cmd: string,
   args: string[] = [],
-  opts: { stdin?: string } = {},
+  opts: { stdin?: string; noStreamStdout?: boolean } = {},
 ) {
   let output = "";
   let error = "";
   const exitCode = await new toolrunner.ToolRunner(cmd, args, {
+    ignoreReturnCode: true,
     listeners: {
       stdout: (data: Buffer) => {
         output += data.toString("utf8");
+        if (!opts.noStreamStdout) {
+          process.stdout.write(data);
+        }
       },
       stderr: (data: Buffer) => {
         let readStartIndex = 0;
@@ -1148,9 +1155,11 @@ async function runTool(
           readStartIndex = data.length - maxErrorSize + 1;
         }
         error += data.toString("utf8", readStartIndex);
+        // Mimic the standard behavior of the toolrunner by writing stderr to stdout
+        process.stdout.write(data);
       },
     },
-    ignoreReturnCode: true,
+    silent: true,
     ...(opts.stdin ? { input: Buffer.from(opts.stdin || "") } : {}),
   }).exec();
   if (exitCode !== 0) {