feat(rust-bridge): integrate tsrust to build and locate cross-compiled Rust binaries; refactor rust-proxy bridge to use typed IPC and streamline process handling; add @push.rocks/smartrust and update build/dev dependencies
This commit is contained in:
52
readme.md
52
readme.md
@@ -378,7 +378,9 @@ await proxy.updateRoutes([...newRoutes]);
|
||||
// Get real-time metrics
|
||||
const metrics = proxy.getMetrics();
|
||||
console.log(`Active connections: ${metrics.connections.active()}`);
|
||||
console.log(`Requests/sec: ${metrics.throughput.requestsPerSecond()}`);
|
||||
console.log(`Bytes in: ${metrics.totals.bytesIn()}`);
|
||||
console.log(`Requests/sec: ${metrics.requests.perSecond()}`);
|
||||
console.log(`Throughput in: ${metrics.throughput.instant().in} bytes/sec`);
|
||||
|
||||
// Get detailed statistics from the Rust engine
|
||||
const stats = await proxy.getStatistics();
|
||||
@@ -486,8 +488,8 @@ SmartProxy uses a hybrid **Rust + TypeScript** architecture:
|
||||
|
||||
- **Rust Engine** handles all networking, TLS, HTTP proxying, connection management, security, and metrics
|
||||
- **TypeScript** provides the npm API, configuration types, route helpers, validation, and socket handler callbacks
|
||||
- **IPC** — JSON commands/events over stdin/stdout for seamless cross-language communication
|
||||
- **Socket Relay** — a Unix domain socket server for routes requiring TypeScript-side handling (socket handlers, dynamic host/port functions)
|
||||
- **IPC** — The TypeScript wrapper uses [`@push.rocks/smartrust`](https://code.foss.global/push.rocks/smartrust) for type-safe JSON commands/events over stdin/stdout
|
||||
- **Socket Relay** — A Unix domain socket server for routes requiring TypeScript-side handling (socket handlers, dynamic host/port functions)
|
||||
|
||||
## 🎯 Route Configuration Reference
|
||||
|
||||
@@ -699,7 +701,7 @@ interface ISmartProxyOptions {
|
||||
|
||||
// Timeouts
|
||||
connectionTimeout?: number; // Backend connection timeout (default: 30s)
|
||||
initialDataTimeout?: number; // Initial data/SNI timeout (default: 60s)
|
||||
initialDataTimeout?: number; // Initial data/SNI timeout (default: 120s)
|
||||
socketTimeout?: number; // Socket inactivity timeout (default: 1h)
|
||||
maxConnectionLifetime?: number; // Max connection lifetime (default: 24h)
|
||||
inactivityTimeout?: number; // Inactivity timeout (default: 4h)
|
||||
@@ -724,12 +726,40 @@ interface ISmartProxyOptions {
|
||||
// Behavior
|
||||
enableDetailedLogging?: boolean; // Verbose connection logging
|
||||
enableTlsDebugLogging?: boolean; // TLS handshake debug logging
|
||||
|
||||
// Rust binary
|
||||
rustBinaryPath?: string; // Custom path to the Rust binary
|
||||
}
|
||||
```
|
||||
|
||||
### IMetrics Interface
|
||||
|
||||
The `getMetrics()` method returns a cached metrics adapter that polls the Rust engine:
|
||||
|
||||
```typescript
|
||||
const metrics = proxy.getMetrics();
|
||||
|
||||
// Connection metrics
|
||||
metrics.connections.active(); // Current active connections
|
||||
metrics.connections.total(); // Total connections since start
|
||||
metrics.connections.byRoute(); // Map<routeName, activeCount>
|
||||
metrics.connections.byIP(); // Map<ip, activeCount>
|
||||
metrics.connections.topIPs(10); // Top N IPs by connection count
|
||||
|
||||
// Throughput (bytes/sec)
|
||||
metrics.throughput.instant(); // { in: number, out: number }
|
||||
metrics.throughput.recent(); // Recent average
|
||||
metrics.throughput.average(); // Overall average
|
||||
metrics.throughput.byRoute(); // Map<routeName, { in, out }>
|
||||
|
||||
// Request rates
|
||||
metrics.requests.perSecond(); // Requests per second
|
||||
metrics.requests.perMinute(); // Requests per minute
|
||||
metrics.requests.total(); // Total requests
|
||||
|
||||
// Cumulative totals
|
||||
metrics.totals.bytesIn(); // Total bytes received
|
||||
metrics.totals.bytesOut(); // Total bytes sent
|
||||
metrics.totals.connections(); // Total connections
|
||||
```
|
||||
|
||||
## 🐛 Troubleshooting
|
||||
|
||||
### Certificate Issues
|
||||
@@ -746,13 +776,13 @@ interface ISmartProxyOptions {
|
||||
- ✅ Enable debug logging with `enableDetailedLogging: true`
|
||||
|
||||
### Rust Binary Not Found
|
||||
|
||||
SmartProxy searches for the Rust binary in this order:
|
||||
1. `SMARTPROXY_RUST_BINARY` environment variable
|
||||
2. Platform-specific npm package (`@push.rocks/smartproxy-linux-x64`, etc.)
|
||||
3. Local dev build (`./rust/target/release/rustproxy`)
|
||||
4. System PATH (`rustproxy`)
|
||||
|
||||
Set `rustBinaryPath` in options to override.
|
||||
3. `dist_rust/rustproxy` relative to the package root (built by `tsrust`)
|
||||
4. Local dev build (`./rust/target/release/rustproxy`)
|
||||
5. System PATH (`rustproxy`)
|
||||
|
||||
### Performance Tuning
|
||||
- ✅ Use NFTables forwarding for high-traffic routes (Linux only)
|
||||
|
||||
Reference in New Issue
Block a user