fix : Instrumentation,refactoring and bump version

Author: tech-sushant

src/lib/utils.ts

@@ -2,6 +2,9 @@ import sharp from "sharp";
 import type { ApiResponse } from "./apiClient.js";
 import { BrowserStackConfig } from "./types.js";
 import { getBrowserStackAuth } from "./get-auth.js";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { trackMCP } from "../index.js";
 
 export function sanitizeUrlParam(param: string): string {
   // Remove any characters that could be used for command injection
@@ -62,3 +65,27 @@ export async function fetchFromBrowserStackAPI(
 
   return res.json();
 }
+
+function errorContent(message: string): CallToolResult {
+  return {
+    content: [{ type: "text", text: message }],
+    isError: true,
+  };
+}
+
+export function handleMCPError(
+  toolName: string,
+  server: McpServer,
+  config: BrowserStackConfig,
+  error: unknown,
+) {
+  trackMCP(toolName, server.server.getClientVersion()!, error, config);
+
+  const errorMessage = error instanceof Error ? error.message : "Unknown error";
+
+  const readableToolName = toolName.replace(/([A-Z])/g, " $1").toLowerCase();
+
+  return errorContent(
+    `Failed to ${readableToolName}: ${errorMessage}. Please open an issue on GitHub if the problem persists`,
+  );
+}

src/tools/build-insights.ts

@@ -3,7 +3,7 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import logger from "../logger.js";
 import { BrowserStackConfig } from "../lib/types.js";
-import { fetchFromBrowserStackAPI } from "../lib/utils.js";
+import { fetchFromBrowserStackAPI, handleMCPError } from "../lib/utils.js";
 
 // Tool function that fetches build insights from two APIs
 export async function fetchBuildInsightsTool(
@@ -80,16 +80,7 @@ export default function addBuildInsightsTools(
       try {
         return await fetchBuildInsightsTool(args, config);
       } catch (error) {
-        const errorMessage =
-          error instanceof Error ? error.message : "Unknown error";
-        return {
-          content: [
-            {
-              type: "text",
-              text: `Error during fetching build insights: ${errorMessage}`,
-            },
-          ],
-        };
+        return handleMCPError("fetchBuildInsights", server, config, error);
       }
     },
   );

src/tools/list-test-files.ts

@@ -7,6 +7,12 @@ export async function addListTestFiles(args: any): Promise<CallToolResult> {
   const { dirs, language, framework } = args;
   let testFiles: string[] = [];
 
+  if (!dirs || dirs.length === 0) {
+    throw new Error(
+      "No directories provided to add the test files. Please provide test directories to add percy snapshot commands.",
+    );
+  }
+
   for (const dir of dirs) {
     const files = await listTestFiles({
       language,

src/tools/percy-sdk.ts

@@ -1,6 +1,6 @@
 import { trackMCP } from "../index.js";
 import { BrowserStackConfig } from "../lib/types.js";
-import { fetchPercyChanges } from "./percy-change.js";
+import { fetchPercyChanges } from "./review-agent.js";
 import { addListTestFiles } from "./list-test-files.js";
 import { runPercyScan } from "./run-percy-scan.js";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
@@ -25,14 +25,14 @@ import {
   FetchPercyChangesParamsShape,
   ManagePercyBuildApprovalParamsShape,
 } from "./sdk-utils/common/schema.js";
+import { handleMCPError } from "../lib/utils.js";
 
 export function registerPercyTools(
   server: McpServer,
   config: BrowserStackConfig,
 ) {
   const tools: Record<string, any> = {};
 
-  // Register setupPercyVisualTesting
   tools.setupPercyVisualTesting = server.tool(
     "setupPercyVisualTesting",
     SETUP_PERCY_DESCRIPTION,
@@ -46,26 +46,11 @@ export function registerPercyTools(
         );
         return setUpPercyHandler(args, config);
       } catch (error) {
-        trackMCP(
-          "setupPercyVisualTesting",
-          server.server.getClientVersion()!,
-          error,
-          config,
-        );
-        return {
-          content: [
-            {
-              type: "text",
-              text: error instanceof Error ? error.message : String(error),
-            },
-          ],
-          isError: true,
-        };
+        return handleMCPError("setupPercyVisualTesting", server, config, error);
       }
     },
   );
 
-  // Register addPercySnapshotCommands
   tools.addPercySnapshotCommands = server.tool(
     "addPercySnapshotCommands",
     PERCY_SNAPSHOT_COMMANDS_DESCRIPTION,
@@ -79,26 +64,16 @@ export function registerPercyTools(
         );
         return await updateTestsWithPercyCommands(args);
       } catch (error) {
-        trackMCP(
+        return handleMCPError(
           "addPercySnapshotCommands",
-          server.server.getClientVersion()!,
-          error,
+          server,
           config,
+          error,
         );
-        return {
-          content: [
-            {
-              type: "text",
-              text: error instanceof Error ? error.message : String(error),
-            },
-          ],
-          isError: true,
-        };
       }
     },
   );
 
-  // Register listTestFiles
   tools.listTestFiles = server.tool(
     "listTestFiles",
     LIST_TEST_FILES_DESCRIPTION,
@@ -108,21 +83,7 @@ export function registerPercyTools(
         trackMCP("listTestFiles", server.server.getClientVersion()!, config);
         return addListTestFiles(args);
       } catch (error) {
-        trackMCP(
-          "listTestFiles",
-          server.server.getClientVersion()!,
-          error,
-          config,
-        );
-        return {
-          content: [
-            {
-              type: "text",
-              text: error instanceof Error ? error.message : String(error),
-            },
-          ],
-          isError: true,
-        };
+        return handleMCPError("listTestFiles", server, config, error);
       }
     },
   );
@@ -132,16 +93,30 @@ export function registerPercyTools(
     "Run a Percy visual test scan. Example prompts : Run this Percy build/scan. Never run percy scan/build without this tool",
     RunPercyScanParamsShape,
     async (args) => {
-      return runPercyScan(args, config);
+      try {
+        trackMCP("runPercyScan", server.server.getClientVersion()!, config);
+        return runPercyScan(args, config);
+      } catch (error) {
+        return handleMCPError("runPercyScan", server, config, error);
+      }
     },
   );
 
   tools.fetchPercyChanges = server.tool(
     "fetchPercyChanges",
-    "Retrieves and summarizes all visual changes detected by Percy between the latest and previous builds, helping quickly review what has changed in your project.",
+    "Retrieves and summarizes all visual changes detected by Percy AI between the latest and previous builds, helping quickly review what has changed in your project.",
     FetchPercyChangesParamsShape,
     async (args) => {
-      return await fetchPercyChanges(args, config);
+      try {
+        trackMCP(
+          "fetchPercyChanges",
+          server.server.getClientVersion()!,
+          config,
+        );
+        return await fetchPercyChanges(args, config);
+      } catch (error) {
+        return handleMCPError("fetchPercyChanges", server, config, error);
+      }
     },
   );
 
@@ -150,7 +125,21 @@ export function registerPercyTools(
     "Approve or reject a Percy build",
     ManagePercyBuildApprovalParamsShape,
     async (args) => {
-      return await approveOrDeclinePercyBuild(args, config);
+      try {
+        trackMCP(
+          "managePercyBuildApproval",
+          server.server.getClientVersion()!,
+          config,
+        );
+        return await approveOrDeclinePercyBuild(args, config);
+      } catch (error) {
+        return handleMCPError(
+          "managePercyBuildApproval",
+          server,
+          config,
+          error,
+        );
+      }
     },
   );
 

src/tools/percy-snapshot-utils/detect-test-files.ts

@@ -1,6 +1,5 @@
 import fs from "fs";
 import path from "path";
-import logger from "../../logger.js";
 
 import {
   SDKSupportedLanguage,
@@ -38,7 +37,7 @@ async function walkDir(
       }
     }
   } catch {
-    logger.error(`Failed to read directory: ${dir}`);
+    // ignore
   }
 
   return result;
@@ -54,7 +53,6 @@ async function fileContainsRegex(
     const content = await fs.promises.readFile(filePath, "utf8");
     return regexes.some((re) => re.test(content));
   } catch {
-    logger.warn(`Failed to read file: ${filePath}`);
     return false;
   }
 }
