fix(site): ensure empty string error shows default message (coder#10196)

Kira-Pilot · web-flow · commit 7c6687813d0e · 2023-10-11T13:54:58.000-04:00
* fix(site): ensure empty string error shows default message

* added test

* added logging

* asserting axios message

* cleanup and add test
diff --git a/site/src/api/errors.test.ts b/site/src/api/errors.test.ts
@@ -3,6 +3,7 @@ import {
   getValidationErrorMessage,
   isApiError,
   mapApiErrorToFieldErrors,
+  getErrorMessage,
 } from "./errors";
 
 describe("isApiError", () => {
@@ -82,4 +83,21 @@ describe("getValidationErrorMessage", () => {
       ),
     ).toEqual("");
   });
+
+  it("returns default message for error that is empty string", () => {
+    expect(getErrorMessage("", "Something went wrong.")).toBe(
+      "Something went wrong.",
+    );
+  });
+
+  it("returns default message for 404 API response", () => {
+    expect(
+      getErrorMessage(
+        mockApiError({
+          message: "",
+        }),
+        "Something went wrong.",
+      ),
+    ).toBe("Something went wrong.");
+  });
 });
diff --git a/site/src/api/errors.ts b/site/src/api/errors.ts
@@ -62,10 +62,13 @@ export const getErrorMessage = (
   error: unknown,
   defaultMessage: string,
 ): string => {
-  if (isApiError(error)) {
+  // if error is API error
+  // 404s result in the default message being returned
+  if (isApiError(error) && error.response.data.message) {
     return error.response.data.message;
   }
-  if (typeof error === "string") {
+  // if error is a non-empty string
+  if (error && typeof error === "string") {
     return error;
   }
   return defaultMessage;
