Add UserError

This commit adds a `UserError` class that should be thrown when the
cause of an error is fundamentally from user configuration.

When sending status reports, avoid sending a `failure` for `UserError`s.
This will prevent our diagnostics from pinging us for errors outside of
our control.

src/actions-util.ts

@@ -8,7 +8,12 @@ import * as yaml from "js-yaml";
 
 import * as api from "./api-client";
 import * as sharedEnv from "./shared-environment";
-import { getRequiredEnvParam, GITHUB_DOTCOM_URL, isHTTPError } from "./util";
+import {
+  getRequiredEnvParam,
+  GITHUB_DOTCOM_URL,
+  isHTTPError,
+  UserError,
+} from "./util";
 
 /**
  * The utils in this module are meant to be run inside of the action only.
@@ -545,7 +550,12 @@ export async function getRef(): Promise<string> {
 }
 
 type ActionName = "init" | "autobuild" | "finish" | "upload-sarif";
-type ActionStatus = "starting" | "aborted" | "success" | "failure";
+type ActionStatus =
+  | "starting"
+  | "aborted"
+  | "success"
+  | "failure"
+  | "user-error";
 
 export interface StatusReportBase {
   /** ID of the workflow run containing the action run. */
@@ -588,6 +598,17 @@ export interface StatusReportBase {
   exception?: string;
 }
 
+export function getActionsStatus(
+  error?: unknown,
+  otherFailureCause?: string
+): ActionStatus {
+  if (error || otherFailureCause) {
+    return error instanceof UserError ? "user-error" : "failure";
+  } else {
+    return "success";
+  }
+}
+
 /**
  * Compose a StatusReport.
  *
@@ -650,7 +671,12 @@ export async function createStatusReportBase(
   if (exception) {
     statusReport.exception = exception;
   }
-  if (status === "success" || status === "failure" || status === "aborted") {
+  if (
+    status === "success" ||
+    status === "failure" ||
+    status === "aborted" ||
+    status === "user-error"
+  ) {
     statusReport.completed_at = new Date().toISOString();
   }
   const matrix = getRequiredInput("matrix");

src/analyze-action.ts

@@ -39,10 +39,10 @@ export async function sendStatusReport(
   stats: AnalysisStatusReport | undefined,
   error?: Error
 ) {
-  const status =
-    stats?.analyze_failure_language !== undefined || error !== undefined
-      ? "failure"
-      : "success";
+  const status = actionsUtil.getActionsStatus(
+    error,
+    stats?.analyze_failure_language
+  );
   const statusReportBase = await actionsUtil.createStatusReportBase(
     "finish",
     status,

src/autobuild-action.ts

@@ -2,6 +2,7 @@ import * as core from "@actions/core";
 
 import {
   createStatusReportBase,
+  getActionsStatus,
   getTemporaryDirectory,
   sendStatusReport,
   StatusReportBase,
@@ -30,10 +31,7 @@ async function sendCompletedStatusReport(
 ) {
   initializeEnvironment(Mode.actions, pkg.version);
 
-  const status =
-    failingLanguage !== undefined || cause !== undefined
-      ? "failure"
-      : "success";
+  const status = getActionsStatus(cause, failingLanguage);
   const statusReportBase = await createStatusReportBase(
     "autobuild",
     status,

src/init-action.ts

@@ -4,6 +4,7 @@ import * as core from "@actions/core";
 
 import {
   createStatusReportBase,
+  getActionsStatus,
   getOptionalInput,
   getRequiredInput,
   getTemporaryDirectory,
@@ -289,7 +290,7 @@ async function run() {
     await sendStatusReport(
       await createStatusReportBase(
         "init",
-        "failure",
+        getActionsStatus(error),
         startedAt,
         String(error),
         error instanceof Error ? error.stack : undefined

src/init.ts

@@ -119,9 +119,14 @@ export async function runInit(
       e.message?.includes("Refusing to create databases") &&
       e.message.includes("exists and is not an empty directory.")
     ) {
-      throw new Error(
+      throw new util.UserError(
         `Is the "init" action called twice in the same job? ${e.message}`
       );
+    } else if (
+      e instanceof Error &&
+      e.message?.includes("is not compatible with this CodeQL CLI")
+    ) {
+      throw new util.UserError(e.message);
     } else {
       throw e;
     }

src/upload-sarif-action.ts

@@ -81,7 +81,7 @@ async function run() {
     await actionsUtil.sendStatusReport(
       await actionsUtil.createStatusReportBase(
         "upload-sarif",
-        "failure",
+        actionsUtil.getActionsStatus(error),
         startedAt,
         message,
         stack

src/util.ts

@@ -580,6 +580,16 @@ export class HTTPError extends Error {
   }
 }
 
+/**
+ * An Error class that indicates an error that occurred due to
+ * a misconfiguration of the action or the CodeQL CLI.
+ */
+export class UserError extends Error {
+  constructor(message: string) {
+    super(message);
+  }
+}
+
 export function isHTTPError(arg: any): arg is HTTPError {
   return arg?.status !== undefined && Number.isInteger(arg.status);
 }