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

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

Author: henrymercer

.github/workflows/__resolve-environment-action.yml

@@ -1,17 +1,29 @@
 name: "Resolve environment"
-description: "Tests that the resolve-environment action works for Go"
-versions: ["stable-v2.13.4"]
+description: "Tests that the resolve-environment action works for Go and JavaScript/TypeScript"
+versions: ["stable-v2.13.4", "default", "latest", "nightly-latest"]
 steps:
   - uses: ./../action/init
     with:
-      languages: go
+      languages: ${{ matrix.version == 'stable-v2.13.4' && 'go' || 'go,javascript-typescript' }}
       tools: ${{ steps.prepare-test.outputs.tools-url }}
 
-  - uses: ./../action/resolve-environment
-    id: resolve-environment
+  - name: Resolve environment for Go
+    uses: ./../action/resolve-environment
+    id: resolve-environment-go
     with:
       language: go
 
-  - name: "Fail if no Go configuration was returned"
-    if: (!fromJSON(steps.resolve-environment.outputs.environment).configuration.go)
+  - name: Fail if Go configuration missing
+    if: (!fromJSON(steps.resolve-environment-go.outputs.environment).configuration.go)
+    run: exit 1
+
+  - name: Resolve environment for JavaScript/TypeScript
+    if: matrix.version != 'stable-v2.13.4'
+    uses: ./../action/resolve-environment
+    id: resolve-environment-js
+    with:
+      language: javascript-typescript
+
+  - name: Fail if JavaScript/TypeScript configuration present
+    if: matrix.version != 'stable-v2.13.4' && fromJSON(steps.resolve-environment-js.outputs.environment).configuration.javascript
     run: exit 1

lib/codeql.js

@@ -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 [];
+}

lib/codeql.js.map

@@ -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) {