Class PostgresSshEngine

src/database-engines/postgres-ssh-engine.ts:11–161

import * as os from 'os'

export class PostgresSshEngine implements DatabaseEngine {
	private tunnel: SshTunnel | null = null
	private wrappedEngine: PostgresEngine | null = null
	private config: PostgresSshConfigFile
	private credentialService: RemoteCredentialService

	constructor(config: PostgresSshConfigFile, credentialService: RemoteCredentialService) {
		this.config = config
		this.credentialService = credentialService
	}

	async connect(): Promise<boolean> {
		try {
			const dbPassword = await this.credentialService.getCredential(this.config.name, 'password')
				?? await this.credentialService.promptForCredential(this.config.name, 'password')

			let sshAuth: { privateKey?: Buffer; passphrase?: string; password?: string } = {}

			if (this.config.sshPrivateKeyPath) {
				const keyPath = this.config.sshPrivateKeyPath.startsWith('~')
					? this.config.sshPrivateKeyPath.replace('~', os.homedir())
					: this.config.sshPrivateKeyPath
				const privateKey = fs.readFileSync(keyPath)
				const passphrase = await this.credentialService.getCredential(this.config.name, 'sshPassphrase')
				sshAuth = { privateKey, passphrase: passphrase ?? undefined }
			} else {
				const sshPassword = await this.credentialService.getCredential(this.config.name, 'sshPassword')
					?? await this.credentialService.promptForCredential(this.config.name, 'sshPassword')
				sshAuth = { password: sshPassword ?? undefined }
			}

			this.tunnel = await createSshTunnel({
				sshHost: this.config.sshHost,
				sshPort: this.config.sshPort ?? 22,
				sshUsername: this.config.sshUsername,
				sshPassword: sshAuth.password,
				sshPrivateKeyPath: this.config.sshPrivateKeyPath,
				sshPassphrase: sshAuth.passphrase,
				remoteHost: this.config.host ?? '127.0.0.1',
				remotePort: this.config.port ?? 5432,
			})

			const connection = await getConnectionFor(
				this.config.name, 'postgres',
				'127.0.0.1', this.tunnel.localPort,
				this.config.username ?? 'postgres', dbPassword ?? '',
				this.config.database, false
			)

			if (!connection) return false

			this.wrappedEngine = new PostgresEngine(connection)
			return this.wrappedEngine.isOkay()
		} catch {
			return false
		}
	}