Replace analyze with run-queries and interpret-results

src/analyze.ts

@@ -10,7 +10,6 @@ import { countLoc, getIdPrefix } from "./count-loc";
 import { isScannedLanguage, Language } from "./languages";
 import { Logger } from "./logging";
 import * as sharedEnv from "./shared-environment";
-import { combineSarifFiles } from "./upload-lib";
 import * as util from "./util";
 
 export class CodeQLAnalysisError extends Error {
@@ -163,7 +162,7 @@ export async function runQueries(
   );
 
   for (const language of config.languages) {
-    logger.startGroup(`Analyzing ${language}`);
+    logger.startGroup(`Running queries for ${language}`);
 
     const queries = config.queries[language];
     if (
@@ -176,71 +175,54 @@ export async function runQueries(
     }
 
     try {
-      let analysisSummaryBuiltIn = "";
-      const customAnalysisSummaries: string[] = [];
+      const querySuitePaths: string[] = [];
       if (queries["builtin"].length > 0) {
         const startTimeBuiltIn = new Date().getTime();
-        const { sarifFile, stdout } = await runQueryGroup(
-          language,
-          "builtin",
-          queries["builtin"],
-          sarifFolder,
-          undefined
+        querySuitePaths.push(
+          await runQueryGroup(
+            language,
+            "builtin",
+            queries["builtin"],
+            undefined
+          )
         );
-        analysisSummaryBuiltIn = stdout;
-        await injectLinesOfCode(sarifFile, language, locPromise);
-
         statusReport[`analyze_builtin_queries_${language}_duration_ms`] =
           new Date().getTime() - startTimeBuiltIn;
       }
       const startTimeCustom = new Date().getTime();
-      const temporarySarifDir = config.tempDir;
-      const temporarySarifFiles: string[] = [];
+      let ranCustom = false;
       for (let i = 0; i < queries["custom"].length; ++i) {
         if (queries["custom"][i].queries.length > 0) {
-          const { sarifFile, stdout } = await runQueryGroup(
-            language,
-            `custom-${i}`,
-            queries["custom"][i].queries,
-            temporarySarifDir,
-            queries["custom"][i].searchPath
+          querySuitePaths.push(
+            await runQueryGroup(
+              language,
+              `custom-${i}`,
+              queries["custom"][i].queries,
+              queries["custom"][i].searchPath
+            )
           );
-          customAnalysisSummaries.push(stdout);
-          temporarySarifFiles.push(sarifFile);
+          ranCustom = true;
         }
       }
-      if (temporarySarifFiles.length > 0) {
-        const sarifFile = path.join(sarifFolder, `${language}-custom.sarif`);
-        fs.writeFileSync(sarifFile, combineSarifFiles(temporarySarifFiles));
-        await injectLinesOfCode(sarifFile, language, locPromise);
-
+      if (ranCustom) {
         statusReport[`analyze_custom_queries_${language}_duration_ms`] =
           new Date().getTime() - startTimeCustom;
       }
       logger.endGroup();
-
-      // Print the LoC baseline and the summary results from database analyze for the standard
-      // query suite and (if appropriate) each custom query suite.
-      logger.startGroup(`Analysis summary for ${language}`);
-
-      printLinesOfCodeSummary(logger, language, await locPromise);
-      logger.info(analysisSummaryBuiltIn);
-
-      for (const [i, customSummary] of customAnalysisSummaries.entries()) {
-        if (customSummary.trim() === "") {
-          continue;
-        }
-        const description =
-          customAnalysisSummaries.length === 1
-            ? "custom queries"
-            : `custom query suite ${i + 1}/${customAnalysisSummaries.length}`;
-        logger.info(`Analysis summary for ${description}:`);
-        logger.info("");
-        logger.info(customSummary);
-        logger.info("");
-      }
-
+      logger.startGroup(`Interpreting results for ${language}`);
+      const startTimeInterpretResults = new Date().getTime();
+      const sarifFile = path.join(sarifFolder, `${language}.sarif`);
+      const analysisSummary = await runInterpretResults(
+        language,
+        querySuitePaths,
+        sarifFile
+      );
+      await injectLinesOfCode(sarifFile, language, locPromise);
+      statusReport[`interpret_results_${language}_duration_ms`] =
+        new Date().getTime() - startTimeInterpretResults;
       logger.endGroup();
+      logger.info(analysisSummary);
+      printLinesOfCodeSummary(logger, language, await locPromise);
     } catch (e) {
       logger.info(e);
       statusReport.analyze_failure_language = language;
@@ -253,13 +235,29 @@ export async function runQueries(
 
   return statusReport;
 
+  async function runInterpretResults(
+    language: Language,
+    queries: string[],
+    sarifFile: string
+  ): Promise<string> {
+    const databasePath = util.getCodeQLDatabasePath(config, language);
+    const codeql = getCodeQL(config.codeQLCmd);
+    return await codeql.databaseInterpretResults(
+      databasePath,
+      queries,
+      sarifFile,
+      addSnippetsFlag,
+      threadsFlag,
+      automationDetailsId
+    );
+  }
+
   async function runQueryGroup(
     language: Language,
     type: string,
     queries: string[],
-    destinationFolder: string,
     searchPath: string | undefined
-  ): Promise<{ sarifFile: string; stdout: string }> {
+  ): Promise<string> {
     const databasePath = util.getCodeQLDatabasePath(config, language);
     // Pass the queries to codeql using a file instead of using the command
     // line to avoid command line length restrictions, particularly on windows.
@@ -270,24 +268,17 @@ export async function runQueries(
     fs.writeFileSync(querySuitePath, querySuiteContents);
     logger.debug(`Query suite file for ${language}...\n${querySuiteContents}`);
 
-    const sarifFile = path.join(destinationFolder, `${language}-${type}.sarif`);
-
     const codeql = getCodeQL(config.codeQLCmd);
-    const databaseAnalyzeStdout = await codeql.databaseAnalyze(
+    await codeql.databaseRunQueries(
       databasePath,
-      sarifFile,
       searchPath,
       querySuitePath,
       memoryFlag,
-      addSnippetsFlag,
-      threadsFlag,
-      automationDetailsId
+      threadsFlag
     );
 
-    logger.debug(
-      `SARIF results for database ${language} created at "${sarifFile}"`
-    );
-    return { sarifFile, stdout: databaseAnalyzeStdout };
+    logger.debug(`BQRS results produced for ${language} (queries: ${type})"`);
+    return querySuitePath;
   }
 }