chore: add ActionError for expected user errors

Author: cjquines

dist/build.js

@@ -1,11 +1,12 @@
 import spawn from "nano-spawn";
 import { getInput } from "./compat";
 import { getMergeBase, saveConfig } from "./config";
+import { ActionError } from "./error";
 import { logger } from "./logger";
 
 function assertRef(ref: string): asserts ref is "base" | "head" {
   if (ref !== "base" && ref !== "head") {
-    throw new Error(`Expected ref to be 'base' or 'head', but was ${ref}`);
+    throw new ActionError(`Expected ref to be 'base' or 'head', but was ${ref}`);
   }
 }
 
@@ -32,7 +33,7 @@ async function main() {
     // Callers come in from checkout-pr-ref against base; save the config.
     const { hasOAS, savedSha } = await saveConfig({ oasPath, configPath });
     if (!hasOAS) {
-      throw new Error(`Expected OpenAPI spec at ${oasPath}.`);
+      throw new ActionError(`Expected OpenAPI spec at ${oasPath}.`);
     }
     if (savedSha !== null && savedSha !== mergeBaseSha) {
       logger.warn(

dist/checkoutPRRef.js

@@ -0,0 +1,11 @@
+/**
+ * An error that represents an expected failure in the action (e.g. invalid input,
+ * missing files, auth failures). These are distinguished from unexpected internal
+ * errors so that we don't prompt users to file a bug report.
+ */
+export class ActionError extends Error {
+  constructor(message: string, options?: ErrorOptions) {
+    super(message, options);
+    this.name = "ActionError";
+  }
+}

dist/index.js

@@ -3,6 +3,7 @@ import { getStainlessClient } from "./stainless";
 import { readFileSync, writeFileSync } from "node:fs";
 import YAML from "yaml";
 import { getBooleanInput, getInput, getStainlessAuth } from "./compat";
+import { ActionError } from "./error";
 import { logger } from "./logger";
 
 // https://www.conventionalcommits.org/en/v1.0.0/
@@ -30,14 +31,14 @@ export async function main() {
   if (configPath && guessConfig) {
     const errorMsg = "Can't set both configPath and guessConfig";
     logger.error(errorMsg);
-    throw Error(errorMsg);
+    throw new ActionError(errorMsg);
   }
 
   if (commitMessage && !isValidConventionalCommitMessage(commitMessage)) {
     const errorMsg =
       "Invalid commit message format. Please follow the Conventional Commits format: https://www.conventionalcommits.org/en/v1.0.0/";
     logger.error(errorMsg);
-    throw Error(errorMsg);
+    throw new ActionError(errorMsg);
   }
 
   if (!projectName) {
@@ -48,7 +49,7 @@ export async function main() {
     if (projects.data.length === 0) {
       const errorMsg = "No projects found. Please create a project first.";
       logger.error(errorMsg);
-      throw Error(errorMsg);
+      throw new ActionError(errorMsg);
     }
     projectName = projects.data[0]!.slug;
     if (projects.data.length > 1) {
@@ -77,15 +78,15 @@ export async function main() {
       response.errors,
     )} See more details in the Stainless Studio.`;
     logger.error(errorMsg);
-    throw Error(errorMsg);
+    throw new ActionError(errorMsg);
   }
   logger.info("Uploaded!");
 
   if (outputPath) {
     if (!response.decoratedSpec) {
       const errorMsg = "Failed to get decorated spec";
       logger.error(errorMsg);
-      throw Error(errorMsg);
+      throw new ActionError(errorMsg);
     }
     // Decorated spec is currently always YAML, so convert it to JSON if needed.
     if (!(outputPath.endsWith(".yml") || outputPath.endsWith(".yaml"))) {