@push.rocks/smartproxy 5.0.0 → 6.0.0

package/ts/networkproxy/classes.np.requesthandler.ts

@@ -0,0 +1,278 @@
+import * as plugins from '../plugins.js';
+import { type INetworkProxyOptions, type ILogger, createLogger, type IReverseProxyConfig } from './classes.np.types.js';
+import { ConnectionPool } from './classes.np.connectionpool.js';
+import { ProxyRouter } from '../classes.router.js';
+
+/**
+ * Interface for tracking metrics
+ */
+export interface IMetricsTracker {
+  incrementRequestsServed(): void;
+  incrementFailedRequests(): void;
+}
+
+/**
+ * Handles HTTP request processing and proxying
+ */
+export class RequestHandler {
+  private defaultHeaders: { [key: string]: string } = {};
+  private logger: ILogger;
+  private metricsTracker: IMetricsTracker | null = null;
+  
+  constructor(
+    private options: INetworkProxyOptions,
+    private connectionPool: ConnectionPool,
+    private router: ProxyRouter
+  ) {
+    this.logger = createLogger(options.logLevel || 'info');
+  }
+  
+  /**
+   * Set the metrics tracker instance
+   */
+  public setMetricsTracker(tracker: IMetricsTracker): void {
+    this.metricsTracker = tracker;
+  }
+  
+  /**
+   * Set default headers to be included in all responses
+   */
+  public setDefaultHeaders(headers: { [key: string]: string }): void {
+    this.defaultHeaders = {
+      ...this.defaultHeaders,
+      ...headers
+    };
+    this.logger.info('Updated default response headers');
+  }
+  
+  /**
+   * Get all default headers
+   */
+  public getDefaultHeaders(): { [key: string]: string } {
+    return { ...this.defaultHeaders };
+  }
+  
+  /**
+   * Apply CORS headers to response if configured
+   */
+  private applyCorsHeaders(
+    res: plugins.http.ServerResponse, 
+    req: plugins.http.IncomingMessage
+  ): void {
+    if (!this.options.cors) {
+      return;
+    }
+    
+    // Apply CORS headers
+    if (this.options.cors.allowOrigin) {
+      res.setHeader('Access-Control-Allow-Origin', this.options.cors.allowOrigin);
+    }
+    
+    if (this.options.cors.allowMethods) {
+      res.setHeader('Access-Control-Allow-Methods', this.options.cors.allowMethods);
+    }
+    
+    if (this.options.cors.allowHeaders) {
+      res.setHeader('Access-Control-Allow-Headers', this.options.cors.allowHeaders);
+    }
+    
+    if (this.options.cors.maxAge) {
+      res.setHeader('Access-Control-Max-Age', this.options.cors.maxAge.toString());
+    }
+    
+    // Handle CORS preflight requests
+    if (req.method === 'OPTIONS') {
+      res.statusCode = 204; // No content
+      res.end();
+      return;
+    }
+  }
+  
+  /**
+   * Apply default headers to response
+   */
+  private applyDefaultHeaders(res: plugins.http.ServerResponse): void {
+    // Apply default headers
+    for (const [key, value] of Object.entries(this.defaultHeaders)) {
+      if (!res.hasHeader(key)) {
+        res.setHeader(key, value);
+      }
+    }
+    
+    // Add server identifier if not already set
+    if (!res.hasHeader('Server')) {
+      res.setHeader('Server', 'NetworkProxy');
+    }
+  }
+  
+  /**
+   * Handle an HTTP request
+   */
+  public async handleRequest(
+    req: plugins.http.IncomingMessage,
+    res: plugins.http.ServerResponse
+  ): Promise<void> {
+    // Record start time for logging
+    const startTime = Date.now();
+    
+    // Apply CORS headers if configured
+    this.applyCorsHeaders(res, req);
+    
+    // If this is an OPTIONS request, the response has already been ended in applyCorsHeaders
+    // so we should return early to avoid trying to set more headers
+    if (req.method === 'OPTIONS') {
+      // Increment metrics for OPTIONS requests too
+      if (this.metricsTracker) {
+        this.metricsTracker.incrementRequestsServed();
+      }
+      return;
+    }
+    
+    // Apply default headers
+    this.applyDefaultHeaders(res);
+    
+    try {
+      // Find target based on hostname
+      const proxyConfig = this.router.routeReq(req);
+      
+      if (!proxyConfig) {
+        // No matching proxy configuration
+        this.logger.warn(`No proxy configuration for host: ${req.headers.host}`);
+        res.statusCode = 404;
+        res.end('Not Found: No proxy configuration for this host');
+        
+        // Increment failed requests counter
+        if (this.metricsTracker) {
+          this.metricsTracker.incrementFailedRequests();
+        }
+        
+        return;
+      }
+      
+      // Get destination IP using round-robin if multiple IPs configured
+      const destination = this.connectionPool.getNextTarget(
+        proxyConfig.destinationIps, 
+        proxyConfig.destinationPorts[0]
+      );
+      
+      // Create options for the proxy request
+      const options: plugins.http.RequestOptions = {
+        hostname: destination.host,
+        port: destination.port,
+        path: req.url,
+        method: req.method,
+        headers: { ...req.headers }
+      };
+      
+      // Remove host header to avoid issues with virtual hosts on target server
+      // The host header should match the target server's expected hostname
+      if (options.headers && options.headers.host) {
+        if ((proxyConfig as IReverseProxyConfig).rewriteHostHeader) {
+          options.headers.host = `${destination.host}:${destination.port}`;
+        }
+      }
+      
+      this.logger.debug(
+        `Proxying request to ${destination.host}:${destination.port}${req.url}`,
+        { method: req.method }
+      );
+      
+      // Create proxy request
+      const proxyReq = plugins.http.request(options, (proxyRes) => {
+        // Copy status code
+        res.statusCode = proxyRes.statusCode || 500;
+        
+        // Copy headers from proxy response to client response
+        for (const [key, value] of Object.entries(proxyRes.headers)) {
+          if (value !== undefined) {
+            res.setHeader(key, value);
+          }
+        }
+        
+        // Pipe proxy response to client response
+        proxyRes.pipe(res);
+        
+        // Increment served requests counter when the response finishes
+        res.on('finish', () => {
+          if (this.metricsTracker) {
+            this.metricsTracker.incrementRequestsServed();
+          }
+          
+          // Log the completed request
+          const duration = Date.now() - startTime;
+          this.logger.debug(
+            `Request completed in ${duration}ms: ${req.method} ${req.url} ${res.statusCode}`,
+            { duration, statusCode: res.statusCode }
+          );
+        });
+      });
+      
+      // Handle proxy request errors
+      proxyReq.on('error', (error) => {
+        const duration = Date.now() - startTime;
+        this.logger.error(
+          `Proxy error for ${req.method} ${req.url}: ${error.message}`,
+          { duration, error: error.message }
+        );
+        
+        // Increment failed requests counter
+        if (this.metricsTracker) {
+          this.metricsTracker.incrementFailedRequests();
+        }
+        
+        // Check if headers have already been sent
+        if (!res.headersSent) {
+          res.statusCode = 502;
+          res.end(`Bad Gateway: ${error.message}`);
+        } else {
+          // If headers already sent, just close the connection
+          res.end();
+        }
+      });
+      
+      // Pipe request body to proxy request and handle client-side errors
+      req.pipe(proxyReq);
+      
+      // Handle client disconnection
+      req.on('error', (error) => {
+        this.logger.debug(`Client connection error: ${error.message}`);
+        proxyReq.destroy();
+        
+        // Increment failed requests counter on client errors
+        if (this.metricsTracker) {
+          this.metricsTracker.incrementFailedRequests();
+        }
+      });
+      
+      // Handle response errors
+      res.on('error', (error) => {
+        this.logger.debug(`Response error: ${error.message}`);
+        proxyReq.destroy();
+        
+        // Increment failed requests counter on response errors
+        if (this.metricsTracker) {
+          this.metricsTracker.incrementFailedRequests();
+        }
+      });
+      
+    } catch (error) {
+      // Handle any unexpected errors
+      this.logger.error(
+        `Unexpected error handling request: ${error.message}`,
+        { error: error.stack }
+      );
+      
+      // Increment failed requests counter
+      if (this.metricsTracker) {
+        this.metricsTracker.incrementFailedRequests();
+      }
+      
+      if (!res.headersSent) {
+        res.statusCode = 500;
+        res.end('Internal Server Error');
+      } else {
+        res.end();
+      }
+    }
+  }
+}

