Add timeout to dns lookup and progress notification (#55)

* Add timeout to dns lookup

* Add progress notification

Author: jeanp413

src/local-ssh/common.ts

@@ -4,8 +4,6 @@
  *--------------------------------------------------------------------------------------------*/
 
 import dns from 'dns';
-import { GetWorkspaceAuthInfoResponse } from '../proto/typescript/ipc/v1/ipc';
-import { ILogService } from '../services/logService';
 
 // This public key is safe to be public since we only use it to verify local-ssh connections.
 const HOST_KEY = 'LS0tLS1CRUdJTiBQUklWQVRFIEtFWS0tLS0tCk1JR0hBZ0VBTUJNR0J5cUdTTTQ5QWdFR0NDcUdTTTQ5QXdFSEJHMHdhd0lCQVFRZ1QwcXg1eEJUVmc4TUVJbUUKZmN4RXRZN1dmQVVsM0JYQURBK2JYREsyaDZlaFJBTkNBQVJlQXo0RDVVZXpqZ0l1SXVOWXpVL3BCWDdlOXoxeApvZUN6UklqcGdCUHozS0dWRzZLYXV5TU5YUm95a21YSS9BNFpWaW9nd2Vjb0FUUjRUQ2FtWm1ScAotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCg==';
@@ -41,39 +39,40 @@ export interface DaemonOptions {
 	logFilePath: string;
 }
 
-export type WorkspaceAuthInfo = GetWorkspaceAuthInfoResponse;
-
-
-export function isDNSPointToLocalhost(logService: ILogService, domain: string): Promise<boolean> {
-	return new Promise(resolve => {
-		dns.lookup(domain, { all: true }, (err, addresses) => {
-			if (err) {
-				resolve(false);
-			} else {
-				for (const addr of addresses) {
-					if ((addr.family === 4 && addr.address === '127.0.0.1') || (addr.family === 6 && addr.address === '::1')) {
-						resolve(true);
-						return;
+export function isDNSPointToLocalhost(domain: string, timeout: number = 10000): Promise<boolean> {
+	return Promise.race([
+		new Promise<boolean>(resolve => {
+			dns.lookup(domain, { all: true }, (err, addresses) => {
+				if (err) {
+					resolve(false);
+				} else {
+					for (const addr of addresses) {
+						if ((addr.family === 4 && addr.address === '127.0.0.1') || (addr.family === 6 && addr.address === '::1')) {
+							resolve(true);
+							return;
+						}
 					}
+					resolve(false);
 				}
-				logService.warn('current domain is not point to localhost', domain, addresses);
-				resolve(false);
-			}
-		});
-	});
+			});
+		}),
+		new Promise<boolean>(resolve => setTimeout(() => resolve(false), timeout))
+	]);
 }
 
-export function isDomainConnectable(logService: ILogService, domain: string): Promise<boolean> {
-	return new Promise(resolve => {
-		dns.lookup(domain, (err, _address) => {
-			if (err) {
-				logService.warn('current domain is not connectable', domain, err);
-				resolve(false);
-			} else {
-				resolve(true);
-			}
-		});
-	});
+export function isDomainConnectable(domain: string, timeout: number = 10000): Promise<boolean> {
+	return Promise.race([
+		new Promise<boolean>(resolve => {
+			dns.lookup(domain, (err, _address) => {
+				if (err) {
+					resolve(false);
+				} else {
+					resolve(true);
+				}
+			});
+		}),
+		new Promise<boolean>(resolve => setTimeout(() => resolve(false), timeout))
+	]);
 }
 
 export const GitpodDefaultLocalhost = 'lssh.gitpod.io';
@@ -84,4 +83,4 @@ export function getRunningExtensionVersion() {
 
 export function getDaemonVersion() {
 	return process.env.DAEMON_VERSION ?? '0.0.1';
-}
+}

src/local-ssh/server.ts

@@ -4,15 +4,15 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { Server as GrpcServer } from 'nice-grpc';
-import { WorkspaceAuthInfo, ExitCode, exitProcess, getHostKey, getDaemonVersion, getRunningExtensionVersion } from './common';
+import { ExitCode, exitProcess, getHostKey, getDaemonVersion, getRunningExtensionVersion } from './common';
 import { LocalSSHServiceImpl, startLocalSSHService } from './ipc/localssh';
 import { SupervisorSSHTunnel } from './sshTunnel';
 import { ILogService } from '../services/logService';
 import { SshServer, SshClient } from '@microsoft/dev-tunnels-ssh-tcp';
 import { NodeStream, SshClientCredentials, SshClientSession, SshDisconnectReason, SshSessionConfiguration } from '@microsoft/dev-tunnels-ssh';
 import { importKeyBytes } from '@microsoft/dev-tunnels-ssh-keys';
 import { parsePrivateKey } from 'sshpk';
-import { SendLocalSSHUserFlowStatusRequest_Code, SendLocalSSHUserFlowStatusRequest_ConnType, SendLocalSSHUserFlowStatusRequest_Status } from '../proto/typescript/ipc/v1/ipc';
+import { GetWorkspaceAuthInfoResponse, SendLocalSSHUserFlowStatusRequest_Code, SendLocalSSHUserFlowStatusRequest_ConnType, SendLocalSSHUserFlowStatusRequest_Status } from '../proto/typescript/ipc/v1/ipc';
 import { PipeExtensions } from './patch/pipeExtension';
 
 // TODO(local-ssh): Remove me after direct ssh works with @microsft/dev-tunnels-ssh
@@ -116,7 +116,7 @@ export class LocalSSHGatewayServer {
 		});
 	}
 
-	private async tryDirectSSH(workspaceInfo: WorkspaceAuthInfo): Promise<SshClientSession | undefined> {
+	private async tryDirectSSH(workspaceInfo: GetWorkspaceAuthInfoResponse): Promise<SshClientSession | undefined> {
 		try {
 			const connConfig = {
 				host: `${workspaceInfo.workspaceId}.ssh.${workspaceInfo.workspaceHost}`,
@@ -153,7 +153,7 @@ export class LocalSSHGatewayServer {
 		return;
 	}
 
-	private async getTunnelSSHConfig(workspaceInfo: WorkspaceAuthInfo): Promise<SshClientSession> {
+	private async getTunnelSSHConfig(workspaceInfo: GetWorkspaceAuthInfoResponse): Promise<SshClientSession> {
 		const ssh = new SupervisorSSHTunnel(this.logger, workspaceInfo, this.localsshService);
 		const connConfig = await ssh.establishTunnel();
 		const config = new SshSessionConfiguration();

src/local-ssh/sshTunnel.ts

@@ -11,10 +11,10 @@ import { CreateSSHKeyPairRequest, CreateSSHKeyPairResponse } from '@gitpod/super
 import { NodeHttpTransport } from '@improbable-eng/grpc-web-node-http-transport';
 import { grpc } from '@improbable-eng/grpc-web';
 import { BrowserHeaders } from 'browser-headers';
-import { WorkspaceAuthInfo, getDaemonVersion, getRunningExtensionVersion } from './common';
+import { getDaemonVersion, getRunningExtensionVersion } from './common';
 import { ILogService } from '../services/logService';
 import { LocalSSHServiceImpl } from './ipc/localssh';
-import { SendLocalSSHUserFlowStatusRequest_Code, SendLocalSSHUserFlowStatusRequest_ConnType, SendLocalSSHUserFlowStatusRequest_Status } from '../proto/typescript/ipc/v1/ipc';
+import { GetWorkspaceAuthInfoResponse, SendLocalSSHUserFlowStatusRequest_Code, SendLocalSSHUserFlowStatusRequest_ConnType, SendLocalSSHUserFlowStatusRequest_Status } from '../proto/typescript/ipc/v1/ipc';
 
 grpc.setDefaultTransport(NodeHttpTransport());
 
@@ -44,7 +44,7 @@ export class SupervisorSSHTunnel {
 
 	constructor(
 		private readonly logger: ILogService,
-		readonly workspaceInfo: WorkspaceAuthInfo,
+		readonly workspaceInfo: GetWorkspaceAuthInfoResponse,
 		private readonly localsshService: LocalSSHServiceImpl,
 	) { }