Lock file before copy proxy scripts to reduce race condition IDE-141 (#71)

* Initialize when needed

* Lock file before copy content

Author: mustard-mh

package.json

@@ -148,6 +148,7 @@
 		"@types/js-yaml": "^4.0.5",
 		"@types/mocha": "^9.1.1",
 		"@types/node": "16.x",
+		"@types/proper-lockfile": "^4.1.2",
 		"@types/ps-node": "^0.1.1",
 		"@types/semver": "^7.3.10",
 		"@types/ssh2": "^0.5.52",
@@ -193,6 +194,7 @@
 		"node-fetch-commonjs": "^3.2.4",
 		"pkce-challenge": "^3.0.0",
 		"prom-client": "^14.1.1",
+		"proper-lockfile": "^4.1.2",
 		"protobufjs": "^7.2.2",
 		"ps-node": "^0.1.6",
 		"semver": "^7.3.7",

src/remoteConnector.ts

@@ -692,6 +692,7 @@ export class RemoteConnector extends Disposable {
 					// we need to update the remote ssh config first, since another call is too late for local-ssh
 					await this.updateRemoteSSHConfig(true, undefined);
 					this.localSSHService.flow = sshFlow;
+					this.localSSHService.prepareInitialize();
 					await this.localSSHService.initialized;
 					if (!this.localSSHService.isSupportLocalSSH) {
 						this.logService.error('Local SSH is not supported on this platform');

src/services/localSSHService.ts

@@ -5,6 +5,7 @@
 
 import * as vscode from 'vscode';
 import fsp from 'fs/promises';
+import lockfile from 'proper-lockfile';
 import { Disposable } from '../common/dispose';
 import { ILogService } from './logService';
 import { Configuration } from '../configuration';
@@ -20,13 +21,14 @@ export interface ILocalSSHService {
     flow?: UserFlowTelemetryProperties;
     isSupportLocalSSH: boolean;
     initialized: Promise<void>;
+    prepareInitialize: () => void;
 }
 
-type FailedToInitializeCode = 'Unknown' | string;
+type FailedToInitializeCode = 'Unknown' | 'LockFailed' | string;
 
 export class LocalSSHService extends Disposable implements ILocalSSHService {
     public isSupportLocalSSH: boolean = false;
-    public initialized: Promise<void>;
+    public initialized!: Promise<void>;
     public flow?: UserFlowTelemetryProperties;
     constructor(
         private readonly context: vscode.ExtensionContext,
@@ -36,9 +38,10 @@ export class LocalSSHService extends Disposable implements ILocalSSHService {
         private readonly logService: ILogService,
     ) {
         super();
+    }
 
+    prepareInitialize() {
         this.initialized = this.initialize();
-
         this._register(vscode.workspace.onDidChangeConfiguration(async e => {
             if (
                 e.affectsConfiguration('gitpod.lsshExtensionIpcPort') ||
@@ -62,10 +65,13 @@ export class LocalSSHService extends Disposable implements ILocalSSHService {
     private async initialize() {
         let failureCode: FailedToInitializeCode | undefined;
         const useLocalAPP = String(Configuration.getUseLocalApp());
+        const lockFolder = vscode.Uri.joinPath(this.context.globalStorageUri, 'initialize.lock');
         try {
-            const locations = await this.copyProxyScript();
-            await this.configureSettings(locations);
-            this.isSupportLocalSSH = true;
+            await this.lock(lockFolder.fsPath, async () => {
+                const locations = await this.copyProxyScript();
+                await this.configureSettings(locations);
+                this.isSupportLocalSSH = true;
+            });
         } catch (e) {
             this.logService.error(e, 'failed to initialize');
             failureCode = 'Unknown';
@@ -121,4 +127,29 @@ export class LocalSSHService extends Disposable implements ILocalSSHService {
         await vscode.workspace.fs.copy(fileUri, destUri, { overwrite: true });
         return destUri.fsPath;
     }
+
+    private async lock(path: string, cb: () => Promise<void>) {
+        let release: () => Promise<void>;
+        try {
+            release = await lockfile.lock(path, {
+                stale: 1000 * 10, // 10s
+                retries: {
+                    retries: 3,
+                    factor: 1,
+                    minTimeout: 1 * 1000,
+                    randomize: true,
+                },
+                realpath: false,
+            });
+        } catch (e) {
+            throw new WrapError('Failed to lock file', e, 'LockFailed');
+        }
+        try {
+            await cb();
+        } catch (e) {
+            throw e;
+        } finally {
+            await release();
+        }
+    }
 }

yarn.lock

@@ -456,6 +456,13 @@
   resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.5.tgz#5f19d2b85a98e9558036f6a3cacc8819420f05cf"
   integrity sha512-JCB8C6SnDoQf0cNycqd/35A7MjcnK+ZTqE7judS6o7utxUCg6imJg3QK2qzHKszlTjcj2cn+NwMB2i96ubpj7w==
 
+"@types/proper-lockfile@^4.1.2":
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/@types/proper-lockfile/-/proper-lockfile-4.1.2.tgz#49537cee7134055ee13a1833b76a1c298f39bb26"
+  integrity sha512-kd4LMvcnpYkspDcp7rmXKedn8iJSCoa331zRRamUp5oanKt/CefbEGPQP7G89enz7sKD4bvsr8mHSsC8j5WOvA==
+  dependencies:
+    "@types/retry" "*"
+
 "@types/ps-node@^0.1.1":
   version "0.1.1"
   resolved "https://registry.yarnpkg.com/@types/ps-node/-/ps-node-0.1.1.tgz#fbbb7a0c55bf4e945756c023ccd205576f6177d2"
@@ -470,6 +477,11 @@
     "@types/scheduler" "*"
     csstype "^3.0.2"
 
+"@types/retry@*":
+  version "0.12.2"
+  resolved "https://registry.yarnpkg.com/@types/retry/-/retry-0.12.2.tgz#ed279a64fa438bb69f2480eda44937912bb7480a"
+  integrity sha512-XISRgDJ2Tc5q4TRqvgJtzsRkFYNJzZrhTdtMoGVBttwzzQJkPnS3WWTFc7kuDRoPtPakl+T+OfdEUjYJj7Jbow==
+
 "@types/scheduler@*":
   version "0.16.2"
   resolved "https://registry.yarnpkg.com/@types/scheduler/-/scheduler-0.16.2.tgz#1a62f89525723dde24ba1b01b092bf5df8ad4d39"
@@ -3173,6 +3185,15 @@ prom-client@^14.1.1:
   dependencies:
     tdigest "^0.1.1"
 
+proper-lockfile@^4.1.2:
+  version "4.1.2"
+  resolved "https://registry.yarnpkg.com/proper-lockfile/-/proper-lockfile-4.1.2.tgz#c8b9de2af6b2f1601067f98e01ac66baa223141f"
+  integrity sha512-TjNPblN4BwAWMXU8s9AEz4JmQxnD1NNL7bNOY/AKUzyamc379FWASUhc/K1pL2noVb+XmZKLL68cjzLsiOAMaA==
+  dependencies:
+    graceful-fs "^4.2.4"
+    retry "^0.12.0"
+    signal-exit "^3.0.2"
+
 protobufjs@^6.11.3, protobufjs@^6.8.8:
   version "6.11.3"
   resolved "https://registry.yarnpkg.com/protobufjs/-/protobufjs-6.11.3.tgz#637a527205a35caa4f3e2a9a4a13ddffe0e7af74"
@@ -3414,6 +3435,11 @@ resolve@^1.9.0:
     path-parse "^1.0.7"
     supports-preserve-symlinks-flag "^1.0.0"
 
+retry@^0.12.0:
+  version "0.12.0"
+  resolved "https://registry.yarnpkg.com/retry/-/retry-0.12.0.tgz#1b42a6266a21f07421d1b0b54b7dc167b01c013b"
+  integrity sha512-9LkiTwjUh6rT555DtE9rTX+BKByPfrMzEAtnlEtdEwr3Nkffwiihqe2bWADg+OQRjt9gl6ICdmB/ZFDCGAtSow==
+
 reusify@^1.0.4:
   version "1.0.4"
   resolved "https://registry.yarnpkg.com/reusify/-/reusify-1.0.4.tgz#90da382b1e126efc02146e90845a88db12925d76"
@@ -3573,7 +3599,7 @@ side-channel@^1.0.4:
     get-intrinsic "^1.0.2"
     object-inspect "^1.9.0"
 
-signal-exit@^3.0.0, signal-exit@^3.0.3:
+signal-exit@^3.0.0, signal-exit@^3.0.2, signal-exit@^3.0.3:
   version "3.0.7"
   resolved "https://registry.yarnpkg.com/signal-exit/-/signal-exit-3.0.7.tgz#a9a1767f8af84155114eaabd73f99273c8f59ad9"
   integrity sha512-wnD2ZE+l+SPC/uoS0vXeE9L1+0wuaMqKlfz9AMUo38JsyLSBWSFcHR1Rri62LZc12vLr1gb3jl7iwQhgwpAbGQ==