Fix legacy SARIF categories for CQ in default setup

Author: mbg

src/analyze.test.ts

@@ -10,6 +10,7 @@ import {
   runQueries,
   defaultSuites,
   resolveQuerySuiteAlias,
+  fixCodeQualityCategory,
 } from "./analyze";
 import { setCodeQL } from "./codeql";
 import { Feature } from "./feature-flags";
@@ -349,3 +350,42 @@ test("resolveQuerySuiteAlias", (t) => {
     t.deepEqual(resolveQuerySuiteAlias(Language.go, name), name);
   }
 });
+
+test("fixCodeQualityCategory", (t) => {
+  const logger = getRunnerLogger(true);
+  process.env["GITHUB_EVENT_NAME"] = "dynamic";
+
+  // Categories that should get adjusted.
+  t.is(fixCodeQualityCategory(logger, "/language:c#"), "/language:csharp");
+  t.is(fixCodeQualityCategory(logger, "/language:cpp"), "/language:c-cpp");
+  t.is(fixCodeQualityCategory(logger, "/language:c"), "/language:c-cpp");
+  t.is(
+    fixCodeQualityCategory(logger, "/language:java"),
+    "/language:java-kotlin",
+  );
+  t.is(
+    fixCodeQualityCategory(logger, "/language:javascript"),
+    "/language:javascript-typescript",
+  );
+  t.is(
+    fixCodeQualityCategory(logger, "/language:typescript"),
+    "/language:javascript-typescript",
+  );
+  t.is(
+    fixCodeQualityCategory(logger, "/language:kotlin"),
+    "/language:java-kotlin",
+  );
+
+  // Categories that should not get adjusted.
+  t.is(fixCodeQualityCategory(logger, "/language:csharp"), "/language:csharp");
+  t.is(fixCodeQualityCategory(logger, "/language:go"), "/language:go");
+  t.is(
+    fixCodeQualityCategory(logger, "/language:actions"),
+    "/language:actions",
+  );
+
+  // Other cases.
+  t.is(fixCodeQualityCategory(logger, undefined), undefined);
+  t.is(fixCodeQualityCategory(logger, "random string"), "random string");
+  t.is(fixCodeQualityCategory(logger, "kotlin"), "kotlin");
+});

src/analyze.ts

@@ -9,6 +9,7 @@ import * as yaml from "js-yaml";
 import {
   getRequiredInput,
   getTemporaryDirectory,
+  isDefaultSetup,
   PullRequestBranches,
 } from "./actions-util";
 import { getApiClient } from "./api-client";
@@ -602,6 +603,47 @@ export function resolveQuerySuiteAlias(
   return maybeSuite;
 }
 
+/** Adjusts the category string for a Code Quality SARIF file if an "old"
+ * category identifier is used by Default Setup.
+ */
+export function fixCodeQualityCategory(
+  logger: Logger,
+  category?: string,
+): string | undefined {
+  // A mapping from old categories to new ones.
+  const qualityCategoryMapping: Record<string, string> = {
+    "c#": "csharp",
+    cpp: "c-cpp",
+    c: "c-cpp",
+    "c++": "c-cpp",
+    java: "java-kotlin",
+    javascript: "javascript-typescript",
+    typescript: "javascript-typescript",
+    kotlin: "java-kotlin",
+  };
+
+  // The `category` should always be set by Default Setup. We perform this check
+  // to avoid potential issues if Code Quality supports Advanced Setup in the future
+  // and before this workaround is removed.
+  if (
+    category !== undefined &&
+    isDefaultSetup() &&
+    category.startsWith("/language:")
+  ) {
+    const language = category.substring("/language:".length);
+    const mappedLanguage = qualityCategoryMapping[language];
+    if (mappedLanguage) {
+      const newCategory = `/language:${mappedLanguage}`;
+      logger.info(
+        `Adjusted category for Code Quality from '${category}' to '${newCategory}'.`,
+      );
+      return newCategory;
+    }
+  }
+
+  return category;
+}
+
 // Runs queries and creates sarif files in the given folder
 export async function runQueries(
   sarifFolder: string,
@@ -697,7 +739,10 @@ export async function runQueries(
       let qualityAnalysisSummary: string | undefined = undefined;
       if (config.augmentationProperties.qualityQueriesInput !== undefined) {
         logger.info(`Interpreting quality results for ${language}`);
-        const qualityCategory = automationDetailsId;
+        const qualityCategory = fixCodeQualityCategory(
+          logger,
+          automationDetailsId,
+        );
         const qualitySarifFile = path.join(
           sarifFolder,
           `${language}.quality.sarif`,