Add processCliConfigurationError method

Author: angelapwen

lib/cli-config-errors.js

@@ -1,3 +1,4 @@
+/** Error messages from the CLI that we handle specially. */
 export enum CliError {
   IncompatibleWithActionVersion,
   InitCalledTwice,
@@ -74,3 +75,47 @@ export function isCliConfigurationError(
   }
   return true;
 }
+
+/**
+ * Maps a CLI error class to the error message that the Action should return in
+ * case of this error. Leave undefined if the CLI error message should be returned
+ * directly.
+ *
+ * Otherwise, specify an error message to return for this CLI error; and whether the
+ * original CLI error text should be appended to it.
+ */
+export const cliToActionErrorsConfig: Record<
+  CliError,
+  | {
+      actionErrorMessage: string;
+      appendCliError: boolean;
+    }
+  | undefined
+> = {
+  [CliError.InitCalledTwice]: {
+    actionErrorMessage: `Is the "init" action called twice in the same job?`,
+    appendCliError: true,
+  },
+  [CliError.NoJavaScriptTypeScriptCodeFound]: {
+    actionErrorMessage:
+      "No code found during the build. Please see: " +
+      "https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build",
+    appendCliError: false,
+  },
+  [CliError.IncompatibleWithActionVersion]: undefined,
+  [CliError.InvalidSourceRoot]: undefined,
+};
+
+export function processCliConfigurationError(
+  cliError: CliError,
+  cliErrorMessage: string,
+): string {
+  const cliToActionErrorConfig = cliToActionErrorsConfig[cliError];
+  if (cliToActionErrorConfig === undefined) {
+    return cliErrorMessage;
+  }
+
+  return cliToActionErrorConfig.appendCliError
+    ? cliToActionErrorConfig.actionErrorMessage + cliErrorMessage
+    : cliToActionErrorConfig.actionErrorMessage;
+}

lib/cli-config-errors.js.map

@@ -12,7 +12,11 @@ import {
   isAnalyzingDefaultBranch,
 } from "./actions-util";
 import * as api from "./api-client";
-import { CliError, isCliConfigurationError } from "./cli-config-errors";
+import {
+  CliError,
+  isCliConfigurationError,
+  processCliConfigurationError,
+} from "./cli-config-errors";
 import type { Config } from "./config-utils";
 import { EnvVar } from "./environment";
 import {
@@ -636,17 +640,29 @@ export async function getCodeQLForCmd(
         if (e instanceof CommandInvocationError) {
           if (isCliConfigurationError(CliError.InitCalledTwice, e.message)) {
             throw new util.UserError(
-              `Is the "init" action called twice in the same job? ${e.message}`,
+              processCliConfigurationError(CliError.InitCalledTwice, e.message),
             );
           }
           if (
             isCliConfigurationError(
               CliError.IncompatibleWithActionVersion,
               e.message,
-            ) ||
-            isCliConfigurationError(CliError.InvalidSourceRoot, e.message)
+            )
           ) {
-            throw new util.UserError(e.message);
+            throw new util.UserError(
+              processCliConfigurationError(
+                CliError.IncompatibleWithActionVersion,
+                e.message,
+              ),
+            );
+          }
+          if (isCliConfigurationError(CliError.InvalidSourceRoot, e.message)) {
+            throw new util.UserError(
+              processCliConfigurationError(
+                CliError.InvalidSourceRoot,
+                e.message,
+              ),
+            );
           }
         }
         throw e;
@@ -727,8 +743,10 @@ export async function getCodeQLForCmd(
           )
         ) {
           throw new util.UserError(
-            "No code found during the build. Please see: " +
-              "https://gh.io/troubleshooting-code-scanning/no-source-code-seen-during-build",
+            processCliConfigurationError(
+              CliError.NoJavaScriptTypeScriptCodeFound,
+              e.stderr,
+            ),
           );
         }
         throw e;