package/ts/networkproxy/classes.np.types.ts

@@ -0,0 +1,123 @@
+import * as plugins from '../plugins.js';
+
+/**
+ * Configuration options for NetworkProxy
+ */
+export interface INetworkProxyOptions {
+  port: number;
+  maxConnections?: number;
+  keepAliveTimeout?: number;
+  headersTimeout?: number;
+  logLevel?: 'error' | 'warn' | 'info' | 'debug';
+  cors?: {
+    allowOrigin?: string;
+    allowMethods?: string;
+    allowHeaders?: string;
+    maxAge?: number;
+  };
+  
+  // Settings for PortProxy integration
+  connectionPoolSize?: number; // Maximum connections to maintain in the pool to each backend
+  portProxyIntegration?: boolean; // Flag to indicate this proxy is used by PortProxy
+  useExternalPort80Handler?: boolean; // Flag to indicate using external Port80Handler
+  
+  // ACME certificate management options
+  acme?: {
+    enabled?: boolean;              // Whether to enable automatic certificate management
+    port?: number;                  // Port to listen on for ACME challenges (default: 80)
+    contactEmail?: string;          // Email for Let's Encrypt account 
+    useProduction?: boolean;        // Whether to use Let's Encrypt production (default: false for staging)
+    renewThresholdDays?: number;    // Days before expiry to renew certificates (default: 30)
+    autoRenew?: boolean;            // Whether to automatically renew certificates (default: true)
+    certificateStore?: string;      // Directory to store certificates (default: ./certs)
+    skipConfiguredCerts?: boolean;  // Skip domains that already have certificates configured
+  };
+}
+
+/**
+ * Interface for a certificate entry in the cache
+ */
+export interface ICertificateEntry {
+  key: string;
+  cert: string;
+  expires?: Date;
+}
+
+/**
+ * Interface for reverse proxy configuration
+ */
+export interface IReverseProxyConfig {
+  destinationIps: string[];
+  destinationPorts: number[];
+  hostName: string;
+  privateKey: string;
+  publicKey: string;
+  authentication?: {
+    type: 'Basic';
+    user: string;
+    pass: string;
+  };
+  rewriteHostHeader?: boolean;
+}
+
+/**
+ * Interface for connection tracking in the pool
+ */
+export interface IConnectionEntry {
+  socket: plugins.net.Socket;
+  lastUsed: number;
+  isIdle: boolean;
+}
+
+/**
+ * WebSocket with heartbeat interface
+ */
+export interface IWebSocketWithHeartbeat extends plugins.wsDefault {
+  lastPong: number;
+  isAlive: boolean;
+}
+
+/**
+ * Logger interface for consistent logging across components
+ */
+export interface ILogger {
+  debug(message: string, data?: any): void;
+  info(message: string, data?: any): void;
+  warn(message: string, data?: any): void;
+  error(message: string, data?: any): void;
+}
+
+/**
+ * Creates a logger based on the specified log level
+ */
+export function createLogger(logLevel: string = 'info'): ILogger {
+  const logLevels = {
+    error: 0,
+    warn: 1,
+    info: 2,
+    debug: 3
+  };
+  
+  return {
+    debug: (message: string, data?: any) => {
+      if (logLevels[logLevel] >= logLevels.debug) {
+        console.log(`[DEBUG] ${message}`, data || '');
+      }
+    },
+    info: (message: string, data?: any) => {
+      if (logLevels[logLevel] >= logLevels.info) {
+        console.log(`[INFO] ${message}`, data || '');
+      }
+    },
+    warn: (message: string, data?: any) => {
+      if (logLevels[logLevel] >= logLevels.warn) {
+        console.warn(`[WARN] ${message}`, data || '');
+      }
+    },
+    error: (message: string, data?: any) => {
+      if (logLevels[logLevel] >= logLevels.error) {
+        console.error(`[ERROR] ${message}`, data || '');
+      }
+    }
+  };
+}

