RCA data fetching by improving pagination handling

Author: tech-sushant

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

@@ -1,76 +1,66 @@
 import { TestStatus, FailedTestInfo, TestRun, TestDetails } from "./types.js";
 
-let hasNext = false;
-let nextPageUrl: string | null = null;
-
 export async function getTestIds(
   buildId: string,
   authString: string,
   status?: TestStatus,
 ): Promise<FailedTestInfo[]> {
   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 url = status ? `${baseUrl}?test_statuses=${status}` : baseUrl;
   let allFailedTests: FailedTestInfo[] = [];
+  let requestNumber = 0;
 
   // Construct Basic auth header
   const encodedCredentials = Buffer.from(authString).toString("base64");
   const authHeader = `Basic ${encodedCredentials}`;
 
   try {
-    const response = await fetch(requestUrl, {
-      headers: {
-        Authorization: authHeader,
-        "Content-Type": "application/json",
-      },
-    });
+    while (true) {
+      requestNumber++;
+
+      const response = await fetch(url, {
+        headers: {
+          Authorization: authHeader,
+          "Content-Type": "application/json",
+        },
+      });
+
+      if (!response.ok) {
+        throw new Error(
+          `Failed to fetch test runs: ${response.status} ${response.statusText}`,
+        );
+      }
 
-    if (!response.ok) {
-      throw new Error(
-        `Failed to fetch test runs: ${response.status} ${response.statusText}`,
-      );
-    }
+      const data = (await response.json()) as TestRun;
 
-    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);
+      }
 
-    // Extract failed IDs from current page
-    if (data.hierarchy && data.hierarchy.length > 0) {
-      allFailedTests = extractFailedTestIds(data.hierarchy);
-    }
+      // Check for pagination termination conditions
+      if (!data.pagination?.has_next || !data.pagination.next_page) {
+        break;
+      }
+
+      // Safety limit to prevent runaway requests
+      if (requestNumber >= 5) {
+        break;
+      }
 
-    // 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;
+      // Prepare next request
+      url = `${baseUrl}?next_page=${encodeURIComponent(data.pagination.next_page)}`;
+    }
 
-    // Return failed test IDs from current page only
+    // Return unique failed test IDs
     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[] = [];
@@ -80,7 +70,10 @@ 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] });
+          failedTests.push({
+            test_id: idMatch[1],
+            test_name: node.display_name || `Test ${idMatch[1]}`,
+          });
         }
       }
     }

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

@@ -1,4 +1,3 @@
-import { FailedTestInfo } from "./types.js";
 import { RCAState, RCATestCase, RCAResponse } from "./types.js";
 
 interface ScanProgressContext {
@@ -76,19 +75,19 @@ async function updateProgress(
 }
 
 async function fetchInitialRCA(
-  testInfo: FailedTestInfo,
+  testId: string,
   headers: Record<string, string>,
   baseUrl: string,
 ): Promise<RCATestCase> {
-  const url = baseUrl.replace("{testId}", testInfo.id);
+  const url = baseUrl.replace("{testId}", testId);
 
   try {
     const response = await fetch(url, { headers });
 
     if (!response.ok) {
       return {
-        id: testInfo.id,
-        testRunId: testInfo.id,
+        id: testId,
+        testRunId: testId,
         state: RCAState.LOG_FETCH_ERROR,
         rcaData: {
           error: `HTTP ${response.status}: Failed to start RCA analysis`,
@@ -115,8 +114,8 @@ async function fetchInitialRCA(
     else resultState = RCAState.PENDING;
 
     return {
-      id: testInfo.id,
-      testRunId: testInfo.id,
+      id: testId,
+      testRunId: testId,
       state: resultState,
       ...(resultState === RCAState.COMPLETED && { rcaData: data }),
       ...(isFailedState(resultState) &&
@@ -129,8 +128,8 @@ async function fetchInitialRCA(
     };
   } catch (error) {
     return {
-      id: testInfo.id,
-      testRunId: testInfo.id,
+      id: testId,
+      testRunId: testId,
       state: RCAState.LLM_SERVICE_ERROR,
       rcaData: {
         error:
@@ -267,7 +266,7 @@ export async function getRCAData(
   await notifyProgress(context, "Starting RCA analysis for test cases...", 0);
 
   const testCases = await Promise.all(
-    testIds.map((testId) => fetchInitialRCA({ id: testId }, headers, baseUrl)),
+    testIds.map((testId) => fetchInitialRCA(testId, headers, baseUrl)),
   );
 
   const inProgressCount = testCases.filter((tc) =>

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

@@ -21,7 +21,8 @@ export interface TestRun {
 }
 
 export interface FailedTestInfo {
-  id: string;
+  test_id: string;
+  test_name: string;
 }
 
 export enum RCAState {

src/tools/rca-agent.ts

@@ -98,7 +98,9 @@ export default function addRCATools(
     {
       testId: z
         .array(z.string())
-        .describe("Array of test IDs to fetch RCA data for"),
+        .describe(
+          "Array of test IDs to fetch RCA data for If not provided call listTestIds tool first to get the IDs",
+        ),
     },
     async (args) => {
       try {