fix: html error formatting MAASENG-2935 (#5405)

Co-authored-by: Jones Ogolo <47540149+Jay-Topher@users.noreply.github.com>
canonical · Apr 15, 2024 · 4265c3d · 4265c3d
1 parent f9e9634
commit 4265c3d
Show file tree

Hide file tree

Showing 2 changed files with 66 additions and 4 deletions.
diff --git a/src/app/utils/formatErrors.test.ts b/src/app/utils/formatErrors.test.ts
@@ -51,4 +51,23 @@ describe("formatErrors", () => {
       "The primary rack controller must be up and running to set a secondary rack controller."
     );
   });
+
+  it("can handle HTML", () => {
+    const html = `
+    <html>
+      <head>
+        <title>502 Bad Gateway</title>
+      </head>
+      <body>
+        <center>
+          <h1>502 Bad Gateway</h1>
+        </center>
+        <hr>
+        <center>nginx/1.18.0 (Ubuntu)</center>
+      </body>
+    </html>
+    `;
+
+    expect(formatErrors(html)).toEqual("502 Bad Gateway nginx/1.18.0 (Ubuntu)");
+  });
 });
diff --git a/src/app/utils/formatErrors.ts b/src/app/utils/formatErrors.ts
@@ -60,10 +60,34 @@ const parseObjectError = (
   return null;
 };
 
+const parseHtmlToText = (htmlContent: string): string | null => {
+  const bodyMatch = htmlContent.match(/<body[^>]*>([\s\S]*?)<\/body>/i);
+
+  if (bodyMatch) {
+    const bodyContent = bodyMatch[1];
+    const strippedText = bodyContent
+      // Remove all HTML tags from the body content
+      .replace(/<[^>]+>/g, "")
+      // Collapse multiple consecutive whitespace characters into a single space
+      .replace(/\s+/g, " ")
+      // Trim any leading or trailing whitespace from the resulting text
+      .trim();
+
+    return strippedText || null;
+  }
+
+  // Return the original content if the body tag is not found
+  return htmlContent;
+};
+
 type ErrorFormatter = (errors: any, errorKey?: string) => FlattenedError;
-const errorTypeFormatters: Record<string, ErrorFormatter> = {
+
+type ErrorTypeFormat = "string" | "object" | "html";
+
+const errorTypeFormatters: Record<ErrorTypeFormat, ErrorFormatter> = {
   string: parseJSONError,
   object: parseObjectError,
+  html: parseHtmlToText,
 };
 
 export type ErrorType<E = null, I = any, K extends keyof I = any> =
@@ -84,7 +108,26 @@ export const formatErrors = <E, I, K extends keyof I>(
   if (!errors) {
     return null;
   }
-  const errorType = typeof errors;
-  const formatErrors = errorTypeFormatters[errorType];
-  return formatErrors ? formatErrors(errors, errorKey) : null;
+
+  const isHTMLContent = (content: string): boolean => {
+    return /<\/?[a-z][\s\S]*>/i.test(content);
+  };
+
+  const getErrorType = (errors: ErrorType<E, I, K>): ErrorTypeFormat => {
+    if (typeof errors === "string" && isHTMLContent(errors)) {
+      return "html";
+    }
+    return typeof errors in errorTypeFormatters
+      ? (typeof errors as ErrorTypeFormat)
+      : "string";
+  };
+
+  const errorType = getErrorType(errors);
+  const formatErrorsByType = errorTypeFormatters[errorType];
+
+  if (formatErrorsByType) {
+    return formatErrorsByType(errors, errorKey);
+  }
+
+  return null;
 };