Refactor: Consolidate MCP event tracking functions

tech-sushant · tech-sushant · commit 89a28f580d10 · 2025-05-08T18:06:37.000+05:30
diff --git a/src/lib/instrumentation.ts b/src/lib/instrumentation.ts
@@ -15,13 +15,16 @@ interface MCPEventPayload {
   };
 }
 
-export function trackMCPEvent(
+export function trackMCP(
   toolName: string,
   clientInfo: { name?: string; version?: string },
+  error?: unknown
 ): void {
   const instrumentationEndpoint = "https://api.browserstack.com/sdk/v1/event";
-
+  const isSuccess = !error;
   const mcpClient = clientInfo?.name || "unknown";
+  
+  // Log client information
   if (clientInfo?.name) {
     logger.info(
       `Client connected: ${clientInfo.name} (version: ${clientInfo.version})`,
@@ -36,60 +39,15 @@ export function trackMCPEvent(
       mcp_version: packageJson.version,
       tool_name: toolName,
       mcp_client: mcpClient,
-      success: true,
+      success: isSuccess,
     },
   };
 
-  axios
-    .post(instrumentationEndpoint, event, {
-      headers: {
-        "Content-Type": "application/json",
-        Authorization: `Basic ${Buffer.from(
-          `${config.browserstackUsername}:${config.browserstackAccessKey}`,
-        ).toString("base64")}`,
-      },
-      timeout: 2000,
-    })
-    .then((response) => {
-      logger.info("MCP event tracked successfully", {
-        toolName,
-        response,
-      });
-    })
-    .catch((error: unknown) => {
-      logger.warn(
-        `Failed to track MCP event: ${error instanceof Error ? error.message : String(error)}`,
-        {
-          toolName,
-        },
-      );
-    });
-}
-
-export function trackMCPFailure(
-  toolName: string,
-  error: unknown,
-  clientInfo: { name?: string; version?: string },
-): void {
-  const instrumentationEndpoint = "https://api.browserstack.com/sdk/v1/event";
-
-  const mcpClient = clientInfo?.name || "unknown";
-  const errorMessage = error instanceof Error ? error.message : String(error);
-  const errorType = error instanceof Error ? error.constructor.name : "Unknown";
-
-  logger.error(`Tool failure: ${toolName} - ${errorMessage}`, { errorType });
-
-  const event: MCPEventPayload = {
-    event_type: "MCPInstrumentation",
-    event_properties: {
-      mcp_version: packageJson.version,
-      tool_name: toolName,
-      mcp_client: mcpClient,
-      success: false,
-      error_message: errorMessage,
-      error_type: errorType,
-    },
-  };
+  // Add error details if applicable
+  if (error) {
+    event.event_properties.error_message = error instanceof Error ? error.message : String(error);
+    event.event_properties.error_type = error instanceof Error ? error.constructor.name : "Unknown";
+  }
 
   axios
     .post(instrumentationEndpoint, event, {
@@ -102,17 +60,17 @@ export function trackMCPFailure(
       timeout: 2000,
     })
     .then((response) => {
-      logger.info("MCP failure event tracked successfully", {
+      logger.info(`MCP ${isSuccess ? 'event' : 'failure event'} tracked successfully`, {
         toolName,
         response,
       });
     })
     .catch((error: unknown) => {
       logger.warn(
-        `Failed to track MCP failure event: ${error instanceof Error ? error.message : String(error)}`,
+        `Failed to track MCP ${isSuccess ? 'event' : 'failure event'}: ${error instanceof Error ? error.message : String(error)}`,
         {
           toolName,
         },
       );
     });
-}
+}
diff --git a/src/tools/accessibility.ts b/src/tools/accessibility.ts
@@ -5,7 +5,7 @@ import {
   startAccessibilityScan,
   AccessibilityScanResponse,
 } from "./accessiblity-utils/accessibility";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 
 async function runAccessibilityScan(
   name: string,
@@ -44,16 +44,16 @@ export default function addAccessibilityTools(server: McpServer) {
     },
     async (args) => {
       try {
-        trackMCPEvent(
+        trackMCP(
           "startAccessibilityScan",
-          server.server.getClientVersion()!,
+          server.server.getClientVersion()!
         );
         return await runAccessibilityScan(args.name, args.pageURL);
       } catch (error) {
-        trackMCPFailure(
+        trackMCP(
           "startAccessibilityScan",
-          error,
           server.server.getClientVersion()!,
+          error
         );
         return {
           content: [
diff --git a/src/tools/applive.ts b/src/tools/applive.ts
@@ -4,7 +4,7 @@ import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import fs from "fs";
 import { startSession } from "./applive-utils/start-session";
 import logger from "../logger";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 
 /**
  * Launches an App Live Session on BrowserStack.
@@ -91,14 +91,14 @@ export default function addAppLiveTools(server: McpServer) {
     },
     async (args) => {
       try {
-        trackMCPEvent("runAppLiveSession", server.server.getClientVersion()!);
+        trackMCP("runAppLiveSession", server.server.getClientVersion()!);
         return await startAppLiveSession(args);
       } catch (error) {
         logger.error("App live session failed: %s", error);
-        trackMCPFailure(
+        trackMCP(
           "runAppLiveSession",
-          error,
           server.server.getClientVersion()!,
+          error
         );
         return {
           content: [
diff --git a/src/tools/automate.ts b/src/tools/automate.ts
@@ -3,7 +3,7 @@ import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import logger from "../logger";
 import { retrieveNetworkFailures } from "../lib/api";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 
 /**
  * Fetches failed network requests from a BrowserStack Automate session.
@@ -48,17 +48,17 @@ export default function addAutomateTools(server: McpServer) {
     },
     async (args) => {
       try {
-        trackMCPEvent("getNetworkFailures", server.server.getClientVersion()!);
+        trackMCP("getNetworkFailures", server.server.getClientVersion()!);
         return await getNetworkFailures(args);
       } catch (error) {
         const errorMessage =
           error instanceof Error ? error.message : String(error);
         logger.error("Failed to fetch network logs: %s", errorMessage);
 
-        trackMCPFailure(
+        trackMCP(
           "getNetworkFailures",
-          error,
           server.server.getClientVersion()!,
+          error
         );
 
         return {
diff --git a/src/tools/bstack-sdk.ts b/src/tools/bstack-sdk.ts
@@ -10,7 +10,7 @@ import {
   generateBrowserStackYMLInstructions,
   getInstructionsForProjectConfiguration,
 } from "./sdk-utils/instructions";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 
 /**
  * BrowserStack SDK hooks into your test framework to seamlessly run tests on BrowserStack.
@@ -74,9 +74,9 @@ export default function addSDKTools(server: McpServer) {
     },
     async (args) => {
       try {
-        trackMCPEvent(
+        trackMCP(
           "runTestsOnBrowserStack",
-          server.server.getClientVersion()!,
+          server.server.getClientVersion()!
         );
 
         return await bootstrapProjectWithSDK({
@@ -88,10 +88,10 @@ export default function addSDKTools(server: McpServer) {
           desiredPlatforms: args.desiredPlatforms,
         });
       } catch (error) {
-        trackMCPFailure(
+        trackMCP(
           "runTestsOnBrowserStack",
-          error,
           server.server.getClientVersion()!,
+          error
         );
         return {
           content: [
diff --git a/src/tools/live.ts b/src/tools/live.ts
@@ -4,7 +4,7 @@ import { z } from "zod";
 import logger from "../logger";
 import { startBrowserSession } from "./live-utils/start-session";
 import { PlatformType } from "./live-utils/types";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 
 // Define the schema shape
 const LiveArgsShape = {
@@ -105,17 +105,17 @@ export default function addBrowserLiveTools(server: McpServer) {
     LiveArgsShape,
     async (args) => {
       try {
-        trackMCPEvent(
+        trackMCP(
           "runBrowserLiveSession",
-          server.server.getClientVersion()!,
+          server.server.getClientVersion()!
         );
         return await runBrowserSession(args);
       } catch (error) {
         logger.error("Live session failed: %s", error);
-        trackMCPFailure(
+        trackMCP(
           "runBrowserLiveSession",
-          error,
           server.server.getClientVersion()!,
+          error
         );
         return {
           content: [
diff --git a/src/tools/observability.ts b/src/tools/observability.ts
@@ -2,7 +2,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
 import { getLatestO11YBuildInfo } from "../lib/api";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 import logger from "../logger";
 
 export async function getFailuresInLastRun(
@@ -59,17 +59,17 @@ export default function addObservabilityTools(server: McpServer) {
     },
     async (args) => {
       try {
-        trackMCPEvent(
+        trackMCP(
           "getFailuresInLastRun",
-          server.server.getClientVersion()!,
+          server.server.getClientVersion()!
         );
         return await getFailuresInLastRun(args.buildName, args.projectName);
       } catch (error) {
         logger.error("Failed to get failures in the last run: %s", error);
-        trackMCPFailure(
+        trackMCP(
           "getFailuresInLastRun",
-          error,
           server.server.getClientVersion()!,
+          error
         );
         return {
           content: [
diff --git a/src/tools/testmanagement.ts b/src/tools/testmanagement.ts
@@ -1,7 +1,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { z } from "zod";
 import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
-import { trackMCPEvent, trackMCPFailure } from "../lib/instrumentation";
+import { trackMCP } from "../lib/instrumentation";
 import logger from "../logger";
 import {
   createProjectOrFolder,
@@ -23,17 +23,17 @@ export async function createProjectOrFolderTool(
   args: z.infer<typeof CreateProjFoldSchema>,
 ): Promise<CallToolResult> {
   try {
-    trackMCPEvent(
+    trackMCP(
       "createProjectOrFolder",
-      serverInstance.server.getClientVersion()!,
+      serverInstance.server.getClientVersion()!
     );
     return await createProjectOrFolder(args);
   } catch (err) {
     logger.error("Failed to create project/folder: %s", err);
-    trackMCPFailure(
+    trackMCP(
       "createProjectOrFolder",
-      err,
       serverInstance.server.getClientVersion()!,
+      err
     );
     return {
       content: [
@@ -59,14 +59,14 @@ export async function createTestCaseTool(
   // Sanitize input arguments
   const cleanedArgs = sanitizeArgs(args);
   try {
-    trackMCPEvent("createTestCase", serverInstance.server.getClientVersion()!);
+    trackMCP("createTestCase", serverInstance.server.getClientVersion()!);
     return await createTestCaseAPI(cleanedArgs);
   } catch (err) {
     logger.error("Failed to create test case: %s", err);
-    trackMCPFailure(
+    trackMCP(
       "createTestCase",
-      err,
       serverInstance.server.getClientVersion()!,
+      err
     );
     return {
       content: [
