Use supportsFeature check for merging SARIF files

github · Mar 22, 2024 · e20c273 · e20c273
1 parent 2bbafcd
commit e20c273
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 9 deletions.
diff --git a/lib/feature-flags.js b/lib/feature-flags.js
diff --git a/lib/feature-flags.js.map b/lib/feature-flags.js.map
diff --git a/lib/tools-features.js b/lib/tools-features.js
diff --git a/lib/tools-features.js.map b/lib/tools-features.js.map
diff --git a/lib/upload-lib.js b/lib/upload-lib.js
diff --git a/lib/upload-lib.js.map b/lib/upload-lib.js.map
diff --git a/src/feature-flags.ts b/src/feature-flags.ts
@@ -61,8 +61,7 @@ export const featureConfig: Record<
 > = {
   [Feature.CliSarifMerge]: {
     envVar: "CODEQL_ACTION_CLI_SARIF_MERGE",
-    // This feature is only supported in 2.17.0, but we'll want to test this feature
-    // with nightly builds before that. We'll update this to 2.17.0 once it's released.
+    // This is guarded by a `supportsFeature` check rather than by a version check.
     minimumVersion: undefined,
     defaultValue: false,
   },

diff --git a/src/tools-features.ts b/src/tools-features.ts
@@ -6,6 +6,7 @@ export enum ToolsFeature {
   InformsAboutUnsupportedPathFilters = "informsAboutUnsupportedPathFilters",
   SetsCodeqlRunnerEnvVar = "setsCodeqlRunnerEnvVar",
   TraceCommandUseBuildMode = "traceCommandUseBuildMode",
+  SarifMergeRunsFromEqualCategory = "sarifMergeRunsFromEqualCategory",
 }
 
 /**

diff --git a/src/upload-lib.ts b/src/upload-lib.ts
@@ -19,13 +19,14 @@ import * as fingerprints from "./fingerprints";
 import { initCodeQL } from "./init";
 import { Logger } from "./logging";
 import { parseRepositoryNwo, RepositoryNwo } from "./repository";
+import { ToolsFeature } from "./tools-features";
 import * as util from "./util";
 import {
-  SarifFile,
   ConfigurationError,
-  wrapError,
   getRequiredEnvParam,
   GitHubVersion,
+  SarifFile,
+  wrapError,
 } from "./util";
 
 const GENERIC_403_MSG =
@@ -134,6 +135,18 @@ async function combineSarifFilesUsingCLI(
     codeQL = initCodeQLResult.codeql;
   }
 
+  if (
+    !(await codeQL.supportsFeature(
+      ToolsFeature.SarifMergeRunsFromEqualCategory,
+    ))
+  ) {
+    logger.warning(
+      "The CodeQL CLI does not support merging SARIF files. Merging files in the action.",
+    );
+
+    return combineSarifFiles(sarifFiles);
+  }
+
   const baseTempDir = path.resolve(tempDir, "combined-sarif");
   fs.mkdirSync(baseTempDir, { recursive: true });
   const outputDirectory = fs.mkdtempSync(path.resolve(baseTempDir, "output-"));