BREAKING CHANGE(smartproxy): Update documentation and refactor core proxy components; remove legacy performRenewals method from SmartProxy; update router type imports and adjust test suites for improved coverage
This commit is contained in:
578
test/test.networkproxy.ts
Normal file
578
test/test.networkproxy.ts
Normal file
@ -0,0 +1,578 @@
|
||||
import { expect, tap } from '@push.rocks/tapbundle';
|
||||
import * as smartproxy from '../ts/index.js';
|
||||
import { loadTestCertificates } from './helpers/certificates.js';
|
||||
import * as https from 'https';
|
||||
import * as http from 'http';
|
||||
import { WebSocket, WebSocketServer } from 'ws';
|
||||
|
||||
let testProxy: smartproxy.NetworkProxy;
|
||||
let testServer: http.Server;
|
||||
let wsServer: WebSocketServer;
|
||||
let testCertificates: { privateKey: string; publicKey: string };
|
||||
|
||||
// Helper function to make HTTPS requests
|
||||
async function makeHttpsRequest(
|
||||
options: https.RequestOptions,
|
||||
): Promise<{ statusCode: number; headers: http.IncomingHttpHeaders; body: string }> {
|
||||
console.log('[TEST] Making HTTPS request:', {
|
||||
hostname: options.hostname,
|
||||
port: options.port,
|
||||
path: options.path,
|
||||
method: options.method,
|
||||
headers: options.headers,
|
||||
});
|
||||
return new Promise((resolve, reject) => {
|
||||
const req = https.request(options, (res) => {
|
||||
console.log('[TEST] Received HTTPS response:', {
|
||||
statusCode: res.statusCode,
|
||||
headers: res.headers,
|
||||
});
|
||||
let data = '';
|
||||
res.on('data', (chunk) => (data += chunk));
|
||||
res.on('end', () => {
|
||||
console.log('[TEST] Response completed:', { data });
|
||||
resolve({
|
||||
statusCode: res.statusCode!,
|
||||
headers: res.headers,
|
||||
body: data,
|
||||
});
|
||||
});
|
||||
});
|
||||
req.on('error', (error) => {
|
||||
console.error('[TEST] Request error:', error);
|
||||
reject(error);
|
||||
});
|
||||
req.end();
|
||||
});
|
||||
}
|
||||
|
||||
// Setup test environment
|
||||
tap.test('setup test environment', async () => {
|
||||
// Load and validate certificates
|
||||
console.log('[TEST] Loading and validating certificates');
|
||||
testCertificates = loadTestCertificates();
|
||||
console.log('[TEST] Certificates loaded and validated');
|
||||
|
||||
// Create a test HTTP server
|
||||
testServer = http.createServer((req, res) => {
|
||||
console.log('[TEST SERVER] Received HTTP request:', {
|
||||
url: req.url,
|
||||
method: req.method,
|
||||
headers: req.headers,
|
||||
});
|
||||
res.writeHead(200, { 'Content-Type': 'text/plain' });
|
||||
res.end('Hello from test server!');
|
||||
});
|
||||
|
||||
// Handle WebSocket upgrade requests
|
||||
testServer.on('upgrade', (request, socket, head) => {
|
||||
console.log('[TEST SERVER] Received WebSocket upgrade request:', {
|
||||
url: request.url,
|
||||
method: request.method,
|
||||
headers: {
|
||||
host: request.headers.host,
|
||||
upgrade: request.headers.upgrade,
|
||||
connection: request.headers.connection,
|
||||
'sec-websocket-key': request.headers['sec-websocket-key'],
|
||||
'sec-websocket-version': request.headers['sec-websocket-version'],
|
||||
'sec-websocket-protocol': request.headers['sec-websocket-protocol'],
|
||||
},
|
||||
});
|
||||
|
||||
if (request.headers.upgrade?.toLowerCase() !== 'websocket') {
|
||||
console.log('[TEST SERVER] Not a WebSocket upgrade request');
|
||||
socket.destroy();
|
||||
return;
|
||||
}
|
||||
|
||||
console.log('[TEST SERVER] Handling WebSocket upgrade');
|
||||
wsServer.handleUpgrade(request, socket, head, (ws) => {
|
||||
console.log('[TEST SERVER] WebSocket connection upgraded');
|
||||
wsServer.emit('connection', ws, request);
|
||||
});
|
||||
});
|
||||
|
||||
// Create a WebSocket server (for the test HTTP server)
|
||||
console.log('[TEST SERVER] Creating WebSocket server');
|
||||
wsServer = new WebSocketServer({
|
||||
noServer: true,
|
||||
perMessageDeflate: false,
|
||||
clientTracking: true,
|
||||
handleProtocols: () => 'echo-protocol',
|
||||
});
|
||||
|
||||
wsServer.on('connection', (ws, request) => {
|
||||
console.log('[TEST SERVER] WebSocket connection established:', {
|
||||
url: request.url,
|
||||
headers: {
|
||||
host: request.headers.host,
|
||||
upgrade: request.headers.upgrade,
|
||||
connection: request.headers.connection,
|
||||
'sec-websocket-key': request.headers['sec-websocket-key'],
|
||||
'sec-websocket-version': request.headers['sec-websocket-version'],
|
||||
'sec-websocket-protocol': request.headers['sec-websocket-protocol'],
|
||||
},
|
||||
});
|
||||
|
||||
// Set up connection timeout
|
||||
const connectionTimeout = setTimeout(() => {
|
||||
console.error('[TEST SERVER] WebSocket connection timed out');
|
||||
ws.terminate();
|
||||
}, 5000);
|
||||
|
||||
// Clear timeout when connection is properly closed
|
||||
const clearConnectionTimeout = () => {
|
||||
clearTimeout(connectionTimeout);
|
||||
};
|
||||
|
||||
ws.on('message', (message) => {
|
||||
const msg = message.toString();
|
||||
console.log('[TEST SERVER] Received message:', msg);
|
||||
try {
|
||||
const response = `Echo: ${msg}`;
|
||||
console.log('[TEST SERVER] Sending response:', response);
|
||||
ws.send(response);
|
||||
// Clear timeout on successful message exchange
|
||||
clearConnectionTimeout();
|
||||
} catch (error) {
|
||||
console.error('[TEST SERVER] Error sending message:', error);
|
||||
}
|
||||
});
|
||||
|
||||
ws.on('error', (error) => {
|
||||
console.error('[TEST SERVER] WebSocket error:', error);
|
||||
clearConnectionTimeout();
|
||||
});
|
||||
|
||||
ws.on('close', (code, reason) => {
|
||||
console.log('[TEST SERVER] WebSocket connection closed:', {
|
||||
code,
|
||||
reason: reason.toString(),
|
||||
wasClean: code === 1000 || code === 1001,
|
||||
});
|
||||
clearConnectionTimeout();
|
||||
});
|
||||
|
||||
ws.on('ping', (data) => {
|
||||
try {
|
||||
console.log('[TEST SERVER] Received ping, sending pong');
|
||||
ws.pong(data);
|
||||
} catch (error) {
|
||||
console.error('[TEST SERVER] Error sending pong:', error);
|
||||
}
|
||||
});
|
||||
|
||||
ws.on('pong', (data) => {
|
||||
console.log('[TEST SERVER] Received pong');
|
||||
});
|
||||
});
|
||||
|
||||
wsServer.on('error', (error) => {
|
||||
console.error('Test server: WebSocket server error:', error);
|
||||
});
|
||||
|
||||
wsServer.on('headers', (headers) => {
|
||||
console.log('Test server: WebSocket headers:', headers);
|
||||
});
|
||||
|
||||
wsServer.on('close', () => {
|
||||
console.log('Test server: WebSocket server closed');
|
||||
});
|
||||
|
||||
await new Promise<void>((resolve) => testServer.listen(3000, resolve));
|
||||
console.log('Test server listening on port 3000');
|
||||
});
|
||||
|
||||
tap.test('should create proxy instance', async () => {
|
||||
// Test with the original minimal options (only port)
|
||||
testProxy = new smartproxy.NetworkProxy({
|
||||
port: 3001,
|
||||
});
|
||||
expect(testProxy).toEqual(testProxy); // Instance equality check
|
||||
});
|
||||
|
||||
tap.test('should create proxy instance with extended options', async () => {
|
||||
// Test with extended options to verify backward compatibility
|
||||
testProxy = new smartproxy.NetworkProxy({
|
||||
port: 3001,
|
||||
maxConnections: 5000,
|
||||
keepAliveTimeout: 120000,
|
||||
headersTimeout: 60000,
|
||||
logLevel: 'info',
|
||||
cors: {
|
||||
allowOrigin: '*',
|
||||
allowMethods: 'GET, POST, OPTIONS',
|
||||
allowHeaders: 'Content-Type',
|
||||
maxAge: 3600
|
||||
}
|
||||
});
|
||||
expect(testProxy).toEqual(testProxy); // Instance equality check
|
||||
expect(testProxy.options.port).toEqual(3001);
|
||||
});
|
||||
|
||||
tap.test('should start the proxy server', async () => {
|
||||
// Ensure any previous server is closed
|
||||
if (testProxy && testProxy.httpsServer) {
|
||||
await new Promise<void>((resolve) =>
|
||||
testProxy.httpsServer.close(() => resolve())
|
||||
);
|
||||
}
|
||||
|
||||
console.log('[TEST] Starting the proxy server');
|
||||
await testProxy.start();
|
||||
console.log('[TEST] Proxy server started');
|
||||
|
||||
// Configure proxy with test certificates
|
||||
// Awaiting the update ensures that the SNI context is added before any requests come in.
|
||||
await testProxy.updateProxyConfigs([
|
||||
{
|
||||
destinationIps: ['127.0.0.1'],
|
||||
destinationPorts: [3000],
|
||||
hostName: 'push.rocks',
|
||||
publicKey: testCertificates.publicKey,
|
||||
privateKey: testCertificates.privateKey,
|
||||
},
|
||||
]);
|
||||
|
||||
console.log('[TEST] Proxy configuration updated');
|
||||
});
|
||||
|
||||
tap.test('should route HTTPS requests based on host header', async () => {
|
||||
// IMPORTANT: Connect to localhost (where the proxy is listening) but use the Host header "push.rocks"
|
||||
const response = await makeHttpsRequest({
|
||||
hostname: 'localhost', // changed from 'push.rocks' to 'localhost'
|
||||
port: 3001,
|
||||
path: '/',
|
||||
method: 'GET',
|
||||
headers: {
|
||||
host: 'push.rocks', // virtual host for routing
|
||||
},
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
|
||||
expect(response.statusCode).toEqual(200);
|
||||
expect(response.body).toEqual('Hello from test server!');
|
||||
});
|
||||
|
||||
tap.test('should handle unknown host headers', async () => {
|
||||
// Connect to localhost but use an unknown host header.
|
||||
const response = await makeHttpsRequest({
|
||||
hostname: 'localhost', // connecting to localhost
|
||||
port: 3001,
|
||||
path: '/',
|
||||
method: 'GET',
|
||||
headers: {
|
||||
host: 'unknown.host', // this should not match any proxy config
|
||||
},
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
|
||||
// Expect a 404 response with the appropriate error message.
|
||||
expect(response.statusCode).toEqual(404);
|
||||
});
|
||||
|
||||
tap.test('should support WebSocket connections', async () => {
|
||||
console.log('\n[TEST] ====== WebSocket Test Started ======');
|
||||
console.log('[TEST] Test server port:', 3000);
|
||||
console.log('[TEST] Proxy server port:', 3001);
|
||||
console.log('\n[TEST] Starting WebSocket test');
|
||||
|
||||
// Reconfigure proxy with test certificates if necessary
|
||||
await testProxy.updateProxyConfigs([
|
||||
{
|
||||
destinationIps: ['127.0.0.1'],
|
||||
destinationPorts: [3000],
|
||||
hostName: 'push.rocks',
|
||||
publicKey: testCertificates.publicKey,
|
||||
privateKey: testCertificates.privateKey,
|
||||
},
|
||||
]);
|
||||
|
||||
return new Promise<void>((resolve, reject) => {
|
||||
console.log('[TEST] Creating WebSocket client');
|
||||
|
||||
// IMPORTANT: Connect to localhost but specify the SNI servername and Host header as "push.rocks"
|
||||
const wsUrl = 'wss://localhost:3001'; // changed from 'wss://push.rocks:3001'
|
||||
console.log('[TEST] Creating WebSocket connection to:', wsUrl);
|
||||
|
||||
const ws = new WebSocket(wsUrl, {
|
||||
rejectUnauthorized: false, // Accept self-signed certificates
|
||||
handshakeTimeout: 5000,
|
||||
perMessageDeflate: false,
|
||||
headers: {
|
||||
Host: 'push.rocks', // required for SNI and routing on the proxy
|
||||
Connection: 'Upgrade',
|
||||
Upgrade: 'websocket',
|
||||
'Sec-WebSocket-Version': '13',
|
||||
},
|
||||
protocol: 'echo-protocol',
|
||||
agent: new https.Agent({
|
||||
rejectUnauthorized: false, // Also needed for the underlying HTTPS connection
|
||||
}),
|
||||
});
|
||||
|
||||
console.log('[TEST] WebSocket client created');
|
||||
|
||||
let resolved = false;
|
||||
const cleanup = () => {
|
||||
if (!resolved) {
|
||||
resolved = true;
|
||||
try {
|
||||
console.log('[TEST] Cleaning up WebSocket connection');
|
||||
ws.close();
|
||||
resolve();
|
||||
} catch (error) {
|
||||
console.error('[TEST] Error during cleanup:', error);
|
||||
reject(error);
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
const timeout = setTimeout(() => {
|
||||
console.error('[TEST] WebSocket test timed out');
|
||||
cleanup();
|
||||
reject(new Error('WebSocket test timed out after 5 seconds'));
|
||||
}, 5000);
|
||||
|
||||
// Connection establishment events
|
||||
ws.on('upgrade', (response) => {
|
||||
console.log('[TEST] WebSocket upgrade response received:', {
|
||||
headers: response.headers,
|
||||
statusCode: response.statusCode,
|
||||
});
|
||||
});
|
||||
|
||||
ws.on('open', () => {
|
||||
console.log('[TEST] WebSocket connection opened');
|
||||
try {
|
||||
console.log('[TEST] Sending test message');
|
||||
ws.send('Hello WebSocket');
|
||||
} catch (error) {
|
||||
console.error('[TEST] Error sending message:', error);
|
||||
cleanup();
|
||||
reject(error);
|
||||
}
|
||||
});
|
||||
|
||||
ws.on('message', (message) => {
|
||||
console.log('[TEST] Received message:', message.toString());
|
||||
if (
|
||||
message.toString() === 'Hello WebSocket' ||
|
||||
message.toString() === 'Echo: Hello WebSocket'
|
||||
) {
|
||||
console.log('[TEST] Message received correctly');
|
||||
clearTimeout(timeout);
|
||||
cleanup();
|
||||
}
|
||||
});
|
||||
|
||||
ws.on('error', (error) => {
|
||||
console.error('[TEST] WebSocket error:', error);
|
||||
cleanup();
|
||||
reject(error);
|
||||
});
|
||||
|
||||
ws.on('close', (code, reason) => {
|
||||
console.log('[TEST] WebSocket connection closed:', {
|
||||
code,
|
||||
reason: reason.toString(),
|
||||
});
|
||||
cleanup();
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
tap.test('should handle custom headers', async () => {
|
||||
await testProxy.addDefaultHeaders({
|
||||
'X-Proxy-Header': 'test-value',
|
||||
});
|
||||
|
||||
const response = await makeHttpsRequest({
|
||||
hostname: 'localhost', // changed to 'localhost'
|
||||
port: 3001,
|
||||
path: '/',
|
||||
method: 'GET',
|
||||
headers: {
|
||||
host: 'push.rocks', // still routing to push.rocks
|
||||
},
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
|
||||
expect(response.headers['x-proxy-header']).toEqual('test-value');
|
||||
});
|
||||
|
||||
tap.test('should handle CORS preflight requests', async () => {
|
||||
try {
|
||||
console.log('[TEST] Testing CORS preflight handling...');
|
||||
|
||||
// First ensure the existing proxy is working correctly
|
||||
console.log('[TEST] Making initial GET request to verify server');
|
||||
const initialResponse = await makeHttpsRequest({
|
||||
hostname: 'localhost',
|
||||
port: 3001,
|
||||
path: '/',
|
||||
method: 'GET',
|
||||
headers: { host: 'push.rocks' },
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
|
||||
console.log('[TEST] Initial response status:', initialResponse.statusCode);
|
||||
expect(initialResponse.statusCode).toEqual(200);
|
||||
|
||||
// Add CORS headers to the existing proxy
|
||||
console.log('[TEST] Adding CORS headers');
|
||||
await testProxy.addDefaultHeaders({
|
||||
'Access-Control-Allow-Origin': '*',
|
||||
'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
|
||||
'Access-Control-Allow-Headers': 'Content-Type, Authorization',
|
||||
'Access-Control-Max-Age': '86400'
|
||||
});
|
||||
|
||||
// Allow server to process the header changes
|
||||
console.log('[TEST] Waiting for headers to be processed');
|
||||
await new Promise(resolve => setTimeout(resolve, 500)); // Increased timeout
|
||||
|
||||
// Send OPTIONS request to simulate CORS preflight
|
||||
console.log('[TEST] Sending OPTIONS request for CORS preflight');
|
||||
const response = await makeHttpsRequest({
|
||||
hostname: 'localhost',
|
||||
port: 3001,
|
||||
path: '/',
|
||||
method: 'OPTIONS',
|
||||
headers: {
|
||||
host: 'push.rocks',
|
||||
'Access-Control-Request-Method': 'POST',
|
||||
'Access-Control-Request-Headers': 'Content-Type',
|
||||
'Origin': 'https://example.com'
|
||||
},
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
|
||||
console.log('[TEST] CORS preflight response status:', response.statusCode);
|
||||
console.log('[TEST] CORS preflight response headers:', response.headers);
|
||||
|
||||
// For now, accept either 204 or 200 as success
|
||||
expect([200, 204]).toContain(response.statusCode);
|
||||
console.log('[TEST] CORS test completed successfully');
|
||||
} catch (error) {
|
||||
console.error('[TEST] Error in CORS test:', error);
|
||||
throw error; // Rethrow to fail the test
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('should track connections and metrics', async () => {
|
||||
try {
|
||||
console.log('[TEST] Testing metrics tracking...');
|
||||
|
||||
// Get initial metrics counts
|
||||
const initialRequestsServed = testProxy.requestsServed || 0;
|
||||
console.log('[TEST] Initial requests served:', initialRequestsServed);
|
||||
|
||||
// Make a few requests to ensure we have metrics to check
|
||||
console.log('[TEST] Making test requests to increment metrics');
|
||||
for (let i = 0; i < 3; i++) {
|
||||
console.log(`[TEST] Making request ${i+1}/3`);
|
||||
await makeHttpsRequest({
|
||||
hostname: 'localhost',
|
||||
port: 3001,
|
||||
path: '/metrics-test-' + i,
|
||||
method: 'GET',
|
||||
headers: { host: 'push.rocks' },
|
||||
rejectUnauthorized: false,
|
||||
});
|
||||
}
|
||||
|
||||
// Wait a bit to let metrics update
|
||||
console.log('[TEST] Waiting for metrics to update');
|
||||
await new Promise(resolve => setTimeout(resolve, 500)); // Increased timeout
|
||||
|
||||
// Verify metrics tracking is working
|
||||
console.log('[TEST] Current requests served:', testProxy.requestsServed);
|
||||
console.log('[TEST] Connected clients:', testProxy.connectedClients);
|
||||
|
||||
expect(testProxy.connectedClients).toBeDefined();
|
||||
expect(typeof testProxy.requestsServed).toEqual('number');
|
||||
|
||||
// Use ">=" instead of ">" to be more forgiving with edge cases
|
||||
expect(testProxy.requestsServed).toBeGreaterThanOrEqual(initialRequestsServed + 2);
|
||||
console.log('[TEST] Metrics test completed successfully');
|
||||
} catch (error) {
|
||||
console.error('[TEST] Error in metrics test:', error);
|
||||
throw error; // Rethrow to fail the test
|
||||
}
|
||||
});
|
||||
|
||||
tap.test('cleanup', async () => {
|
||||
try {
|
||||
console.log('[TEST] Starting cleanup');
|
||||
|
||||
// Clean up all servers
|
||||
console.log('[TEST] Terminating WebSocket clients');
|
||||
try {
|
||||
wsServer.clients.forEach((client) => {
|
||||
try {
|
||||
client.terminate();
|
||||
} catch (err) {
|
||||
console.error('[TEST] Error terminating client:', err);
|
||||
}
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('[TEST] Error accessing WebSocket clients:', err);
|
||||
}
|
||||
|
||||
console.log('[TEST] Closing WebSocket server');
|
||||
try {
|
||||
await new Promise<void>((resolve) => {
|
||||
wsServer.close(() => {
|
||||
console.log('[TEST] WebSocket server closed');
|
||||
resolve();
|
||||
});
|
||||
// Add timeout to prevent hanging
|
||||
setTimeout(() => {
|
||||
console.log('[TEST] WebSocket server close timed out, continuing');
|
||||
resolve();
|
||||
}, 1000);
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('[TEST] Error closing WebSocket server:', err);
|
||||
}
|
||||
|
||||
console.log('[TEST] Closing test server');
|
||||
try {
|
||||
await new Promise<void>((resolve) => {
|
||||
testServer.close(() => {
|
||||
console.log('[TEST] Test server closed');
|
||||
resolve();
|
||||
});
|
||||
// Add timeout to prevent hanging
|
||||
setTimeout(() => {
|
||||
console.log('[TEST] Test server close timed out, continuing');
|
||||
resolve();
|
||||
}, 1000);
|
||||
});
|
||||
} catch (err) {
|
||||
console.error('[TEST] Error closing test server:', err);
|
||||
}
|
||||
|
||||
console.log('[TEST] Stopping proxy');
|
||||
try {
|
||||
await testProxy.stop();
|
||||
} catch (err) {
|
||||
console.error('[TEST] Error stopping proxy:', err);
|
||||
}
|
||||
|
||||
console.log('[TEST] Cleanup complete');
|
||||
} catch (error) {
|
||||
console.error('[TEST] Error during cleanup:', error);
|
||||
// Don't throw here - we want cleanup to always complete
|
||||
}
|
||||
});
|
||||
|
||||
process.on('exit', () => {
|
||||
console.log('[TEST] Shutting down test server');
|
||||
testServer.close(() => console.log('[TEST] Test server shut down'));
|
||||
wsServer.close(() => console.log('[TEST] WebSocket server shut down'));
|
||||
testProxy.stop().then(() => console.log('[TEST] Proxy server stopped'));
|
||||
});
|
||||
|
||||
tap.start();
|
||||
Reference in New Issue
Block a user