Merge pull request #1753 from github/henrymercer/new-analysis-summary

Add support for new analysis summaries

lib/codeql.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getExtraOptions = exports.getCodeQLForCmd = exports.getCodeQLForTesting = exports.getCachedCodeQL = exports.setCodeQL = exports.getCodeQL = exports.setupCodeQL = exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = exports.CODEQL_VERSION_INIT_WITH_QLCONFIG = exports.CODEQL_VERSION_EXPORT_CODE_SCANNING_CONFIG = exports.CODEQL_VERSION_SECURITY_EXPERIMENTAL_SUITE = exports.CODEQL_VERSION_BETTER_RESOLVE_LANGUAGES = exports.CODEQL_VERSION_ML_POWERED_QUERIES_WINDOWS = exports.CODEQL_VERSION_GHES_PACK_DOWNLOAD = exports.CommandInvocationError = void 0;
+exports.getExtraOptions = exports.getCodeQLForCmd = exports.getCodeQLForTesting = exports.getCachedCodeQL = exports.setCodeQL = exports.getCodeQL = exports.setupCodeQL = exports.CODEQL_VERSION_NEW_ANALYSIS_SUMMARY = exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = exports.CODEQL_VERSION_INIT_WITH_QLCONFIG = exports.CODEQL_VERSION_EXPORT_CODE_SCANNING_CONFIG = exports.CODEQL_VERSION_SECURITY_EXPERIMENTAL_SUITE = exports.CODEQL_VERSION_BETTER_RESOLVE_LANGUAGES = exports.CODEQL_VERSION_ML_POWERED_QUERIES_WINDOWS = exports.CODEQL_VERSION_GHES_PACK_DOWNLOAD = exports.CommandInvocationError = void 0;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const toolrunner = __importStar(require("@actions/exec/lib/toolrunner"));
@@ -99,6 +99,10 @@ exports.CODEQL_VERSION_INIT_WITH_QLCONFIG = "2.12.4";
  * Versions 2.13.4+ of the CodeQL CLI support the `resolve build-environment` command.
  */
 exports.CODEQL_VERSION_RESOLVE_ENVIRONMENT = "2.13.4";
+/**
+ * Versions 2.14.0+ of the CodeQL CLI support new analysis summaries.
+ */
+exports.CODEQL_VERSION_NEW_ANALYSIS_SUMMARY = "2.14.0";
 /**
  * Set up CodeQL CLI access.
  *
@@ -459,6 +463,12 @@ async function getCodeQLForCmd(cmd, checkVersion) {
             else if (await util.codeQlVersionAbove(this, "2.12.4")) {
                 codeqlArgs.push("--no-sarif-include-diagnostics");
             }
+            if (await features.getValue(feature_flags_1.Feature.NewAnalysisSummaryEnabled, codeql)) {
+                codeqlArgs.push("--new-analysis-summary");
+            }
+            else if (await util.codeQlVersionAbove(codeql, exports.CODEQL_VERSION_NEW_ANALYSIS_SUMMARY)) {
+                codeqlArgs.push("--no-new-analysis-summary");
+            }
             codeqlArgs.push(databasePath);
             if (querySuitePaths) {
                 codeqlArgs.push(...querySuitePaths);

lib/feature-flags.js

@@ -28,6 +28,7 @@ const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const semver = __importStar(require("semver"));
 const api_client_1 = require("./api-client");
+const codeql_1 = require("./codeql");
 const defaults = __importStar(require("./defaults.json"));
 const util = __importStar(require("./util"));
 const DEFAULT_VERSION_FEATURE_FLAG_PREFIX = "default_codeql_version_";
@@ -39,6 +40,7 @@ var Feature;
     Feature["DisablePythonDependencyInstallationEnabled"] = "disable_python_dependency_installation_enabled";
     Feature["ExportDiagnosticsEnabled"] = "export_diagnostics_enabled";
     Feature["MlPoweredQueriesEnabled"] = "ml_powered_queries_enabled";
+    Feature["NewAnalysisSummaryEnabled"] = "new_analysis_summary_enabled";
     Feature["QaTelemetryEnabled"] = "qa_telemetry_enabled";
     Feature["UploadFailedSarifEnabled"] = "upload_failed_sarif_enabled";
 })(Feature = exports.Feature || (exports.Feature = {}));
@@ -63,6 +65,11 @@ exports.featureConfig = {
         minimumVersion: "2.7.5",
         defaultValue: false,
     },
+    [Feature.NewAnalysisSummaryEnabled]: {
+        envVar: "CODEQL_ACTION_NEW_ANALYSIS_SUMMARY",
+        minimumVersion: codeql_1.CODEQL_VERSION_NEW_ANALYSIS_SUMMARY,
+        defaultValue: false,
+    },
     [Feature.QaTelemetryEnabled]: {
         envVar: "CODEQL_ACTION_QA_TELEMETRY",
         minimumVersion: undefined,

src/codeql.ts

@@ -315,6 +315,11 @@ export const CODEQL_VERSION_INIT_WITH_QLCONFIG = "2.12.4";
  */
 export const CODEQL_VERSION_RESOLVE_ENVIRONMENT = "2.13.4";
 
