Contributing to RapidTriageME¶

// Good: Use TypeScript for new code
interface ScreenshotOptions {
  fullPage?: boolean;
  quality?: number;
  format?: 'png' | 'jpeg';
}

// Good: Use descriptive function names
async function captureFullPageScreenshot(options: ScreenshotOptions): Promise<string> {
  // Implementation with clear error handling
  try {
    const result = await browser.captureScreenshot(options);
    return result.dataUrl;
  } catch (error) {
    logger.error('Screenshot capture failed:', error);
    throw new Error('Failed to capture screenshot');
  }
}

// Good: Add comprehensive comments for complex logic
/**
 * Processes browser console logs by filtering sensitive data,
 * applying rate limiting, and formatting for AI consumption.
 * 
 * @param rawLogs - Unprocessed console log entries
 * @param filters - Filtering configuration
 * @returns Processed and sanitized log entries
 */
function processConsoleLogs(rawLogs: RawLogEntry[], filters: LogFilters): ProcessedLogEntry[] {
  // Implementation details...
}

// Example: Testing MCP tool functionality
import { describe, it, expect, beforeEach } from 'jest';
import { MCPServer } from '../src/mcp-server';

describe('MCP Server Tools', () => {
  let server: MCPServer;

  beforeEach(() => {
    server = new MCPServer({ port: 3025 });
  });

  it('should capture screenshot with default options', async () => {
    const result = await server.executeTool('screenshot_capture', {});

    expect(result).toHaveProperty('screenshot');
    expect(result.screenshot).toMatch(/^data:image\/png;base64,/);
    expect(result).toHaveProperty('timestamp');
  });

  it('should handle screenshot errors gracefully', async () => {
    // Mock failure scenario
    jest.spyOn(server.browserConnector, 'captureScreenshot')
        .mockRejectedValue(new Error('Browser not connected'));

    const result = await server.executeTool('screenshot_capture', {});

    expect(result.isError).toBe(true);
    expect(result.content[0].text).toContain('Screenshot capture failed');
  });
});

// Example: Testing browser connector API
import request from 'supertest';
import { app } from '../src/server';

describe('Browser Connector API', () => {
  it('should return server identity', async () => {
    const response = await request(app)
      .get('/.identity')
      .expect(200);

    expect(response.body).toHaveProperty('name', 'RapidTriageME Browser Connector');
    expect(response.body).toHaveProperty('status', 'healthy');
  });

  it('should handle console log requests', async () => {
    const response = await request(app)
      .get('/console-logs?limit=10')
      .expect(200);

    expect(response.body).toHaveProperty('logs');
    expect(Array.isArray(response.body.logs)).toBe(true);
    expect(response.body.logs.length).toBeLessThanOrEqual(10);
  });
});

// Example: Testing complete workflow
import { test, expect } from '@playwright/test';

test.describe('RapidTriageME E2E', () => {
  test('should capture screenshot through AI assistant', async ({ page }) => {
    // Navigate to test page
    await page.goto('http://localhost:3000/test-page');

    // Simulate AI assistant request
    const screenshotResponse = await page.request.post('http://localhost:3025/capture-screenshot', {
      data: { options: { fullPage: true } }
    });

    expect(screenshotResponse.status()).toBe(200);

    const data = await screenshotResponse.json();
    expect(data).toHaveProperty('screenshot');
    expect(data.screenshot).toMatch(/^data:image/);
  });
});

// Use Manifest V3 features
// Good: Use chrome.action instead of chrome.browserAction
chrome.action.onClicked.addListener((tab) => {
  // Implementation
});

// Good: Use service workers for background scripts
// background.js
chrome.runtime.onInstalled.addListener(() => {
  console.log('Extension installed');
});

// Good: Handle async operations properly
async function captureScreenshot() {
  try {
    const dataUrl = await chrome.tabs.captureVisibleTab();
    return dataUrl;
  } catch (error) {
    console.error('Screenshot failed:', error);
    throw error;
  }
}