Merge branch 'browserstack:main' into main

Author: ruturaj-browserstack

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.0.14",
+  "version": "1.1.3",
   "description": "BrowserStack's Official MCP Server",
   "main": "dist/index.js",
   "repository": {

package.json

@@ -1,12 +1,3 @@
-if (
-  !process.env.BROWSERSTACK_ACCESS_KEY ||
-  !process.env.BROWSERSTACK_USERNAME
-) {
-  throw new Error(
-    "Unable to start MCP server. Please set the BROWSERSTACK_ACCESS_KEY and BROWSERSTACK_USERNAME environment variables. Go to https://www.browserstack.com/accounts/profile/details to access them",
-  );
-}
-
 export class Config {
   constructor(
     public readonly browserstackUsername: string,

src/config.ts

@@ -2,7 +2,9 @@
 
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import packageJson from "../package.json" with { type: "json" };
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const packageJson = require("../package.json");
 import "dotenv/config";
 import logger from "./logger.js";
 import addSDKTools from "./tools/bstack-sdk.js";
@@ -13,7 +15,7 @@ import addTestManagementTools from "./tools/testmanagement.js";
 import addAppAutomationTools from "./tools/appautomate.js";
 import addFailureLogsTools from "./tools/getFailureLogs.js";
 import addAutomateTools from "./tools/automate.js";
-import { trackMCP } from "./lib/instrumentation.js";
+import { setupOnInitialized } from "./oninitialized.js";
 
 function registerTools(server: McpServer) {
   addSDKTools(server);
@@ -32,6 +34,8 @@ const server: McpServer = new McpServer({
   version: packageJson.version,
 });
 
+setupOnInitialized(server);
+
 registerTools(server);
 
 async function main() {
@@ -43,9 +47,6 @@ async function main() {
   // Start receiving messages on stdin and sending messages on stdout
   const transport = new StdioServerTransport();
   await server.connect(transport);
-
-  logger.info("MCP server started successfully");
-  trackMCP("started", server.server.getClientVersion()!);
 }
 
 main().catch(console.error);

src/index.ts

@@ -1,6 +1,8 @@
 import logger from "../logger.js";
 import config from "../config.js";
-import packageJson from "../../package.json" with { type: "json" };
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
+const packageJson = require("../../package.json");
 import axios from "axios";
 
 interface MCPEventPayload {

src/lib/instrumentation.ts

@@ -5,28 +5,6 @@ export function sanitizeUrlParam(param: string): string {
   return param.replace(/[;&|`$(){}[\]<>]/g, "");
 }
 
-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;
-}
-
 const ONE_MB = 1048576;
 
 //Compresses a base64 image intelligently to keep it under 1 MB if needed.
@@ -56,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/lib/utils.ts

@@ -0,0 +1,24 @@
+import config from "./config.js";
+import { trackMCP } from "./lib/instrumentation.js";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+
+export function setupOnInitialized(server: McpServer) {
+  const nodeVersion = process.versions.node;
+
+  // Check for Node.js version
+  if (nodeVersion < "18.0.0") {
+    throw new Error(
+      "Node version is not supported. Please upgrade to 18.0.0 or later.",
+    );
+  }
+
+  // Check for BrowserStack credentials
+  if (!config.browserstackUsername || !config.browserstackAccessKey) {
+    throw new Error(
+      "BrowserStack credentials are missing. Please provide a valid username and access key.",
+    );
+  }
+  server.server.oninitialized = () => {
+    trackMCP("started", server.server.getClientVersion()!);
+  };
+}

src/oninitialized.ts

@@ -1,5 +1,5 @@
 import config from "../../config.js";
-import { assertOkResponse, filterLinesByKeywords } from "../../lib/utils.js";
+import { filterLinesByKeywords, validateLogResponse } from "./utils.js";
 
 const auth = Buffer.from(
   `${config.browserstackUsername}:${config.browserstackAccessKey}`,
@@ -9,7 +9,7 @@ const auth = Buffer.from(
 export async function retrieveDeviceLogs(
   sessionId: string,
   buildId: string,
-): Promise<string[]> {
+): Promise<string> {
   const url = `https://api.browserstack.com/app-automate/builds/${buildId}/sessions/${sessionId}/deviceLogs`;
 
   const response = await fetch(url, {
@@ -19,17 +19,21 @@ export async function retrieveDeviceLogs(
     },
   });
 
-  await assertOkResponse(response, "device logs");
+  const validationError = validateLogResponse(response, "device logs");
+  if (validationError) return validationError.message!;
 
   const logText = await response.text();
-  return filterDeviceFailures(logText);
+  const logs = filterDeviceFailures(logText);
+  return logs.length > 0
+    ? `Device Failures (${logs.length} found):\n${JSON.stringify(logs, null, 2)}`
+    : "No device failures found";
 }
 
 // APPIUM LOGS
 export async function retrieveAppiumLogs(
   sessionId: string,
   buildId: string,
-): Promise<string[]> {
+): Promise<string> {
   const url = `https://api.browserstack.com/app-automate/builds/${buildId}/sessions/${sessionId}/appiumlogs`;
 
   const response = await fetch(url, {
@@ -39,17 +43,21 @@ export async function retrieveAppiumLogs(
     },
   });
 
-  await assertOkResponse(response, "Appium logs");
+  const validationError = validateLogResponse(response, "Appium logs");
+  if (validationError) return validationError.message!;
 
   const logText = await response.text();
-  return filterAppiumFailures(logText);
+  const logs = filterAppiumFailures(logText);
+  return logs.length > 0
+    ? `Appium Failures (${logs.length} found):\n${JSON.stringify(logs, null, 2)}`
+    : "No Appium failures found";
 }
 
 // CRASH LOGS
 export async function retrieveCrashLogs(
   sessionId: string,
   buildId: string,
-): Promise<string[]> {
+): Promise<string> {
   const url = `https://api.browserstack.com/app-automate/builds/${buildId}/sessions/${sessionId}/crashlogs`;
 
   const response = await fetch(url, {
@@ -59,14 +67,17 @@ export async function retrieveCrashLogs(
     },
   });
 
-  await assertOkResponse(response, "crash logs");
+  const validationError = validateLogResponse(response, "crash logs");
+  if (validationError) return validationError.message!;
 
   const logText = await response.text();
-  return filterCrashFailures(logText);
+  const logs = filterCrashFailures(logText);
+  return logs.length > 0
+    ? `Crash Failures (${logs.length} found):\n${JSON.stringify(logs, null, 2)}`
+    : "No crash failures found";
 }
 
 // FILTER HELPERS
-
 export function filterDeviceFailures(logText: string): string[] {
   const keywords = [
     "error",

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

@@ -1,13 +1,19 @@
 import config from "../../config.js";
-import { HarEntry, HarFile } from "../../lib/utils.js";
-import { assertOkResponse, filterLinesByKeywords } from "../../lib/utils.js";
+import {
+  HarEntry,
+  HarFile,
+  filterLinesByKeywords,
+  validateLogResponse,
+} from "./utils.js";
 
 const auth = Buffer.from(
   `${config.browserstackUsername}:${config.browserstackAccessKey}`,
 ).toString("base64");
 
 // NETWORK LOGS
-export async function retrieveNetworkFailures(sessionId: string): Promise<any> {
+export async function retrieveNetworkFailures(
+  sessionId: string,
+): Promise<string> {
   const url = `https://api.browserstack.com/automate/sessions/${sessionId}/networklogs`;
 
   const response = await fetch(url, {
@@ -18,43 +24,44 @@ export async function retrieveNetworkFailures(sessionId: string): Promise<any> {
     },
   });
 
-  await assertOkResponse(response, "network logs");
+  const validationError = validateLogResponse(response, "network logs");
+  if (validationError) return validationError.message!;
 
   const networklogs: HarFile = await response.json();
-
-  // Filter for failure logs
   const failureEntries: HarEntry[] = networklogs.log.entries.filter(
-    (entry: HarEntry) => {
-      return (
-        entry.response.status === 0 ||
-        entry.response.status >= 400 ||
-        entry.response._error !== undefined
-      );
-    },
+    (entry: HarEntry) =>
+      entry.response.status === 0 ||
+      entry.response.status >= 400 ||
+      entry.response._error !== undefined,
   );
 
-  // Return only the failure entries with some context
-  return failureEntries.map((entry: any) => ({
-    startedDateTime: entry.startedDateTime,
-    request: {
-      method: entry.request?.method,
-      url: entry.request?.url,
-      queryString: entry.request?.queryString,
-    },
-    response: {
-      status: entry.response?.status,
-      statusText: entry.response?.statusText,
-      _error: entry.response?._error,
-    },
-    serverIPAddress: entry.serverIPAddress,
-    time: entry.time,
-  }));
+  return failureEntries.length > 0
+    ? `Network Failures (${failureEntries.length} found):\n${JSON.stringify(
+        failureEntries.map((entry: any) => ({
+          startedDateTime: entry.startedDateTime,
+          request: {
+            method: entry.request?.method,
+            url: entry.request?.url,
+            queryString: entry.request?.queryString,
+          },
+          response: {
+            status: entry.response?.status,
+            statusText: entry.response?.statusText,
+            _error: entry.response?._error,
+          },
+          serverIPAddress: entry.serverIPAddress,
+          time: entry.time,
+        })),
+        null,
+        2,
+      )}`
+    : "No network failures found";
 }
 
 // SESSION LOGS
 export async function retrieveSessionFailures(
   sessionId: string,
-): Promise<string[]> {
+): Promise<string> {
   const url = `https://api.browserstack.com/automate/sessions/${sessionId}/logs`;
 
   const response = await fetch(url, {
@@ -64,16 +71,20 @@ export async function retrieveSessionFailures(
     },
   });
 
-  await assertOkResponse(response, "session logs");
+  const validationError = validateLogResponse(response, "session logs");
+  if (validationError) return validationError.message!;
 
   const logText = await response.text();
-  return filterSessionFailures(logText);
+  const logs = filterSessionFailures(logText);
+  return logs.length > 0
+    ? `Session Failures (${logs.length} found):\n${JSON.stringify(logs, null, 2)}`
+    : "No session failures found";
 }
 
 // CONSOLE LOGS
 export async function retrieveConsoleFailures(
   sessionId: string,
-): Promise<string[]> {
+): Promise<string> {
   const url = `https://api.browserstack.com/automate/sessions/${sessionId}/consolelogs`;
 
   const response = await fetch(url, {
@@ -83,10 +94,14 @@ export async function retrieveConsoleFailures(
     },
   });
 
-  await assertOkResponse(response, "console logs");
+  const validationError = validateLogResponse(response, "console logs");
+  if (validationError) return validationError.message!;
 
   const logText = await response.text();
-  return filterConsoleFailures(logText);
+  const logs = filterConsoleFailures(logText);
+  return logs.length > 0
+    ? `Console Failures (${logs.length} found):\n${JSON.stringify(logs, null, 2)}`
+    : "No console failures found";
 }
 
 // FILTER: session logs