@@ -69,7 +67,6 @@ async function batchRegexCheck(
       regexes.length > 0 ? regexes.some((re) => re.test(content)) : false,
     );
   } catch {
-    logger.warn(`Failed to read file: ${filePath}`);
     return regexGroups.map(() => false);
   }
 }
@@ -110,7 +107,6 @@ export async function listTestFiles(
   const config = TEST_FILE_DETECTION[language];
 
   if (!config) {
-    logger.error(`Unsupported language: ${language}`);
     return [];
   }
 
@@ -135,7 +131,6 @@ export async function listTestFiles(
 
     if (config.namePatterns.some((pattern) => pattern.test(fileName))) {
       candidateFiles.set(file, score);
-      logger.debug(`File matched by name pattern: ${file} (score: ${score})`);
     }
   }
 
@@ -147,7 +142,6 @@ export async function listTestFiles(
       const fileName = path.basename(file);
       const score = getFileScore(fileName, config);
       candidateFiles.set(file, score);
-      logger.debug(`File matched by content regex: ${file} (score: ${score})`);
     }
   });
 
@@ -158,16 +152,12 @@ export async function listTestFiles(
     try {
       const featureFiles = await walkDir(baseDir, [".feature"], 6);
       featureFiles.forEach((file) => candidateFiles.set(file, 2));
-      logger.info(`Added ${featureFiles.length} SpecFlow .feature files`);
     } catch {
-      logger.warn(
-        `Failed to collect SpecFlow .feature files from baseDir: ${baseDir}`,
-      );
+      // ignore
     }
   }
 
   if (candidateFiles.size === 0) {
-    logger.info("No test files found matching patterns");
     return [];
   }
 
