Fix: Centralize Axios error formatting and improve error handling in project and test case creation

ruturaj-browserstack · ruturaj-browserstack · commit 944ba4457a71 · 2025-04-30T13:54:54.000+05:30
diff --git a/src/lib/error.ts b/src/lib/error.ts
@@ -0,0 +1,30 @@
+import { AxiosError } from "axios";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+
+/**
+ * Formats an AxiosError into a CallToolResult with an appropriate message.
+ * @param err - The error object to format
+ * @param defaultText - The fallback error message
+ */
+export function formatAxiosError(
+  err: unknown,
+  defaultText: string,
+): CallToolResult {
+  let text = defaultText;
+
+  if (err instanceof AxiosError && err.response?.data) {
+    const message =
+      err.response.data.message ||
+      err.response.data.error ||
+      err.message ||
+      defaultText;
+    text = message;
+  } else if (err instanceof Error) {
+    text = err.message;
+  }
+
+  return {
+    content: [{ type: "text", text }],
+    isError: true,
+  };
+}
diff --git a/src/tools/testmanagement-utils/create-project-folder.ts b/src/tools/testmanagement-utils/create-project-folder.ts
@@ -1,7 +1,8 @@
-import axios, { AxiosError } from "axios";
+import axios from "axios";
 import config from "../../config";
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { formatAxiosError } from "../../lib/error"; // or correct path
 
 // Schema for combined project/folder creation
 export const CreateProjFoldSchema = z.object({
@@ -30,29 +31,6 @@ export const CreateProjFoldSchema = z.object({
 
 type CreateProjFoldArgs = z.infer<typeof CreateProjFoldSchema>;
 
-function formatAxiosError(
-  err: unknown,
-  defaultText: string,
-): { content: { type: "text"; text: string }[]; isError: true } {
-  let text = defaultText;
-
-  if (err instanceof AxiosError && err.response?.data) {
-    const { message: apiMessage } = err.response.data;
-    const status = err.response.status;
-
-    if (status >= 400 && status < 500 && apiMessage) {
-      text = apiMessage;
-    }
-  } else if (err instanceof Error) {
-    text = err.message;
-  }
-
-  return {
-    content: [{ type: "text" as const, text }],
-    isError: true,
-  };
-}
-
 /**
  * Creates a project and/or folder in BrowserStack Test Management.
  */
@@ -138,7 +116,7 @@ export async function createProjectOrFolder(
         content: [
           {
             type: "text",
-            text: `Folder created: ID=${folder.id}, name="${folder.name}" in project with identifier ${projId}`,
+            text: `Folder created: ID=${folder.id}, name=${folder.name} in project with identifier ${projId}`,
           },
         ],
       };
diff --git a/src/tools/testmanagement-utils/create-testcase.ts b/src/tools/testmanagement-utils/create-testcase.ts
@@ -1,6 +1,8 @@
-import axios, { AxiosError } from "axios";
+import axios from "axios";
 import config from "../../config";
 import { z } from "zod";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { formatAxiosError } from "../../lib/error"; // or correct
 
 interface TestCaseStep {
   step: string;
@@ -70,18 +72,15 @@ export const CreateTestCaseSchema = z.object({
   description: z
     .string()
     .optional()
-    .nullish()
     .describe("Brief description of the test case."),
   owner: z
     .string()
     .email()
     .describe("Email of the test case owner.")
-    .optional()
-    .nullish(),
+    .optional(),
   preconditions: z
     .string()
     .optional()
-    .nullish()
     .describe("Any preconditions (HTML allowed)."),
   test_case_steps: z
     .array(
@@ -101,15 +100,10 @@ export const CreateTestCaseSchema = z.object({
     .object({
       name: z
         .string()
-        .nullish()
         .describe(
-          "Issue tracker name,  For example, use jira for Jira, azure for Azure DevOps, or asana for Asana ​",
+          "Issue tracker name,  For example, use jira for Jira, azure for Azure DevOps, or asana for Asana.",
         ),
-      host: z
-        .string()
-        .url()
-        .describe("Base URL of the issue tracker.")
-        .nullish(),
+      host: z.string().url().describe("Base URL of the issue tracker."),
     })
     .optional(),
   tags: z
@@ -145,68 +139,52 @@ export function sanitizeArgs(args: any) {
 
 export async function createTestCase(
   params: TestCaseCreateRequest,
-): Promise<TestCaseResponse> {
-  const {
-    project_identifier,
-    folder_id,
-    name,
-    description,
-    owner,
-    preconditions,
-    test_case_steps,
-    issues,
-    issue_tracker,
-    tags,
-    custom_fields,
-  } = params;
-
-  const body = {
-    test_case: {
-      name,
-      description,
-      owner,
-      preconditions,
-      test_case_steps,
-      issues,
-      issue_tracker,
-      tags,
-      custom_fields,
-    },
-  };
+): Promise<CallToolResult> {
+  const body = { test_case: params };
 
   try {
     const response = await axios.post<TestCaseResponse>(
-      `https://test-management.browserstack.com/api/v2/projects/${project_identifier}/folders/${folder_id}/test-cases`,
+      `https://test-management.browserstack.com/api/v2/projects/${encodeURIComponent(
+        params.project_identifier,
+      )}/folders/${encodeURIComponent(params.folder_id)}/test-cases`,
       body,
       {
         auth: {
           username: config.browserstackUsername,
           password: config.browserstackAccessKey,
         },
-        headers: {
-          "Content-Type": "application/json",
-        },
+        headers: { "Content-Type": "application/json" },
       },
     );
 
-    // Check if the response indicates success
-    if (!response.data.data.success) {
-      throw new Error(
-        `Failed to create test case: ${JSON.stringify(response.data)}`,
-      );
+    const { data } = response.data;
+    if (!data.success) {
+      return {
+        content: [
+          {
+            type: "text",
+            text: `Failed to create test case: ${JSON.stringify(
+              response.data,
+            )}`,
+            isError: true,
+          },
+        ],
+        isError: true,
+      };
     }
 
-    return response.data;
-  } catch (error) {
-    if (error instanceof AxiosError) {
-      if (error.response?.data?.message) {
-        throw new Error(
-          `Failed to create test case: ${error.response.data.message}`,
-        );
-      } else {
-        throw new Error(`Failed to create test case: ${error.message}`);
-      }
-    }
-    throw error;
+    const tc = data.test_case;
+    return {
+      content: [
+        {
+          type: "text",
+          text: `Successfully created test case ${tc.identifier}: ${tc.title}`,
+        },
+        { type: "text", text: JSON.stringify(tc, null, 2) },
+      ],
+    };
+  } catch (err) {
+    // Delegate to our centralized Axios error formatter
+    return formatAxiosError(err, "Failed to create test case");
   }
 }
diff --git a/src/tools/testmanagement.ts b/src/tools/testmanagement.ts
@@ -20,13 +20,14 @@ export async function createProjectOrFolderTool(
 ): Promise<CallToolResult> {
   try {
     return await createProjectOrFolder(args);
-  } catch (error) {
-    const msg = error instanceof Error ? error.message : "Unknown error";
+  } catch (err) {
     return {
       content: [
         {
           type: "text",
-          text: `Failed to create project/folder: ${msg}`,
+          text: `Failed to create project/folder: ${
+            err instanceof Error ? err.message : "Unknown error"
+          }. Please open an issue on GitHub if the problem persists`,
           isError: true,
         },
       ],
@@ -44,28 +45,14 @@ export async function createTestCaseTool(
   // Sanitize input arguments
   const cleanedArgs = sanitizeArgs(args);
   try {
-    const response = await createTestCaseAPI(cleanedArgs);
-    const testCase = response.data.test_case;
-
-    return {
-      content: [
-        {
-          type: "text",
-          text: `Successfully created test case ${testCase.identifier}: "${testCase.title}"`,
-        },
-        {
-          type: "text",
-          text: JSON.stringify(testCase, null, 2),
-        },
-      ],
-    };
-  } catch (error) {
+    return await createTestCaseAPI(cleanedArgs);
+  } catch (err) {
     return {
       content: [
         {
           type: "text",
           text: `Failed to create test case: ${
-            error instanceof Error ? error.message : "Unknown error"
+            err instanceof Error ? err.message : "Unknown error"
           }. Please open an issue on GitHub if the problem persists`,
           isError: true,
         },
@@ -90,8 +77,6 @@ export default function addTestManagementTools(server: McpServer) {
     "createTestCase",
     "Use this tool to create a test case in BrowserStack Test Management.",
     CreateTestCaseSchema.shape,
-    async (args) => {
-      return createTestCaseTool(args as TestCaseCreateRequest);
-    },
+    createTestCaseTool,
   );
 }
diff --git a/tests/tools/testmanagement.test.ts b/tests/tools/testmanagement.test.ts
@@ -45,26 +45,22 @@ describe('createTestCaseTool', () => {
     custom_fields: { priority: 'high' },
   };
 
-  const mockTestCaseResponse = {
-    data: {
-      success: true,
-      test_case: {
-        identifier: 'TC-001',
-        title: 'Sample Test Case',
-        // additional fields omitted for brevity
-      },
-    },
+  const mockCallToolResult = {
+    content: [
+      { type: 'text', text: 'Successfully created test case TC-001: Sample Test Case' },
+      { type: 'text', text: JSON.stringify({ identifier: 'TC-001', title: 'Sample Test Case' }, null, 2) },
+    ],
+    isError: false,
   };
 
   it('should successfully create a test case', async () => {
-    (createTestCase as jest.Mock).mockResolvedValue(mockTestCaseResponse);
+    (createTestCase as jest.Mock).mockResolvedValue(mockCallToolResult);
 
     const result = await createTestCaseTool(validArgs);
 
     expect(sanitizeArgs).toHaveBeenCalledWith(validArgs);
     expect(createTestCase).toHaveBeenCalledWith(validArgs);
-    expect(result.content[0].text).toContain('Successfully created test case TC-001');
-    expect(result.content[1].text).toContain('"title": "Sample Test Case"');
+    expect(result).toBe(mockCallToolResult);
   });
 
   it('should handle API errors while creating test case', async () => {
@@ -134,7 +130,7 @@ describe('createProjectOrFolderTool', () => {
     const result = await createProjectOrFolderTool(validProjectArgs);
 
     expect(result.isError).toBe(true);
-    expect(result.content[0].text).toContain('Failed to create project/folder: Failed to create project/folder');
+    expect(result.content[0].text).toContain('Failed to create project/folder: Failed to create project/folder. Please open an issue on GitHub if the problem persists');
   });
 
   it('should handle unknown error while creating project or folder', async () => {
@@ -143,6 +139,6 @@ describe('createProjectOrFolderTool', () => {
     const result = await createProjectOrFolderTool(validProjectArgs);
 
     expect(result.isError).toBe(true);
-    expect(result.content[0].text).toContain('Failed to create project/folder: Unknown error');
+    expect(result.content[0].text).toContain('Failed to create project/folder: Unknown error. Please open an issue on GitHub if the problem persists');
   });
 });
