Restoring files

Author: tech-sushant

src/tools/observability.ts

@@ -0,0 +1,84 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { z } from "zod";
+import { CallToolResult } from "@modelcontextprotocol/sdk/types.js";
+import { getLatestO11YBuildInfo } from "../lib/api.js";
+import { trackMCP } from "../lib/instrumentation.js";
+import logger from "../logger.js";
+
+export async function getFailuresInLastRun(
+  buildName: string,
+  projectName: string,
+): Promise<CallToolResult> {
+  const buildsData = await getLatestO11YBuildInfo(buildName, projectName);
+
+  const observabilityUrl = buildsData.observability_url;
+  if (!observabilityUrl) {
+    throw new Error(
+      "No observability URL found in build data, this is likely because the build is not yet available on BrowserStack Observability.",
+    );
+  }
+
+  let overview = "No overview available";
+  if (buildsData.unique_errors?.overview?.insight) {
+    overview = buildsData.unique_errors.overview.insight;
+  }
+
+  let details = "No error details available";
+  if (buildsData.unique_errors?.top_unique_errors?.length > 0) {
+    details = buildsData.unique_errors.top_unique_errors
+      .map((error: any) => error.error)
+      .filter(Boolean)
+      .join("\n");
+  }
+
+  return {
+    content: [
+      {
+        type: "text",
+        text: `Observability URL: ${observabilityUrl}\nOverview: ${overview}\nError Details: ${details}`,
+      },
+    ],
+  };
+}
+
+export default function addObservabilityTools(server: McpServer) {
+  server.tool(
+    "getFailuresInLastRun",
+    "Use this tool to debug failures in the last run of the test suite on BrowserStack. Use only when browserstack.yml file is present in the project root.",
+    {
+      buildName: z
+        .string()
+        .describe(
+          "Name of the build to get failures for. This is the 'build' key in the browserstack.yml file. If not sure, ask the user for the build name.",
+        ),
+      projectName: z
+        .string()
+        .describe(
+          "Name of the project to get failures for. This is the 'projectName' key in the browserstack.yml file. If not sure, ask the user for the project name.",
+        ),
+    },
+    async (args) => {
+      try {
+        trackMCP("getFailuresInLastRun", server.server.getClientVersion()!);
+        return await getFailuresInLastRun(args.buildName, args.projectName);
+      } catch (error) {
+        logger.error("Failed to get failures in the last run: %s", error);
+        trackMCP(
+          "getFailuresInLastRun",
+          server.server.getClientVersion()!,
+          error,
+        );
+        return {
+          content: [
+            {
+              type: "text",
+              text: `Failed to get failures in the last run. Error: ${error}. Please open an issue on GitHub if this is an issue with BrowserStack`,
+              isError: true,
+            },
+          ],
+          isError: true,
+        };
+      }
+    },
+  );
+}

tests/tools/observability.test.ts

@@ -0,0 +1,104 @@
+import { getFailuresInLastRun } from '../../src/tools/observability';
+import { getLatestO11YBuildInfo } from '../../src/lib/api';
+import { beforeEach, it, expect, describe, vi, Mock } from 'vitest'
+
+// Mock the API module
+vi.mock('../../src/lib/api', () => ({
+  getLatestO11YBuildInfo: vi.fn(),
+}));
+
+vi.mock('../../src/lib/instrumentation', () => ({
+  trackMCP: vi.fn()
+}));
+
+describe('getFailuresInLastRun', () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  const validBuildData = {
+    observability_url: 'https://observability.browserstack.com/123',
+    unique_errors: {
+      overview: {
+        insight: 'Test insight message'
+      },
+      top_unique_errors: [
+        { error: 'Error 1' },
+        { error: 'Error 2' }
+      ]
+    }
+  };
+
+  it('should successfully retrieve failures for a valid build', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue(validBuildData);
+
+    const result = await getFailuresInLastRun('test-build', 'test-project');
+
+    expect(getLatestO11YBuildInfo).toHaveBeenCalledWith('test-build', 'test-project');
+    expect(result.content[0].text).toContain('https://observability.browserstack.com/123');
+    expect(result.content[0].text).toContain('Test insight message');
+    expect(result.content[0].text).toContain('Error 1');
+    expect(result.content[0].text).toContain('Error 2');
+  });
+
+  it('should handle missing observability URL', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue({
+      ...validBuildData,
+      observability_url: null
+    });
+
+    await expect(getFailuresInLastRun('test-build', 'test-project'))
+      .rejects.toThrow('No observability URL found in build data');
+  });
+
+  it('should handle missing overview insight', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue({
+      ...validBuildData,
+      unique_errors: {
+        ...validBuildData.unique_errors,
+        overview: {}
+      }
+    });
+
+    const result = await getFailuresInLastRun('test-build', 'test-project');
+    expect(result.content[0].text).toContain('No overview available');
+  });
+
+  it('should handle missing error details', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue({
+      ...validBuildData,
+      unique_errors: {
+        ...validBuildData.unique_errors,
+        top_unique_errors: []
+      }
+    });
+
+    const result = await getFailuresInLastRun('test-build', 'test-project');
+    expect(result.content[0].text).toContain('No error details available');
+  });
+
+  it('should handle API errors', async () => {
+    (getLatestO11YBuildInfo as Mock).mockRejectedValue(new Error('API Error'));
+
+    await expect(getFailuresInLastRun('test-build', 'test-project'))
+      .rejects.toThrow('API Error');
+  });
+
+  it('should handle empty build data', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue({});
+
+    await expect(getFailuresInLastRun('test-build', 'test-project'))
+      .rejects.toThrow('No observability URL found in build data');
+  });
+
+  it('should handle partial build data', async () => {
+    (getLatestO11YBuildInfo as Mock).mockResolvedValue({
+      observability_url: 'https://observability.browserstack.com/123',
+      unique_errors: {}
+    });
+
+    const result = await getFailuresInLastRun('test-build', 'test-project');
+    expect(result.content[0].text).toContain('No overview available');
+    expect(result.content[0].text).toContain('No error details available');
+  });
+});