Merge pull request #1923 from github/henrymercer/fix-resolve-environment-aliases

Fix using the `resolve-environment` Action with language aliases

src/codeql.ts

@@ -128,7 +128,7 @@ export interface CodeQL {
    */
   resolveBuildEnvironment(
     workingDir: string | undefined,
-    language: Language,
+    language: string,
   ): Promise<ResolveBuildEnvironmentOutput>;
 
   /**
@@ -624,6 +624,7 @@ export async function getCodeQLForCmd(
           "--db-cluster",
           config.dbLocation,
           `--source-root=${sourceRoot}`,
+          ...(await getLanguageAliasingArguments(this)),
           ...extraArgs,
           ...getExtraOptionsFromEnv(["database", "init"]),
         ],
@@ -737,20 +738,12 @@ export async function getCodeQLForCmd(
       }
     },
     async betterResolveLanguages() {
-      const extraArgs: string[] = [];
-
-      if (
-        await util.codeQlVersionAbove(this, CODEQL_VERSION_LANGUAGE_ALIASING)
-      ) {
-        extraArgs.push("--extractor-include-aliases");
-      }
-
       const codeqlArgs = [
         "resolve",
         "languages",
         "--format=betterjson",
         "--extractor-options-verbosity=4",
-        ...extraArgs,
+        ...(await getLanguageAliasingArguments(this)),
         ...getExtraOptionsFromEnv(["resolve", "languages"]),
       ];
       const output = await runTool(cmd, codeqlArgs);
@@ -787,12 +780,13 @@ export async function getCodeQLForCmd(
     },
     async resolveBuildEnvironment(
       workingDir: string | undefined,
-      language: Language,
+      language: string,
     ) {
       const codeqlArgs = [
         "resolve",
         "build-environment",
         `--language=${language}`,
+        ...(await getLanguageAliasingArguments(this)),
         ...getExtraOptionsFromEnv(["resolve", "build-environment"]),
       ];
       if (workingDir !== undefined) {
@@ -1082,6 +1076,7 @@ export async function getCodeQLForCmd(
           "extractor",
           "--format=json",
           `--language=${language}`,
+          ...(await getLanguageAliasingArguments(this)),
           ...getExtraOptionsFromEnv(["resolve", "extractor"]),
         ],
         {
@@ -1470,3 +1465,10 @@ async function isDiagnosticsExportInvalidSarifFixed(
     CODEQL_VERSION_DIAGNOSTICS_EXPORT_FIXED,
   );
 }
+
+async function getLanguageAliasingArguments(codeql: CodeQL): Promise<string[]> {
+  if (await util.codeQlVersionAbove(codeql, CODEQL_VERSION_LANGUAGE_ALIASING)) {
+    return ["--extractor-include-aliases"];
+  }
+  return [];
+}

src/resolve-environment-action.ts

@@ -8,7 +8,6 @@ import {
 import { getGitHubVersion } from "./api-client";
 import { CommandInvocationError } from "./codeql";
 import * as configUtils from "./config-utils";
-import { Language, parseLanguage } from "./languages";
 import { getActionsLogger } from "./logging";
 import { runResolveBuildEnvironment } from "./resolve-environment";
 import {
@@ -44,16 +43,6 @@ async function run() {
       return;
     }
 
-    const language: Language | undefined = parseLanguage(
-      getRequiredInput("language"),
-    );
-
-    if (language === undefined) {
-      throw new Error(
-        `Did not recognize the language "${getRequiredInput("language")}".`,
-      );
-    }
-
     const gitHubVersion = await getGitHubVersion();
     checkGitHubVersionInRange(gitHubVersion, logger);
 
@@ -69,7 +58,7 @@ async function run() {
       config.codeQLCmd,
       logger,
       workingDirectory,
-      language,
+      getRequiredInput("language"),
     );
     core.setOutput(ENVIRONMENT_OUTPUT_NAME, result);
   } catch (unwrappedError) {

src/resolve-environment.ts

@@ -1,5 +1,9 @@
-import { CODEQL_VERSION_RESOLVE_ENVIRONMENT, getCodeQL } from "./codeql";
-import { Language } from "./languages";
+import {
+  CODEQL_VERSION_LANGUAGE_ALIASING,
+  CODEQL_VERSION_RESOLVE_ENVIRONMENT,
+  getCodeQL,
+} from "./codeql";
+import { parseLanguage } from "./languages";
 import { Logger } from "./logging";
 import * as util from "./util";
 
@@ -7,11 +11,27 @@ export async function runResolveBuildEnvironment(
   cmd: string,
   logger: Logger,
   workingDir: string | undefined,
-  language: Language,
+  languageInput: string,
 ) {
-  logger.startGroup(`Attempting to resolve build environment for ${language}`);
+  logger.startGroup(
+    `Attempting to resolve build environment for ${languageInput}`,
+  );
 
   const codeql = await getCodeQL(cmd);
+
+  let language = languageInput;
+  // If the CodeQL CLI version in use supports language aliasing, give the CLI the raw language
+  // input. Otherwise, parse the language input and give the CLI the parsed language.
+  if (
+    !(await util.codeQlVersionAbove(codeql, CODEQL_VERSION_LANGUAGE_ALIASING))
+  ) {
+    const parsedLanguage = parseLanguage(languageInput)?.toString();
+    if (parsedLanguage === undefined) {
+      throw new Error(`Did not recognize the language '${languageInput}'.`);
+    }
+    language = parsedLanguage;
+  }
+
   let result = {};
 
   // If the CodeQL version in use does not support the `resolve build-environment`