Try to kill zombie daemon IDE-59 (#52)

* Try to kill zombie daemon

* Add way to kill daemon in local ssh ipc

* Support windows

* Bump up daemon version

* Fix win32 insider process lookup

Author: mustard-mh

package.json

@@ -4,7 +4,7 @@
 	"description": "Gitpod Support",
 	"publisher": "gitpod",
 	"version": "0.0.102",
-	"daemonVersion": "0.0.3",
+	"daemonVersion": "0.0.4",
 	"license": "MIT",
 	"icon": "resources/gitpod.png",
 	"repository": {
@@ -158,6 +158,7 @@
 		"@types/js-yaml": "^4.0.5",
 		"@types/mocha": "^9.1.1",
 		"@types/node": "16.x",
+		"@types/ps-node": "^0.1.1",
 		"@types/semver": "^7.3.10",
 		"@types/ssh2": "^0.5.52",
 		"@types/sshpk": "^1.17.1",
@@ -204,6 +205,7 @@
 		"pkce-challenge": "^3.0.0",
 		"prom-client": "^14.1.1",
 		"protobufjs": "^7.2.2",
+		"ps-node": "^0.1.6",
 		"semver": "^7.3.7",
 		"ssh-config": "^4.1.6",
 		"ssh2": "^1.10.0",

src/configuration.ts

@@ -44,11 +44,15 @@ function getLocalSshIpcPort() {
     return vscode.workspace.getConfiguration('gitpod').get<number>('lsshIpcPort', defaultPort) || defaultPort;
 }
 
-function getDaemonLogPath(): string {
+function getDaemonLogFileName(): string {
     if (vscode.env.appName.includes('Insiders')) {
-        return join(tmpdir(), 'gitpod-vscode-daemon-insiders.log');
+        return 'gitpod-vscode-daemon-insiders.log';
     }
-    return join(tmpdir(), 'gitpod-vscode-daemon.log');
+    return 'gitpod-vscode-daemon.log';
+}
+
+function getDaemonLogPath(): string {
+    return join(tmpdir(), getDaemonLogFileName());
 }
 
 export const Configuration = {
@@ -58,4 +62,5 @@ export const Configuration = {
     getLocalSSHServerPort,
     getLocalSshIpcPort,
     getDaemonLogPath,
+    getDaemonLogFileName,
 };

src/daemonStarter.ts

@@ -4,12 +4,13 @@
  *--------------------------------------------------------------------------------------------*/
 
 import { join } from 'path';
-import { spawn } from 'child_process';
+import { spawn, exec } from 'child_process';
 import { DaemonOptions, ExitCode } from './local-ssh/common';
 import { ILogService } from './services/logService';
 import { timeout } from './common/async';
 import { Configuration } from './configuration';
 import { ITelemetryService } from './services/telemetryService';
+import { kill, lookup } from 'ps-node';
 
 export async function ensureDaemonStarted(logService: ILogService, telemetryService: ITelemetryService, retry = 10) {
     if (retry < 0) {
@@ -23,6 +24,7 @@ export async function ensureDaemonStarted(logService: ILogService, telemetryServ
             switch (code) {
                 case ExitCode.OK:
                 case ExitCode.ListenPortFailed:
+                case ExitCode.AskedToQuit:
                     resolve(true);
                     return;
             }
@@ -66,3 +68,32 @@ export async function tryStartDaemon(logService: ILogService, options?: Partial<
     daemon.unref();
     return daemon;
 }
+
+export function killDaemon(logService: ILogService) {
+    const logName = Configuration.getDaemonLogFileName();
+    switch (process.platform) {
+        case 'win32': {
+            lookup({
+                arguments: 'local-ssh'
+            }, (err, resultList) => {
+                if (err) {
+                    throw err;
+                }
+                const process = resultList.find(process => process.arguments.join(' ').includes(logName));
+                if (!process) {
+                    return;
+                }
+                kill(process.pid);
+            });
+            return;
+        }
+        case 'darwin':
+        case 'linux': {
+            const regex = `node.*local-ssh.*daemon.js.*${logName}`;
+            exec(`pkill -f ${regex}`);
+            return;
+        }
+        default:
+            logService.warn('failed to kill daemon: unsupported platform');
+    }
+}

src/local-ssh/common.ts

@@ -23,6 +23,7 @@ export enum ExitCode {
 	ListenPortFailed = 100,
 	UnexpectedError = 101,
 	InvalidOptions = 102,
+	AskedToQuit = 103,
 }
 
 export function exitProcess(code: ExitCode) {

src/local-ssh/ipc/extension.ts

@@ -8,7 +8,7 @@ import { ExtensionServiceDefinition, ExtensionServiceImplementation, GetWorkspac
 import { Disposable } from '../../common/dispose';
 import { retry, timeout } from '../../common/async';
 export { ExtensionServiceDefinition } from '../../proto/typescript/ipc/v1/ipc';
-import { ensureDaemonStarted } from '../../daemonStarter';
+import { ensureDaemonStarted, killDaemon } from '../../daemonStarter';
 import { withServerApi } from '../../internalApi';
 import { Workspace, WorkspaceInstanceStatus_Phase } from '@gitpod/public-api/lib/gitpod/experimental/v1';
 import { WorkspaceInfo, WorkspaceInstancePhase } from '@gitpod/gitpod-protocol';
@@ -22,6 +22,7 @@ import { getGitpodRemoteWindowConnectionInfo, showWsNotRunningDialog } from '../
 import { ITelemetryService, UserFlowTelemetry } from '../../services/telemetryService';
 import { ExperimentalSettings } from '../../experiments';
 import { Configuration } from '../../configuration';
+import { SemVer } from 'semver';
 
 const phaseMap: Record<WorkspaceInstanceStatus_Phase, WorkspaceInstancePhase | undefined> = {
     [WorkspaceInstanceStatus_Phase.CREATING]: 'pending',
@@ -69,7 +70,7 @@ export class ExtensionServiceImpl implements ExtensionServiceImplementation {
             }
             const userId = this.sessionService.getUserId();
             const workspaceId = request.workspaceId;
-            
+
             const gitpodHost = this.hostService.gitpodHost;
             const usePublicApi = await this.experiments.getUsePublicAPI(gitpodHost);
             const [workspace, ownerToken] = await withServerApi(accessToken, gitpodHost, svc => Promise.all([
@@ -171,6 +172,7 @@ export class ExtensionServiceServer extends Disposable {
     ) {
         super();
         this.server = this.getServer();
+        this.tryForceKillZombieDaemon();
         this.tryActive();
         this.hostService.onDidChangeHost(() => {
             this.tryActive();
@@ -259,4 +261,18 @@ export class ExtensionServiceServer extends Disposable {
     //     this.logService.info('restart vscode to get latest features of local ssh');
     //     // await this.notificationService.showWarningMessage('Restart VSCode to use latest local ssh daemon', { id: 'daemon_needs_restart', flow: { flow: 'daemon_needs_restart' } });
     // }
+
+    private async tryForceKillZombieDaemon() {
+        try {
+            // force kill daemon if its version less than 0.0.3
+            const resp = await this.localSSHServiceClient.getDaemonVersion({});
+            const runningDaemonVersion = new SemVer(resp.version);
+            if (runningDaemonVersion.compare(new SemVer('0.0.3')) >= 0) {
+                return;
+            }
+            killDaemon(this.logService);
+        } catch (e) {
+            this.logService.error(e, 'failed to force kill zombie daemon');
+        }
+    }
 }

src/local-ssh/ipc/localssh.ts

@@ -3,7 +3,7 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-import { ActiveRequest, ExtensionServiceDefinition, GetDaemonVersionRequest, InactiveRequest, LocalSSHServiceDefinition, LocalSSHServiceImplementation, PingRequest, SendErrorReportRequest, SendLocalSSHUserFlowStatusRequest } from '../../proto/typescript/ipc/v1/ipc';
+import { ActiveRequest, ExtensionServiceDefinition, GetDaemonInfoRequest, GetDaemonVersionRequest, InactiveRequest, KillDaemonRequest, LocalSSHServiceDefinition, LocalSSHServiceImplementation, PingRequest, SendErrorReportRequest, SendLocalSSHUserFlowStatusRequest } from '../../proto/typescript/ipc/v1/ipc';
 import { CallContext, Client, ServerError, Status, createChannel, createClient, createServer } from 'nice-grpc';
 import { ExitCode, exitProcess, getDaemonVersion, getRunningExtensionVersion } from '../common';
 import { retryWithStop } from '../../common/async';
@@ -142,6 +142,20 @@ export class LocalSSHServiceImpl implements LocalSSHServiceImplementation {
             }
         }
     }
+
+    async getDaemonInfo(_request: GetDaemonInfoRequest, _context: CallContext): Promise<{ daemonVersion?: string | undefined; runningExtensionVersion?: string | undefined; pid?: number | undefined }> {
+        return {
+            daemonVersion: getDaemonVersion(),
+            runningExtensionVersion: getRunningExtensionVersion(),
+            pid: process.pid,
+        };
+    }
+
+    public async killDaemon(request: KillDaemonRequest, _context: CallContext): Promise<{}> {
+        this.logger.info('received kill daemon request, reason: ' + request.reason);
+        exitProcess(ExitCode.AskedToQuit);
+        return {};
+    }
 }
 
 export async function startLocalSSHService(logger: ILogService, port: number, serviceImpl: LocalSSHServiceImpl) {

src/proto/ipc/v1/ipc.proto

@@ -13,6 +13,12 @@ service LocalSSHService {
 
     // GetDaemonVersion returns the version of the daemon
     rpc GetDaemonVersion(GetDaemonVersionRequest) returns (GetDaemonVersionResponse) {}
+
+    // GetDaemonInfo returns the infomation of daemon
+    rpc GetDaemonInfo(GetDaemonInfoRequest) returns (GetDaemonInfoResponse) {}
+
+    // KillDaemon kills the daemon
+    rpc KillDaemon(KillDaemonRequest) returns (KillDaemonResponse) {}
 }
 
 service ExtensionService {
@@ -22,6 +28,18 @@ service ExtensionService {
     rpc SendErrorReport (SendErrorReportRequest) returns (SendErrorReportResponse) {}
 }
 
+message GetDaemonInfoRequest {}
+message GetDaemonInfoResponse {
+    string daemon_version = 1;
+    string running_extension_version = 2;
+    uint32 pid = 3;
+}
+
+message KillDaemonRequest {
+    string reason = 1;
+}
+message KillDaemonResponse {}
+
 message SendErrorReportRequest {
     string workspace_id = 1;
     string instance_id = 2;