Moved all the utils related to getFailure tool moved to failure-utils

Author: tech-sushant

src/lib/utils.ts

@@ -1,50 +1,5 @@
 import sharp from "sharp";
 
-export interface LogResponse {
-  logs?: any[];
-  message?: string;
-}
-
-export interface HarFile {
-  log: {
-    entries: HarEntry[];
-  };
-}
-
-export interface HarEntry {
-  startedDateTime: string;
-  request: {
-    method: string;
-    url: string;
-    queryString?: { name: string; value: string }[];
-  };
-  response: {
-    status: number;
-    statusText?: string;
-    _error?: string;
-  };
-  serverIPAddress?: string;
-  time?: number;
-}
-
-export function validateResponse(
-  response: Response,
-  logType: string,
-): LogResponse | null {
-  if (!response.ok) {
-    if (response.status === 404) {
-      return { message: `No ${logType} available for this session` };
-    }
-    if (response.status === 401 || response.status === 403) {
-      return {
-        message: `Unable to access ${logType} - please check your credentials`,
-      };
-    }
-    return { message: `Unable to fetch ${logType} at this time` };
-  }
-  return null;
-}
-
 export function sanitizeUrlParam(param: string): string {
   // Remove any characters that could be used for command injection
   return param.replace(/[;&|`$(){}[\]<>]/g, "");
@@ -79,15 +34,3 @@ export async function assertOkResponse(response: Response, action: string) {
     );
   }
 }
-
-export function filterLinesByKeywords(
-  logText: string,
-  keywords: string[],
-): string[] {
-  return logText
-    .split(/\r?\n/)
-    .map((line) => line.trim())
-    .filter((line) =>
-      keywords.some((keyword) => line.toLowerCase().includes(keyword)),
-    );
-}

src/tools/failurelogs-utils/app-automate.ts

@@ -1,9 +1,9 @@
 import config from "../../config.js";
 import {
   filterLinesByKeywords,
-  validateResponse,
+  validateLogResponse,
   LogResponse,
-} from "../../lib/utils.js";
+} from "./utils.js";
 
 const auth = Buffer.from(
   `${config.browserstackUsername}:${config.browserstackAccessKey}`,
@@ -23,7 +23,7 @@ export async function retrieveDeviceLogs(
     },
   });
 
-  const validationResult = validateResponse(response, "device logs");
+  const validationResult = validateLogResponse(response, "device logs");
   if (validationResult) return validationResult;
 
   const logText = await response.text();
@@ -44,7 +44,7 @@ export async function retrieveAppiumLogs(
     },
   });
 
-  const validationResult = validateResponse(response, "Appium logs");
+  const validationResult = validateLogResponse(response, "Appium logs");
   if (validationResult) return validationResult;
 
   const logText = await response.text();
@@ -65,7 +65,7 @@ export async function retrieveCrashLogs(
     },
   });
 
-  const validationResult = validateResponse(response, "crash logs");
+  const validationResult = validateLogResponse(response, "crash logs");
   if (validationResult) return validationResult;
 
   const logText = await response.text();

src/tools/failurelogs-utils/automate.ts

@@ -3,9 +3,9 @@ import {
   HarEntry,
   HarFile,
   filterLinesByKeywords,
-  validateResponse,
+  validateLogResponse,
   LogResponse,
-} from "../../lib/utils.js";
+} from "./utils.js";
 
 const auth = Buffer.from(
   `${config.browserstackUsername}:${config.browserstackAccessKey}`,
@@ -25,7 +25,7 @@ export async function retrieveNetworkFailures(
     },
   });
 
-  const validationResult = validateResponse(response, "network logs");
+  const validationResult = validateLogResponse(response, "network logs");
   if (validationResult) return validationResult;
 
   const networklogs: HarFile = await response.json();
@@ -73,7 +73,7 @@ export async function retrieveSessionFailures(
     },
   });
 
-  const validationResult = validateResponse(response, "session logs");
+  const validationResult = validateLogResponse(response, "session logs");
   if (validationResult) return validationResult;
 
   const logText = await response.text();
@@ -93,7 +93,7 @@ export async function retrieveConsoleFailures(
     },
   });
 
-  const validationResult = validateResponse(response, "console logs");
+  const validationResult = validateLogResponse(response, "console logs");
   if (validationResult) return validationResult;
 
   const logText = await response.text();

src/tools/failurelogs-utils/utils.ts

@@ -0,0 +1,56 @@
+export interface LogResponse {
+  logs?: any[];
+  message?: string;
+}
+
+export interface HarFile {
+  log: {
+    entries: HarEntry[];
+  };
+}
+
+export interface HarEntry {
+  startedDateTime: string;
+  request: {
+    method: string;
+    url: string;
+    queryString?: { name: string; value: string }[];
+  };
+  response: {
+    status: number;
+    statusText?: string;
+    _error?: string;
+  };
+  serverIPAddress?: string;
+  time?: number;
+}
+
+export function validateLogResponse(
+  response: Response,
+  logType: string,
+): LogResponse | null {
+  if (!response.ok) {
+    if (response.status === 404) {
+      return { message: `No ${logType} available for this session` };
+    }
+    if (response.status === 401 || response.status === 403) {
+      return {
+        message: `Unable to access ${logType} - please check your credentials`,
+      };
+    }
+    return { message: `Unable to fetch ${logType} at this time` };
+  }
+  return null;
+}
+
+export function filterLinesByKeywords(
+  logText: string,
+  keywords: string[],
+): string[] {
+  return logText
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .filter((line) =>
+      keywords.some((keyword) => line.toLowerCase().includes(keyword)),
+    );
+}