refactor: optimize configuration and tool implementations
- Standardized error handling across tool implementations - Improved return type consistency for tool execution results - Simplified configuration parsing and type definitions - Enhanced type safety for various configuration schemas - Cleaned up and normalized tool response structures - Updated SSE and event subscription tool implementations
This commit is contained in:
jango-blockchained
@@ -1,200 +1,230 @@
|
||||
import { SSEManager } from '../index';
|
||||
import { TokenManager } from '../../security/index';
|
||||
import type { SSEClient } from '../types';
|
||||
import { describe, it, expect, beforeEach, afterEach, mock, Mock } from 'bun:test';
|
||||
import { SSEManager } from "../index";
|
||||
import { TokenManager } from "../../security/index";
|
||||
import type { SSEClient } from "../types";
|
||||
import {
|
||||
describe,
|
||||
it,
|
||||
expect,
|
||||
beforeEach,
|
||||
afterEach,
|
||||
mock,
|
||||
Mock,
|
||||
} from "bun:test";
|
||||
|
||||
describe('SSE Security Features', () => {
|
||||
const TEST_IP = '127.0.0.1';
|
||||
const validToken = 'valid_token';
|
||||
let sseManager: SSEManager;
|
||||
let validateTokenMock: Mock<(token: string, ip: string) => { valid: boolean; error?: string }>;
|
||||
describe("SSE Security Features", () => {
|
||||
const TEST_IP = "127.0.0.1";
|
||||
const validToken = "valid_token";
|
||||
let sseManager: SSEManager;
|
||||
let validateTokenMock: Mock<
|
||||
(token: string, ip: string) => { valid: boolean; error?: string }
|
||||
>;
|
||||
|
||||
beforeEach(() => {
|
||||
sseManager = new SSEManager({
|
||||
maxClients: 2,
|
||||
rateLimit: {
|
||||
MAX_MESSAGES: 2,
|
||||
WINDOW_MS: 1000,
|
||||
BURST_LIMIT: 1
|
||||
}
|
||||
});
|
||||
|
||||
validateTokenMock = mock((token: string) => ({
|
||||
valid: token === validToken,
|
||||
error: token !== validToken ? 'Invalid token' : undefined
|
||||
}));
|
||||
TokenManager.validateToken = validateTokenMock;
|
||||
beforeEach(() => {
|
||||
sseManager = new SSEManager({
|
||||
maxClients: 2,
|
||||
rateLimit: {
|
||||
MAX_MESSAGES: 2,
|
||||
WINDOW_MS: 1000,
|
||||
BURST_LIMIT: 1,
|
||||
},
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
validateTokenMock.mockReset();
|
||||
validateTokenMock = mock((token: string) => ({
|
||||
valid: token === validToken,
|
||||
error: token !== validToken ? "Invalid token" : undefined,
|
||||
}));
|
||||
TokenManager.validateToken = validateTokenMock;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
validateTokenMock.mockReset();
|
||||
});
|
||||
|
||||
function createTestClient(
|
||||
id: string,
|
||||
): Omit<SSEClient, "authenticated" | "subscriptions" | "rateLimit"> {
|
||||
return {
|
||||
id,
|
||||
ip: TEST_IP,
|
||||
connectedAt: new Date(),
|
||||
connectionTime: Date.now(),
|
||||
send: mock((data: string) => {}),
|
||||
};
|
||||
}
|
||||
|
||||
describe("Client Authentication", () => {
|
||||
it("should authenticate valid clients", () => {
|
||||
const client = createTestClient("test-client-1");
|
||||
const result = sseManager.addClient(client, validToken);
|
||||
|
||||
expect(result).toBeTruthy();
|
||||
expect(validateTokenMock).toHaveBeenCalledWith(validToken, TEST_IP);
|
||||
expect(result?.authenticated).toBe(true);
|
||||
});
|
||||
|
||||
function createTestClient(id: string): Omit<SSEClient, 'authenticated' | 'subscriptions' | 'rateLimit'> {
|
||||
return {
|
||||
id,
|
||||
ip: TEST_IP,
|
||||
connectedAt: new Date(),
|
||||
connectionTime: Date.now(),
|
||||
send: mock((data: string) => { })
|
||||
};
|
||||
}
|
||||
it("should reject invalid tokens", () => {
|
||||
const client = createTestClient("test-client-2");
|
||||
const result = sseManager.addClient(client, "invalid_token");
|
||||
|
||||
describe('Client Authentication', () => {
|
||||
it('should authenticate valid clients', () => {
|
||||
const client = createTestClient('test-client-1');
|
||||
const result = sseManager.addClient(client, validToken);
|
||||
|
||||
expect(result).toBeTruthy();
|
||||
expect(validateTokenMock).toHaveBeenCalledWith(validToken, TEST_IP);
|
||||
expect(result?.authenticated).toBe(true);
|
||||
});
|
||||
|
||||
it('should reject invalid tokens', () => {
|
||||
const client = createTestClient('test-client-2');
|
||||
const result = sseManager.addClient(client, 'invalid_token');
|
||||
|
||||
expect(result).toBeNull();
|
||||
expect(validateTokenMock).toHaveBeenCalledWith('invalid_token', TEST_IP);
|
||||
});
|
||||
|
||||
it('should enforce maximum client limit', () => {
|
||||
// Add max number of clients
|
||||
const client1 = createTestClient('test-client-0');
|
||||
const client2 = createTestClient('test-client-1');
|
||||
const client3 = createTestClient('test-client-2');
|
||||
|
||||
expect(sseManager.addClient(client1, validToken)).toBeTruthy();
|
||||
expect(sseManager.addClient(client2, validToken)).toBeTruthy();
|
||||
expect(sseManager.addClient(client3, validToken)).toBeNull();
|
||||
});
|
||||
expect(result).toBeNull();
|
||||
expect(validateTokenMock).toHaveBeenCalledWith("invalid_token", TEST_IP);
|
||||
});
|
||||
|
||||
describe('Client Management', () => {
|
||||
it('should track client connections', () => {
|
||||
const client = createTestClient('test-client');
|
||||
sseManager.addClient(client, validToken);
|
||||
it("should enforce maximum client limit", () => {
|
||||
// Add max number of clients
|
||||
const client1 = createTestClient("test-client-0");
|
||||
const client2 = createTestClient("test-client-1");
|
||||
const client3 = createTestClient("test-client-2");
|
||||
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(1);
|
||||
expect(stats.authenticatedClients).toBe(1);
|
||||
});
|
||||
expect(sseManager.addClient(client1, validToken)).toBeTruthy();
|
||||
expect(sseManager.addClient(client2, validToken)).toBeTruthy();
|
||||
expect(sseManager.addClient(client3, validToken)).toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
it('should remove disconnected clients', () => {
|
||||
const client = createTestClient('test-client');
|
||||
sseManager.addClient(client, validToken);
|
||||
sseManager.removeClient('test-client');
|
||||
describe("Client Management", () => {
|
||||
it("should track client connections", () => {
|
||||
const client = createTestClient("test-client");
|
||||
sseManager.addClient(client, validToken);
|
||||
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(0);
|
||||
});
|
||||
|
||||
it('should cleanup inactive clients', async () => {
|
||||
const client = createTestClient('test-client');
|
||||
sseManager.addClient(client, validToken);
|
||||
|
||||
// Wait for cleanup interval
|
||||
await new Promise(resolve => setTimeout(resolve, 250));
|
||||
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(0);
|
||||
});
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(1);
|
||||
expect(stats.authenticatedClients).toBe(1);
|
||||
});
|
||||
|
||||
describe('Rate Limiting', () => {
|
||||
it('should enforce rate limits for message sending', () => {
|
||||
const client = createTestClient('test-client');
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
it("should remove disconnected clients", () => {
|
||||
const client = createTestClient("test-client");
|
||||
sseManager.addClient(client, validToken);
|
||||
sseManager.removeClient("test-client");
|
||||
|
||||
// Send messages up to the limit
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'first' } });
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'second' } });
|
||||
|
||||
// Next message should be rate limited
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'overflow' } });
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(2);
|
||||
});
|
||||
|
||||
it('should reset rate limits after window expires', async () => {
|
||||
const client = createTestClient('test-client');
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
|
||||
// Send messages up to the limit
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'first' } });
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'second' } });
|
||||
|
||||
// Wait for rate limit window to expire
|
||||
await new Promise(resolve => setTimeout(resolve, 1100));
|
||||
|
||||
// Should be able to send messages again
|
||||
sseManager['sendToClient'](sseClient!, { type: 'test', data: { value: 'new message' } });
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(3);
|
||||
});
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(0);
|
||||
});
|
||||
|
||||
describe('Event Broadcasting', () => {
|
||||
it('should only send events to authenticated clients', () => {
|
||||
const client1 = createTestClient('client1');
|
||||
const client2 = createTestClient('client2');
|
||||
it("should cleanup inactive clients", async () => {
|
||||
const client = createTestClient("test-client");
|
||||
sseManager.addClient(client, validToken);
|
||||
|
||||
const sseClient1 = sseManager.addClient(client1, validToken);
|
||||
const sseClient2 = sseManager.addClient(client2, 'invalid_token');
|
||||
// Wait for cleanup interval
|
||||
await new Promise((resolve) => setTimeout(resolve, 250));
|
||||
|
||||
expect(sseClient1).toBeTruthy();
|
||||
expect(sseClient2).toBeNull();
|
||||
|
||||
sseClient1!.subscriptions.add('event:test_event');
|
||||
|
||||
const event = {
|
||||
event_type: 'test_event',
|
||||
data: { value: 'test' },
|
||||
origin: 'test',
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: 'test' }
|
||||
};
|
||||
|
||||
sseManager.broadcastEvent(event);
|
||||
|
||||
const client1SendMock = client1.send as Mock<(data: string) => void>;
|
||||
const client2SendMock = client2.send as Mock<(data: string) => void>;
|
||||
|
||||
expect(client1SendMock.mock.calls.length).toBe(1);
|
||||
expect(client2SendMock.mock.calls.length).toBe(0);
|
||||
});
|
||||
|
||||
it('should respect subscription filters', () => {
|
||||
const client = createTestClient('test-client');
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
|
||||
sseClient!.subscriptions.add('event:test_event');
|
||||
|
||||
// Send matching event
|
||||
sseManager.broadcastEvent({
|
||||
event_type: 'test_event',
|
||||
data: { value: 'test' },
|
||||
origin: 'test',
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: 'test' }
|
||||
});
|
||||
|
||||
// Send non-matching event
|
||||
sseManager.broadcastEvent({
|
||||
event_type: 'other_event',
|
||||
data: { value: 'test' },
|
||||
origin: 'test',
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: 'test' }
|
||||
});
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(1);
|
||||
});
|
||||
const stats = sseManager.getStatistics();
|
||||
expect(stats.totalClients).toBe(0);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe("Rate Limiting", () => {
|
||||
it("should enforce rate limits for message sending", () => {
|
||||
const client = createTestClient("test-client");
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
|
||||
// Send messages up to the limit
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "first" },
|
||||
});
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "second" },
|
||||
});
|
||||
|
||||
// Next message should be rate limited
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "overflow" },
|
||||
});
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(2);
|
||||
});
|
||||
|
||||
it("should reset rate limits after window expires", async () => {
|
||||
const client = createTestClient("test-client");
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
|
||||
// Send messages up to the limit
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "first" },
|
||||
});
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "second" },
|
||||
});
|
||||
|
||||
// Wait for rate limit window to expire
|
||||
await new Promise((resolve) => setTimeout(resolve, 1100));
|
||||
|
||||
// Should be able to send messages again
|
||||
sseManager["sendToClient"](sseClient!, {
|
||||
type: "test",
|
||||
data: { value: "new message" },
|
||||
});
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(3);
|
||||
});
|
||||
});
|
||||
|
||||
describe("Event Broadcasting", () => {
|
||||
it("should only send events to authenticated clients", () => {
|
||||
const client1 = createTestClient("client1");
|
||||
const client2 = createTestClient("client2");
|
||||
|
||||
const sseClient1 = sseManager.addClient(client1, validToken);
|
||||
const sseClient2 = sseManager.addClient(client2, "invalid_token");
|
||||
|
||||
expect(sseClient1).toBeTruthy();
|
||||
expect(sseClient2).toBeNull();
|
||||
|
||||
sseClient1!.subscriptions.add("event:test_event");
|
||||
|
||||
const event = {
|
||||
event_type: "test_event",
|
||||
data: { value: "test" },
|
||||
origin: "test",
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: "test" },
|
||||
};
|
||||
|
||||
sseManager.broadcastEvent(event);
|
||||
|
||||
const client1SendMock = client1.send as Mock<(data: string) => void>;
|
||||
const client2SendMock = client2.send as Mock<(data: string) => void>;
|
||||
|
||||
expect(client1SendMock.mock.calls.length).toBe(1);
|
||||
expect(client2SendMock.mock.calls.length).toBe(0);
|
||||
});
|
||||
|
||||
it("should respect subscription filters", () => {
|
||||
const client = createTestClient("test-client");
|
||||
const sseClient = sseManager.addClient(client, validToken);
|
||||
expect(sseClient).toBeTruthy();
|
||||
|
||||
sseClient!.subscriptions.add("event:test_event");
|
||||
|
||||
// Send matching event
|
||||
sseManager.broadcastEvent({
|
||||
event_type: "test_event",
|
||||
data: { value: "test" },
|
||||
origin: "test",
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: "test" },
|
||||
});
|
||||
|
||||
// Send non-matching event
|
||||
sseManager.broadcastEvent({
|
||||
event_type: "other_event",
|
||||
data: { value: "test" },
|
||||
origin: "test",
|
||||
time_fired: new Date().toISOString(),
|
||||
context: { id: "test" },
|
||||
});
|
||||
|
||||
const sendMock = client.send as Mock<(data: string) => void>;
|
||||
expect(sendMock.mock.calls.length).toBe(1);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user