mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-07-17 05:43:36 +00:00
867058bddd
Host/status caching, shell code-split, SSH pool waits, host-metrics concurrency, background-tab idle, per-host status subscriptions, homepage poll quieting, and virtualized host sidebar + file manager lists.
301 lines
8.1 KiB
TypeScript
301 lines
8.1 KiB
TypeScript
import { Client } from "ssh2";
|
|
import { sshLogger } from "../utils/logger.js";
|
|
|
|
interface PooledConnection {
|
|
client: Client;
|
|
lastUsed: number;
|
|
inUse: boolean;
|
|
hostKey: string;
|
|
}
|
|
|
|
interface ConnectionWaiter {
|
|
resolve: (client: Client) => void;
|
|
reject: (error: Error) => void;
|
|
factory: () => Promise<Client>;
|
|
timer: NodeJS.Timeout;
|
|
}
|
|
|
|
const DEFAULT_MAX_CONNECTIONS_PER_HOST = 3;
|
|
const DEFAULT_MAX_WAIT_MS = 30_000;
|
|
const IDLE_MAX_AGE_MS = 10 * 60 * 1000;
|
|
const CLEANUP_INTERVAL_MS = 2 * 60 * 1000;
|
|
|
|
class SSHConnectionPool {
|
|
private connections = new Map<string, PooledConnection[]>();
|
|
private waiters = new Map<string, ConnectionWaiter[]>();
|
|
private maxConnectionsPerHost = DEFAULT_MAX_CONNECTIONS_PER_HOST;
|
|
private maxWaitMs = DEFAULT_MAX_WAIT_MS;
|
|
private cleanupInterval: NodeJS.Timeout;
|
|
|
|
constructor() {
|
|
this.cleanupInterval = setInterval(() => {
|
|
this.cleanup();
|
|
}, CLEANUP_INTERVAL_MS);
|
|
}
|
|
|
|
private isConnectionHealthy(client: Client): boolean {
|
|
try {
|
|
const sock = (
|
|
client as unknown as {
|
|
_sock?: { destroyed?: boolean; writable?: boolean };
|
|
}
|
|
)._sock;
|
|
if (sock && (sock.destroyed || !sock.writable)) {
|
|
return false;
|
|
}
|
|
return true;
|
|
} catch {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
private removeUnhealthy(
|
|
key: string,
|
|
connections: PooledConnection[],
|
|
target: PooledConnection,
|
|
): PooledConnection[] {
|
|
sshLogger.warn("Removing unhealthy connection from pool", {
|
|
operation: "pool_remove_dead",
|
|
hostKey: key,
|
|
});
|
|
try {
|
|
target.client.end();
|
|
} catch {
|
|
// expected
|
|
}
|
|
const filtered = connections.filter((c) => c !== target);
|
|
this.connections.set(key, filtered);
|
|
return filtered;
|
|
}
|
|
|
|
private async createPooledClient(
|
|
key: string,
|
|
factory: () => Promise<Client>,
|
|
existing: PooledConnection[],
|
|
): Promise<Client> {
|
|
const client = await factory();
|
|
const pooled: PooledConnection = {
|
|
client,
|
|
lastUsed: Date.now(),
|
|
inUse: true,
|
|
hostKey: key,
|
|
};
|
|
existing.push(pooled);
|
|
this.connections.set(key, existing);
|
|
|
|
client.on("end", () => {
|
|
this.removeConnection(key, client);
|
|
});
|
|
client.on("close", () => {
|
|
this.removeConnection(key, client);
|
|
});
|
|
|
|
return client;
|
|
}
|
|
|
|
private enqueueWaiter(
|
|
key: string,
|
|
factory: () => Promise<Client>,
|
|
): Promise<Client> {
|
|
return new Promise<Client>((resolve, reject) => {
|
|
const timer = setTimeout(() => {
|
|
const queue = this.waiters.get(key);
|
|
if (queue) {
|
|
const idx = queue.findIndex((w) => w.timer === timer);
|
|
if (idx >= 0) queue.splice(idx, 1);
|
|
if (queue.length === 0) this.waiters.delete(key);
|
|
}
|
|
const err = new Error(
|
|
`SSH connection pool wait timed out after ${this.maxWaitMs}ms (${key})`,
|
|
);
|
|
sshLogger.warn("Connection pool wait timeout", {
|
|
operation: "pool_wait_timeout",
|
|
hostKey: key,
|
|
maxWaitMs: this.maxWaitMs,
|
|
});
|
|
reject(err);
|
|
}, this.maxWaitMs);
|
|
|
|
const waiter: ConnectionWaiter = { resolve, reject, factory, timer };
|
|
const queue = this.waiters.get(key) || [];
|
|
queue.push(waiter);
|
|
this.waiters.set(key, queue);
|
|
});
|
|
}
|
|
|
|
/** Hand a free connection (or new slot) to the next waiter, if any. */
|
|
private wakeWaiter(key: string): void {
|
|
const queue = this.waiters.get(key);
|
|
if (!queue || queue.length === 0) return;
|
|
|
|
let connections = this.connections.get(key) || [];
|
|
const available = connections.find((conn) => !conn.inUse);
|
|
|
|
if (available) {
|
|
if (!this.isConnectionHealthy(available.client)) {
|
|
connections = this.removeUnhealthy(key, connections, available);
|
|
// Fall through — may create or wait again.
|
|
} else {
|
|
const waiter = queue.shift()!;
|
|
if (queue.length === 0) this.waiters.delete(key);
|
|
else this.waiters.set(key, queue);
|
|
clearTimeout(waiter.timer);
|
|
available.inUse = true;
|
|
available.lastUsed = Date.now();
|
|
waiter.resolve(available.client);
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (connections.length < this.maxConnectionsPerHost) {
|
|
const waiter = queue.shift()!;
|
|
if (queue.length === 0) this.waiters.delete(key);
|
|
else this.waiters.set(key, queue);
|
|
clearTimeout(waiter.timer);
|
|
this.createPooledClient(key, waiter.factory, connections)
|
|
.then(waiter.resolve)
|
|
.catch(waiter.reject);
|
|
return;
|
|
}
|
|
}
|
|
|
|
private rejectWaiters(key: string, reason: string): void {
|
|
const queue = this.waiters.get(key);
|
|
if (!queue) return;
|
|
this.waiters.delete(key);
|
|
for (const waiter of queue) {
|
|
clearTimeout(waiter.timer);
|
|
waiter.reject(new Error(reason));
|
|
}
|
|
}
|
|
|
|
async getConnection(
|
|
key: string,
|
|
factory: () => Promise<Client>,
|
|
): Promise<Client> {
|
|
let connections = this.connections.get(key) || [];
|
|
|
|
const available = connections.find((conn) => !conn.inUse);
|
|
if (available) {
|
|
if (!this.isConnectionHealthy(available.client)) {
|
|
connections = this.removeUnhealthy(key, connections, available);
|
|
} else {
|
|
available.inUse = true;
|
|
available.lastUsed = Date.now();
|
|
return available.client;
|
|
}
|
|
}
|
|
|
|
if (connections.length < this.maxConnectionsPerHost) {
|
|
return this.createPooledClient(key, factory, connections);
|
|
}
|
|
|
|
return this.enqueueWaiter(key, factory);
|
|
}
|
|
|
|
releaseConnection(key: string, client: Client): void {
|
|
const connections = this.connections.get(key) || [];
|
|
const pooled = connections.find((conn) => conn.client === client);
|
|
if (pooled) {
|
|
pooled.inUse = false;
|
|
pooled.lastUsed = Date.now();
|
|
this.wakeWaiter(key);
|
|
}
|
|
}
|
|
|
|
private removeConnection(key: string, client: Client): void {
|
|
const connections = this.connections.get(key);
|
|
if (!connections) return;
|
|
const filtered = connections.filter((c) => c.client !== client);
|
|
if (filtered.length === 0) {
|
|
this.connections.delete(key);
|
|
} else {
|
|
this.connections.set(key, filtered);
|
|
}
|
|
// A slot or idle connection may now be free for waiters.
|
|
this.wakeWaiter(key);
|
|
}
|
|
|
|
clearKeyConnections(key: string): void {
|
|
const connections = this.connections.get(key) || [];
|
|
for (const conn of connections) {
|
|
try {
|
|
conn.client.end();
|
|
} catch {
|
|
// expected
|
|
}
|
|
}
|
|
this.connections.delete(key);
|
|
this.rejectWaiters(key, `SSH connection pool cleared for ${key}`);
|
|
}
|
|
|
|
private cleanup(): void {
|
|
const now = Date.now();
|
|
|
|
for (const [hostKey, connections] of this.connections.entries()) {
|
|
const activeConnections = connections.filter((conn) => {
|
|
if (!conn.inUse && now - conn.lastUsed > IDLE_MAX_AGE_MS) {
|
|
try {
|
|
conn.client.end();
|
|
} catch {
|
|
// expected
|
|
}
|
|
return false;
|
|
}
|
|
if (!this.isConnectionHealthy(conn.client)) {
|
|
try {
|
|
conn.client.end();
|
|
} catch {
|
|
// expected
|
|
}
|
|
return false;
|
|
}
|
|
return true;
|
|
});
|
|
|
|
if (activeConnections.length === 0) {
|
|
this.connections.delete(hostKey);
|
|
} else {
|
|
this.connections.set(hostKey, activeConnections);
|
|
}
|
|
this.wakeWaiter(hostKey);
|
|
}
|
|
}
|
|
|
|
clearAllConnections(): void {
|
|
for (const key of [...this.waiters.keys()]) {
|
|
this.rejectWaiters(key, "SSH connection pool destroyed");
|
|
}
|
|
for (const connections of this.connections.values()) {
|
|
for (const conn of connections) {
|
|
try {
|
|
conn.client.end();
|
|
} catch {
|
|
// expected
|
|
}
|
|
}
|
|
}
|
|
this.connections.clear();
|
|
}
|
|
|
|
destroy(): void {
|
|
clearInterval(this.cleanupInterval);
|
|
this.clearAllConnections();
|
|
}
|
|
}
|
|
|
|
export const connectionPool = new SSHConnectionPool();
|
|
|
|
export async function withConnection<T>(
|
|
key: string,
|
|
factory: () => Promise<Client>,
|
|
fn: (client: Client) => Promise<T>,
|
|
): Promise<T> {
|
|
const client = await connectionPool.getConnection(key, factory);
|
|
try {
|
|
return await fn(client);
|
|
} finally {
|
|
connectionPool.releaseConnection(key, client);
|
|
}
|
|
}
|