Refactor RCA tools and add new types for improved functionality and readability

Author: tech-sushant

src/tools/rca-agent-utils/format-rca.ts

@@ -1,33 +1,47 @@
+import logger from "../../logger.js";
+
 // Utility function to format RCA data for better readability
 export function formatRCAData(rcaData: any): string {
+  logger.info(
+    `Formatting RCA data for output: ${JSON.stringify(rcaData, null, 2)}`,
+  );
   if (!rcaData || !rcaData.testCases || rcaData.testCases.length === 0) {
     return "No RCA data available.";
   }
 
   let output = "## Root Cause Analysis Report\n\n";
-  
+
   rcaData.testCases.forEach((testCase: any, index: number) => {
-    // Show test case name first with smaller heading
-    output += `### ${testCase.displayName || `Test Case ${index + 1}`}\n`;
+    // Show test case ID with smaller heading
+    output += `### Test Case ${index + 1}\n`;
     output += `**Test ID:** ${testCase.id}\n`;
     output += `**Status:** ${testCase.state}\n\n`;
 
-    if (testCase.rcaData?.originalResponse?.rcaData) {
-      const rca = testCase.rcaData.originalResponse.rcaData;
-      
+    // Access RCA data from the correct path
+    const rca = testCase.rcaData?.rcaData;
+
+    if (rca) {
       if (rca.root_cause) {
         output += `**Root Cause:** ${rca.root_cause}\n\n`;
       }
-      
+
+      if (rca.failure_type) {
+        output += `**Failure Type:** ${rca.failure_type}\n\n`;
+      }
+
       if (rca.description) {
-        output += `**Description:**\n${rca.description}\n\n`;
+        output += `**Detailed Analysis:**\n${rca.description}\n\n`;
       }
-      
+
       if (rca.possible_fix) {
         output += `**Recommended Fix:**\n${rca.possible_fix}\n\n`;
       }
+    } else if (testCase.rcaData?.error) {
+      output += `**Error:** ${testCase.rcaData.error}\n\n`;
+    } else if (testCase.state === "failed") {
+      output += `**Note:** RCA analysis failed or is not available for this test case.\n\n`;
     }
-    
+
     output += "---\n\n";
   });
 

src/tools/rca-agent-utils/get-failed-test-id.ts

@@ -1,83 +1,76 @@
-interface TestDetails {
-  status: string;
-  details: any;
-  children?: TestDetails[];
-  display_name?: string;
-}
+import { TestStatus, FailedTestInfo, TestRun, TestDetails } from "./types.js";
 
-interface TestRun {
-  hierarchy: TestDetails[];
-  pagination?: {
-    has_next: boolean;
-    next_page: string | null;
-  };
-}
+let hasNext = false;
+let nextPageUrl: string | null = null;
 
-export interface FailedTestInfo {
-  id: string;
-  displayName: string;
-}
-
-export async function getFailedTestIds(
+export async function getTestIds(
   buildId: string,
   authString: string,
+  status?: TestStatus,
 ): Promise<FailedTestInfo[]> {
-  const baseUrl = `https://api-automation.browserstack.com/ext/v1/builds/${buildId}/testRuns?test_statuses=failed`;
-  let nextUrl = baseUrl;
+  const baseUrl = `https://api-automation.browserstack.com/ext/v1/builds/${buildId}/testRuns`;
+
+  // Build initial URL
+  const initialUrl = new URL(baseUrl);
+  if (status) initialUrl.searchParams.set("test_statuses", status);
+
+  // Use stored nextPageUrl if available, otherwise fresh URL
+  const requestUrl =
+    hasNext && nextPageUrl ? nextPageUrl : initialUrl.toString();
   let allFailedTests: FailedTestInfo[] = [];
-  let requestNumber = 0;
 
   // Construct Basic auth header
   const encodedCredentials = Buffer.from(authString).toString("base64");
   const authHeader = `Basic ${encodedCredentials}`;
 
   try {
-    while (true) {
-      requestNumber++;
-
-      const response = await fetch(nextUrl, {
-        headers: {
-          Authorization: authHeader,
-          "Content-Type": "application/json",
-        },
-      });
-
-      if (!response.ok) {
-        throw new Error(
-          `Failed to fetch test runs: ${response.status} ${response.statusText}`,
-        );
-      }
-
-      const data = (await response.json()) as TestRun;
-
-      // Extract failed IDs from current page
-      if (data.hierarchy && data.hierarchy.length > 0) {
-        const currentFailedTests = extractFailedTestIds(data.hierarchy);
-        allFailedTests = allFailedTests.concat(currentFailedTests);
-      }
-
-      // Check for pagination termination conditions
-      if (!data.pagination?.has_next || !data.pagination.next_page) {
-        break;
-      }
+    const response = await fetch(requestUrl, {
+      headers: {
+        Authorization: authHeader,
+        "Content-Type": "application/json",
+      },
+    });
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to fetch test runs: ${response.status} ${response.statusText}`,
+      );
+    }
 
-      // Safety limit to prevent runaway requests
-      if (requestNumber >= 5) {
-        break;
-      }
+    const data = (await response.json()) as TestRun;
 
-      // Prepare next request
-      nextUrl = `${baseUrl}?next_page=${encodeURIComponent(data.pagination.next_page)}`;
+    // Extract failed IDs from current page
+    if (data.hierarchy && data.hierarchy.length > 0) {
+      allFailedTests = extractFailedTestIds(data.hierarchy);
     }
 
-    // Return unique failed test IDs
+    // Update pagination state in memory
+    hasNext = data.pagination?.has_next || false;
+    nextPageUrl =
+      hasNext && data.pagination?.next_page
+        ? buildNextPageUrl(baseUrl, status, data.pagination.next_page)
+        : null;
+
+    // Return failed test IDs from current page only
     return allFailedTests;
   } catch (error) {
     console.error("Error fetching failed tests:", error);
     throw error;
   }
 }
 
+// Helper to build next page URL safely
+function buildNextPageUrl(
+  baseUrl: string,
+  status: TestStatus | undefined,
+  nextPage: string,
+): string {
+  const url = new URL(baseUrl);
+  if (status) url.searchParams.set("test_statuses", status);
+  url.searchParams.set("next_page", nextPage);
+  return url.toString();
+}
+
 // Recursive function to extract failed test IDs from hierarchy
 function extractFailedTestIds(hierarchy: TestDetails[]): FailedTestInfo[] {
   let failedTests: FailedTestInfo[] = [];
@@ -87,10 +80,7 @@ function extractFailedTestIds(hierarchy: TestDetails[]): FailedTestInfo[] {
       if (node.details?.observability_url) {
         const idMatch = node.details.observability_url.match(/details=(\d+)/);
         if (idMatch) {
-          failedTests.push({
-            id: idMatch[1],
-            displayName: node.display_name || `Test ${idMatch[1]}`
-          });
+          failedTests.push({ id: idMatch[1] });
         }
       }
     }