typescript-virtual-container 1.1.7 → 1.2.1

package/src/SSHClient/index.ts

@@ -1,5 +1,7 @@
 import { runCommand } from "../commands";
 import type { CommandResult } from "../types/commands";
+import type { PerfLogger } from "../utils/perfLogger";
+import { createPerfLogger } from "../utils/perfLogger";
 import type { VirtualShell } from "../VirtualShell";
 
 /**
@@ -16,6 +18,8 @@ import type { VirtualShell } from "../VirtualShell";
  * const list = await client.ls();
  * ```
  */
+const perf: PerfLogger = createPerfLogger("SshClient");
+
 export class SshClient {
 	private currentCwd = "/";
 
@@ -28,7 +32,9 @@ export class SshClient {
 	constructor(
 		private shell: VirtualShell,
 		private username: string,
-	) {}
+	) {
+		perf.mark("constructor");
+	}
 
 	/**
 	 * Executes raw shell command.
@@ -37,6 +43,7 @@ export class SshClient {
 	 * @returns Command result with stdout/stderr/exitCode.
 	 */
 	async exec(command: string): Promise<CommandResult> {
+		perf.mark("exec");
 		const vfs = this.shell.getVfs();
 		const users = this.shell.getUsers();
 		const hostname = this.shell.getHostname();
@@ -69,6 +76,7 @@ export class SshClient {
 	 * @returns Result with directory listing in stdout.
 	 */
 	async ls(path?: string): Promise<CommandResult> {
+		perf.mark("ls");
 		const target = path ?? ".";
 		return this.exec(`ls ${target}`);
 	}
@@ -79,6 +87,7 @@ export class SshClient {
 	 * @returns Result with cwd path in stdout.
 	 */
 	async pwd(): Promise<CommandResult> {
+		perf.mark("pwd");
 		return this.exec("pwd");
 	}
 
@@ -89,6 +98,7 @@ export class SshClient {
 	 * @returns Result; updates internal cwd on success.
 	 */
 	async cd(path: string): Promise<CommandResult> {
+		perf.mark("cd");
 		const result = await this.exec(`cd ${path}`);
 		if (result.nextCwd && result.exitCode !== 1) {
 			this.currentCwd = result.nextCwd;
@@ -103,6 +113,7 @@ export class SshClient {
 	 * @returns Result with file content in stdout.
 	 */
 	async cat(path: string): Promise<CommandResult> {
+		perf.mark("cat");
 		return this.exec(`cat ${path}`);
 	}
 
@@ -114,6 +125,7 @@ export class SshClient {
 	 * @returns Result from mkdir command.
 	 */
 	async mkdir(path: string, recursive = false): Promise<CommandResult> {
+		perf.mark("mkdir");
 		const flag = recursive ? "-p " : "";
 		return this.exec(`mkdir ${flag}${path}`);
 	}
@@ -125,6 +137,7 @@ export class SshClient {
 	 * @returns Result from touch command.
 	 */
 	async touch(path: string): Promise<CommandResult> {
+		perf.mark("touch");
 		return this.exec(`touch ${path}`);
 	}
 
@@ -136,6 +149,7 @@ export class SshClient {
 	 * @returns Result from rm command.
 	 */
 	async rm(path: string, recursive = false): Promise<CommandResult> {
+		perf.mark("rm");
 		const flag = recursive ? "-r " : "";
 		return this.exec(`rm ${flag}${path}`);
 	}
@@ -148,6 +162,7 @@ export class SshClient {
 	 * @returns Result from touch/write simulation.
 	 */
 	async writeFile(path: string, content: string): Promise<CommandResult> {
+		perf.mark("writeFile");
 		const vfs = this.shell.getVfs();
 		if (!vfs) {
 			throw new Error("SSH client not started");
@@ -171,6 +186,7 @@ export class SshClient {
 	 * @returns File content as string or error in result.
 	 */
 	async readFile(path: string): Promise<CommandResult> {
+		perf.mark("readFile");
 		const vfs = this.shell.getVfs();
 		if (!vfs) {
 			throw new Error("SSH client not started");
@@ -193,6 +209,7 @@ export class SshClient {
 	 * @returns Normalized cwd path.
 	 */
 	getCwd(): string {
+		perf.mark("getCwd");
 		return this.currentCwd;
 	}
 
@@ -202,6 +219,7 @@ export class SshClient {
 	 * @returns Associated username.
 	 */
 	getUsername(): string {
+		perf.mark("getUsername");
 		return this.username;
 	}
 
@@ -212,6 +230,7 @@ export class SshClient {
 	 * @returns Result with ASCII tree in stdout.
 	 */
 	async tree(path?: string): Promise<CommandResult> {
+		perf.mark("tree");
 		const target = path ?? ".";
 		return this.exec(`tree ${target}`);
 	}
@@ -222,6 +241,7 @@ export class SshClient {
 	 * @returns Result from whoami command.
 	 */
 	async whoami(): Promise<CommandResult> {
+		perf.mark("whoami");
 		return this.exec("whoami");
 	}
 
@@ -231,6 +251,7 @@ export class SshClient {
 	 * @returns Result from hostname command.
 	 */
 	async hostname(): Promise<CommandResult> {
+		perf.mark("hostname");
 		return this.exec("hostname");
 	}
 
@@ -240,6 +261,7 @@ export class SshClient {
 	 * @returns Result from who command.
 	 */
 	async who(): Promise<CommandResult> {
+		perf.mark("who");
 		return this.exec("who");
 	}
 }

package/src/SSHMimic/index.ts

@@ -1,6 +1,7 @@
 import { EventEmitter } from "node:events";
 import { Server as SshServer } from "ssh2";
 import { VirtualShell } from "../VirtualShell";
+import { createPerfLogger, type PerfLogger } from "../utils/perfLogger";
 import { runExec } from "./exec";
 import { loadOrCreateHostKey } from "./hostKey";
 
@@ -11,6 +12,8 @@ import { loadOrCreateHostKey } from "./hostKey";
  * Create an instance, call {@link SshMimic.start}, and stop it with
  * {@link SshMimic.stop} when your process exits.
  */
+const perf: PerfLogger = createPerfLogger("SshMimic");
+
 class SshMimic extends EventEmitter {
 	port: number;
 	server: SshServer | null;
@@ -34,6 +37,7 @@ class SshMimic extends EventEmitter {
 		shell?: VirtualShell;
 	}) {
 		super();
+		perf.mark("constructor");
 		this.port = port;
 		this.shellHostname = hostname;
 		this.server = null;
@@ -46,6 +50,7 @@ class SshMimic extends EventEmitter {
 	 * @returns Promise resolved with bound listening port.
 	 */
 	public async start(): Promise<number> {
+		perf.mark("start");
 		const shell = this.shell;
 		const privateKey = loadOrCreateHostKey();
 
@@ -169,6 +174,7 @@ class SshMimic extends EventEmitter {
 	 * Stops server if running.
 	 */
 	public stop(): void {
+		perf.mark("stop");
 		if (this.server) {
 			this.server.close(() => {
 				console.log("SSH Mimic stopped");

package/src/SSHMimic/sftp.ts

@@ -3,10 +3,12 @@ import { EventEmitter } from "node:events";
 import * as path from "node:path";
 import type { AuthenticationType, KeyboardAuthContext } from "ssh2";
 import { Server as SshServer } from "ssh2";
+import type { VfsNodeStats } from "../types/vfs";
+import type { PerfLogger } from "../utils/perfLogger";
+import { createPerfLogger } from "../utils/perfLogger";
 import type VirtualFileSystem from "../VirtualFileSystem";
 import { VirtualShell } from "../VirtualShell";
 import type { VirtualUserManager } from "../VirtualUserManager";
-import type { VfsNodeStats } from "../types/vfs";
 import { loadOrCreateHostKey } from "./hostKey";
 
 const SFTP_STATUS_CODE = {
@@ -30,6 +32,8 @@ const OPEN_MODE = {
 	EXCL: 0x00000020,
 };
 
+const perf: PerfLogger = createPerfLogger("SftpMimic");
+
 interface SftpFileHandle {
 	type: "file";
 	path: string;
@@ -154,6 +158,7 @@ export class SftpMimic extends EventEmitter {
 		users,
 	}: SftpMimicOptions) {
 		super();
+		perf.mark("constructor");
 		this.port = port;
 		this.server = null;
 		this.hostname = hostname;
@@ -184,6 +189,7 @@ export class SftpMimic extends EventEmitter {
 	}
 
 	public async start(): Promise<number> {
+		perf.mark("start");
 		const privateKey = loadOrCreateHostKey();
 
 		// Ensure VirtualShell is fully initialized before accepting connections
@@ -336,6 +342,7 @@ export class SftpMimic extends EventEmitter {
 	}
 
 	public stop(): void {
+		perf.mark("stop");
 		if (this.server) {
 			this.server.close(() => {
 				console.log("SFTP Mimic stopped");

package/src/VirtualFileSystem/index.ts

@@ -7,6 +7,8 @@ import type {
 	VfsNodeStats,
 	WriteFileOptions,
 } from "../types/vfs";
+import type { PerfLogger } from "../utils/perfLogger";
+import { createPerfLogger } from "../utils/perfLogger";
 import { normalizePath } from "./path";
 
 /**
@@ -16,6 +18,8 @@ import { normalizePath } from "./path";
  * {@link VirtualFileSystem.restoreMirror} on startup and
  * {@link VirtualFileSystem.flushMirror} to persist pending changes.
  */
+const perf: PerfLogger = createPerfLogger("VirtualFileSystem");
+
 class VirtualFileSystem extends EventEmitter {
 	private readonly mirrorRoot: string;
 
@@ -95,6 +99,7 @@ class VirtualFileSystem extends EventEmitter {
 	 */
 	constructor(baseDir: string = process.cwd()) {
 		super();
+		perf.mark("constructor");
 		this.mirrorRoot = path.resolve(baseDir, ".vfs", "mirror");
 	}
 
@@ -104,6 +109,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * If archive does not exist or cannot be read, creates fresh mirror file.
 	 */
 	public async restoreMirror(): Promise<void> {
+		perf.mark("restoreMirror");
 		this.ensureMirrorRoot();
 	}
 
@@ -113,6 +119,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * No-op when nothing changed and archive already exists.
 	 */
 	public async flushMirror(): Promise<void> {
+		perf.mark("flushMirror");
 		this.ensureMirrorRoot();
 		this.emit("mirror:flush");
 	}
@@ -124,6 +131,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param mode POSIX-like mode bits for new directories.
 	 */
 	public mkdir(targetPath: string, mode: number = 0o755): void {
+		perf.mark("mkdir");
 		this.ensureMirrorRoot();
 		const fsPath = this.resolveFsPath(targetPath);
 		if (fs.existsSync(fsPath) && !fs.statSync(fsPath).isDirectory()) {
@@ -149,6 +157,7 @@ class VirtualFileSystem extends EventEmitter {
 		content: string | Buffer,
 		options: WriteFileOptions = {},
 	): void {
+		perf.mark("writeFile");
 		this.ensureMirrorRoot();
 		const normalized = normalizePath(targetPath);
 		const fsPath = this.resolveFsPath(normalized);
@@ -181,6 +190,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns UTF-8 string content.
 	 */
 	public readFile(targetPath: string): string {
+		perf.mark("readFile");
 		this.ensureMirrorRoot();
 		const fsPath = this.resolveFsPath(targetPath);
 		if (!fs.existsSync(fsPath) || !fs.statSync(fsPath).isFile()) {
@@ -201,6 +211,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns True when file or directory exists.
 	 */
 	public exists(targetPath: string): boolean {
+		perf.mark("exists");
 		try {
 			const fsPath = this.resolveFsPath(targetPath);
 			return fs.existsSync(fsPath);
@@ -216,6 +227,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param mode New POSIX-like mode.
 	 */
 	public chmod(targetPath: string, mode: number): void {
+		perf.mark("chmod");
 		const fsPath = this.resolveFsPath(targetPath);
 		if (!fs.existsSync(fsPath)) {
 			throw new Error(`Path '${normalizePath(targetPath)}' does not exist.`);
@@ -230,6 +242,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns Typed stat object based on node type.
 	 */
 	public stat(targetPath: string): VfsNodeStats {
+		perf.mark("stat");
 		this.ensureMirrorRoot();
 		const normalized = normalizePath(targetPath);
 		const fsPath = this.resolveFsPath(normalized);
@@ -273,6 +286,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns Sorted child names.
 	 */
 	public list(dirPath: string = "/"): string[] {
+		perf.mark("list");
 		const fsPath = this.resolveFsPath(dirPath);
 		if (!fs.existsSync(fsPath) || !fs.statSync(fsPath).isDirectory()) {
 			throw new Error(`Cannot list '${dirPath}': not a directory.`);
@@ -288,6 +302,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns Multi-line tree string.
 	 */
 	public tree(dirPath: string = "/"): string {
+		perf.mark("tree");
 		const fsPath = this.resolveFsPath(dirPath);
 		if (!fs.existsSync(fsPath) || !fs.statSync(fsPath).isDirectory()) {
 			throw new Error(`Cannot render tree for '${dirPath}': not a directory.`);
@@ -308,6 +323,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @returns Total byte usage for file content under target path.
 	 */
 	public getUsageBytes(targetPath: string = "/"): number {
+		perf.mark("getUsageBytes");
 		const fsPath = this.resolveFsPath(targetPath);
 		if (!fs.existsSync(fsPath)) {
 			throw new Error(`Path '${normalizePath(targetPath)}' does not exist.`);
@@ -321,6 +337,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param targetPath Path to file.
 	 */
 	public compressFile(targetPath: string): void {
+		perf.mark("compressFile");
 		const fsPath = this.resolveFsPath(targetPath);
 		if (!fs.existsSync(fsPath) || !fs.statSync(fsPath).isFile()) {
 			throw new Error(`Cannot compress '${targetPath}': not a file.`);
@@ -338,6 +355,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param targetPath Path to file.
 	 */
 	public decompressFile(targetPath: string): void {
+		perf.mark("decompressFile");
 		const fsPath = this.resolveFsPath(targetPath);
 		if (!fs.existsSync(fsPath) || !fs.statSync(fsPath).isFile()) {
 			throw new Error(`Cannot decompress '${targetPath}': not a file.`);
@@ -356,6 +374,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param options Removal options, including recursive delete.
 	 */
 	public remove(targetPath: string, options: RemoveOptions = {}): void {
+		perf.mark("remove");
 		const normalized = normalizePath(targetPath);
 		if (normalized === "/") {
 			throw new Error("Cannot remove root directory.");
@@ -390,6 +409,7 @@ class VirtualFileSystem extends EventEmitter {
 	 * @param toPath Destination path.
 	 */
 	public move(fromPath: string, toPath: string): void {
+		perf.mark("move");
 		const fromNormalized = normalizePath(fromPath);
 		const toNormalized = normalizePath(toPath);
 

package/src/VirtualShell/index.ts

@@ -3,6 +3,8 @@ import { EventEmitter } from "node:events";
 import { createCustomCommand, registerCommand, runCommand } from "../commands";
 import type { CommandContext, CommandResult } from "../types/commands";
 import type { ShellStream } from "../types/streams";
+import type { PerfLogger } from "../utils/perfLogger";
+import { createPerfLogger } from "../utils/perfLogger";
 import VirtualFileSystem from "../VirtualFileSystem";
 import { VirtualUserManager } from "../VirtualUserManager";
 import { startShell } from "./shell";
@@ -19,13 +21,23 @@ const defaultShellProperties: ShellProperties = {
 	arch: "x86_64",
 };
 
+const perf: PerfLogger = createPerfLogger("VirtualShell");
+
+let cachedRootPassword: string | null = null;
+
 function resolveRootPassword(): string {
+	if (cachedRootPassword) {
+		return cachedRootPassword;
+	}
+
 	const configured = process.env.SSH_MIMIC_ROOT_PASSWORD;
 	if (configured && configured.trim().length > 0) {
-		return configured;
+		cachedRootPassword = configured.trim();
+		return cachedRootPassword;
 	}
 
 	const generated = randomBytes(18).toString("base64url");
+	cachedRootPassword = generated;
 	console.warn(
 		`[ssh-mimic] SSH_MIMIC_ROOT_PASSWORD missing; generated ephemeral root password: ${generated}`,
 	);
@@ -68,6 +80,7 @@ class VirtualShell extends EventEmitter {
 		basePath?: string,
 	) {
 		super();
+		perf.mark("constructor");
 		this.hostname = hostname;
 		this.properties = properties || defaultShellProperties;
 		this.basePath = basePath || ".";
@@ -95,6 +108,7 @@ class VirtualShell extends EventEmitter {
 	 * Call this before any authentication or command execution.
 	 */
 	public async ensureInitialized(): Promise<void> {
+		perf.mark("ensureInitialized");
 		await this.initialized;
 	}
 
@@ -126,6 +140,7 @@ class VirtualShell extends EventEmitter {
 	 * @param cwd
 	 */
 	executeCommand(rawInput: string, authUser: string, cwd: string): void {
+		perf.mark("executeCommand");
 		runCommand(rawInput, authUser, this.hostname, "shell", cwd, this);
 		this.emit("command", { command: rawInput, user: authUser, cwd });
 	}
@@ -146,6 +161,7 @@ class VirtualShell extends EventEmitter {
 		remoteAddress: string,
 		terminalSize: { cols: number; rows: number },
 	): void {
+		perf.mark("startInteractiveSession");
 		// Interactive shell logic
 		this.emit("session:start", { user: authUser, sessionId, remoteAddress });
 		startShell(
@@ -199,6 +215,7 @@ class VirtualShell extends EventEmitter {
 		targetPath: string,
 		content: string | Buffer,
 	): void {
+		perf.mark("writeFileAsUser");
 		this.users.assertWriteWithinQuota(authUser, targetPath, content);
 		this.vfs.writeFile(targetPath, content);
 	}