+/**
+ * Versions 2.14.0+ of the CodeQL CLI support new analysis summaries.
+ */
+export const CODEQL_VERSION_NEW_ANALYSIS_SUMMARY = "2.14.0";
+
 /**
  * Set up CodeQL CLI access.
  *
@@ -816,6 +821,16 @@ export async function getCodeQLForCmd(
       } else if (await util.codeQlVersionAbove(this, "2.12.4")) {
         codeqlArgs.push("--no-sarif-include-diagnostics");
       }
+      if (await features.getValue(Feature.NewAnalysisSummaryEnabled, codeql)) {
+        codeqlArgs.push("--new-analysis-summary");
+      } else if (
+        await util.codeQlVersionAbove(
+          codeql,
+          CODEQL_VERSION_NEW_ANALYSIS_SUMMARY
+        )
+      ) {
+        codeqlArgs.push("--no-new-analysis-summary");
+      }
       codeqlArgs.push(databasePath);
       if (querySuitePaths) {
         codeqlArgs.push(...querySuitePaths);

src/feature-flags.ts

@@ -4,7 +4,7 @@ import * as path from "path";
 import * as semver from "semver";
 
 import { getApiClient } from "./api-client";
-import { CodeQL } from "./codeql";
+import { CODEQL_VERSION_NEW_ANALYSIS_SUMMARY, CodeQL } from "./codeql";
 import * as defaults from "./defaults.json";
 import { Logger } from "./logging";
 import { RepositoryNwo } from "./repository";
@@ -42,6 +42,7 @@ export enum Feature {
   DisablePythonDependencyInstallationEnabled = "disable_python_dependency_installation_enabled",
   ExportDiagnosticsEnabled = "export_diagnostics_enabled",
   MlPoweredQueriesEnabled = "ml_powered_queries_enabled",
+  NewAnalysisSummaryEnabled = "new_analysis_summary_enabled",
   QaTelemetryEnabled = "qa_telemetry_enabled",
   UploadFailedSarifEnabled = "upload_failed_sarif_enabled",
 }
@@ -70,6 +71,11 @@ export const featureConfig: Record<
     minimumVersion: "2.7.5",
     defaultValue: false,
   },
+  [Feature.NewAnalysisSummaryEnabled]: {
+    envVar: "CODEQL_ACTION_NEW_ANALYSIS_SUMMARY",
+    minimumVersion: CODEQL_VERSION_NEW_ANALYSIS_SUMMARY,
+    defaultValue: false,
+  },
   [Feature.QaTelemetryEnabled]: {
     envVar: "CODEQL_ACTION_QA_TELEMETRY",
     minimumVersion: undefined,