@@ -185,7 +175,6 @@ export async function listTestFiles(
       const isUITest = await isLikelyUITest(file);
 
       if (isUITest) {
-        logger.debug(`File included - strong UI indicators: ${file}`);
         return file;
       }
 
@@ -198,43 +187,29 @@ export async function listTestFiles(
           config.excludeRegex || [],
         ]);
 
-      // Skip if explicitly excluded (mocks, unit tests, etc.)
       if (shouldExclude) {
-        logger.debug(`File excluded by exclude regex: ${file}`);
         return null;
       }
 
-      // Skip backend tests in any mode
       if (hasBackend) {
-        logger.debug(`File excluded as backend test: ${file}`);
         return null;
       }
 
-      // Include if has explicit UI drivers
       if (hasExplicitUI) {
-        logger.debug(`File included - explicit UI drivers: ${file}`);
         return file;
       }
 
-      // Include if has UI indicators (for cases where drivers aren't explicitly imported)
       if (hasUIIndicators) {
-        logger.debug(`File included - UI indicators: ${file}`);
         return file;
       }
 
-      // In non-strict mode, include high-scoring test files even without explicit UI patterns
       if (!strictMode) {
         const score = candidateFiles.get(file) || 0;
         if (score >= 3) {
-          // High confidence UI test based on naming
-          logger.debug(
-            `File included - high confidence score: ${file} (score: ${score})`,
-          );
           return file;
         }
       }
 
-      logger.debug(`File excluded - no UI patterns detected: ${file}`);
       return null;
     });
 
@@ -251,9 +226,6 @@ export async function listTestFiles(
     return scoreB - scoreA;
   });
 
-  logger.info(
-    `Returning ${uiFiles.length} UI test files from ${candidateFiles.size} total test files`,
-  );
   return uiFiles;
 }