package/ts/networkproxy/classes.np.websockethandler.ts

@@ -0,0 +1,226 @@
+import * as plugins from '../plugins.js';
+import { type INetworkProxyOptions, type IWebSocketWithHeartbeat, type ILogger, createLogger, type IReverseProxyConfig } from './classes.np.types.js';
+import { ConnectionPool } from './classes.np.connectionpool.js';
+import { ProxyRouter } from '../classes.router.js';
+
+/**
+ * Handles WebSocket connections and proxying
+ */
+export class WebSocketHandler {
+  private heartbeatInterval: NodeJS.Timeout | null = null;
+  private wsServer: plugins.ws.WebSocketServer | null = null;
+  private logger: ILogger;
+  
+  constructor(
+    private options: INetworkProxyOptions,
+    private connectionPool: ConnectionPool,
+    private router: ProxyRouter
+  ) {
+    this.logger = createLogger(options.logLevel || 'info');
+  }
+  
+  /**
+   * Initialize WebSocket server on an existing HTTPS server
+   */
+  public initialize(server: plugins.https.Server): void {
+    // Create WebSocket server
+    this.wsServer = new plugins.ws.WebSocketServer({ 
+      server: server,
+      clientTracking: true
+    });
+
+    // Handle WebSocket connections
+    this.wsServer.on('connection', (wsIncoming: IWebSocketWithHeartbeat, req: plugins.http.IncomingMessage) => {
+      this.handleWebSocketConnection(wsIncoming, req);
+    });
+    
+    // Start the heartbeat interval
+    this.startHeartbeat();
+    
+    this.logger.info('WebSocket handler initialized');
+  }
+  
+  /**
+   * Start the heartbeat interval to check for inactive WebSocket connections
+   */
+  private startHeartbeat(): void {
+    // Clean up existing interval if any
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
+    }
+    
+    // Set up the heartbeat interval (check every 30 seconds)
+    this.heartbeatInterval = setInterval(() => {
+      if (!this.wsServer || this.wsServer.clients.size === 0) {
+        return; // Skip if no active connections
+      }
+      
+      this.logger.debug(`WebSocket heartbeat check for ${this.wsServer.clients.size} clients`);
+      
+      this.wsServer.clients.forEach((ws: plugins.wsDefault) => {
+        const wsWithHeartbeat = ws as IWebSocketWithHeartbeat;
+        
+        if (wsWithHeartbeat.isAlive === false) {
+          this.logger.debug('Terminating inactive WebSocket connection');
+          return wsWithHeartbeat.terminate();
+        }
+        
+        wsWithHeartbeat.isAlive = false;
+        wsWithHeartbeat.ping();
+      });
+    }, 30000);
+
+    // Make sure the interval doesn't keep the process alive
+    if (this.heartbeatInterval.unref) {
+      this.heartbeatInterval.unref();
+    }
+  }
+  
+  /**
+   * Handle a new WebSocket connection
+   */
+  private handleWebSocketConnection(wsIncoming: IWebSocketWithHeartbeat, req: plugins.http.IncomingMessage): void {
+    try {
+      // Initialize heartbeat tracking
+      wsIncoming.isAlive = true;
+      wsIncoming.lastPong = Date.now();
+      
+      // Handle pong messages to track liveness
+      wsIncoming.on('pong', () => {
+        wsIncoming.isAlive = true;
+        wsIncoming.lastPong = Date.now();
+      });
+      
+      // Find target configuration based on request
+      const proxyConfig = this.router.routeReq(req);
+      
+      if (!proxyConfig) {
+        this.logger.warn(`No proxy configuration for WebSocket host: ${req.headers.host}`);
+        wsIncoming.close(1008, 'No proxy configuration for this host');
+        return;
+      }
+      
+      // Get destination target using round-robin if multiple targets
+      const destination = this.connectionPool.getNextTarget(
+        proxyConfig.destinationIps, 
+        proxyConfig.destinationPorts[0]
+      );
+      
+      // Build target URL
+      const protocol = (req.socket as any).encrypted ? 'wss' : 'ws';
+      const targetUrl = `${protocol}://${destination.host}:${destination.port}${req.url}`;
+      
+      this.logger.debug(`WebSocket connection from ${req.socket.remoteAddress} to ${targetUrl}`);
+      
+      // Create headers for outgoing WebSocket connection
+      const headers: { [key: string]: string } = {};
+      
+      // Copy relevant headers from incoming request
+      for (const [key, value] of Object.entries(req.headers)) {
+        if (value && typeof value === 'string' && 
+            key.toLowerCase() !== 'connection' && 
+            key.toLowerCase() !== 'upgrade' &&
+            key.toLowerCase() !== 'sec-websocket-key' &&
+            key.toLowerCase() !== 'sec-websocket-version') {
+          headers[key] = value;
+        }
+      }
+      
+      // Override host header if needed
+      if ((proxyConfig as IReverseProxyConfig).rewriteHostHeader) {
+        headers['host'] = `${destination.host}:${destination.port}`;
+      }
+      
+      // Create outgoing WebSocket connection
+      const wsOutgoing = new plugins.wsDefault(targetUrl, {
+        headers: headers,
+        followRedirects: true
+      });
+      
+      // Handle connection errors
+      wsOutgoing.on('error', (err) => {
+        this.logger.error(`WebSocket target connection error: ${err.message}`);
+        if (wsIncoming.readyState === wsIncoming.OPEN) {
+          wsIncoming.close(1011, 'Internal server error');
+        }
+      });
+      
+      // Handle outgoing connection open
+      wsOutgoing.on('open', () => {
+        // Forward incoming messages to outgoing connection
+        wsIncoming.on('message', (data, isBinary) => {
+          if (wsOutgoing.readyState === wsOutgoing.OPEN) {
+            wsOutgoing.send(data, { binary: isBinary });
+          }
+        });
+        
+        // Forward outgoing messages to incoming connection
+        wsOutgoing.on('message', (data, isBinary) => {
+          if (wsIncoming.readyState === wsIncoming.OPEN) {
+            wsIncoming.send(data, { binary: isBinary });
+          }
+        });
+        
+        // Handle closing of connections
+        wsIncoming.on('close', (code, reason) => {
+          this.logger.debug(`WebSocket client connection closed: ${code} ${reason}`);
+          if (wsOutgoing.readyState === wsOutgoing.OPEN) {
+            wsOutgoing.close(code, reason);
+          }
+        });
+        
+        wsOutgoing.on('close', (code, reason) => {
+          this.logger.debug(`WebSocket target connection closed: ${code} ${reason}`);
+          if (wsIncoming.readyState === wsIncoming.OPEN) {
+            wsIncoming.close(code, reason);
+          }
+        });
+        
+        this.logger.debug(`WebSocket connection established: ${req.headers.host} -> ${destination.host}:${destination.port}`);
+      });
+      
+    } catch (error) {
+      this.logger.error(`Error handling WebSocket connection: ${error.message}`);
+      if (wsIncoming.readyState === wsIncoming.OPEN) {
+        wsIncoming.close(1011, 'Internal server error');
+      }
+    }
+  }
+  
+  /**
+   * Get information about active WebSocket connections
+   */
+  public getConnectionInfo(): { activeConnections: number } {
+    return {
+      activeConnections: this.wsServer ? this.wsServer.clients.size : 0
+    };
+  }
+  
+  /**
+   * Shutdown the WebSocket handler
+   */
+  public shutdown(): void {
+    // Stop heartbeat interval
+    if (this.heartbeatInterval) {
+      clearInterval(this.heartbeatInterval);
+      this.heartbeatInterval = null;
+    }
+    
+    // Close all WebSocket connections
+    if (this.wsServer) {
+      this.logger.info(`Closing ${this.wsServer.clients.size} WebSocket connections`);
+      
+      for (const client of this.wsServer.clients) {
+        try {
+          client.terminate();
+        } catch (error) {
+          this.logger.error('Error terminating WebSocket client', error);
+        }
+      }
+      
+      // Close the server
+      this.wsServer.close();
+      this.wsServer = null;
+    }
+  }
+}

package/ts/networkproxy/index.ts

@@ -0,0 +1,7 @@
+// Re-export all components for easier imports
+export * from './classes.np.types.js';
+export * from './classes.np.certificatemanager.js';
+export * from './classes.np.connectionpool.js';
+export * from './classes.np.requesthandler.js';
+export * from './classes.np.websockethandler.js';
+export * from './classes.np.networkproxy.js';